org.itsnat.core.event

Class SingleParamTransport

java.lang.Object

org.itsnat.core.event.ParamTransport

org.itsnat.core.event.SingleParamTransport

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CustomParamTransport, NodeAttributeTransport, NodeInnerTransport, NodePropertyTransport

public abstract class SingleParamTransport
extends ParamTransport

Is the base class of "transport" classes which carry one named value, these classes are used to send custom data from client to server using an event fired on the client and listened in the server.

Derived classes may do some kind of automatic synchronization in the server, for instance an attribute of a client element can be transported and updated the server counterpart element.

With or without synchronization the transported value can be obtained calling ItsNatEvent.getExtraParam(String)

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatDocument.addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,ParamTransport[],String,long), Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleParamTransport(String name, boolean sync) Creates a new instance ready to transport a client value with the specified name with optional server synchronization.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the item name for instance a property or attribute name.

Methods inherited from class org.itsnat.core.event.ParamTransport

isSync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleParamTransport

protected SingleParamTransport(String name,
                    boolean sync)

Creates a new instance ready to transport a client value with the specified name with optional server synchronization.

Parameters:

name - the attribute name.

sync - if true the server attribute is updated.

Method Detail

getName

public String getName()

Returns the item name for instance a property or attribute name.

Returns:

the item name.