com.sapportals.portal.prt.service.epcftoolbox
Interface IClientEventReceiver

All Superinterfaces:

IScriptGenerator

public interface IClientEventReceiver

extends IScriptGenerator

interface for receiver object in the eventing pattern. The receiver object allows to generate client script code, which process an incoming client side event, transfer the corresponding parameter to the backend.

See Also:

IClientEventSender

Field Summary

static java.lang.String	EVENT_FILTER_ALL EventFilter: component accepts any client events
static java.lang.String	EVENT_FILTER_FOREIGN EventFilter: component accepts only client events from another components but not his own
static java.lang.String	EVENT_FILTER_OWN EventFilter: component accepts only own client events

Method Summary

java.lang.String	getParameter(java.lang.String key) returns paramerer value transferred from the client along with the event.
boolean	isReceived() returns true when the current component request has been triggered by the associated client side event.
void	setEventFilter(java.lang.String filter) specifies which client side events should be accepted by the receiver.
void	setWaitingMessage(java.lang.String message) activates displaying of message when the content is loaded.

Methods inherited from interface com.sapportals.portal.prt.service.epcftoolbox.IScriptGenerator

getScript, getWrappedScript

Field Detail

EVENT_FILTER_ALL

public static final java.lang.String EVENT_FILTER_ALL

EventFilter: component accepts any client events

See Also:

setEventFilter(java.lang.String)

EVENT_FILTER_FOREIGN

public static final java.lang.String EVENT_FILTER_FOREIGN

EventFilter: component accepts only client events from another components but not his own

See Also:

setEventFilter(java.lang.String)

EVENT_FILTER_OWN

public static final java.lang.String EVENT_FILTER_OWN

EventFilter: component accepts only own client events

See Also:

setEventFilter(java.lang.String)

Method Detail

isReceived

public boolean isReceived()

returns true when the current component request has been triggered by the associated client side event. Otherwise returns false

getParameter

public java.lang.String getParameter(java.lang.String key)

returns paramerer value transferred from the client along with the event. When the parameter is not availble, returns null.

setEventFilter

public void setEventFilter(java.lang.String filter)

specifies which client side events should be accepted by the receiver. By default the component reacts only to events from the another components or iViews.

See Also:

EVENT_FILTER_ALL, EVENT_FILTER_FOREIGN, EVENT_FILTER_OWN

setWaitingMessage

public void setWaitingMessage(java.lang.String message)

activates displaying of message when the content is loaded. By default this option is disabled in order to avoid flicker. The message must be localized inside of the each component.