org.itsnat.core.event

Interface ItsNatEvent

All Superinterfaces:

ItsNatUserData

All Known Subinterfaces:

ItsNatAsyncTaskEvent, ItsNatAttachedClientCometEvent, ItsNatAttachedClientEvent, ItsNatAttachedClientTimerEvent, ItsNatCometEvent, ItsNatContinueEvent, ItsNatDOMExtEvent, ItsNatDOMStdEvent, ItsNatEventDOMStateless, ItsNatEventStateless, ItsNatKeyEvent, ItsNatNormalEvent, ItsNatTimerEvent, ItsNatUserEvent

public interface ItsNatEvent
extends ItsNatUserData

This interface is the parent of any ItsNat event interface: normal and remote view/control events.

Any org.w3c.dom.events.Event object managed by ItsNat implements this interface.

Current implementation inherits from java.util.EventObject.

Author:

Jose Maria Arranz Santamaria

Method Summary

Methods

Modifier and Type	Method and Description
ClientDocument	getClientDocument() Returns the associated client document target of this event.
int	getCommMode() Returns the communication mode used to send this event.
java.lang.Object	getExtraParam(java.lang.String name) Returns the remote value carried alongside this event with the specified name.
java.lang.Object[]	getExtraParamMultiple(java.lang.String name) Returns the remote values carried alongside this event with the specified name in case of multiple values.
ItsNatDocument	getItsNatDocument() Returns the associated ItsNat document target of this event.
ItsNatEventListenerChain	getItsNatEventListenerChain() Returns the event listener chain flow control object associated to this event.
ItsNatServletRequest	getItsNatServletRequest() Returns the associated ItsNat Servlet Request of this event.
ItsNatServletResponse	getItsNatServletResponse() Returns the associated ItsNat Servlet Response of this event.
void	setExtraParam(java.lang.String name, java.lang.Object value) Sets the specified name and value as a remote browser data carried by this event.

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getItsNatServletRequest

ItsNatServletRequest getItsNatServletRequest()

Returns the associated ItsNat Servlet Request of this event.

Returns:

the current request.

getItsNatServletResponse

ItsNatServletResponse getItsNatServletResponse()

Returns the associated ItsNat Servlet Response of this event.

Returns:

the current response.

getItsNatDocument

ItsNatDocument getItsNatDocument()

Returns the associated ItsNat document target of this event.

Returns:

the ItsNat document. May be null.

See Also:

ItsNatServletRequest.getItsNatDocument()

getClientDocument

ClientDocument getClientDocument()

Returns the associated client document target of this event.

Returns:

the client document. Is null getItsNatDocument() is null too.

See Also:

ItsNatServletRequest.getClientDocument()

getCommMode

int getCommMode()

Returns the communication mode used to send this event.

Returns:

the communication mode.

getExtraParam

java.lang.Object getExtraParam(java.lang.String name)

Returns the remote value carried alongside this event with the specified name.

Usually these name/value pairs are declared using ParamTransport objects.

Current implementation calls: ServletRequest.getParameter(String) with the specified name, if the name/value pair was not set calling setExtraParam(String,Object).

Parameters:

name - the name to search for.

Returns:

the value carried with the specified name.

getExtraParamMultiple

java.lang.Object[] getExtraParamMultiple(java.lang.String name)

Returns the remote values carried alongside this event with the specified name in case of multiple values.

Usually these name/value pairs are declared using ParamTransport objects.

Current implementation calls: ServletRequest.getParameterValues(String) with the specified name, if the name/value pair was not set calling setExtraParam(String,Object).

Parameters:

name - the name to search for.

Returns:

the value carried with the specified name.

See Also:

getExtraParam(String)

setExtraParam

void setExtraParam(java.lang.String name,
                 java.lang.Object value)

Sets the specified name and value as a remote browser data carried by this event.

This method may be useful to simulate data transportation from the browser in an event directly (locally) dispatched to the server DOM calling ItsNatDocument.dispatchEventLocally(EventTarget,Event).

Parameters:

name - the name of the value.

value - the value associated the specified name.

getItsNatEventListenerChain

ItsNatEventListenerChain getItsNatEventListenerChain()

Returns the event listener chain flow control object associated to this event.

Returns:

the listener flow control object of this event. May be null if this capability is not enabled for this type of event or this event is no longer valid.