org.jacpfx.rcp.perspective

Class AFXPerspective

java.lang.Object

org.jacpfx.rcp.perspective.AFXPerspective

All Implemented Interfaces:

java.lang.Comparable<org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>>, javafx.fxml.Initializable, org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>, org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>, org.jacpfx.api.component.RootComponent<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

Direct Known Subclasses:

EmbeddedFXPerspective

public abstract class AFXPerspective
extends java.lang.Object
implements org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>, org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>, javafx.fxml.Initializable

represents a basic javafx perspective that handles subcomponents, perspective are not handled in thread so avoid long running tasks in perspective.

Author:

Andy Moncsek

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jacpfx.api.component.Injectable	perspective

Constructor Summary

Constructors

Constructor and Description
AFXPerspective()

Method Summary

Modifier and Type	Method and Description
void	addComponent(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component) Add a component, this does not fully register the component.
int	compareTo(org.jacpfx.api.component.ComponentBase o)
boolean	equals(java.lang.Object o)
java.util.concurrent.BlockingQueue<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>>	getComponentDelegateQueue() Returns delegate queue to delegate component to correct target
org.jacpfx.api.handler.ComponentHandler<org.jacpfx.api.component.SubComponent<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.net.URL	getDocumentURL() The document URL describing the UI.
org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node>	getIPerspectiveLayout() Returns layout dto.
java.lang.String	getLocaleID() Represents the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.
java.util.concurrent.BlockingQueue<org.jacpfx.api.message.DelegateDTO<javafx.event.Event,java.lang.Object>>	getMessageDelegateQueue() Returns delegate queue to delegate actions to correct target
java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>	getMessageQueue() returns the component coordinator message queue;
org.jacpfx.api.component.Injectable	getPerspective() Returns the injected perspective representation.
java.lang.String	getResourceBundleLocation() Represents the location of your resource bundle file.
java.util.List<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>>	getSubcomponents() Returns all subcomponents in perspective.
org.jacpfx.api.util.UIType	getType() Distinguish component types.
java.lang.String	getViewLocation() Contains the document url describing the UI.
void	handlePerspective(org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action) Handle a message call on perspective instance.
int	hashCode()
void	init(java.util.concurrent.BlockingQueue<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> componentDelegateQueue, java.util.concurrent.BlockingQueue<org.jacpfx.api.message.DelegateDTO<javafx.event.Event,java.lang.Object>> messageDelegateQueue, org.jacpfx.api.coordinator.Coordinator<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> messageCoordinator, org.jacpfx.api.launcher.Launcher<?> launcher) The initialization method.
void	initComponents(org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action) Handles initialization of subcomponents.
void	initialize(java.net.URL url, java.util.ResourceBundle resourceBundle)
boolean	isLast() Marks the last perspective to handle, this is the visible perspective after initialisation
boolean	isStarted() Get if component was activated, can occur if message was send before "init" message arrived.
void	postInit(org.jacpfx.api.handler.ComponentHandler<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> componentHandler) post init method to set correct component handler and to initialize component depending on objects created in startUp sequence.
void	registerComponent(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component) Register the component at the listener.
void	removeAllCompnents() Remove all component when perspective is shut down.
void	setIPerspectiveLayout(org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node> layout) Set the default perspective layout entity for the perspective.
void	setLocaleID(java.lang.String localeID) Set the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.
void	setResourceBundleLocation(java.lang.String resourceBundleLocation) Set the location of your resource bundle file.
void	setStarted(boolean started) Set once when component was first started
void	setUIType(org.jacpfx.api.util.UIType type) Set the UI type to distinguish component types
void	setViewLocation(java.lang.String documentURL) Set the viewLocation location on component start.
void	unregisterComponent(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component) Unregister component from current perspective.
void	updatePositions(int pos, int of) defines the position of an active perspective in workspace

Methods inherited from class java.lang.Object

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

Field Detail

perspective

protected org.jacpfx.api.component.Injectable perspective

Constructor Detail

AFXPerspective

public AFXPerspective()

Method Detail

isStarted

public final boolean isStarted()

Get if component was activated, can occur if message was send before "init" message arrived.

Specified by:

isStarted in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the active status

setStarted

public final void setStarted(boolean started)

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

Set once when component was first started

Specified by:

setStarted in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

getLocaleID

public final java.lang.String getLocaleID()

Represents the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.

Specified by:

getLocaleID in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the locale id

setLocaleID

public final void setLocaleID(java.lang.String localeID)

Set the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.

Specified by:

