org.alfresco.web.app

Class AlfrescoNavigationHandler

java.lang.Object

javax.faces.application.NavigationHandler

org.alfresco.web.app.AlfrescoNavigationHandler

public class AlfrescoNavigationHandler
extends NavigationHandler

Author:

gavinc

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE_DIALOG_OUTCOME
static String	CLOSE_MULTIPLE_END
static String	CLOSE_MULTIPLE_START
static String	CLOSE_WIZARD_OUTCOME
static String	DIALOG_PREFIX
protected String	dialogContainer
static String	EXTERNAL_CONTAINER_SESSION
static String	OUTCOME_BROWSE
static String	OUTCOME_SEPARATOR
protected String	plainDialogContainer
protected String	plainWizardContainer
static String	WIZARD_PREFIX
protected String	wizardContainer

Constructor Summary

Constructors

Constructor and Description
AlfrescoNavigationHandler(NavigationHandler origHandler) Default constructor

Method Summary

Modifier and Type	Method and Description
protected void	addCurrentViewToStack(FacesContext context) Adds the current view to the stack (if required).
protected DialogsConfigElement.DialogConfig	getDialogConfig(FacesContext context, String name, Node dispatchContext) Returns the dialog configuration object for the given dialog name.
protected String	getDialogContainer(FacesContext context) Retrieves the configured dialog container page
protected Node	getDispatchContextNode(FacesContext context) Returns the node currently in the dispatch context
protected int	getNumberToClose(String outcome)
protected String	getOutcomeOverride(String outcome) Returns the overridden outcome.
protected String	getViewIdFromStackObject(FacesContext context, Object topOfStack) Returns the view id of the given item retrieved from the view stack.
protected WizardsConfigElement.WizardConfig	getWizardConfig(FacesContext context, String name, Node dispatchContext) Returns the wizard configuration object for the given wizard name.
protected String	getWizardContainer(FacesContext context) Retrieves the configured wizard container page
protected void	handleBrowseDispatch(FacesContext context, String fromAction, String outcome)
protected void	handleDialogOpen(FacesContext context, String fromAction, String name) Opens a dialog
protected void	handleDialogOrWizardClose(FacesContext context, String fromAction, String outcome, boolean dialog) Closes the current dialog or wizard
protected void	handleDispatch(FacesContext context, String fromAction, String outcome) Processes any dispatching that may need to occur
void	handleNavigation(FacesContext context, String fromAction, String outcome)
protected void	handleWizardOpen(FacesContext context, String fromAction, String name) Opens a wizard
protected boolean	isDialog(String outcome) Determines whether the given outcome is dialog related
protected boolean	isDialogOrWizardClosing(String outcome) Determines whether the given outcome represents a dialog or wizard closing
protected boolean	isWizard(String outcome) Determines whether the given outcome is wizard related
protected boolean	isWizardStep(String fromAction) Determines whether the given fromAction represents a step in the wizard i.e.
protected String	stripPrefix(String outcome) Removes the dialog or wizard prefix from the given outcome

Methods inherited from class java.lang.Object

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

Field Detail

OUTCOME_SEPARATOR

public static final String OUTCOME_SEPARATOR

See Also:

Constant Field Values

OUTCOME_BROWSE

public static final String OUTCOME_BROWSE

See Also:

Constant Field Values

DIALOG_PREFIX

public static final String DIALOG_PREFIX

See Also:

Constant Field Values

WIZARD_PREFIX

public static final String WIZARD_PREFIX

See Also:

Constant Field Values

CLOSE_DIALOG_OUTCOME

public static final String CLOSE_DIALOG_OUTCOME

See Also:

Constant Field Values

CLOSE_WIZARD_OUTCOME

public static final String CLOSE_WIZARD_OUTCOME

See Also:

Constant Field Values

CLOSE_MULTIPLE_START

public static final String CLOSE_MULTIPLE_START

See Also:

Constant Field Values

CLOSE_MULTIPLE_END

public static final String CLOSE_MULTIPLE_END

See Also:

Constant Field Values

EXTERNAL_CONTAINER_SESSION

public static final String EXTERNAL_CONTAINER_SESSION

See Also:

Constant Field Values

dialogContainer

protected String dialogContainer

wizardContainer

protected String wizardContainer

plainDialogContainer

protected String plainDialogContainer

plainWizardContainer

protected String plainWizardContainer

Constructor Detail

AlfrescoNavigationHandler

public AlfrescoNavigationHandler(NavigationHandler origHandler)

Default constructor

Parameters:

origHandler - The original navigation handler

Method Detail

handleNavigation

public void handleNavigation(FacesContext context,
                             String fromAction,
                             String outcome)

Specified by:

