org.apache.shale.dialog.faces

Class DialogNavigationHandler

java.lang.Object

javax.faces.application.NavigationHandler

org.apache.shale.dialog.faces.DialogNavigationHandler

public final class DialogNavigationHandler
extends javax.faces.application.NavigationHandler

NavigationHandler implementation that allows dialogs to be created via a logical outcome that returns with a specified prefix. This is not the only way to start a dialog instance (applications can also do this programmatically), but it is convenient in many cases.

Since:

1.0.4

Constructor Summary

Constructors

Constructor and Description
DialogNavigationHandler(javax.faces.application.NavigationHandler original) Creates a new instance of DialogNavigationHandler that delegates to the specified original handler.

Method Summary

Methods

Modifier and Type	Method and Description
void	handleNavigation(javax.faces.context.FacesContext context, String fromAction, String outcome) Handle a navigation request from the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogNavigationHandler

public DialogNavigationHandler(javax.faces.application.NavigationHandler original)

Creates a new instance of DialogNavigationHandler that delegates to the specified original handler.

Parameters:

original - Original NavigationHandler

Method Detail

handleNavigation

public void handleNavigation(javax.faces.context.FacesContext context,
                    String fromAction,
                    String outcome)

Handle a navigation request from the application. The following rules are applied:

• If this view is NOT currently executing a DialogContext instance:
  • If the logical outcome begins with the prefix identified by the prefix specified by context init parameter Constants.DIALOG_PREFIX_PARAM (with a default value of Constants.DIALOG_PREFIX), create and start a new DialogContext instance for a logical name based on the remainder of the logical outcome after the prefix.
  • Otherwise, delegate control to the original navigation handler passed to our constructor.
• If this view is currently executing a DialogContext instance, advance its progress based on the specified logical outcome.

Specified by:

handleNavigation in class javax.faces.application.NavigationHandler

Parameters:

context - FacesContext for the current request

fromAction - Action that was invoked

outcome - Logical outcome from the invoked action