setLocaleID in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

getResourceBundleLocation

public final java.lang.String getResourceBundleLocation()

Represents the location of your resource bundle file.

Specified by:

getResourceBundleLocation in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the url of resource bundle

setResourceBundleLocation

public final void setResourceBundleLocation(java.lang.String resourceBundleLocation)

Set the location of your resource bundle file.

Specified by:

setResourceBundleLocation in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Parameters:

resourceBundleLocation - . The location of the resource bundle.

init

public final void init(java.util.concurrent.BlockingQueue<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> componentDelegateQueue,
                       java.util.concurrent.BlockingQueue<org.jacpfx.api.message.DelegateDTO<javafx.event.Event,java.lang.Object>> messageDelegateQueue,
                       org.jacpfx.api.coordinator.Coordinator<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> messageCoordinator,
                       org.jacpfx.api.launcher.Launcher<?> launcher)

The initialization method.

Specified by:

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

postInit

public final void postInit(org.jacpfx.api.handler.ComponentHandler<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> componentHandler)

post init method to set correct component handler and to initialize component depending on objects created in startUp sequence.

Specified by:

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

handlePerspective

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

Handle a message call on perspective instance. This method should be override to handle the layout of an perspective.

Specified by:

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

registerComponent

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

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.SubComponent<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.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component)

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.SubComponent<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.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component)

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.SubComponent<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.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

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.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>,org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>

getSubcomponents

public final java.util.List<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> getSubcomponents()

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

Returns all subcomponents in perspective.

Specified by:

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

Returns:

a list of all handled component in current perspective.

getIPerspectiveLayout

public final org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node> getIPerspectiveLayout()

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

Returns layout dto.

Specified by:

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

Returns:

an PerspectiveLayoutInterface instance to define basic layout stuff for perspective

setIPerspectiveLayout

public final void setIPerspectiveLayout(org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node> layout)

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

Set the default perspective layout entity for the perspective.

Specified by:

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

getComponentDelegateQueue

public final java.util.concurrent.BlockingQueue<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> getComponentDelegateQueue()

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

Returns delegate queue to delegate component to correct target

Specified by:

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

Returns:

the delegate queue

getMessageDelegateQueue

public final java.util.concurrent.BlockingQueue<org.jacpfx.api.message.DelegateDTO<javafx.event.Event,java.lang.Object>> getMessageDelegateQueue()

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

Returns delegate queue to delegate actions to correct target

Specified by:

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

Returns:

the delegate queue

getMessageQueue

public final java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> getMessageQueue()

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

returns the component coordinator message queue;

Specified by:

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

Returns:

message queue

getComponentHandler

public final org.jacpfx.api.handler.ComponentHandler<org.jacpfx.api.component.SubComponent<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.SubComponent<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

getViewLocation

public final java.lang.String getViewLocation()

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

Contains the document url describing the UI.

Specified by:

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

Returns:

the document url

setViewLocation

public final void setViewLocation(java.lang.String documentURL)

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

Set the viewLocation location on component start.

Specified by:

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

Parameters:

documentURL - , the url of the FXML document

initialize

public final void initialize(java.net.URL url,
                             java.util.ResourceBundle resourceBundle)

Specified by:

initialize in interface javafx.fxml.Initializable

getDocumentURL

public final java.net.URL getDocumentURL()

The document URL describing the UI.

Specified by:

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

Returns:

the document url

getType

public final org.jacpfx.api.util.UIType getType()

Distinguish component types.

Specified by:

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

Returns:

the type of the component.

setUIType

public final void setUIType(org.jacpfx.api.util.UIType type)

Set the UI type to distinguish component types

Specified by:

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

getPerspective

public final org.jacpfx.api.component.Injectable getPerspective()

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

Returns the injected perspective representation. This Injectable is the implementation of a perspective which includes all handle methods.

Specified by:

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

Returns:

the perspective implementation.

getContext

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

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

Returns the component context object.

Specified by:

getContext in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the context object.

compareTo

public final int compareTo(org.jacpfx.api.component.ComponentBase o)

Specified by:

compareTo in interface java.lang.Comparable<org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>>

updatePositions

public void updatePositions(int pos,
                            int of)

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

defines the position of an active perspective in workspace

Specified by:

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

Parameters:

pos - the current position of the perspective

of - the total amount of active perspectives

isLast

public boolean isLast()

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

Marks the last perspective to handle, this is the visible perspective after initialisation

Specified by:

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

Returns:

true if perspective is the last visible perspective while initialisation

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object