Package javax.faces.application
Class ConfigurableNavigationHandlerWrapper
java.lang.Object
javax.faces.application.NavigationHandler
javax.faces.application.ConfigurableNavigationHandler
javax.faces.application.ConfigurableNavigationHandlerWrapper
- All Implemented Interfaces:
FacesWrapper<ConfigurableNavigationHandler>
public abstract class ConfigurableNavigationHandlerWrapper
extends ConfigurableNavigationHandler
implements FacesWrapper<ConfigurableNavigationHandler>
Provides a simple implementation of
ConfigurableNavigationHandler
that can be subclassed by developers wishing
to provide specialized behavior to an existing ConfigurableNavigationHandler
instance. The default implementation of all methods
is to call through to the wrapped ConfigurableNavigationHandler
.
Usage: extend this class and override getWrapped()
to
return the instance we are wrapping.
- Since:
- 2.2
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetNavigationCase
(FacesContext context, String fromAction, String outcome) Return theNavigationCase
representing the navigation that would be taken hadNavigationHandler.handleNavigation(javax.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments ornull
if there is no such case.getNavigationCase
(FacesContext context, String fromAction, String outcome, String toFlowDocumentId) Return theNavigationCase
representing the navigation that would be taken hadNavigationHandler.handleNavigation(javax.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments ornull
if there is no such case.Return aMap<String, Set<NavigationCase>>
where the keys are<from-view-id>
values and the values areSet<NavigationCase>
where each element in the Set is aNavigationCase
that applies to that<from-view-id>
.abstract ConfigurableNavigationHandler
A class that implements this interface uses this method to return an instance of the class being wrapped.void
handleNavigation
(FacesContext context, String fromAction, String outcome) Perform navigation processing based on the state information in the specifiedFacesContext
, plus the outcome string returned by an executed application action.void
inspectFlow
(FacesContext context, Flow flow) Called by the flow system to cause the flow to be inspected for navigation rules.void
performNavigation
(String outcome) A convenience method to signal the JavaServer Faces implementation to perform navigation with the provided outcome.Methods inherited from class javax.faces.application.NavigationHandler
handleNavigation
-
Constructor Details
-
ConfigurableNavigationHandlerWrapper
public ConfigurableNavigationHandlerWrapper()
-
-
Method Details
-
getWrapped
Description copied from interface:FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<ConfigurableNavigationHandler>
- Returns:
- the instance that we are wrapping.
-
inspectFlow
Description copied from class:ConfigurableNavigationHandler
Called by the flow system to cause the flow to be inspected for navigation rules. For backward compatibility with earlier implementations, an empty method is provided.
- Overrides:
inspectFlow
in classConfigurableNavigationHandler
-