Package javax.faces.application
Class ConfigurableNavigationHandler
java.lang.Object
javax.faces.application.NavigationHandler
javax.faces.application.ConfigurableNavigationHandler
- Direct Known Subclasses:
ConfigurableNavigationHandlerWrapper
ConfigurableNavigationHandler
extends the contract of NavigationHandler
to allow runtime
inspection of the NavigationCase
s that make up the rule-base
for navigation. An implementation compliant with the version of the
specification in which this class was introduced (or a later version)
must make it so that its NavigationHandler
is an
extension of this class.
- Since:
- 2.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract NavigationCase
getNavigationCase
(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.abstract Map<String,
Set<NavigationCase>> 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>
.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, handleNavigation
-
Constructor Details
-
ConfigurableNavigationHandler
public ConfigurableNavigationHandler()
-
-
Method Details
-
inspectFlow
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.
- Since:
- 2.2