| org.araneaframework.framework.FlowContext
All known Subclasses: org.araneaframework.example.main.web.popups.StandalonePopupFlowWrapperWidget,
| Inner Class :public interface FlowReference extends Serializable | |
| Inner Class :public interface Configurator extends Serializable | |
| Inner Class :interface TransitionHandler extends Serializable | |
| Method Summary | |
| public void | addNestedEnvironmentEntry(ApplicationWidget scope, Object entryId, Object envEntry)
Adds an environment entry that is visible in all subflows. | | public void | cancel()
Finished the current flow passing control back to the calling flow. | | public void | finish(Object result)
Finisheds the current flow passing control back to the calling flow. | | public FlowReference | getCurrentReference()
Returns a reference to the current flow that can be used later to manipulate the current flow. | | TransitionHandler | getTransitionHandler()
| | public boolean | isNested()
Returns whether the current flow is nested, that is has a caller flow. | | public void | replace(Widget flow)
Destroys the current flow and starts a new one. | | public void | replace(Widget flow, Configurator configurator)
Destroys the current flow and starts a new one. | | public void | reset(EnvironmentAwareCallback callback)
Resets all currently running flows and calls the callback allowing to start
new flows. | | void | setTransitionHandler(TransitionHandler handler)
Sets the
TransitionHandler which performs the flow navigation. | | public void | start(Widget flow)
Starts a new nested subflow. | | public void | start(Widget flow, Handler handler)
Starts a new nested subflow. | | public void | start(Widget flow, Configurator configurator, Handler handler)
Starts a new nested subflow, that can be configured using the configurator. |
| TRANSITION_CANCEL | | int TRANSITION_CANCEL(Code) | |
since:
1.1 |
| TRANSITION_FINISH | | int TRANSITION_FINISH(Code) | |
since:
1.1 |
| TRANSITION_REPLACE | | int TRANSITION_REPLACE(Code) | |
since:
1.1 |
| TRANSITION_RESET | | int TRANSITION_RESET(Code) | |
since:
1.1 |
| TRANSITION_START | | int TRANSITION_START(Code) | |
since:
1.1 |
| addNestedEnvironmentEntry | | public void addNestedEnvironmentEntry(ApplicationWidget scope, Object entryId, Object envEntry)(Code) | | Adds an environment entry that is visible in all subflows.
|
| cancel | | public void cancel()(Code) | | Finished the current flow passing control back to the calling flow.
Should be interpreted by the calling flow as a unsuccessful return.
|
| finish | | public void finish(Object result)(Code) | | Finisheds the current flow passing control back to the calling flow. Optionally may return some value that
can be interpreted by the calling flow as the result of the call.
|
| getCurrentReference | | public FlowReference getCurrentReference()(Code) | | Returns a reference to the current flow that can be used later to manipulate the current flow.
FlowReference |
| getTransitionHandler | | TransitionHandler getTransitionHandler()(Code) | | Returns currently active
TransitionHandler
since:
1.1 |
| isNested | | public boolean isNested()(Code) | | Returns whether the current flow is nested, that is has a caller flow.
|
| replace | | public void replace(Widget flow)(Code) | | Destroys the current flow and starts a new one. When the new flow will end execution it will return control
to the caller of the current flow (if there is one).
|
| replace | | public void replace(Widget flow, Configurator configurator)(Code) | | Destroys the current flow and starts a new one. When the new flow will end execution it will return control
to the caller of the current flow (if there is one). Started subflow can be configured using the configurator.
since:
1.0.9 |
| reset | | public void reset(EnvironmentAwareCallback callback)(Code) | | Resets all currently running flows and calls the callback allowing to start
new flows. Useful e.g. in a menu, when selecting a new menu item and reseting the old
stack.
|
| setTransitionHandler | | void setTransitionHandler(TransitionHandler handler)(Code) | | Sets the
TransitionHandler which performs the flow navigation.
since:
1.1 |
| start | | public void start(Widget flow, Configurator configurator, Handler handler)(Code) | | Starts a new nested subflow, that can be configured using the configurator. Current flow becomes inactive
untils subflow calls
FlowContext.finish(Object) or
FlowContext.cancel() .
Handler allows to receive notification,
when the subflow ends execution.
|
|
|