|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--net.aejase.plugin.wizard.WizardFlow
The WizardFlow is the interface between the user and the Wizard API. It allows user to control the Wizard.
Field Summary | |
static int |
DYNAHELPER
Helper type : dynamically created object |
static int |
MAPPEDHELPER
Helper type : WizardBaseHelper |
Constructor Summary | |
WizardFlow()
Constructor |
Method Summary | |
static void |
destroy(javax.servlet.http.HttpServletRequest request)
Removes the WizardFlow from the current session's context |
static org.apache.struts.action.ActionForward |
findForward(javax.servlet.http.HttpServletRequest request,
int index)
Gets the forward of a specific form |
static org.apache.struts.action.ActionForward |
findForward(javax.servlet.http.HttpServletRequest request,
java.lang.String action)
Gets the forward of a specific form |
static int |
findIndexByAction(javax.servlet.jsp.PageContext pageContext,
java.lang.String action)
Gets the index of the WizardInput which contain specific action's path |
java.lang.String |
getDisplayStep()
Returns the value of the current step, usable to display on screen |
static java.lang.Object |
getHelper(javax.servlet.http.HttpServletRequest request,
java.lang.String action,
int type)
Gets a form helper |
java.lang.Object |
getHelperObject(javax.servlet.http.HttpServletRequest request,
java.lang.String action,
int type)
Creates and return the helper class for a given action |
static org.apache.struts.action.ActionForward |
getPreviousForward(javax.servlet.http.HttpServletRequest request)
Gets the forward for the previous form |
static java.lang.String |
getProperty(javax.servlet.http.HttpSession session,
java.lang.String property)
Gets the value of a property of the current wizard |
int |
getStep()
Gets the step |
static int |
getStep(javax.servlet.jsp.PageContext pageContext)
Gets the current step |
static void |
init(javax.servlet.http.HttpServletRequest request)
Initializes a new WizardFlow |
static void |
processForm(javax.servlet.http.HttpServletRequest request,
org.apache.struts.action.ActionForm form)
What is done to add form's input to the current WizardFlow |
static void |
putHelper(javax.servlet.http.HttpServletRequest request,
java.lang.String key,
java.lang.String actionPath,
int type)
Puts the page's helper in the request context |
java.lang.String |
toString()
Returns a representation of the class |
static java.lang.String |
toString(javax.servlet.http.HttpServletRequest request)
Returns a representation of the class |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int DYNAHELPER
public static final int MAPPEDHELPER
Constructor Detail |
public WizardFlow()
Method Detail |
public static void init(javax.servlet.http.HttpServletRequest request)
request
- the current requestpublic static void destroy(javax.servlet.http.HttpServletRequest request)
request
- the current requestpublic static int findIndexByAction(javax.servlet.jsp.PageContext pageContext, java.lang.String action)
pageContext
- the current page contextaction
- the path of the action to search
public static java.lang.String toString(javax.servlet.http.HttpServletRequest request)
request
- the current request
public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.Object getHelper(javax.servlet.http.HttpServletRequest request, java.lang.String action, int type)
action
- the actiontype
- the type of wanted helper
public static org.apache.struts.action.ActionForward findForward(javax.servlet.http.HttpServletRequest request, java.lang.String action) throws FormNotFoundException
request
- the current request
FormNotFoundException
- if the name is badpublic static org.apache.struts.action.ActionForward findForward(javax.servlet.http.HttpServletRequest request, int index) throws FormNotFoundException
request
- the current requestindex
- the index of the form
FormNotFoundException
- if the index is badpublic static org.apache.struts.action.ActionForward getPreviousForward(javax.servlet.http.HttpServletRequest request)
request
- the current request
public java.lang.String getDisplayStep()
public static java.lang.String getProperty(javax.servlet.http.HttpSession session, java.lang.String property)
session
- the current sessionproperty
- the property to get
public static void processForm(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form)
request
- the current requestform
- the form to addpublic static int getStep(javax.servlet.jsp.PageContext pageContext)
pageContext
- PageContext object
public int getStep()
public static void putHelper(javax.servlet.http.HttpServletRequest request, java.lang.String key, java.lang.String actionPath, int type)
request
- the current requestkey
- the key to store the helper inactionPath
- the helper's related actiontype
- the helper's typepublic java.lang.Object getHelperObject(javax.servlet.http.HttpServletRequest request, java.lang.String action, int type)
request
- the current requestaction
- the helper's action pathtype
- the helper's type
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |