com.sapportals.portal.prt.pom

Interface IEvent

All Superinterfaces:

IPOMConstants

All Known Subinterfaces:

IModeChangeEvent, IPortalComponentEvent, IPortalRequestEvent, IProfileValidationEvent

All Known Implementing Classes:

AbstractEvent

public interface IEvent
extends IPOMConstants

This interface describes an event object in the Portal Object Model.

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

boolean	getBubbles() Finds out whether this event bubbles
boolean	getCancelable() Finds out wether this event's bubbling can be canceled
INode	getCurrentTarget() Gets the current target node of this event
INode	getTarget() Gets the original target of the event.
EventType	getType() Retrieves the type of the event.
void	setCurrentTarget(INode eventTarget) Sets the current target of the event, i.e. the one those listener will have this event dispatched to.
void	setTarget(INode target) Defines the original target of the event, i.e. the target the event was originally fired on Note: This method should not be called directly, instead the portal implementation will use it to indicate the event's target.
void	stopPropagation() Stops the propagation (for now only bubbling) of the event

Method Detail

getType

EventType getType()

Retrieves the type of the event.

Returns:

the event type

getBubbles

boolean getBubbles()

Finds out whether this event bubbles

Returns:

true if the event has bubbling behavior else false.

getCurrentTarget

INode getCurrentTarget()

Gets the current target node of this event

Returns:

The target node.

getTarget

INode getTarget()

Gets the original target of the event.
An event can be dispatched to several nodes. The current target is available via getCurrentTargetMethod.

Returns:

the original target node

setCurrentTarget

void setCurrentTarget(INode eventTarget)

Sets the current target of the event, i.e. the one those listener will have this event dispatched to.
Note: This method should not be called directly, instead the portal implementation will use it to indicate the current target. The set value will not be evaluated by the portal implementation.

Parameters:

eventTarget -

setTarget

void setTarget(INode target)

Defines the original target of the event, i.e. the target the event was originally fired on
Note: This method should not be called directly, instead the portal implementation will use it to indicate the event's target. The set value will not be evaluated by the portal implementation.

Parameters:

target -

getCancelable

boolean getCancelable()

Finds out wether this event's bubbling can be canceled

stopPropagation

void stopPropagation()

Stops the propagation (for now only bubbling) 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/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN