oracle.adf.view.page.editor.event

Class CloseEvent

java.lang.Object

oracle.adf.view.page.editor.event.PageEditorEvent

oracle.adf.view.page.editor.event.CloseEvent

public class CloseEvent
extends PageEditorEvent

A CloseEvent is a notification that the Close button on the Oracle Composer has been clicked by the end user.

CloseEvent does not have parameters.

Since:

11.1.1.0.1BETA

Constructor Summary

Constructors

Constructor and Description
CloseEvent() Overloaded constructor to be used for creating close event in sandboxed MDS interactions without commiting the changes.
CloseEvent(boolean isCommit) Overloaded constructor to be used for creating close event in sandboxed MDS interactions, when the page is being marked for persisting the customizations at the end of current request lifecycle

Method Summary

Modifier and Type	Method and Description
Event	getEventType() Returns the type of this event.
boolean	isCommit() Returns true if this event was created to indicate that the page was marked to commit the customizations done to the page at the end of the current request lifecycle.
void	processListener(PageEditorListener listener) Broadcast this CloseEvent to the specified PageEditorListener, by whatever mechanism is appropriate.

Methods inherited from class oracle.adf.view.page.editor.event.PageEditorEvent

isEventHandled, setEventHandled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloseEvent

public CloseEvent()

Overloaded constructor to be used for creating close event in sandboxed MDS interactions without commiting the changes.

CloseEvent

public CloseEvent(boolean isCommit)

Overloaded constructor to be used for creating close event in sandboxed MDS interactions, when the page is being marked for persisting the customizations at the end of current request lifecycle

Parameters:

isCommit - set this to true to indicate page commit

Method Detail

processListener

public void processListener(PageEditorListener listener)
                     throws javax.faces.event.AbortProcessingException

Broadcast this CloseEvent to the specified PageEditorListener, by whatever mechanism is appropriate. This is accomplished by calling processClose method on CloseListener, and passing this CloseEvent as a paramter.

Specified by:

processListener in class PageEditorEvent

Parameters:

listener - PageEditorListener to send this CloseEvent to.

Throws:

javax.faces.event.AbortProcessingException - Signal Oracle Composer that no further processing on the current event should be performed.

getEventType

public final Event getEventType()

Returns the type of this event.

Specified by:

getEventType in class PageEditorEvent

Returns:

Returns Event.CLOSE_EVENT.

isCommit

public boolean isCommit()

Returns true if this event was created to indicate that the page was marked to commit the customizations done to the page at the end of the current request lifecycle. It returns false if the event was created to indicate that a close should be performed without commiting changes.

Returns:

true if page was marked to commit customizations, false otherwise