com.sapportals.portal.prt.service.epcftoolbox

Interface IClientEventReceiver

All Superinterfaces:
IScriptGenerator

public interface IClientEventReceiver
extends IScriptGenerator

The interface that represents a receiver object for working with the EPCF toolbox.

The receiver object enables you to generate client script code that processes an incoming client-side event and transfers the corresponding parameters to the backend.

See Also:
IClientEventSender

Field Summary
static String EVENT_FILTER_ALL
          A constant that indicates the component accepts client events from all components, including its own events.
static String EVENT_FILTER_FOREIGN
          A constant that indicates the component accepts client events only from other components.
static String EVENT_FILTER_OWN
          A constant that indicates the component accepts only its own client events.
 
Method Summary
 String getParameter(String key)
          Returns a parameter value that was transferred from the client along with the event.
 boolean isReceived()
          Indicates whether the current component request has been triggered by the associated client-side event.
 void setEventFilter(String filter)
          Specifies which client-side events the receiver subscribed to.
 void setWaitingMessage(String message)
          Activates the displaying of a message when the content is loaded.
 
Methods inherited from interface com.sapportals.portal.prt.service.epcftoolbox.IScriptGenerator
getScript, getWrappedScript
 

Field Detail

EVENT_FILTER_ALL

static final String EVENT_FILTER_ALL
A constant that indicates the component accepts client events from all components, including its own events.

See Also:
setEventFilter(String), Constant Field Values

EVENT_FILTER_FOREIGN

static final String EVENT_FILTER_FOREIGN
A constant that indicates the component accepts client events only from other components.

See Also:
setEventFilter(String), Constant Field Values

EVENT_FILTER_OWN

static final String EVENT_FILTER_OWN
A constant that indicates the component accepts only its own client events.

See Also:
setEventFilter(String), Constant Field Values
Method Detail

isReceived

boolean isReceived()
Indicates whether the current component request has been triggered by the associated client-side event.

Returns:
true if the current component request has been triggered by the associated client-side event

getParameter

String getParameter(String key)
Returns a parameter value that was transferred from the client along with the event. When the parameter is not available, returns null.

Parameters:
key - the key of the parameter
Returns:
the value of the parameter or null if no such key exists

setEventFilter

void setEventFilter(String filter)
Specifies which client-side events the receiver subscribed to. The event filter can be one of the following:

Parameters:
filter - the event filter

setWaitingMessage

void setWaitingMessage(String message)
Activates the displaying of a message when the content is loaded. By default, this option is disabled in order to avoid flicker. The message must be localized in the component.

Parameters:
message - the message to be displayed
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/epcftoolbox/api api EP-PIN


Copyright 2015 SAP AG Complete Copyright Notice