oracle.adf.view.page.editor.event

Class NavigationEvent

java.lang.Object

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

oracle.adf.view.page.editor.event.NavigationEvent

public class NavigationEvent
extends PageEditorEvent

A NavigationEvent is a notification that the end-user has navigated to a different view.

The previous view id and the current view id can be obtained by calling the getPreviousView and getNewView respectively.

This event is delivered during the Render Response phase. Note: This may change in the future.

Since:

11.1.1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NavigationEvent.NavigationType Enumeration that determines the type of the navigation.

Constructor Summary

Constructors

Constructor and Description
NavigationEvent(java.lang.String newView, java.lang.String oldView)
NavigationEvent(java.lang.String newView, java.lang.String oldView, NavigationEvent.NavigationType navigationType)

Method Summary

Modifier and Type	Method and Description
Event	getEventType() Returns the type of this event.
NavigationEvent.NavigationType	getNavigationType() Returns the type of the navigation.
java.lang.String	getNewView() Returns the view id of the page that is currently navigated to.
java.lang.String	getPreviousView() Returns the view id of last viewed page.
void	processListener(PageEditorListener listener) Broadcast this NavigationEvent 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

NavigationEvent

public NavigationEvent(java.lang.String newView,
                       java.lang.String oldView)

NavigationEvent

public NavigationEvent(java.lang.String newView,
                       java.lang.String oldView,
                       NavigationEvent.NavigationType navigationType)

Method Detail

getEventType

public final Event getEventType()

Returns the type of this event.

Specified by:

getEventType in class PageEditorEvent

Returns:

Returns Event.NAVIGATION_EVENT.

processListener

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

Broadcast this NavigationEvent to the specified PageEditorListener, by whatever mechanism is appropriate. This is accomplished by calling processNavigation method on NavigationListener, and passing this NavigationEvent as a paramter.

Specified by:

processListener in class PageEditorEvent

Parameters:

listener - PageEditorListener to send this NavigationEvent to.

Throws:

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

getPreviousView

public java.lang.String getPreviousView()

Returns the view id of last viewed page.

Returns:

view id of the the page that was last visited.

getNewView

public java.lang.String getNewView()

Returns the view id of the page that is currently navigated to.

Returns:

view id of the current page.

getNavigationType

public NavigationEvent.NavigationType getNavigationType()

Returns the type of the navigation.

Returns:

Returns NavigationType.PAGE_NAVIGATION if the user navigated to another page. Returns NavigationType.TASKFLOW_NAVIGATION if the user navigated within a taskflow. Note: Currently, the listener is not notified of taskflow navigation.