Package org.apache.myfaces.application

Class NavigationHandlerImpl

java.lang.Object

jakarta.faces.application.NavigationHandler

jakarta.faces.application.ConfigurableNavigationHandler

org.apache.myfaces.application.NavigationHandlerImpl

public class NavigationHandlerImpl
extends ConfigurableNavigationHandler

Version:

$Revision$ $Date$

Author:

Thomas Spiegl (latest modification by $Author$), Anton Koinov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CALL_PRE_DISPOSE_VIEW

Constructor Summary

Constructors

Constructor	Description
NavigationHandlerImpl()

Method Summary

Modifier and Type	Method	Description
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)
String	getViewId(FacesContext context, String fromAction, String outcome)	Returns the view ID that would be created for the given action and outcome
protected ViewIdSupport	getViewIdSupport()
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	setViewIdSupport(ViewIdSupport viewIdSupport)

Methods inherited from class jakarta.faces.application.ConfigurableNavigationHandler

getNavigationCase, performNavigation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CALL_PRE_DISPOSE_VIEW

public static final String CALL_PRE_DISPOSE_VIEW

See Also:

Constant Field Values

Constructor Detail

NavigationHandlerImpl

public NavigationHandlerImpl()

Method Detail

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

getViewIdSupport

protected ViewIdSupport getViewIdSupport()

setViewIdSupport

public void setViewIdSupport(ViewIdSupport viewIdSupport)

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

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