handleNavigation in class NavigationHandler

See Also:

NavigationHandler.handleNavigation(javax.faces.context.FacesContext, java.lang.String, java.lang.String)

isDialog

protected boolean isDialog(String outcome)

Determines whether the given outcome is dialog related

Parameters:

outcome - The outcome to test

Returns:

true if outcome is dialog related i.e. starts with dialog:

isWizard

protected boolean isWizard(String outcome)

Determines whether the given outcome is wizard related

Parameters:

outcome - The outcome to test

Returns:

true if outcome is wizard related i.e. starts with create-wizard: or edit-wizard:

isDialogOrWizardClosing

protected boolean isDialogOrWizardClosing(String outcome)

Determines whether the given outcome represents a dialog or wizard closing

Parameters:

outcome - The outcome to test

Returns:

true if the outcome represents a closing dialog or wizard

getNumberToClose

protected int getNumberToClose(String outcome)

isWizardStep

protected boolean isWizardStep(String fromAction)

Determines whether the given fromAction represents a step in the wizard i.e. next or back

Parameters:

fromAction - The fromAction

Returns:

true if the from action represents a wizard step

stripPrefix

protected String stripPrefix(String outcome)

Removes the dialog or wizard prefix from the given outcome

Parameters:

outcome - The outcome to remove the prefix from

Returns:

The remaining outcome

getOutcomeOverride

protected String getOutcomeOverride(String outcome)

Returns the overridden outcome. Used by dialogs and wizards to go to a particular page after it closes rather than back to the page it was launched from.

Parameters:

outcome - The current outcome

Returns:

The overridden outcome or null if there isn't an override

getDialogConfig

protected DialogsConfigElement.DialogConfig getDialogConfig(FacesContext context,
                                                            String name,
                                                            Node dispatchContext)

Returns the dialog configuration object for the given dialog name. If there is a node in the dispatch context a lookup is performed using the node otherwise the global config section is used.

Parameters:

name - The name of dialog being launched

dispatchContext - The node being acted upon

Returns:

The DialogConfig for the dialog or null if no config could be found

getWizardConfig

protected WizardsConfigElement.WizardConfig getWizardConfig(FacesContext context,
                                                            String name,
                                                            Node dispatchContext)

Returns the wizard configuration object for the given wizard name. If there is a node in the dispatch context a lookup is performed using the node otherwise the global config section is used.

Parameters:

name - The name of wizard being launched

dispatchContext - The node being acted upon

Returns:

The WizardConfig for the wizard or null if no config could be found

getDialogContainer

protected String getDialogContainer(FacesContext context)

Retrieves the configured dialog container page

Parameters:

context - FacesContext

Returns:

The container page

getWizardContainer

protected String getWizardContainer(FacesContext context)

Retrieves the configured wizard container page

Parameters:

context - FacesContext

Returns:

The container page

getDispatchContextNode

protected Node getDispatchContextNode(FacesContext context)

Returns the node currently in the dispatch context

Returns:

The node currently in the dispatch context or null if the dispatch context is empty

handleBrowseDispatch

protected void handleBrowseDispatch(FacesContext context,
                                    String fromAction,
                                    String outcome)

handleDispatch

protected void handleDispatch(FacesContext context,
                              String fromAction,
                              String outcome)

Processes any dispatching that may need to occur

Parameters:

context - Faces context

fromAction - The from action

outcome - The outcome

handleDialogOpen

protected void handleDialogOpen(FacesContext context,
                                String fromAction,
                                String name)

Opens a dialog

Parameters:

context - FacesContext

fromAction - The fromAction

name - The name of the dialog to open

handleWizardOpen

protected void handleWizardOpen(FacesContext context,
                                String fromAction,
                                String name)

Opens a wizard

Parameters:

context - FacesContext

fromAction - The fromAction

name - The name of the wizard to open

handleDialogOrWizardClose

protected void handleDialogOrWizardClose(FacesContext context,
                                         String fromAction,
                                         String outcome,
                                         boolean dialog)

Closes the current dialog or wizard

Parameters:

context - FacesContext

fromAction - The fromAction

outcome - The outcome

dialog - true if a dialog is being closed, false if a wizard is being closed

getViewIdFromStackObject

protected String getViewIdFromStackObject(FacesContext context,
                                          Object topOfStack)

Returns the view id of the given item retrieved from the view stack.

Parameters:

context - FacesContext

topOfStack - The object retrieved from the view stack

Returns:

The view id

addCurrentViewToStack

protected void addCurrentViewToStack(FacesContext context)

Adds the current view to the stack (if required). If the current view is already the top of the stack it is not added again to stop the stack from growing and growing.

Parameters:

context - FacesContext