Top Description Fields Constructors Methods
jakarta.faces.application

public abstract Class NavigationHandlerWrapper

extends NavigationHandler
implements FacesWrapper<NavigationHandler>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Imports
jakarta.faces.FacesWrapper, jakarta.faces.context.FacesContext

NavigationHandlerWrapper provides a simple implementation of NavigationHandler that can be subclassed by developers wishing to provide specialized behavior to an existing NavigationHandler instance. The default implementation of all methods is to call through to the wrapped NavigationHandler 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

Field Summary

Modifier and TypeField and Description
private NavigationHandler
wrapped

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
public NavigationHandler
getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

public void
handleNavigation(FacesContext
The FacesContext for the current request
context, String
The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means
fromAction, String
The logical outcome returned by a previous invoked application action (which may be null)
outcome)

Implements abstract jakarta.faces.application.NavigationHandler.handleNavigation.

Perform navigation processing based on the state information in the specified FacesContext, plus the outcome string returned by an executed application action.

public void
handleNavigation(FacesContext
The FacesContext for the current request
context, String
The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means
fromAction, String
The logical outcome returned by a previous invoked application action (which may be null)
outcome, String
The defining document id of the flow into which this navigation will cause entry.
toFlowDocumentId)

Overrides jakarta.faces.application.NavigationHandler.handleNavigation.

Overloaded variant of 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.

Field Detail

wrappedback to summary
private NavigationHandler wrapped

Constructor Detail

NavigationHandlerWrapperback to summary
public NavigationHandlerWrapper()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
NavigationHandlerWrapperback to summary
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:NavigationHandler

The implementation being wrapped.

Since
2.3

Method Detail

getWrappedback to summary
public NavigationHandler getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

Doc from jakarta.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

Returns:NavigationHandler

the wrapped instance.

Annotations
@Override
handleNavigationback to summary
public void handleNavigation(FacesContext context, String fromAction, String outcome)

Implements abstract jakarta.faces.application.NavigationHandler.handleNavigation.

Doc from jakarta.faces.application.NavigationHandler.handleNavigation.

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 to ConfigurableNavigationHandler#getNavigationCase is used in this method to determine the correct navigation.

This method must set the render targets (used in partial rendering) to render all invoking jakarta.faces.context.PartialViewContext#setRenderAll) if the view identifier has changed as the result of an application action (to take into account Ajax requests).

Parameters
context:FacesContext

The FacesContext for the current request

fromAction:String

The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means

outcome:String

The logical outcome returned by a previous invoked application action (which may be null)

Annotations
@Override
handleNavigationback to summary
public void handleNavigation(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)

Overrides jakarta.faces.application.NavigationHandler.handleNavigation.

Doc from jakarta.faces.application.NavigationHandler.handleNavigation.

Overloaded variant of 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 decorated NavigationHandler implementations that conform to an earlier version of the specification, an implementation is provided that calls through to handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter.

Parameters
context:FacesContext

The FacesContext for the current request

fromAction:String

The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means

outcome:String

The logical outcome returned by a previous invoked application action (which may be null)

toFlowDocumentId:String

The defining document id of the flow into which this navigation will cause entry.

Annotations
@Override