org.itsnat.core

Interface ClientDocument

All Superinterfaces:

ItsNatUserData

public interface ClientDocument
extends ItsNatUserData

Represents the document/page of the brower. A client document may be a "normal" document (owner) or a remote view/control document.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatDocument.getClientDocumentOwner(), ItsNatEvent.getClientDocument(), ItsNatServletRequest.getClientDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAsynchronousTask(Runnable task, boolean lockDoc, int maxWait, EventTarget target, EventListener listener, int commMode, ParamTransport[] extraParams, String preSendCode, long eventTimeout) Executes the specified task in a new thread and ensures that any DOM modification performed by this task is sent to the client when the task ends.
void	addAsynchronousTask(Runnable task, EventListener listener) Executes the specified task in a new thread and ensures that any DOM modification performed by this task is sent to the client when the task ends.
void	addCodeToSend(Object code) Add JavaScript code to send to the client (pending code).
void	addCodeToSendListener(CodeToSendListener listener) Registers a new CodeToSendListener, this listener is called every time addCodeToSend(Object) is called.
void	addContinueEventListener(EventTarget target, EventListener listener) Registers a "continue" EventListener with the document default communication mode and event timeout, no extra parameters and no custom JavaScript code.
void	addContinueEventListener(EventTarget target, EventListener listener, int commMode, ParamTransport[] extraParams, String preSendCode, long eventTimeout) Registers a "continue" EventListener.
void	addEventListener(EventListener listener) Adds a global event listener to this client.
void	addEventListener(EventTarget target, String type, EventListener listener, boolean useCapture) Registers a new DOM org.w3c.dom.events.EventListener with the document default communication mode and timeout, no extra parameters and no custom JavaScript code.
void	addEventListener(EventTarget target, String type, EventListener listener, boolean useCapture, int commMode) Registers a new DOM org.w3c.dom.events.EventListener with no extra parameters and no custom JavaScript code, and document default event timeout.
void	addEventListener(EventTarget target, String type, EventListener listener, boolean useCapture, int commMode, ParamTransport[] extraParams, String preSendCode, long eventTimeout) Registers a new DOM org.w3c.dom.events.EventListener.
void	addEventListener(EventTarget target, String type, EventListener listener, boolean useCapture, ParamTransport extraParam) Registers a new DOM org.w3c.dom.events.EventListener with document default communication mode and timeout, the specified extra parameter and no custom JavaScript code.
void	addEventListener(EventTarget target, String type, EventListener listener, boolean useCapture, ParamTransport[] extraParams) Registers a new DOM org.w3c.dom.events.EventListener with document default communication mode and timeout, the specified extra parameters and no custom JavaScript code.
void	addEventListener(EventTarget target, String type, EventListener listener, boolean useCapture, String preSendCode) Registers a new DOM org.w3c.dom.events.EventListener with document default communication mode and event timeout, no extra parameters and the specified custom JavaScript code.
void	addMutationEventListener(EventTarget target, EventListener listener, boolean useCapture) Registers a new DOM org.w3c.dom.events.EventListener to receive any node mutation as a mutation event fired by the client, using the default communication mode and timeout of the document and no custom JavaScript code.
void	addMutationEventListener(EventTarget target, EventListener listener, boolean useCapture, int commMode, String preSendCode, long eventTimeout) Registers a new DOM org.w3c.dom.events.EventListener to receive any node mutation as a mutation event fired by the client.
void	addUserEventListener(EventTarget target, String name, EventListener listener) Registers a "user" EventListener.
void	addUserEventListener(EventTarget target, String name, EventListener listener, int commMode, ParamTransport[] extraParams, String preSendCode, long eventTimeout) Registers a "user" EventListener.
CometNotifier	createCometNotifier() Creates a COMET notifier bound to this client and to the server document associated.
CometNotifier	createCometNotifier(int commMode, long eventTimeout) Creates a COMET notifier bound to this client and to the server document associated.
CometNotifier	createCometNotifier(int commMode, ParamTransport[] extraParams, String preSendCode, long eventTimeout) Creates a COMET notifier bound to this client and to the server document associated.
CometNotifier	createCometNotifier(long eventTimeout) Creates a COMET notifier bound to this client and to the server document associated.
ItsNatTimer	createItsNatTimer() Creates a timer utility object associated to this client.
void	disableSendCode() Disables the addCodeToSend(Object) method, no new code can be added to send to the client.
boolean	dispatchEvent(EventTarget target, Event evt) Sends the specified event to the browser and waits until this event is dispatched calling dispatchEvent (W3C browsers) or fireEvent (MSIE) on the browser.
boolean	dispatchEvent(EventTarget target, Event evt, int commMode, long eventTimeout) Sends the specified event to the browser and waits until this event is dispatched calling dispatchEvent (W3C browsers) or fireEvent (MSIE) on the browser.
void	enableSendCode() Enables the addCodeToSend(Object) method, new code can be added to send to the client.
long	getCreationTime() Returns the time in milliseconds when this object was created.
String	getId() Returns the client identity.
ItsNatDocument	getItsNatDocument() Returns the ItsNat document associated.
ItsNatSession	getItsNatSession() Returns the parent ItsNat session.
long	getLastRequestTime() Returns the time in milliseconds of the last access to the document using this client.
ScriptUtil	getScriptUtil() Returns the scripting utility.
boolean	isSendCodeEnabled() Informs whether JavaScript code can be added to send to the client calling addCodeToSend(Object)
void	removeCodeToSendListener(CodeToSendListener listener) Removes a previously registered CodeToSendListener.
void	removeEventListener(EventListener listener) Removes the specified global event listener registered in this client.
void	removeEventListener(EventTarget target, String type, EventListener listener, boolean useCapture) Removes the listener registration with the specified node target, name, listener and capture.
void	removeMutationEventListener(EventTarget target, EventListener listener, boolean useCapture) Removes the mutation listener registration with the specified node target, listener and capture.
void	removeUserEventListener(EventTarget target, String name, EventListener listener) Removes the listener registration with the specified node target, name and listener.
void	startEventDispatcherThread(Runnable task) Executes the specified task in a new thread, this code is ready to call EventTarget.dispatchEvent(Event) or dispatchEvent(EventTarget,Event,int,long) many times.

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getId

String getId()

Returns the client identity. This value is unique per ItsNatSession and never reused in this context.

The identity value is unique no other session-identified object in the same session shares the same id.

Although this object is garbage collected, the identity value is never reused by another session-identified object in the same session.

Returns:

the identity value.

getItsNatSession

ItsNatSession getItsNatSession()

Returns the parent ItsNat session. If this object is a remote control client the session may be different to the document owner session.

Returns:

the ItsNat session.

getItsNatDocument

ItsNatDocument getItsNatDocument()

Returns the ItsNat document associated.

If this object is a remote control client the document returned may be invalid (see ItsNatDocument.isInvalid()).

Returns:

the ItsNat document, may be null if this client is a remote control client.

addCodeToSend

void addCodeToSend(Object code)

Add JavaScript code to send to the client (pending code). This code is removed and sent to the client as the return of the load process or any event.

Use this method exceptionally when only this client must receive the code submitted, otherwise use ItsNatDocument.addCodeToSend(Object)

Parameters:

code - the code to send, Object.toString() is called to convert to string.

Throws:

ItsNatException - if no code can be added.

See Also:

isSendCodeEnabled(), ScriptUtil

isSendCodeEnabled

boolean isSendCodeEnabled()

Informs whether JavaScript code can be added to send to the client calling addCodeToSend(Object)

Returns:

true if new code can be added.

See Also:

disableSendCode()

disableSendCode

void disableSendCode()

Disables the addCodeToSend(Object) method, no new code can be added to send to the client.

See Also:

enableSendCode()

enableSendCode

void enableSendCode()

Enables the addCodeToSend(Object) method, new code can be added to send to the client.

See Also:

disableSendCode()

addCodeToSendListener

void addCodeToSendListener(CodeToSendListener listener)

Registers a new CodeToSendListener, this listener is called every time addCodeToSend(Object) is called.

Parameters:

listener - the new listener.

See Also:

removeCodeToSendListener(CodeToSendListener)

removeCodeToSendListener

void removeCodeToSendListener(CodeToSendListener listener)

Removes a previously registered CodeToSendListener.

Parameters:

listener - the new listener.

See Also:

addCodeToSendListener(CodeToSendListener)

getCreationTime

long getCreationTime()

Returns the time in milliseconds when this object was created.

Returns:

the creation time

getLastRequestTime

long getLastRequestTime()

Returns the time in milliseconds of the last access to the document using this client.

Returns:

the time of the last access.

getScriptUtil

ScriptUtil getScriptUtil()

Returns the scripting utility.

Returns:

the scripting utility.

createCometNotifier

CometNotifier createCometNotifier()

Creates a COMET notifier bound to this client and to the server document associated.

Current implementation calls createCometNotifier(long) with the default event timeout returned by ItsNatDocument.getEventTimeout().

Returns:

a new COMET notifier.

createCometNotifier

CometNotifier createCometNotifier(long eventTimeout)

Creates a COMET notifier bound to this client and to the server document associated.

The communication mode is the pure asynchronous mode of the default communication mode (CommMode.XHR_ASYNC or CommMode.SCRIPT)

Parameters:

eventTimeout - the timeout for any event used to notify the client. If negative no timeout is defined.

Returns:

a new COMET notifier.

See Also:

createCometNotifier(int,long)

createCometNotifier

CometNotifier createCometNotifier(int commMode,
                                long eventTimeout)

Creates a COMET notifier bound to this client and to the server document associated.

Parameters:

commMode - the communication mode, must be pure asynchronous.

eventTimeout - the timeout for any event used to notify the client. If negative no timeout is defined.

Returns:

a new COMET notifier.

See Also:

CommMode

createCometNotifier

CometNotifier createCometNotifier(int commMode,
                                ParamTransport[] extraParams,
                                String preSendCode,
                                long eventTimeout)

Creates a COMET notifier bound to this client and to the server document associated.

Parameters:

commMode - the communication mode, must be pure asynchronous.

extraParams - optional client to server data transport and synchronization rules. May be null.

preSendCode - custom JavaScript code to execute before an event of this listener type is fired. May be null.

eventTimeout - the timeout for any event used to notify the client. If negative no timeout is defined.

Returns:

a new COMET notifier.

See Also:

CommMode

startEventDispatcherThread

void startEventDispatcherThread(Runnable task)

Executes the specified task in a new thread, this code is ready to call EventTarget.dispatchEvent(Event) or dispatchEvent(EventTarget,Event,int,long) many times.

Use the thread created by this method to send events fired in the server to the browser simulating user actions.

This method must be called using a servlet-request thread.

Parameters:

task - the task to execute.

dispatchEvent

boolean dispatchEvent(EventTarget target,
                    Event evt)
                      throws EventException

Sends the specified event to the browser and waits until this event is dispatched calling dispatchEvent (W3C browsers) or fireEvent (MSIE) on the browser. The call returns when the event is processed by the browser.

Used the default communication mode of the document (ItsNatDocument.getCommMode()) and event timeout (ItsNatDocument.getEventTimeout()).

Parameters:

target - the event target DOM object.

evt - the DOM event to send to target.

Returns:

The return value is false if at least one of the event handlers which handled this event called Event.preventDefault(). Otherwise it returns true.

Throws:

EventException

See Also:

dispatchEvent(EventTarget,Event,int,long)

dispatchEvent

boolean dispatchEvent(EventTarget target,
                    Event evt,
                    int commMode,
                    long eventTimeout)
                      throws EventException

Sends the specified event to the browser and waits until this event is dispatched calling dispatchEvent (W3C browsers) or fireEvent (MSIE) on the browser. The call returns when the event is processed by the browser.

This method must not be called using a servlet-request thread. See the Reference Manual ("Events fired by the server" chapter) about requirements of the caller thread.

The commMode parameter and eventTimeout are used to specify the communication mode and timeout of the internal event sent to the server to notify the client has already dispatched the event.

Parameters:

target - the event target DOM object.

evt - the DOM event to send to target.

commMode - communication mode.

eventTimeout - the timeout of the event when asynchronous. If negative no timeout is defined.

Returns:

The return value is false if at least one of the event handlers which handled this event called Event.preventDefault(). Otherwise it returns true.

Throws:

EventException

See Also:

ItsNatDocument.dispatchEvent(EventTarget,Event), startEventDispatcherThread(Runnable code)

addContinueEventListener

void addContinueEventListener(EventTarget target,
                            EventListener listener)

Registers a "continue" EventListener with the document default communication mode and event timeout, no extra parameters and no custom JavaScript code.

Parameters:

target - optional target element usually useful along with ParamTransport objects. May be null.

listener - the listener to receive the event.

See Also:

addContinueEventListener(org.w3c.dom.events.EventTarget,org.w3c.dom.events.EventListener,int,org.itsnat.core.event.ParamTransport[],String,long)

addContinueEventListener

