io.datafx.controller.flow

Class FlowHandler

java.lang.Object

io.datafx.controller.flow.FlowHandler

public class FlowHandler
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FlowHandler(Flow flow, ViewFlowContext flowContext)
FlowHandler(Flow flow, ViewFlowContext flowContext, ViewConfiguration viewConfiguration)
FlowHandler(Flow flow, ViewFlowContext flowContext, ViewConfiguration viewConfiguration, io.datafx.core.ExceptionHandler exceptionHandler)

Method Summary

Modifier and Type	Method and Description
void	attachAction(javafx.scene.control.MenuItem menuItem, java.lang.Runnable action)
void	attachAction(javafx.scene.Node node, java.lang.Runnable action)
void	attachBackEventHandler(javafx.scene.control.MenuItem menuItem)
void	attachBackEventHandler(javafx.scene.Node node)
void	attachEventHandler(javafx.scene.control.MenuItem menuItem, java.lang.String actionId)
void	attachEventHandler(javafx.scene.Node node, java.lang.String actionId)
void	destroy()
javafx.beans.property.ReadOnlyObjectProperty<FlowContainer>	getContainerProperty()
javafx.collections.ObservableList<ViewHistoryDefinition<?>>	getControllerHistory()
FlowView<?>	getCurrentView()
ViewContext<?>	getCurrentViewContext()
java.lang.Class<?>	getCurrentViewControllerClass() Returns the controller class of the current visible
javafx.beans.property.ReadOnlyObjectProperty<ViewMetadata>	getCurrentViewMetadata()
javafx.beans.property.ReadOnlyObjectProperty<FlowView<?>>	getCurrentViewProperty()
io.datafx.core.ExceptionHandler	getExceptionHandler()
ViewFlowContext	getFlowContext()
javafx.beans.property.ReadOnlyObjectProperty<ViewFlowContext>	getFlowContextProperty()
ViewConfiguration	getViewConfiguration()
void	handle(FlowAction action, java.lang.String actionId)
void	handle(java.lang.String actionId)
void	navigateBack()
void	navigateTo(java.lang.Class<?> controllerClass) Navigate to the view that is defined by the given controller class
void	navigateToHistoryIndex(int index)
<S,T extends S> void	registerInApplicationContext(java.lang.Class<S> toRegister, T object)
<T> void	registerInApplicationContext(java.lang.String key, T object)
<T> void	registerInApplicationContext(T object)
<S,T extends S> void	registerInFlowContext(java.lang.Class<S> toRegister, T object)
<T> void	registerInFlowContext(java.lang.String key, T object)
<T> void	registerInFlowContext(T object)
<S,T extends S> void	registerInViewContext(java.lang.Class<S> toRegister, T object)
<T> void	registerInViewContext(java.lang.String key, T object)
<T> void	registerInViewContext(T object)
void	setExceptionHandler(io.datafx.core.ExceptionHandler exceptionHandler) Set the exception handler for this flow.
<U> ViewContext<U>	setNewView(FlowView<U> newView, boolean addOldToHistory)
javafx.scene.layout.StackPane	start()
<T extends javafx.scene.Node> T	start(FlowContainer<T> container)
void	startInPane(javafx.scene.layout.StackPane pane)
javafx.scene.control.Tab	startInTab()
<T extends javafx.scene.Node> javafx.scene.control.Tab	startInTab(FlowContainer<T> container)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowHandler

public FlowHandler(Flow flow,
                   ViewFlowContext flowContext)

FlowHandler

public FlowHandler(Flow flow,
                   ViewFlowContext flowContext,
                   ViewConfiguration viewConfiguration)

FlowHandler

public FlowHandler(Flow flow,
                   ViewFlowContext flowContext,
                   ViewConfiguration viewConfiguration,
                   io.datafx.core.ExceptionHandler exceptionHandler)

Method Detail

start

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

Throws:

FlowException

startInPane

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

