org.apache.beehive.netui.pageflow
Class PreviousPageInfo

Object
  extended by PreviousPageInfo
All Implemented Interfaces:
Serializable

public class PreviousPageInfo
extends Object
implements Serializable

Stores information about a previously-displayed page, as well as its initialization data. Used with return-to="currentPage" or return-to="previousPage" on @jpf:forward.

See Also:
Serialized Form

Constructor Summary
PreviousPageInfo(ActionForward forward, ActionForm form, ActionMapping mapping)
          Constructor which accepts the ActionForward used to display the page, the ActionForm used to initialize the page, and the associated ActionMapping, which represents the action that forwarded to the page.
 
Method Summary
 Object getClientState()
          Get client state associated with the page (e.g., component tree state for a JSF page).
 ActionForm getForm()
          Get the form bean that was used to initialize the page.
 ActionForward getForward()
          Get the object that was used to forward to the page.
 ActionMapping getMapping()
          Get information about the action that forwarded to the page.
 void reinitialize(PageFlowController pfc)
          Reinitialize the stored ActionMapping and PageFlowController objects.
 void setClientState(Object clientState)
          Set client state associated with the page (e.g., component tree state for a JSF page).
 void setForm(ActionForm form)
          Set the form bean that was used to initialize the page.
 void setForward(ActionForward forward)
          Set the object that was used to forward to the page.
 void setMapping(ActionMapping mapping)
          Set information about the action that forwarded to the page.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PreviousPageInfo

public PreviousPageInfo(ActionForward forward,
                        ActionForm form,
                        ActionMapping mapping)
Constructor which accepts the ActionForward used to display the page, the ActionForm used to initialize the page, and the associated ActionMapping, which represents the action that forwarded to the page.

Parameters:
forward -
form -
mapping -
Method Detail

getForm

public ActionForm getForm()
Get the form bean that was used to initialize the page.

Returns:
the ActionForm instance that was used to initialize the page, or null if there was none.

setForm

public void setForm(ActionForm form)
Set the form bean that was used to initialize the page.

Parameters:
form - the ActionForm instance that was used to initialize the page.

getMapping

public ActionMapping getMapping()
Get information about the action that forwarded to the page.

Note that this information is transient. If you place this object in the session, and then retrieve it after a session failover has occurred (i.e., after this object has been serialized and deserialized), then this method will return null unless you first call reinitialize(org.apache.beehive.netui.pageflow.PageFlowController).

Returns:
an ActionMapping that contains information about the action that forwarded to this page.

setMapping

public void setMapping(ActionMapping mapping)
Set information about the action that forwarded to the page.

Parameters:
mapping - an ActionMapping that contains information about the action that forwarded to this page.

reinitialize

public void reinitialize(PageFlowController pfc)
Reinitialize the stored ActionMapping and PageFlowController objects. These are transient, and will be lost if you place this object in the session, and then retrieve it after a session failover has occurred (i.e., after this object has been serialized and deserialized).


getForward

public ActionForward getForward()
Get the object that was used to forward to the page.

Returns:
the ActionForward returned by the action that forwarded to this page.

setForward

public void setForward(ActionForward forward)
Set the object that was used to forward to the page.

Parameters:
forward - the ActionForward returned by the action that forwarded to this page.

getClientState

public Object getClientState()
Get client state associated with the page (e.g., component tree state for a JSF page).


setClientState

public void setClientState(Object clientState)
Set client state associated with the page (e.g., component tree state for a JSF page).