|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.page.editor.event.PageEditorEvent
oracle.adf.view.page.editor.event.NavigationEvent
public class NavigationEvent
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.
Nested Class Summary | |
---|---|
static class |
NavigationEvent.NavigationType Enumeration that determines the type of the navigation. |
Constructor Summary | |
---|---|
NavigationEvent(java.lang.String newView, java.lang.String oldView) |
|
NavigationEvent(java.lang.String newView, java.lang.String oldView, NavigationEvent.NavigationType navigationType) |
Method Summary | |
---|---|
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 |
---|
public NavigationEvent(java.lang.String newView, java.lang.String oldView)
public NavigationEvent(java.lang.String newView, java.lang.String oldView, NavigationEvent.NavigationType navigationType)
Method Detail |
---|
public final Event getEventType()
getEventType
in class PageEditorEvent
Event.NAVIGATION_EVENT
.public void processListener(PageEditorListener listener) throws javax.faces.event.AbortProcessingException
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.processListener
in class PageEditorEvent
listener
- PageEditorListener
to send this NavigationEvent
to.javax.faces.event.AbortProcessingException
- Signal Oracle Composer that no further processing on the current event should be performed.public java.lang.String getPreviousView()
public java.lang.String getNewView()
public NavigationEvent.NavigationType getNavigationType()
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.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |