org.jacpfx.rcp.util

Class WorkerUtil

java.lang.Object

org.jacpfx.rcp.util.WorkerUtil

public class WorkerUtil
extends java.lang.Object

Created with IntelliJ IDEA. User: Andy Moncsek Date: 11.10.13 Time: 14:22 This util class contains methods needed in all types of workers

Constructor Summary

Constructors

Constructor and Description
WorkerUtil()

Method Summary

Modifier and Type	Method and Description
static void	addComponentByType(javafx.scene.Node validContainer, org.jacpfx.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component) find valid target and add type specific new component.
static void	changeComponentTarget(java.util.concurrent.BlockingQueue<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> delegateQueue, org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component) Move component to new target in perspective.
static void	delegateReturnValue(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> comp, java.lang.String targetId, java.lang.Object value, org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action) delegate component handle return value to specified target
static void	executeComponentViewPostHandle(javafx.scene.Node handleReturnValue, EmbeddedFXComponent component, org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> message) Executes post handle method in application main thread.
static void	handleViewState(javafx.scene.Node componentViewNode, boolean state) set visibility and enable/disable
static void	invokeOnFXThreadAndWait(java.lang.Runnable runnable) invokes a runnable on application thread and waits until execution is finished
static javafx.scene.Node	prepareAndRunHandleMethod(org.jacpfx.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component, org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action) Runs the handle method of a componentView.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerUtil

public WorkerUtil()

Method Detail

invokeOnFXThreadAndWait

public static void invokeOnFXThreadAndWait(java.lang.Runnable runnable)
                                    throws java.lang.InterruptedException,
                                           java.util.concurrent.ExecutionException

invokes a runnable on application thread and waits until execution is finished

Parameters:

runnable, - a runnable which will be invoked and wait until execution is finished

Throws:

java.lang.InterruptedException - when thread was interrupted on shutdown

java.util.concurrent.ExecutionException - when an exception was thrown in a component

addComponentByType

public static void addComponentByType(javafx.scene.Node validContainer,
                                      org.jacpfx.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component)

find valid target and add type specific new component. Handles Container, ScrollPanes, Menus and Bar Entries from user

Parameters:

validContainer, - a valid container where component root will be added

component, - the component

handleViewState

public static void handleViewState(javafx.scene.Node componentViewNode,
                                   boolean state)

set visibility and enable/disable

Parameters:

componentViewNode, - a Node where to set the state

state, - the boolean value of the state

delegateReturnValue

public static void delegateReturnValue(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> comp,
                                       java.lang.String targetId,
                                       java.lang.Object value,
                                       org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action)

delegate component handle return value to specified target

Parameters:

comp, - the component

targetId, - the message target id

value, - the message value

action, - the message

executeComponentViewPostHandle

public static void executeComponentViewPostHandle(javafx.scene.Node handleReturnValue,
                                                  EmbeddedFXComponent component,
                                                  org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> message)
                                           throws java.lang.Exception

Executes post handle method in application main thread. The result value of handle method (from worker thread) is Input for the postHandle Method. The return value or the handleReturnValue are the root node of this component.

Parameters:

handleReturnValue - the UI return value after "handle(message)" ComponentHandle.handle(org.jacpfx.api.message.Message) was executed

component, - a component

message, - the current message

Throws:

java.lang.Exception - when an Exception occures while execute ComponentView.postHandle(Object, org.jacpfx.api.message.Message)

changeComponentTarget

public static void changeComponentTarget(java.util.concurrent.BlockingQueue<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> delegateQueue,
                                         org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component)

Move component to new target in perspective.

Parameters:

delegateQueue, - the component delegate queue

component, - the component

prepareAndRunHandleMethod

public static javafx.scene.Node prepareAndRunHandleMethod(org.jacpfx.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component,
                                                          org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action)
                                                   throws java.lang.Exception

Runs the handle method of a componentView.

Parameters:

component, - the component

action, - the current message

Returns:

a returned node from component execution ComponentHandle.handle(org.jacpfx.api.message.Message)

Throws:

java.lang.Exception - when an Exception occures while execute ComponentHandle.handle(org.jacpfx.api.message.Message)