A B C D F G H I L M O P R S V

A

AbstractDialogContext - Class in org.apache.shale.dialog.base

Convenience abstract DialogContext implementation.

AbstractDialogContext() - Constructor for class org.apache.shale.dialog.base.AbstractDialogContext

AbstractDialogContextListener - Class in org.apache.shale.dialog.base

Convenience abstract DialogContextListener implementation.

AbstractDialogContextListener() - Constructor for class org.apache.shale.dialog.base.AbstractDialogContextListener

AbstractDialogContextManager - Class in org.apache.shale.dialog.base

Abstract base class for DialogContextManager implementations.

AbstractDialogContextManager() - Constructor for class org.apache.shale.dialog.base.AbstractDialogContextManager

AbstractDialogContextManagerListener - Class in org.apache.shale.dialog.base

Convenience abstract base class for DialogContextManagerListener instances.

AbstractDialogContextManagerListener() - Constructor for class org.apache.shale.dialog.base.AbstractDialogContextManagerListener

AbstractDialogLifecycleListener - Class in org.apache.shale.dialog.base

Convenience abstract base class for DialogLifecycleListener instances.

AbstractDialogLifecycleListener() - Constructor for class org.apache.shale.dialog.base.AbstractDialogLifecycleListener

addDialogContextListener(DialogContextListener) - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Register given DialogContextListener for this DialogContext.

addDialogContextListener(DialogContextListener) - Method in interface org.apache.shale.dialog.DialogContext

Register given DialogContextListener for this DialogContext.

addDialogContextManagerListener(DialogContextManagerListener) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManager

Register a new DialogContextManagerListener instance.

addDialogContextManagerListener(DialogContextManagerListener) - Method in interface org.apache.shale.dialog.DialogContextManager

Register given DialogContextManagerListener for this DialogContextManager.

advance(FacesContext, String) - Method in interface org.apache.shale.dialog.DialogContext

Advance the execution of this DialogContext instance, until an interaction with the user is required.

afterPhase(PhaseEvent) - Method in class org.apache.shale.dialog.faces.DialogPhaseListener

After the Restore View phase, retrieve the current dialog identifier (if any), and restore the corresponding DialogContext.

B

beforePhase(PhaseEvent) - Method in class org.apache.shale.dialog.faces.DialogPhaseListener

Before the Render Response phase, acquire the current dialog identifier (if any), and store it in the view.

C

Constants - Class in org.apache.shale.dialog

Manifest constants related to the integration of state machine implementations into the Shale Dialog Manager.

Constants() - Constructor for class org.apache.shale.dialog.Constants

CONTEXT_BEAN - Static variable in class org.apache.shale.dialog.Constants

Request scoped attribute under which the DialogContext instance for the dialog that is active for this view (if any) is stored.

create(FacesContext, String) - Method in interface org.apache.shale.dialog.DialogContextManager

Create a new instance of the specified dialog configuration, returning the newly created instance.

create(FacesContext, String, DialogContext) - Method in interface org.apache.shale.dialog.DialogContextManager

Create a new instance of the specified dialog configuration, returning the newly created instance.

D

DIALOG_ID - Static variable in class org.apache.shale.dialog.Constants

Request parameter containing the dialog identifier of an existing DialogContext instance to be restored for the current view.

DIALOG_NAME - Static variable in class org.apache.shale.dialog.Constants

Request parameter containing the logical name of a new DialogContext instance to be created for the current view, if there is no active instance already.

DIALOG_PREFIX - Static variable in class org.apache.shale.dialog.Constants

Default prefix on a logical outcome that indicates a new dialog instance should be initiated.

DIALOG_PREFIX_PARAM - Static variable in class org.apache.shale.dialog.Constants

Context initialization attribute that specifies an override for the default prefix on a logical outcome that indicates a new dialog instance should be initiated.

DialogContext - Interface in org.apache.shale.dialog

Interface describing the current state of a particular dialog context instance.

DialogContextListener - Interface in org.apache.shale.dialog

JavaBeans listener for a single instance of a Shale dialog.

DialogContextManager - Interface in org.apache.shale.dialog

Management functions for the DialogContext instances related to a particular user's session.

DialogContextManagerListener - Interface in org.apache.shale.dialog

JavaBeans event listener for events on a DialogContextManager instance.

DialogLifecycleListener - Interface in org.apache.shale.dialog

JavaBeans event listener for notification of the installation and removal of DialogContextManager instances (which are stored in session scope).

DialogNavigationHandler - Class in org.apache.shale.dialog.faces

NavigationHandler implementation that allows dialogs to be created via a logical outcome that returns with a specified prefix.

