com.sapportals.portal.prt.event

Interface IPortalComponentEvent

All Superinterfaces:

IEvent, IPOMConstants

public interface IPortalComponentEvent
extends IEvent

The IPortalComponentEvent is an extension of the IEvent interface. This specific event carries a name and some data accesible through the IPortalComponentEventData interface.
This event has the type COMPONENT_EVENT. Listeners can register to this type and receive this event. When receiving this event on a PortalComponent that implements the interface IEventListenerComponent the method handleEvent(request,event) will be trigerred.
There is also an ability to register to these events using a special filter. A abstract implementation is provided in AbstractComponentEventFilter for convenience.

See Also:

IEventFilter AbstractComponentEventFilter

Field Summary

Fields inherited from interface com.sapportals.portal.prt.pom.IPOMConstants

ABOUT_MODE, ABOUT_REQUEST_EVENT, ACTION_EVENT, AFTER_CONTENT_EVENT, BEFORE_CONTENT_EVENT, COMPONENT_EVENT, COMPONENT_NODE, DEFAULT_MODE, EDIT_ACKNOWLEDGE_EVENT, EDIT_MODE, EDIT_REQUEST_EVENT, HELP_MODE, HELP_REQUEST_EVENT, LOGON_EVENT, LOGON_MODE, LOGOUT_EVENT, ON_NODE_READY_EVENT, ON_NODE_REMOVE_EVENT, ON_POM_READY_EVENT, PORTAL_NODE, PREVIEW_MODE, PREVIEW_REQUEST_EVENT, REFRESH_MODE, REFRESH_REQUEST_EVENT, REQUEST_EVENT, TEST_MODE

Method Summary

IPortalComponentEventData	getEventData() returns the object that has fired this event.
String	getName() gets the name of this event.
String	getNameSpace() Deprecated.
IPortalComponentContext	getSource() Deprecated.

Methods inherited from interface com.sapportals.portal.prt.pom.IEvent

getBubbles, getCancelable, getCurrentTarget, getTarget, getType, setCurrentTarget, setTarget, stopPropagation

Method Detail

getEventData

IPortalComponentEventData getEventData()

returns the object that has fired this event.

Returns:

the source of the event.

getSource

IPortalComponentContext getSource()

Deprecated.

returns the object that has fired this event.

Returns:

the source of the event.

getNameSpace

String getNameSpace()

Deprecated.

gets the name of the context on which this event has been created. A null context means global

Returns:

The context of this event

getName

String getName()

gets the name of this event.

Returns:

The name of the event

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT