|
SAP NetWeaver 7.31 Enterprise Portal (SP 16) | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IClientEventReceiver
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.
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 |
|---|
static final String EVENT_FILTER_ALL
setEventFilter(String),
Constant Field Valuesstatic final String EVENT_FILTER_FOREIGN
setEventFilter(String),
Constant Field Valuesstatic final String EVENT_FILTER_OWN
setEventFilter(String),
Constant Field Values| Method Detail |
|---|
boolean isReceived()
String getParameter(String key)
key - the key of the parameter
void setEventFilter(String filter)
EVENT_FILTER_ALL - the receiver subscribes to events from all components.EVENT_FILTER_FOREIGN - the receiver subscribes only to events from other components (default).EVENT_FILTER_OWN - the receiver subscribes only to its own events.
filter - the event filtervoid setWaitingMessage(String message)
message - the message to be displayed| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] EP-RUNTIME
|
[sap.com] tc/ep/epcftoolbox/api
|
api
|
EP-PIN
|
|
SAP NetWeaver 7.31 Enterprise Portal (SP 16) | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||