io.datafx.controller.flow.action

Class FlowLink<T>

java.lang.Object

io.datafx.controller.flow.action.FlowLink<T>

Type Parameters:

T - class of the controller of the target view

All Implemented Interfaces:

FlowAction

public class FlowLink<T>
extends java.lang.Object
implements FlowAction

A FlowAction implementation that navigates to a different view in a flow.

Constructor Summary

Constructors

Constructor and Description
FlowLink(java.lang.Class<T> controllerClass) Default constructor of the class
FlowLink(java.lang.Class<T> controllerClass, boolean addOldToHistory) This Constructor is needed for DataFX when calling a back action.

Method Summary

Modifier and Type	Method and Description
void	handle(FlowHandler flowHandler, java.lang.String actionId) This method will be called by the FlowHandler of the current flow whenever the action is triggered.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowLink

public FlowLink(java.lang.Class<T> controllerClass)

Default constructor of the class

Parameters:

controllerClass - controller class of the target view

FlowLink

public FlowLink(java.lang.Class<T> controllerClass,
                boolean addOldToHistory)

This Constructor is needed for DataFX when calling a back action. In this case the navigation should not be added to the navigation history. Normally a developer should not use this constructor.

Parameters:

controllerClass - controller class of the target view

addOldToHistory - defines if the old view should be added to the view history of the flow

Method Detail

handle

public void handle(FlowHandler flowHandler,
                   java.lang.String actionId)
            throws FlowException

Description copied from interface: FlowAction

This method will be called by the FlowHandler of the current flow whenever the action is triggered.

Specified by:

handle in interface FlowAction

Parameters:

flowHandler - the flowHandler of the current flow

actionId - unique ID of this action in the current flow

Throws:

FlowException - if an error occures while handling the action