Throws:

FlowException

startInTab

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

Throws:

FlowException

startInTab

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

Throws:

FlowException

destroy

public void destroy()

start

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

Throws:

FlowException

getViewConfiguration

public ViewConfiguration getViewConfiguration()

handle

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

Throws:

VetoException

FlowException

getExceptionHandler

public io.datafx.core.ExceptionHandler getExceptionHandler()

setExceptionHandler

public void setExceptionHandler(io.datafx.core.ExceptionHandler exceptionHandler)

Set the exception handler for this flow.

Parameters:

exceptionHandler - the exception handler

getFlowContext

public ViewFlowContext getFlowContext()

getCurrentViewMetadata

public javafx.beans.property.ReadOnlyObjectProperty<ViewMetadata> getCurrentViewMetadata()

getFlowContextProperty

public javafx.beans.property.ReadOnlyObjectProperty<ViewFlowContext> getFlowContextProperty()

getCurrentViewProperty

public javafx.beans.property.ReadOnlyObjectProperty<FlowView<?>> getCurrentViewProperty()

getContainerProperty

public javafx.beans.property.ReadOnlyObjectProperty<FlowContainer> getContainerProperty()

getCurrentView

public FlowView<?> getCurrentView()

getCurrentViewContext

public ViewContext<?> getCurrentViewContext()

getCurrentViewControllerClass

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

Returns the controller class of the current visible

Returns:

the view controller class

handle

public void handle(FlowAction action,
                   java.lang.String actionId)
            throws FlowException,
                   VetoException

Throws:

FlowException

VetoException

setNewView

public <U> ViewContext<U> setNewView(FlowView<U> newView,
                                     boolean addOldToHistory)
                              throws FlowException

Throws:

FlowException

navigateBack

public void navigateBack()
                  throws VetoException,
                         FlowException

Throws:

VetoException

FlowException

getControllerHistory

public javafx.collections.ObservableList<ViewHistoryDefinition<?>> getControllerHistory()

navigateToHistoryIndex

public void navigateToHistoryIndex(int index)
                            throws VetoException,
                                   FlowException

Throws:

VetoException

FlowException

navigateTo

public void navigateTo(java.lang.Class<?> controllerClass)
                throws VetoException,
                       FlowException

Navigate to the view that is defined by the given controller class

Parameters:

controllerClass - the controller class of the view

Throws:

VetoException

FlowException

attachAction

public void attachAction(javafx.scene.Node node,
                         java.lang.Runnable action)

attachAction

public void attachAction(javafx.scene.control.MenuItem menuItem,
                         java.lang.Runnable action)

attachEventHandler

public void attachEventHandler(javafx.scene.Node node,
                               java.lang.String actionId)

attachBackEventHandler

public void attachBackEventHandler(javafx.scene.control.MenuItem menuItem)

attachBackEventHandler

public void attachBackEventHandler(javafx.scene.Node node)

attachEventHandler

public void attachEventHandler(javafx.scene.control.MenuItem menuItem,
                               java.lang.String actionId)

registerInViewContext

public <T> void registerInViewContext(T object)

registerInViewContext

public <T> void registerInViewContext(java.lang.String key,
                                      T object)

registerInViewContext

public <S,T extends S> void registerInViewContext(java.lang.Class<S> toRegister,
                                                  T object)

registerInFlowContext

public <T> void registerInFlowContext(T object)

registerInFlowContext

public <T> void registerInFlowContext(java.lang.String key,
                                      T object)

registerInFlowContext

public <S,T extends S> void registerInFlowContext(java.lang.Class<S> toRegister,
                                                  T object)

registerInApplicationContext

public <T> void registerInApplicationContext(T object)

registerInApplicationContext

public <T> void registerInApplicationContext(java.lang.String key,
                                             T object)

registerInApplicationContext

public <S,T extends S> void registerInApplicationContext(java.lang.Class<S> toRegister,
                                                         T object)