oracle.adf.view.page.editor.event

Class ModeChangeEvent

java.lang.Object

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

oracle.adf.view.page.editor.event.ModeChangeEvent

public class ModeChangeEvent
extends PageEditorEvent

A ModeChangeEvent is a notification that the end-user has switched to edit mode from view mode.

Constructor Summary

Constructors

Constructor and Description
ModeChangeEvent(java.lang.String newMode, java.lang.String oldMode)

Method Summary

Modifier and Type	Method and Description
Event	getEventType() Returns the type of this event.
java.lang.String	getNewMode() Returns new mode when mode is changed from edit to view or viceversa.
java.lang.String	getOldMode() Returns the old mode when mode is changed from edit to view or viceversa.
void	processListener(PageEditorListener listener) Calling this method throws UnsupportedOperationException Method is not supported for ModeChangeEvent.

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

ModeChangeEvent

public ModeChangeEvent(java.lang.String newMode,
                       java.lang.String oldMode)

Method Detail

getEventType

public final Event getEventType()

Returns the type of this event.

Specified by:

getEventType in class PageEditorEvent

Returns:

Returns Event.EDIT_MODE_EVENT.

processListener

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

Calling this method throws UnsupportedOperationException Method is not supported for ModeChangeEvent.

Specified by:

processListener in class PageEditorEvent

Parameters:

listener - PageEditorListener to send this CloseEvent to.

Throws:

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

getOldMode

public java.lang.String getOldMode()

Returns the old mode when mode is changed from edit to view or viceversa.

Returns:

Returns ModeContext.EDIT_MODE if the current mode is Edit and switching to View mode. Returns ModeContext.VIEW_MODE if the current mode is View and switching to Edit mode.

getNewMode

public java.lang.String getNewMode()

Returns new mode when mode is changed from edit to view or viceversa.

Returns:

Returns ModeContext.VIEW_MODE if the current mode is Edit and switching to View mode. Returns ModeContext.EDIT_MODE if the current mode is View and switching to Edit mode.