|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.shale.dialog.base.AbstractDialogContextListener
public abstract class AbstractDialogContextListener
Convenience abstract DialogContextListener
implementation. Subclasses
are expected to be serializable.
Constructor Summary | |
---|---|
AbstractDialogContextListener()
|
Method Summary | |
---|---|
DialogContext |
getDialogContext()
Return the |
void |
onActivate()
Handle our parent |
void |
onEntry(String stateId)
Handle an entry into a dialog state. |
void |
onException(Exception e)
Handle an unexpected failure during the execution of this dialg instance. |
void |
onExit(String stateId)
Handle an exit from a dialog state. |
void |
onPassivate()
Handle our parent |
void |
onStart()
Handle the starting of the dialog instance. |
void |
onStop()
Handle the stopping of the dialog instance. |
void |
onTransition(String fromStateId,
String toStateId)
Handle a transition being followed. |
void |
setDialogContext(DialogContext dialogContext)
Set the |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractDialogContextListener()
Method Detail |
---|
public void onStart()
Handle the starting of the dialog instance.
onStart
in interface DialogContextListener
DialogContextListener.onStart()
public void onStop()
Handle the stopping of the dialog instance.
onStop
in interface DialogContextListener
DialogContextListener.onStop()
public void onException(Exception e)
Handle an unexpected failure during the execution of this dialg instance.
onException
in interface DialogContextListener
e
- A potentially implementation specific exception
during the execution of this dialog instanceDialogContextListener.onException(java.lang.Exception)
public void onActivate()
Handle our parent DialogContext
instance being placed
into service for the current request. This will occur when a
dialog is newly created (by any of the available means), or when
it is recognized, during a subsequent postback, that there is a
currently active dialog identiier.
NOTE - For a newly created DialogContext
instance, this event will be fired after the
instance has been started (and, therefore, after an onStart()
callback to this listener).
onActivate
in interface DialogContextListener
DialogContextListener.onActivate()
public void onPassivate()
Handle our parent DialogContext
instance being taken out
of service at the end of a request. The response for this request
has already been rendered, so any changes to the JSF component tree
will not have any effect.
NOTE - For a DialogContext
instance being
stopped, this event will be fired before the
instance has been started (and, therefore, before an onStop()
callback to this listener).
onPassivate
in interface DialogContextListener
DialogContextListener.onPassivate()
public void onEntry(String stateId)
Handle an entry into a dialog state.
onEntry
in interface DialogContextListener
stateId
- Implementation specific identifier of the state
that has been enteredDialogContextListener.onEntry(java.lang.String)
public void onExit(String stateId)
Handle an exit from a dialog state.
onExit
in interface DialogContextListener
stateId
- Implementation specific identifier of the state
that has been exitedDialogContextListener.onExit(java.lang.String)
public void onTransition(String fromStateId, String toStateId)
Handle a transition being followed.
onTransition
in interface DialogContextListener
fromStateId
- Implementation specific identifier of the source
state for the transition that has been followedtoStateId
- Implementation specific identifier of the target
state for the transition that has been followedDialogContextListener.onTransition(java.lang.String,java.lang.String)
public DialogContext getDialogContext()
Return the DialogContext
instance associated with this
DialogContextListener
.
getDialogContext
in interface DialogContextListener
DialogContext
whose execution we are listening toDialogContextListener.getDialogContext()
public void setDialogContext(DialogContext dialogContext)
Set the DialogContext
instance associated with this
DialogContextListener
.
setDialogContext
in interface DialogContextListener
dialogContext
- The DialogContext
whose execution we
will trackDialogContextListener.setDialogContext(org.apache.shale.dialog.DialogContext)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |