org.apache.myfaces.application
Class NavigationHandlerImpl
java.lang.Object
javax.faces.application.NavigationHandler
javax.faces.application.ConfigurableNavigationHandler
org.apache.myfaces.application.NavigationHandlerImpl
public class NavigationHandlerImpl
- extends ConfigurableNavigationHandler
- Version:
- $Revision: 1570052 $ $Date: 2014-02-19 20:58:02 -0500 (Wed, 19 Feb 2014) $
- Author:
- Thomas Spiegl (latest modification by $Author: lu4242 $), Anton Koinov
Nested Class Summary |
protected static class |
NavigationHandlerImpl.NavigationContext
A navigation command is an operation to do by the navigation handler like
do a redirect, execute a normal navigation or enter or exit a flow. |
Method Summary |
String |
beforeNavigation(String viewId)
TODO
Invoked by the navigation handler before the new view component is created. |
NavigationCase |
getNavigationCase(FacesContext facesContext,
String fromAction,
String outcome)
Returns the navigation case that applies for the given action and outcome |
Map<String,Set<NavigationCase>> |
getNavigationCases()
|
NavigationCase |
getNavigationCommand(FacesContext facesContext,
NavigationHandlerImpl.NavigationContext navigationContext,
String fromAction,
String outcome,
String toFlowDocumentId)
|
NavigationCase |
getNavigationCommandFromGlobalNavigationCases(FacesContext facesContext,
String viewId,
NavigationHandlerImpl.NavigationContext navigationContext,
String fromAction,
String outcome)
|
protected NavigationHandlerSupport |
getNavigationHandlerSupport()
|
String |
getViewId(FacesContext context,
String fromAction,
String outcome)
Returns the view ID that would be created for the given action and outcome |
void |
handleNavigation(FacesContext facesContext,
String fromAction,
String outcome)
|
void |
handleNavigation(FacesContext facesContext,
String fromAction,
String outcome,
String toFlowDocumentId)
|
void |
inspectFlow(FacesContext context,
Flow flow)
|
void |
setNavigationHandlerSupport(NavigationHandlerSupport navigationHandlerSupport)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
NavigationHandlerImpl
public NavigationHandlerImpl()
handleNavigation
public void handleNavigation(FacesContext facesContext,
String fromAction,
String outcome)
- Specified by:
handleNavigation
in class NavigationHandler
handleNavigation
public void handleNavigation(FacesContext facesContext,
String fromAction,
String outcome,
String toFlowDocumentId)
- Overrides:
handleNavigation
in class NavigationHandler
getNavigationHandlerSupport
protected NavigationHandlerSupport getNavigationHandlerSupport()
- Returns:
- the navigationHandlerSupport
setNavigationHandlerSupport
public void setNavigationHandlerSupport(NavigationHandlerSupport navigationHandlerSupport)
getNavigationCase
public NavigationCase getNavigationCase(FacesContext facesContext,
String fromAction,
String outcome)
- Returns the navigation case that applies for the given action and outcome
- Specified by:
getNavigationCase
in class ConfigurableNavigationHandler
getNavigationCommandFromGlobalNavigationCases
public NavigationCase getNavigationCommandFromGlobalNavigationCases(FacesContext facesContext,
String viewId,
NavigationHandlerImpl.NavigationContext navigationContext,
String fromAction,
String outcome)
getNavigationCommand
public NavigationCase getNavigationCommand(FacesContext facesContext,
NavigationHandlerImpl.NavigationContext navigationContext,
String fromAction,
String outcome,
String toFlowDocumentId)
getViewId
public String getViewId(FacesContext context,
String fromAction,
String outcome)
- Returns the view ID that would be created for the given action and outcome
beforeNavigation
public String beforeNavigation(String viewId)
- TODO
Invoked by the navigation handler before the new view component is created.
- Parameters:
viewId
- The view ID to be created
- Returns:
- The view ID that should be used instead. If null, the view ID passed
in will be used without modification.
getNavigationCases
public Map<String,Set<NavigationCase>> getNavigationCases()
- Specified by:
getNavigationCases
in class ConfigurableNavigationHandler
inspectFlow
public void inspectFlow(FacesContext context,
Flow flow)
- Overrides:
inspectFlow
in class ConfigurableNavigationHandler
Copyright © 2014 The Apache Software Foundation. All rights reserved.