DialogNavigationHandler(NavigationHandler) - Constructor for class org.apache.shale.dialog.faces.DialogNavigationHandler

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

DialogPhaseListener - Class in org.apache.shale.dialog.faces

Phase listener that saves and restores the dialog identifier for the currently active dialog, if any.

DialogPhaseListener() - Constructor for class org.apache.shale.dialog.faces.DialogPhaseListener

Creates a new instance of DialogPhaseListener.

F

fireOnCreate(DialogContext) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManager

Fire an onCreate() event to all registered listeners.

fireOnEntry(String) - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Inform all registered DialogContextListeners that the dialog instance execution has entered a particular state.

fireOnException(Exception) - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Inform all registered DialogContextListeners that the dialog instance has encountered an unexpected error condition.

fireOnExit(String) - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Inform all registered DialogContextListeners that the dialog instance execution has exited a particular state.

fireOnRemove(DialogContext) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManager

Fire an onRemove() event to all registered listeners.

fireOnStart() - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Inform all registered DialogContextListeners that the dialog instance has begun execution.

fireOnStop() - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Inform all registered DialogContextListeners that the dialog instance has finished execution normally.

fireOnTransition(String, String) - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Inform all registered DialogContextListeners that the dialog instance execution has followed a particular transition.

G

get(String) - Method in interface org.apache.shale.dialog.DialogContextManager

Return the DialogContext instance for the specified identifier (if any); otherwise, return null.

getData() - Method in interface org.apache.shale.dialog.DialogContext

Return the generic data object representing model state for this dialog instance.

getDialogContext() - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Return the DialogContext instance associated with this DialogContextListener.

getDialogContext() - Method in interface org.apache.shale.dialog.DialogContextListener

Return the DialogContext instance associated with this DialogContextListener.

getDialogContextListeners() - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Return the set of currently registered DialogContextListeners.

getDialogContextListeners() - Method in interface org.apache.shale.dialog.DialogContext

Return the set of currently registered DialogContextListeners.

getDialogContextManager() - Method in class org.apache.shale.dialog.base.AbstractDialogContextManagerListener

Return the DialogContextManager instance associated with this DialogContextManagerListener.

getDialogContextManager() - Method in interface org.apache.shale.dialog.DialogContextManagerListener

Return the DialogContextManager instance associated with this DialogContextManagerListener.

getDialogContextManagerListeners() - Method in class org.apache.shale.dialog.base.AbstractDialogContextManager

Return the set of currently registered DialogContextManagerListeners.

getDialogContextManagerListeners() - Method in interface org.apache.shale.dialog.DialogContextManager

Return the set of currently registered DialogContextManagerListeners.

getId() - Method in interface org.apache.shale.dialog.DialogContext

Return the context identifier for this instance of the specified dialog.

getName() - Method in interface org.apache.shale.dialog.DialogContext

Return the logical name of the dialog being executed by this instance.

getOpaqueState() - Method in interface org.apache.shale.dialog.DialogContext

Return an opaque object containing any state information (besides the context identifier, which is already saved) that this DialogContext instance would like to have saved in the JavaServer Faces component tree, and then restored (via a call to setOpaqueData() on the subsequent form submit.

getParent() - Method in interface org.apache.shale.dialog.DialogContext

Return the parent DialogContext instance associated with this child DialogContext, if any; otherwise, return null.

getPhaseId() - Method in class org.apache.shale.dialog.faces.DialogPhaseListener

Return the phase identifier we are interested in.

H

handleNavigation(FacesContext, String, String) - Method in class org.apache.shale.dialog.faces.DialogNavigationHandler

Handle a navigation request from the application.

I

isActive() - Method in interface org.apache.shale.dialog.DialogContext

Return true if this DialogContext is currently active (created but not yet removed).

L

LIFECYCLE_ATTR - Static variable in class org.apache.shale.dialog.Constants

Application scope attribute under which the application may optionally define an instance of DialogLifecycleListener to receive notification of the creation and removal of DialogContextManager instances.

M

MANAGER_BEAN - Static variable in class org.apache.shale.dialog.Constants

Session scoped attribute under which the DialogContextManager instance for this user (if any) is stored.

O

onCreate(DialogContext) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManagerListener

Handle the case where a new DialogContext instance has been created.

onCreate(DialogContext) - Method in interface org.apache.shale.dialog.DialogContextManagerListener

Handle the case where a new DialogContext instance has been created.

onDestroy(DialogContextManager) - Method in class org.apache.shale.dialog.base.AbstractDialogLifecycleListener

Handle notification that the specified DialogContextManager instance has been removed from service.

onDestroy(DialogContextManager) - Method in interface org.apache.shale.dialog.DialogLifecycleListener

Handle notification that the specified DialogContextManager instance has been removed from service.

onEntry(String) - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Handle an entry into a dialog state.

onEntry(String) - Method in interface org.apache.shale.dialog.DialogContextListener

Handle an entry into a dialog state.

onException(Exception) - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Handle an unexpected failure during the execution of this dialg instance.

onException(Exception) - Method in interface org.apache.shale.dialog.DialogContextListener

Handle an unexpected failure during the execution of this dialg instance.

onExit(String) - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Handle an exit from a dialog state.

onExit(String) - Method in interface org.apache.shale.dialog.DialogContextListener

Handle an exit from a dialog state.

onInit(DialogContextManager) - Method in class org.apache.shale.dialog.base.AbstractDialogLifecycleListener

Handle notification that the specified DialogContextManager instance has been placed into service.

onInit(DialogContextManager) - Method in interface org.apache.shale.dialog.DialogLifecycleListener

Handle notification that the specified DialogContextManager instance has been placed into service.

onRemove(DialogContext) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManagerListener

Handle the case where a new DialogContext instance has been removed.

onRemove(DialogContext) - Method in interface org.apache.shale.dialog.DialogContextManagerListener

Handle the case where a new DialogContext instance has been removed.

onStart() - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Handle the starting of the dialog instance.

onStart() - Method in interface org.apache.shale.dialog.DialogContextListener

Handle the starting of the dialog instance.

onStop() - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Handle the stopping of the dialog instance.

onStop() - Method in interface org.apache.shale.dialog.DialogContextListener

Handle the stopping of the dialog instance.

onTransition(String, String) - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Handle a transition being followed.

onTransition(String, String) - Method in interface org.apache.shale.dialog.DialogContextListener

Handle a transition being followed.

org.apache.shale.dialog - package org.apache.shale.dialog

org.apache.shale.dialog.base - package org.apache.shale.dialog.base

org.apache.shale.dialog.faces - package org.apache.shale.dialog.faces

P

PARENT_ID - Static variable in class org.apache.shale.dialog.Constants

Request parameter containing the DialogContext instance identifier of a parent instance with which a new child DialogContext instance (to be created for the current view) should be associated.

R

remove(DialogContext) - Method in interface org.apache.shale.dialog.DialogContextManager

Remove the specified DialogContext instance from the set of active instances for the current user.

removeDialogContextListener(DialogContextListener) - Method in class org.apache.shale.dialog.base.AbstractDialogContext

Remove this previously registered DialogContextListener for this DialogContext.

removeDialogContextListener(DialogContextListener) - Method in interface org.apache.shale.dialog.DialogContext

Remove this previously registered DialogContextListener for this DialogContext.

removeDialogContextManagerListener(DialogContextManagerListener) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManager

Deregister an existing DialogContextManagerListener instance.

removeDialogContextManagerListener(DialogContextManagerListener) - Method in interface org.apache.shale.dialog.DialogContextManager

Remove this previously registered DialogContextManagerListener for this DialogContextManager.

S

setData(Object) - Method in interface org.apache.shale.dialog.DialogContext

Set the generic data object representing model state for this dialog instance.

setDialogContext(DialogContext) - Method in class org.apache.shale.dialog.base.AbstractDialogContextListener

Set the DialogContext instance associated with this DialogContextListener.

setDialogContext(DialogContext) - Method in interface org.apache.shale.dialog.DialogContextListener

Set the DialogContext instance associated with this DialogContextListener.

setDialogContextManager(DialogContextManager) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManagerListener

Set the DialogContextManager instance associated with this DialogContextManagerListener.

setDialogContextManager(DialogContextManager) - Method in interface org.apache.shale.dialog.DialogContextManagerListener

Set the DialogContextManager instance associated with this DialogContextManagerListener.

setOpaqueState(Object) - Method in interface org.apache.shale.dialog.DialogContext

Restore state information that was previously returned by a call to getOpaqueState() on this DialogContext instance.

start(FacesContext) - Method in interface org.apache.shale.dialog.DialogContext

Start the execution of this DialogContext instance, advancing until an interaction with the user is required.

stop(FacesContext) - Method in interface org.apache.shale.dialog.DialogContext

Stop the execution of this DialogContext instance, resulting in no currently active dialog for the current JavaServer Faces view.

V

valueBound(HttpSessionBindingEvent) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManager

Handle an instance of this class being bound into an HttpSession.

valueUnbound(HttpSessionBindingEvent) - Method in class org.apache.shale.dialog.base.AbstractDialogContextManager

Handle an instance of this class being unbound from an HttpSession.

A B C D F G H I L M O P R S V