com.ibm.tivoli.maximo.map

Class MapControlClientEvent

java.lang.Object

com.ibm.tivoli.maximo.map.MapControlClientEvent

public class MapControlClientEvent
extends java.lang.Object

Controller for the Map component. It loads the configuration and implements the action.

Author:

rosado

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_EVENT_TARGET_EVENT_NAME Event handler (ie, method) in this Class that will respond to push to client events

Constructor Summary

Constructors

Constructor and Description
MapControlClientEvent(ControlInstance control)

Method Summary

Modifier and Type	Method and Description
java.util.List<ClientEvent>	getClientEvents() This will return a COPY of the list of the client events that need to sent to the client.
boolean	hasClientEvents() Returns true if there are pending client events that need to be pushed to the browser.
static WebClientEvent	pushClientEvent(WebClientSession clientSession, java.lang.String controlId, java.lang.String eventName, java.lang.String eventArgs) Convenience method for creating and pushing a client event to a map control.
int	pushMapControlClientEventHandler() means for the server code to dispatch ClientEvent instances to the browser map control.
static WebClientEvent	sendClientEvent(WebClientSession clientSession, java.lang.String controlId, java.lang.String eventName, java.lang.String eventArgs) Convenience shortcut method to handleEvent(WebClientSession, WebClientEvent) to a map control.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_EVENT_TARGET_EVENT_NAME

public static final java.lang.String CLIENT_EVENT_TARGET_EVENT_NAME

Event handler (ie, method) in this Class that will respond to push to client events

See Also:

Constant Field Values

Constructor Detail

MapControlClientEvent

public MapControlClientEvent(ControlInstance control)

Method Detail

pushMapControlClientEventHandler

public int pushMapControlClientEventHandler()

means for the server code to dispatch ClientEvent instances to the browser map control. ClientEvent instances are sent using dojo's topic subscription model

Returns:

EVENT_HANDLED

pushClientEvent

public static WebClientEvent pushClientEvent(WebClientSession clientSession,
                                             java.lang.String controlId,
                                             java.lang.String eventName,
                                             java.lang.String eventArgs)

Convenience method for creating and pushing a client event to a map control.

Parameters:

clientSession - current WebClientSession

controlId - control id (ie, map control id to handle the event)

eventName - dojo event name the client will have subscribed to

eventArgs - an option string contain some data to pass along in the event

Returns:

sendClientEvent

public static WebClientEvent sendClientEvent(WebClientSession clientSession,
                                             java.lang.String controlId,
                                             java.lang.String eventName,
                                             java.lang.String eventArgs)

Convenience shortcut method to handleEvent(WebClientSession, WebClientEvent) to a map control.

Parameters:

clientSession - current WebClientSession

controlId - control id (ie, map control id to handle the event)

eventName - dojo event name the client will have subscribed to

eventArgs - an option string contain some data to pass along in the event

Returns:

WebClientEvent

See Also:

handleEvent(WebClientSession, WebClientEvent)

hasClientEvents

public boolean hasClientEvents()

Returns true if there are pending client events that need to be pushed to the browser.

Returns:

getClientEvents

public java.util.List<ClientEvent> getClientEvents()

This will return a COPY of the list of the client events that need to sent to the client. This method will clear the event list, so multiple calls this will return an empty list. Hold a reference to the returned list, if you need to access it multiple times.

Returns: