io.datafx.controller.flow

Class Flow

java.lang.Object

io.datafx.controller.flow.Flow

public class Flow
extends java.lang.Object

This class defines a flow. A flow is a map of different views that are linked. A flow can define actions for each view or global actions for the complete flow. The class provides a fluent API to create a flow with views and actions.

Constructor Summary

Constructors

Constructor and Description
Flow(java.lang.Class<?> startViewControllerClass) Creates a new Flow with the given controller for the start view.
Flow(java.lang.Class<?> startViewControllerClass, ViewConfiguration viewConfiguration) Creates a new Flow with the given controller for the start view and a view configuration for all views.

Method Summary

Modifier and Type	Method and Description
<U> void	addActionsToView(FlowView<U> newView) This methods adds all registered actions to the given flow view.
Flow	addActionToView(java.lang.Class<?> controllerClass, java.lang.String actionId, FlowAction action) Adds an action to the defined view of the flow.
Flow	addGlobalAction(java.lang.String actionId, FlowAction action) Adds a global action to the flow.
FlowHandler	createHandler() Creates a handler that can be used to run the flow.
FlowHandler	createHandler(ViewFlowContext flowContext) Creates a handler that can be used to run the flow.
FlowAction	getGlobalActionById(java.lang.String actionId) Returns the action that is registered by the given unique id
java.lang.Class<?>	getStartViewControllerClass() Returns the class of the view controller that is defined as the start view.
ViewConfiguration	getViewConfiguration() Returns the view configuration for all views of the flow
javafx.scene.layout.StackPane	start() Start the flow with a default handler and a default FlowContainer This will start the flow using a DefaultFlowContainer, which returns a StackPane.
<T extends javafx.scene.Node> T	start(FlowContainer<T> flowContainer) Start the flow with a default handler and a provided FlowContainer
void	startInPane(javafx.scene.layout.StackPane pane)
void	startInStage(javafx.stage.Stage stage) Starts the flow directly in a Stage.
javafx.scene.control.Tab	startInTab() Creates a Tab that contains a running instance of the flow.
<T extends javafx.scene.Node> javafx.scene.control.Tab	startInTab(FlowContainer<T> container) Creates a Tab that contains a running instance of the flow.
Flow	withAction(java.lang.Class<?> controllerClass, java.lang.String actionId, FlowAction action) Adds a action to the view of the given view controller.
Flow	withBackAction(java.lang.Class<?> controllerClass, java.lang.String actionId) Adds a back action to the defined view of the flow that navigates back to the last view of a flow.
Flow	withGlobalAction(java.lang.String actionId, FlowAction action) Adds a global action to the flow.
Flow	withGlobalBackAction(java.lang.String actionId) Adds a global back action to the flow that navigates back to the last view of a flow.
Flow	withGlobalLink(java.lang.String actionId, java.lang.Class<?> controllerClass) Adds a link action as a global action to the flow.
Flow	withGlobalTaskAction(java.lang.String actionId, java.lang.Class<? extends java.lang.Runnable> actionClass) Adds a task action as a global action to the flow.
Flow	withGlobalTaskAction(java.lang.String actionId, java.lang.Runnable action) Adds a task action as a global action to the flow.
Flow	withLink(java.lang.Class<?> fromControllerClass, java.lang.String actionId, java.lang.Class<?> toControllerClass) Adds a navigation action to the flow that will navigate from one view to another.
Flow	withTaskAction(java.lang.Class<?> controllerClass, java.lang.String actionId, java.lang.Class<? extends java.lang.Runnable> actionClass) Adds a task action to the defined view of the flow.
Flow	withTaskAction(java.lang.Class<?> controllerClass, java.lang.String actionId, java.lang.Runnable action) Adds a task action to the defined view of the flow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Flow

public Flow(java.lang.Class<?> startViewControllerClass,
            ViewConfiguration viewConfiguration)

Creates a new Flow with the given controller for the start view and a view configuration for all views. The start view must be a view controller as specified in the DataFX-Controller API. See ViewController for more information

Parameters:

startViewControllerClass - Controller class of the start view

viewConfiguration - Configuration for all views of the flow

See Also:

ViewController

Flow

public Flow(java.lang.Class<?> startViewControllerClass)

Creates a new Flow with the given controller for the start view. The startViewControllerClass must be a view controller as specified in the DataFX-Controller API, which means it must be a class annotated with ViewController. See ViewController for more information. Using this constructor will create a new ViewConfiguration.

Parameters:

startViewControllerClass - Controller class of the start view

See Also:

ViewController

Method Detail

getViewConfiguration

public ViewConfiguration getViewConfiguration()

Returns the view configuration for all views of the flow

Returns:

the view configuration

createHandler

public FlowHandler createHandler(ViewFlowContext flowContext)

Creates a handler that can be used to run the flow. The Flow class provides only the definition of a flow. To run a flow in the JavaFX scene graph aFlowHandler is needed

Parameters:

flowContext - The context for the flow

Returns:

a flow handler to run the flow

createHandler

public FlowHandler createHandler()

Creates a handler that can be used to run the flow. The Flow class provides only the definition of a flow. To run a flow in the JavaFX scene graph a FlowHandler is needed

Returns:

a flow handler to run the flow

withGlobalAction

public Flow withGlobalAction(java.lang.String actionId,
                             FlowAction action)

Adds a global action to the flow. The action is registered by the given unique ID and can be called at runtime by using the id. A global action can be called from each view and from outside of the flow.

Parameters:

actionId - unique action id

action - the action

Returns:

returns this flow (for the fluent API)

withGlobalTaskAction

public Flow withGlobalTaskAction(java.lang.String actionId,
                                 java.lang.Class<? extends java.lang.Runnable> actionClass)

Adds a task action as a global action to the flow. Internally a FlowTaskAction will be created and added to the flow. As you can read in the documentation of FlowTaskAction a instance of the given actionClass will be created and executed whenever the action will be called.

Parameters:

actionId - unique action id

actionClass - class that defines the runnable that will be called whenever the action is called

Returns:

returns this flow (for the fluent API)

See Also:

FlowTaskAction

withGlobalTaskAction

public Flow withGlobalTaskAction(java.lang.String actionId,
                                 java.lang.Runnable action)

Adds a task action as a global action to the flow. Internally a FlowTaskAction will be created and added to the flow.

Parameters:

actionId - unique action id

action - a runnable that will be called whenever the action is called

Returns:

returns this flow (for the fluent API)

See Also:

FlowTaskAction

withGlobalLink

public Flow withGlobalLink(java.lang.String actionId,
                           java.lang.Class<?> controllerClass)

Adds a link action as a global action to the flow. Internally a FlowLink will be created and added to the flow.

Parameters:

actionId - unique action id

controllerClass - the controller of the view that should be shown whenever the action will be called

Returns:

returns this flow (for the fluent API)

See Also:

FlowLink

withGlobalBackAction

public Flow withGlobalBackAction(java.lang.String actionId)

Adds a global back action to the flow that navigates back to the last view of a flow. Internally a FlowBackAction will be created and added to the flow.

Parameters:

actionId - unique action id

Returns:

returns this flow (for the fluent API)

See Also:

FlowBackAction

withAction

public Flow withAction(java.lang.Class<?> controllerClass,
                       java.lang.String actionId,
                       FlowAction action)

Adds a action to the view of the given view controller. The action is registered by the given unique ID and can be called at runtime by using the id. the action can only be called when the view of the given controller is the active view of the flow

Parameters:

controllerClass - controller class for the view of the action

actionId - unique action id

action - the action

Returns:

returns this flow (for the fluent API)

withLink

public Flow withLink(java.lang.Class<?> fromControllerClass,
                     java.lang.String actionId,
                     java.lang.Class<?> toControllerClass)

Adds a navigation action to the flow that will navigate from one view to another. The two controller classes that must be passed as parameters defines the origin view and the destination. Internally a FlowLink will be created and added to the flow.

Parameters:

fromControllerClass - the controller class of the view that is the origin of the navigation

actionId - unique action id

toControllerClass - the controller class of the view that is the destination of the navigation

Returns:

returns this flow (for the fluent API)

See Also:

FlowLink

withTaskAction

public Flow withTaskAction(java.lang.Class<?> controllerClass,
                           java.lang.String actionId,
                           java.lang.Class<? extends java.lang.Runnable> actionClass)

Adds a task action to the defined view of the flow. Internally a FlowTaskAction will be created and added to the flow. As you can read in the documentation of FlowTaskAction a instance of the given actionClass will be created and executed whenever the action will be called.

Parameters:

controllerClass - the controller class of the view to that the action will be registered

actionId - unique action id

actionClass - class that defines the runnable that will be called whenever the action is called

Returns:

returns this flow (for the fluent API)

See Also:

FlowTaskAction

withTaskAction

public Flow withTaskAction(java.lang.Class<?> controllerClass,
                           java.lang.String actionId,
                           java.lang.Runnable action)

Adds a task action to the defined view of the flow. Internally a FlowTaskAction will be created and added to the flow.

Parameters:

controllerClass - the controller class of the view to that the action will be registered

actionId - unique action id

action - a runnable that will be called whenever the action is called

Returns:

returns this flow (for the fluent API)

See Also:

FlowTaskAction

withBackAction

public Flow withBackAction(java.lang.Class<?> controllerClass,
                           java.lang.String actionId)

Adds a back action to the defined view of the flow that navigates back to the last view of a flow. Internally a FlowBackAction will be created and added to the flow.

Parameters:

controllerClass - the controller class of the view to that the action will be registered

actionId - unique action id

Returns:

returns this flow (for the fluent API)

See Also:

FlowBackAction

addActionToView

public Flow addActionToView(java.lang.Class<?> controllerClass,
                            java.lang.String actionId,
                            FlowAction action)

Adds an action to the defined view of the flow.

Parameters:

controllerClass - the controller class of the view to that the action will be registered

actionId - unique action id

action - the action that will be added

Returns:

returns this flow (for the fluent API)

See Also:

FlowAction

addGlobalAction

public Flow addGlobalAction(java.lang.String actionId,
                            FlowAction action)

Adds a global action to the flow.

Parameters:

actionId - unique action id

action - the action that will be added

Returns:

returns this flow (for the fluent API)

See Also:

FlowAction

getGlobalActionById

public FlowAction getGlobalActionById(java.lang.String actionId)

Returns the action that is registered by the given unique id

Parameters:

actionId - the id

Returns:

the action that is registered by the given unique id

getStartViewControllerClass

public java.lang.Class<?> getStartViewControllerClass()

Returns the class of the view controller that is defined as the start view.

Returns:

the class of the view controller that is defined as the start view

addActionsToView

public <U> void addActionsToView(FlowView<U> newView)

This methods adds all registered actions to the given flow view. This method is needed by DataFX and should normally not called by a developer.

Type Parameters:

U - Class of the view controller

Parameters:

newView - the view that shoudl be prepaired

start

public javafx.scene.layout.StackPane start()
                                    throws FlowException

Start the flow with a default handler and a default FlowContainer This will start the flow using a DefaultFlowContainer, which returns a StackPane.

Returns:

the Parent that will be used for rendering

Throws:

FlowException - in case something goes wrong

startInStage

public void startInStage(javafx.stage.Stage stage)
                  throws FlowException

Starts the flow directly in a Stage. This method is useful if an application contains of one main flow. Because this flow can contain several sub-flows this is the preferred way to create a DataFX based application. The title of the Stage will be bound to the title of the flow metadata and will change whenever the flow title fill change. This can happen if a view of the flow defines its own title by using the title attribute of the @FXMLController annotation or the ViewMetadata of an view is changed in code.

By using the method a flow based application can be created by only a few lines of code as shown in this example: public class Example extends Application { public static void main(String[] args) { launch(args); } public void start(Stage primaryStage) throws Exception { new Flow(SimpleController.class).startInStage(primaryStage); } }

Parameters:

stage - The stage in that the flow should be displayed.

Throws:

FlowException - If the flow can't be created or started

startInPane

public void startInPane(javafx.scene.layout.StackPane pane)
                 throws FlowException

Throws:

FlowException

startInTab

public javafx.scene.control.Tab startInTab()
                                    throws FlowException

Creates a Tab that contains a running instance of the flow. A DefaultFlowContainer is used as the flow container.

Returns:

the tab that contains the running flow.

Throws:

FlowException - if the flow instance can't be created

startInTab

public <T extends javafx.scene.Node> javafx.scene.control.Tab startInTab(FlowContainer<T> container)
                                                                  throws FlowException

Creates a Tab that contains a running instance of the flow.

Type Parameters:

T - node type of the flow container

Parameters:

container - the flow container in that the flow instance should run

Returns:

the tab that contains the running flow.

Throws:

FlowException - if the flow instance can't be created

start

public <T extends javafx.scene.Node> T start(FlowContainer<T> flowContainer)
                                      throws FlowException

Start the flow with a default handler and a provided FlowContainer

Type Parameters:

T - node type of the flow container

Parameters:

flowContainer - the FlowContainer used to visualize this flow

Returns:

the Parent that will be used for rendering

Throws:

FlowException