void addContinueEventListener(EventTarget target,
                            EventListener listener,
                            int commMode,
                            ParamTransport[] extraParams,
                            String preSendCode,
                            long eventTimeout)

Registers a "continue" EventListener.

When this listener is registered the server sends custom JavaScript code to fire automatically from browser a ItsNatContinueEvent sent to the listener. This event usually carries client data necesary to continue a pending server task (and any JavaScript code sent to the client prior to register the listener was executed, this new client state may be the carried data if any).

There is no "remove listener" method because the listener is automatically removed when receives and processes the event.

Parameters:

target - optional target element usually useful along with ParamTransport objects. May be null.

listener - the listener to receive the event.

commMode - communication mode.

extraParams - optional client to server data transport and synchronization rules. May be null.

preSendCode - custom JavaScript code to execute before an event of this listener type is fired. May be null.

eventTimeout - the timeout of asynchronous events. If negative no timeout is defined.

See Also:

CommMode

createItsNatTimer

ItsNatTimer createItsNatTimer()

Creates a timer utility object associated to this client.

Returns:

a timer object.

addAsynchronousTask

void addAsynchronousTask(Runnable task,
                       boolean lockDoc,
                       int maxWait,
                       EventTarget target,
                       EventListener listener,
                       int commMode,
                       ParamTransport[] extraParams,
                       String preSendCode,
                       long eventTimeout)

Executes the specified task in a new thread and ensures that any DOM modification performed by this task is sent to the client when the task ends.

If lockDoc is true this document is synchronized during the task execution, but if lockDoc is false the task code must synchronize the document before any access.

In a long running task is highly recommended to set lockDoc as false to avoid a long document lock.

Parameters:

task - the task to execute in a new thread.

lockDoc - whether the document is synchronized by the framework.

maxWait - maximum time in milliseconds to wait until the task ends. 0 means unlimited wait.

target - optional target element usually useful along with ParamTransport objects. May be null.

listener - the listener to receive the event when the client is going to be notified. May be null.

commMode - communication mode.

extraParams - optional client to server data transport and synchronization rules. May be null.

preSendCode - custom JavaScript code to execute before an event of this listener type is fired. May be null.

eventTimeout - the timeout for the event used to notify the client. If negative no timeout is defined.

addAsynchronousTask

void addAsynchronousTask(Runnable task,
                       EventListener listener)

Executes the specified task in a new thread and ensures that any DOM modification performed by this task is sent to the client when the task ends. The document is not locked and waits indefinitely.

Parameters:

task - the task to execute in a new thread.

listener - the listener to receive the event when the client is going to be notified. May be null.

See Also:

addAsynchronousTask(Runnable,boolean,int,EventTarget,EventListener,int,ParamTransport[],String,long)

addEventListener

void addEventListener(EventTarget target,
                    String type,
                    EventListener listener,
                    boolean useCapture)

Registers a new DOM org.w3c.dom.events.EventListener with the document default communication mode and timeout, no extra parameters and no custom JavaScript code.

Parameters:

target - target element. Can not be null.

type - the DOM event type name (click, change etc).

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

See Also:

addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.addEventListener(EventTarget,String,EventListener,boolean)

addEventListener

void addEventListener(EventTarget target,
                    String type,
                    EventListener listener,
                    boolean useCapture,
                    int commMode)

Registers a new DOM org.w3c.dom.events.EventListener with no extra parameters and no custom JavaScript code, and document default event timeout.

Parameters:

target - target element. Can not be null.

type - the DOM event type name (click, change etc).

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

commMode - communication mode.

See Also:

addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.addEventListener(EventTarget ,String ,EventListener ,boolean ,int )

addEventListener

void addEventListener(EventTarget target,
                    String type,
                    EventListener listener,
                    boolean useCapture,
                    ParamTransport extraParam)

Registers a new DOM org.w3c.dom.events.EventListener with document default communication mode and timeout, the specified extra parameter and no custom JavaScript code.

Parameters:

target - target element. Can not be null.

type - the DOM event type name (click, change etc).

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

extraParam - client to server data transport and synchronization rule.

See Also:

addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.addEventListener(EventTarget ,String ,EventListener ,boolean ,ParamTransport )

addEventListener

void addEventListener(EventTarget target,
                    String type,
                    EventListener listener,
                    boolean useCapture,
                    ParamTransport[] extraParams)

Registers a new DOM org.w3c.dom.events.EventListener with document default communication mode and timeout, the specified extra parameters and no custom JavaScript code.

Parameters:

target - target element. Can not be null.

type - the DOM event type name (click, change etc).

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

extraParams - client to server data transport and synchronization rules.

See Also:

addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.addEventListener(EventTarget ,String ,EventListener ,boolean ,ParamTransport[] )

addEventListener

void addEventListener(EventTarget target,
                    String type,
                    EventListener listener,
                    boolean useCapture,
                    String preSendCode)

Registers a new DOM org.w3c.dom.events.EventListener with document default communication mode and event timeout, no extra parameters and the specified custom JavaScript code.

Parameters:

target - target element. Can not be null.

type - the DOM event type name (click, change etc).

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

preSendCode - custom JavaScript code to execute before an event of this listener type is fired.

See Also:

addEventListener(EventTarget,String,EventListener,boolean,int,ParamTransport[],String,long), ItsNatDocument.addEventListener(EventTarget ,String ,EventListener ,boolean ,String )

addEventListener

void addEventListener(EventTarget target,
                    String type,
                    EventListener listener,
                    boolean useCapture,
                    int commMode,
                    ParamTransport[] extraParams,
                    String preSendCode,
                    long eventTimeout)

Registers a new DOM org.w3c.dom.events.EventListener.

When this listener is registered the server sends custom JavaScript code to register a handler in the client side with the specified node target and DOM event type. When an event is fired this handler forwards the client event to the server and the registered listener receives an org.w3c.dom.events.Event with the same client event data.

If two or more listeners are registered sharing the same node target and event type, they all will receive the same event.

Parameters:

target - target element. Can not be null.

type - the DOM event type name (click, change etc).

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

commMode - communication mode.

extraParams - optional client to server data transport and synchronization rules. May be null.

preSendCode - custom JavaScript code to execute before an event of this listener type is fired. May be null.

eventTimeout - the timeout of asynchronous events. If negative no timeout is defined.

See Also:

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

removeEventListener

void removeEventListener(EventTarget target,
                       String type,
                       EventListener listener,
                       boolean useCapture)

Removes the listener registration with the specified node target, name, listener and capture.

Parameters:

target - the target element. Can not be null.

type - the DOM event type name.

listener - the registered listener.

useCapture - event capture mode.

See Also:

addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.removeEventListener(org.w3c.dom.events.EventTarget, java.lang.String, org.w3c.dom.events.EventListener, boolean)

addMutationEventListener

void addMutationEventListener(EventTarget target,
                            EventListener listener,
                            boolean useCapture)

Registers a new DOM org.w3c.dom.events.EventListener to receive any node mutation as a mutation event fired by the client, using the default communication mode and timeout of the document and no custom JavaScript code.

Parameters:

target - target element. Can not be null.

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

See Also:

addMutationEventListener(org.w3c.dom.events.EventTarget,org.w3c.dom.events.EventListener,boolean,int,String,long), ItsNatDocument.addMutationEventListener(org.w3c.dom.events.EventTarget, org.w3c.dom.events.EventListener, boolean)

addMutationEventListener

void addMutationEventListener(EventTarget target,
                            EventListener listener,
                            boolean useCapture,
                            int commMode,
                            String preSendCode,
                            long eventTimeout)

Registers a new DOM org.w3c.dom.events.EventListener to receive any node mutation as a mutation event fired by the client.

When a mutation event is received, this event carries the necessary data to synchronize the server target element with the client. After this automatic synchronization, the listener is called.

Current implementation does the following:

  ParamTransport[] params = new ParamTransport[]{ new ClientMutation() };
        addEventListener(target,"DOMAttrModified",listener,useCapture,commMode,params,preSendCode,eventTimeout);
        addEventListener(target,"DOMNodeInserted",listener,useCapture,commMode,params,preSendCode,eventTimeout);
        addEventListener(target,"DOMNodeRemoved",listener,useCapture,commMode,params,preSendCode,eventTimeout);
        addEventListener(target,"DOMCharacterDataModified",listener,useCapture,commMode,params,preSendCode,eventTimeout);
 

If the target is the org.w3c.dom.Document object, every document change in the client is automatically synchronized in the server.

Mutation events only works with some W3C browses like Mozilla/FireFox, Safari and Opera (MSIE 6 does not support W3C DOM mutation events).

Parameters:

target - target element. Can not be null.

listener - the listener to receive events.

useCapture - if event capture is enabled. False is the most portable value (MSIE v6 does not support event capture).

commMode - communication mode.

preSendCode - custom JavaScript code to execute before an event of this listener type is fired. May be null.

eventTimeout - the timeout of asynchronous events. If negative no timeout is defined.

See Also:

removeMutationEventListener(org.w3c.dom.events.EventTarget,org.w3c.dom.events.EventListener,boolean), addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.addMutationEventListener(EventTarget ,EventListener ,boolean ,int ,String ,long )

removeMutationEventListener

void removeMutationEventListener(EventTarget target,
                               EventListener listener,
                               boolean useCapture)

Removes the mutation listener registration with the specified node target, listener and capture.

Parameters:

target - the target element. Can not be null.

listener - the registered listener.

useCapture - event capture mode.

See Also:

addMutationEventListener(org.w3c.dom.events.EventTarget,org.w3c.dom.events.EventListener,boolean,int,String,long), ItsNatDocument.removeMutationEventListener(EventTarget ,EventListener ,boolean )

addUserEventListener

void addUserEventListener(EventTarget target,
                        String name,
                        EventListener listener,
                        int commMode,
                        ParamTransport[] extraParams,
                        String preSendCode,
                        long eventTimeout)

Registers a "user" EventListener.

When this listener is registered the server sends custom JavaScript code to register a handler in the client side with the specified node target and name.

User events are fired in the client calling the ItsNat JavaScript method fireUserEvent(targetNode,name) or dispatchUserEvent(targetNode,evt) (where evt is a special user event see Manual for more info). For instance:

document.getItsNatDoc().fireUserEvent(document.body,"myUserAction");

Target node and name must be the same parameters used to register the listener.

If two or more listeners are registered sharing the same node target and name, they all will receive the same event fired by fireUserEvent with this target/name pair. If a listener instance was already registered and is registered again with the same target and name, this second call does nothing.

Parameters:

target - target element. Can not be null.

name - the user defined event type name.

listener - the listener to receive events.

commMode - communication mode.

extraParams - optional client to server data transport and synchronization rules. May be null.

preSendCode - custom JavaScript code to execute before an event of this listener type is fired. May be null.

eventTimeout - the timeout of asynchronous events. If negative no timeout is defined.

See Also:

removeUserEventListener(org.w3c.dom.events.EventTarget,String,EventListener), addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.addUserEventListener(org.w3c.dom.events.EventTarget, java.lang.String, org.w3c.dom.events.EventListener, int, org.itsnat.core.event.ParamTransport[], java.lang.String, long), CommMode

addUserEventListener

void addUserEventListener(EventTarget target,
                        String name,
                        EventListener listener)

Registers a "user" EventListener.

This method calls addUserEventListener(EventTarget,String,EventListener,int,ParamTransport[],String,long) with the document default values (communication mode, event timeout) and no extra parameters and custom code.

Parameters:

target - target element. Can not be null.

name - the user defined event type name.

listener - the listener to receive events.

See Also:

ItsNatDocument.addUserEventListener(EventTarget ,String ,EventListener )

removeUserEventListener

void removeUserEventListener(EventTarget target,
                           String name,
                           EventListener listener)

Removes the listener registration with the specified node target, name and listener.

Parameters:

target - the target element. Can not be null.

name - the user defined event type name.

listener - the registered listener.

See Also:

addUserEventListener(org.w3c.dom.events.EventTarget,String,EventListener,int,org.itsnat.core.event.ParamTransport[],String,long), ItsNatDocument.removeUserEventListener(EventTarget ,String ,EventListener)

addEventListener

void addEventListener(EventListener listener)

Adds a global event listener to this client. This listener is called when any DOM event (standard or extended) is received by this client.

The listener is called before calling any DOM event listener registered in this client. This listener registry is passive, in no way the client is modified (no listener is registered on the client) and usually used for monitoring.

Parameters:

listener - the listener to add.

See Also:

removeEventListener(EventListener), ItsNatServlet.addEventListener(EventListener), ItsNatDocumentTemplate.addEventListener(EventListener), ItsNatDocument.addEventListener(org.w3c.dom.events.EventListener)

removeEventListener

void removeEventListener(EventListener listener)

Removes the specified global event listener registered in this client.

Parameters:

listener - the listener to remove.

See Also:

addEventListener(EventListener), ItsNatDocument.removeEventListener(org.w3c.dom.events.EventListener)