Class NavigationHandlerWrapper
- java.lang.Object
-
- jakarta.faces.application.NavigationHandler
-
- jakarta.faces.application.NavigationHandlerWrapper
-
- All Implemented Interfaces:
FacesWrapper<NavigationHandler>
public abstract class NavigationHandlerWrapper extends NavigationHandler implements FacesWrapper<NavigationHandler>
NavigationHandlerWrapper provides a simple implementation of
NavigationHandler
that can be subclassed by developers wishing to provide specialized behavior to an existingNavigationHandler
instance. The default implementation of all methods is to call through to the wrappedNavigationHandler
instance.Usage: extend this class and push the implementation being wrapped to the constructor and use
getWrapped()
to access the instance being wrapped.- Since:
- 2.2
-
-
Constructor Summary
Constructors Constructor Description NavigationHandlerWrapper()
Deprecated.Use the other constructor taking the implementation being wrapped.NavigationHandlerWrapper(NavigationHandler wrapped)
If this navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NavigationHandler
getWrapped()
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
handleNavigation(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)
Overloaded variant ofNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
that allows the caller to provide the defining document id for a flow to be entered by this navigation.
-
-
-
Constructor Detail
-
NavigationHandlerWrapper
@Deprecated public NavigationHandlerWrapper()
Deprecated.Use the other constructor taking the implementation being wrapped.
-
NavigationHandlerWrapper
public NavigationHandlerWrapper(NavigationHandler wrapped)
If this navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The
getWrapped()
will then return the implementation being wrapped.- Parameters:
wrapped
- The implementation being wrapped.- Since:
- 2.3
-
-
Method Detail
-
getWrapped
public NavigationHandler 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<NavigationHandler>
- Returns:
- the wrapped instance.
-
handleNavigation
public void handleNavigation(FacesContext context, String fromAction, String outcome)
Description copied from class:NavigationHandler
Perform navigation processing based on the state information in the specified
FacesContext
, plus the outcome string returned by an executed application action.If the implementation class also extends
ConfigurableNavigationHandler
, the implementation must guarantee that the logic used in a call toConfigurableNavigationHandler.getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
is used in this method to determine the correct navigation.This method must set the render targets (used in partial rendering) to
render all
invokingPartialViewContext.setRenderAll(boolean)
) if the view identifier has changed as the result of an application action (to take into accountAjax requests
).- Specified by:
handleNavigation
in classNavigationHandler
- Parameters:
context
- TheFacesContext
for the current requestfromAction
- The action binding expression that was evaluated to retrieve the specified outcome, ornull
if the outcome was acquired by some other meansoutcome
- The logical outcome returned by a previous invoked application action (which may benull
)
-
handleNavigation
public void handleNavigation(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)
Description copied from class:NavigationHandler
Overloaded variant of
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
that allows the caller to provide the defining document id for a flow to be entered by this navigation. For backward compatibility with decoratedNavigationHandler
implementations that conform to an earlier version of the specification, an implementation is provided that calls through toNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
, ignoring thetoFlowDocumentId
parameter.- Overrides:
handleNavigation
in classNavigationHandler
- Parameters:
context
- TheFacesContext
for the current requestfromAction
- The action binding expression that was evaluated to retrieve the specified outcome, ornull
if the outcome was acquired by some other meansoutcome
- The logical outcome returned by a previous invoked application action (which may benull
)toFlowDocumentId
- The defining document id of the flow into which this navigation will cause entry.
-
-