org.itsnat.core.event

Class CustomParamTransport

java.lang.Object

org.itsnat.core.event.ParamTransport

org.itsnat.core.event.SingleParamTransport

org.itsnat.core.event.CustomParamTransport

All Implemented Interfaces:

Serializable

public class CustomParamTransport
extends SingleParamTransport

Is used to command ItsNat to transport one value from client to server using an event fired on the client and listened in the server.

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

Constructor and Description
CustomParamTransport(String name, String code) Creates a new instance ready to transport a value obtained in the client using the specified name and the specified JavaScript code.

Method Summary

Methods

Modifier and Type	Method and Description
String	getScriptCode() Returns the JavaScript code used to obtain the value to send to the server.

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

getName

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

CustomParamTransport

public CustomParamTransport(String name,
                    String code)

Creates a new instance ready to transport a value obtained in the client using the specified name and the specified JavaScript code. This code is executed to obtain the value before the event is sent to the server.

Parameters:

name - the name used to identify the value.

code - the JavaScript code used to obtain the value to send to the server.

Method Detail

getScriptCode

public String getScriptCode()

Returns the JavaScript code used to obtain the value to send to the server.

Returns:

code the JavaScript code.