org.jacpfx.rcp.workbench

Class AFXWorkbench

java.lang.Object

org.jacpfx.rcp.workbench.AFXWorkbench

All Implemented Interfaces:

org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>, org.jacpfx.api.workbench.Base<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

Direct Known Subclasses:

EmbeddedFXWorkbench

public abstract class AFXWorkbench
extends java.lang.Object
implements org.jacpfx.api.workbench.Base<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>, org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

represents the basic JavaFX workbench instance; handles perspective and component;

Author:

Andy Moncsek, Patrick Symmangk

Constructor Summary

Constructors

Constructor and Description
AFXWorkbench()

Method Summary

Modifier and Type	Method and Description
void	addComponent(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective) Add a component, this does not fully register the component.
FXWorkbench	getComponentHandle() Returns the component handle class, this is the users implementation of the component.
org.jacpfx.api.handler.ComponentHandler<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>	getComponentHandler() Returns component handler to handle initialization and reassignment of subcomponents.
org.jacpfx.api.context.JacpContext	getContext() Returns the component context object.
java.util.List<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>>	getPerspectives() Get perspective in workbench.
protected WorkbenchDecorator	getWorkbenchDecorator()
void	init(org.jacpfx.api.launcher.Launcher<?> launcher, java.lang.Object root) Initialization sequence returns basic container to handle perspective.
void	initComponents(org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action) Handles initialization of subcomponents.
void	registerComponent(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective) Register the component at the listener.
void	removeAllCompnents() Remove all component when perspective is shut down.
<X extends org.jacpfx.api.component.Injectable> void	setComponentHandle(X handle) Set the component handle class.
protected void	setWorkbenchDecorator(WorkbenchDecorator workbenchDecorator)
void	unregisterComponent(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective) Unregister component from current perspective.

Methods inherited from class java.lang.Object

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

Constructor Detail

AFXWorkbench

public AFXWorkbench()

Method Detail

init

public void init(org.jacpfx.api.launcher.Launcher<?> launcher,
                 java.lang.Object root)

Description copied from interface: org.jacpfx.api.workbench.Base

Initialization sequence returns basic container to handle perspective.

Specified by:

init in interface org.jacpfx.api.workbench.Base<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

Parameters:

launcher - for di container

initComponents

public final void initComponents(org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action)

Description copied from interface: org.jacpfx.api.component.RootComponent

Handles initialization of subcomponents.

Specified by:

initComponents in interface org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

registerComponent

public final void registerComponent(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective)

Description copied from interface: org.jacpfx.api.component.RootComponent

Register the component at the listener.

Specified by:

registerComponent in interface org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

addComponent

public final void addComponent(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective)

Description copied from interface: org.jacpfx.api.component.RootComponent

Add a component, this does not fully register the component. If you want to add a newly created component use registerComponent instead.

Specified by:

addComponent in interface org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

unregisterComponent

public final void unregisterComponent(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective)

Description copied from interface: org.jacpfx.api.component.RootComponent

Unregister component from current perspective.

Specified by:

unregisterComponent in interface org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

removeAllCompnents

public final void removeAllCompnents()

Description copied from interface: org.jacpfx.api.component.RootComponent

Remove all component when perspective is shut down.

Specified by:

removeAllCompnents in interface org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

getComponentHandler

public org.jacpfx.api.handler.ComponentHandler<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> getComponentHandler()

Description copied from interface: org.jacpfx.api.component.RootComponent

Returns component handler to handle initialization and reassignment of subcomponents.

Specified by:

getComponentHandler in interface org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

Returns:

the component handler

getPerspectives

public final java.util.List<org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> getPerspectives()

Description copied from interface: org.jacpfx.api.workbench.Base

Get perspective in workbench.

Specified by:

getPerspectives in interface org.jacpfx.api.workbench.Base<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

Returns:

a list of all perspective

getContext

public org.jacpfx.api.context.JacpContext getContext()

Description copied from interface: org.jacpfx.api.workbench.Base

Returns the component context object.

Specified by:

getContext in interface org.jacpfx.api.workbench.Base<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

Returns:

the context object.

getComponentHandle

public FXWorkbench getComponentHandle()

Description copied from interface: org.jacpfx.api.workbench.Base

Returns the component handle class, this is the users implementation of the component.

Specified by:

getComponentHandle in interface org.jacpfx.api.workbench.Base<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

Returns:

ComponentHandle, the component handle.

setComponentHandle

public <X extends org.jacpfx.api.component.Injectable> void setComponentHandle(X handle)

Description copied from interface: org.jacpfx.api.workbench.Base

Set the component handle class. This is the users implementation of the component.

Specified by:

setComponentHandle in interface org.jacpfx.api.workbench.Base<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getWorkbenchDecorator

protected WorkbenchDecorator getWorkbenchDecorator()

setWorkbenchDecorator

protected void setWorkbenchDecorator(WorkbenchDecorator workbenchDecorator)