|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.webflow.core.AnnotatedObject
org.springframework.webflow.engine.State
org.springframework.webflow.engine.TransitionableState
org.springframework.webflow.engine.ViewState
public class ViewState
A view state is a state that issues a response to the user, for example, for soliciting form input. To accomplish
this, a ViewState
delegates to a ViewFactory
.
ViewFactory
Field Summary |
---|
Fields inherited from class org.springframework.webflow.core.AnnotatedObject |
---|
CAPTION_PROPERTY, DESCRIPTION_PROPERTY |
Constructor Summary | |
---|---|
ViewState(Flow flow,
String id,
ViewFactory viewFactory)
Create a new view state. |
Method Summary | |
---|---|
void |
addVariable(ViewVariable variable)
Adds a view variable. |
void |
addVariables(ViewVariable[] variables)
Adds a set of view variables. |
void |
exit(RequestControlContext context)
Exit this state. |
boolean |
getPopup()
Returns whether this view state should render as a popup. |
boolean |
getRedirect()
Returns whether this view state should request a flow execution redirect when entered. |
ActionList |
getRenderActionList()
Returns the list of actions executable by this view state on entry and on refresh. |
ViewVariable |
getVariable(String name)
Returns the view variable with the given name. |
ViewVariable[] |
getVariables()
Returns the configured view variables. |
ViewFactory |
getViewFactory()
Returns the view factory. |
boolean |
isViewState()
Returns true if this state is a view state. |
void |
resume(RequestControlContext context)
|
void |
setPopup(boolean popup)
Sets whether this view state should render as a popup. |
void |
setRedirect(Boolean redirect)
Sets whether this view state should requests a flow execution redirect when entered. |
Methods inherited from class org.springframework.webflow.engine.TransitionableState |
---|
getExitActionList, getRequiredTransition, getTransition, getTransitions, getTransitionSet, handleEvent |
Methods inherited from class org.springframework.webflow.engine.State |
---|
enter, equals, getEntryActionList, getExceptionHandlerSet, getFlow, getId, getOwner, handleException, hashCode, isStartState, toString |
Methods inherited from class org.springframework.webflow.core.AnnotatedObject |
---|
getAttributes, getCaption, getDescription, setCaption, setDescription |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.springframework.webflow.definition.StateDefinition |
---|
getId, getOwner |
Methods inherited from interface org.springframework.webflow.core.Annotated |
---|
getAttributes, getCaption, getDescription |
Constructor Detail |
---|
public ViewState(Flow flow, String id, ViewFactory viewFactory) throws IllegalArgumentException
flow
- the owning flowid
- the state identifier (must be unique to the flow)viewFactory
- the view factory
IllegalArgumentException
- when this state cannot be added to given flow, e.g. because the id is not uniqueMethod Detail |
---|
public boolean isViewState()
StateDefinition
isViewState
in interface StateDefinition
isViewState
in class State
public void addVariable(ViewVariable variable)
variable
- the variablepublic void addVariables(ViewVariable[] variables)
variables
- the variablespublic ViewVariable getVariable(String name)
name
- the name of the variablepublic ViewVariable[] getVariables()
public boolean getRedirect()
public void setRedirect(Boolean redirect)
redirect
- the redirect flagpublic boolean getPopup()
public void setPopup(boolean popup)
popup
- the popup flagpublic ViewFactory getViewFactory()
public ActionList getRenderActionList()
public void resume(RequestControlContext context)
public void exit(RequestControlContext context)
TransitionableState
exit
in class TransitionableState
context
- the flow control context
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |