org.jacpfx.api.component

Interface Perspective<C,L,A,M>

Type Parameters:

L - defines the message listener type

A - defines the basic event type

M - defines the basic message type

All Superinterfaces:

java.lang.Comparable<ComponentBase<L,M>>, ComponentBase<L,M>, RootComponent<SubComponent<L,A,M>,Message<A,M>>

public interface Perspective<C,L,A,M>
extends ComponentBase<L,M>, RootComponent<SubComponent<L,A,M>,Message<A,M>>

Defines a perspective, a perspective is a root component handled by an workbench and contains sub-component such as visible UI component or background component. A workbench can handle one or more perspective (1-n) and every perspective can handle one ore more component (1-n).

Author:

Andy Moncsek

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.BlockingQueue<SubComponent<L,A,M>>	getComponentDelegateQueue() Returns delegate queue to delegate component to correct target
java.net.URL	getDocumentURL() The document URL describing the UI.
PerspectiveLayoutInterface<C,C>	getIPerspectiveLayout() Returns layout dto.
java.util.concurrent.BlockingQueue<DelegateDTO<A,M>>	getMessageDelegateQueue() Returns delegate queue to delegate actions to correct target
java.util.concurrent.TransferQueue<Message<A,M>>	getMessageQueue() returns the component coordinator message queue;
Injectable	getPerspective() Returns the injected perspective representation.
java.util.List<SubComponent<L,A,M>>	getSubcomponents() Returns all subcomponents in perspective.
UIType	getType() Distinguish component types.
java.lang.String	getViewLocation() Contains the document url describing the UI.
void	handlePerspective(Message<A,M> message) Handle a message call on perspective instance.
void	init(java.util.concurrent.BlockingQueue<SubComponent<L,A,M>> componentDelegateQueue, java.util.concurrent.BlockingQueue<DelegateDTO<A,M>> messageDelegateQueue, Coordinator<L,A,M> messageCoordinator, Launcher<?> launcher) The initialization method.
boolean	isLast() Marks the last perspective to handle, this is the visible perspective after initialisation
void	postInit(ComponentHandler<SubComponent<L,A,M>,Message<A,M>> componentHandler) post init method to set correct component handler and to initialize component depending on objects created in startUp sequence.
void	setIPerspectiveLayout(PerspectiveLayoutInterface<C,C> layout) Set the default perspective layout entity for the perspective.
void	setUIType(UIType type) Set the UI type to distinguish component types
void	setViewLocation(java.lang.String documentURL) Set the viewLocation location on component start.
void	updatePositions(int pos, int of) defines the position of an active perspective in workspace

Methods inherited from interface org.jacpfx.api.component.ComponentBase

getContext, getLocaleID, getResourceBundleLocation, isStarted, setLocaleID, setResourceBundleLocation, setStarted

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.jacpfx.api.component.RootComponent

addComponent, getComponentHandler, initComponents, registerComponent, removeAllCompnents, unregisterComponent

Method Detail

init

void init(java.util.concurrent.BlockingQueue<SubComponent<L,A,M>> componentDelegateQueue,
          java.util.concurrent.BlockingQueue<DelegateDTO<A,M>> messageDelegateQueue,
          Coordinator<L,A,M> messageCoordinator,
          Launcher<?> launcher)

The initialization method.

Parameters:

componentDelegateQueue, - component that should be delegated to an other perspective

messageDelegateQueue, - messages to component

messageCoordinator, - coordinates messages to component

launcher, - the component launcher

postInit

void postInit(ComponentHandler<SubComponent<L,A,M>,Message<A,M>> componentHandler)

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

Parameters:

componentHandler, - the component handler

getSubcomponents

java.util.List<SubComponent<L,A,M>> getSubcomponents()

Returns all subcomponents in perspective.

Returns:

a list of all handled component in current perspective.

handlePerspective

void handlePerspective(Message<A,M> message)

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

Parameters:

message, - the message to perspective.

getComponentDelegateQueue

java.util.concurrent.BlockingQueue<SubComponent<L,A,M>> getComponentDelegateQueue()

Returns delegate queue to delegate component to correct target

Returns:

the delegate queue

getMessageDelegateQueue

java.util.concurrent.BlockingQueue<DelegateDTO<A,M>> getMessageDelegateQueue()

Returns delegate queue to delegate actions to correct target

Returns:

the delegate queue

getMessageQueue

java.util.concurrent.TransferQueue<Message<A,M>> getMessageQueue()

returns the component coordinator message queue;

Returns:

message queue

getPerspective

Injectable getPerspective()

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

Returns:

the perspective implementation.

getIPerspectiveLayout

PerspectiveLayoutInterface<C,C> getIPerspectiveLayout()

Returns layout dto.

Returns:

an PerspectiveLayoutInterface instance to define basic layout stuff for perspective

setIPerspectiveLayout

void setIPerspectiveLayout(PerspectiveLayoutInterface<C,C> layout)

Set the default perspective layout entity for the perspective.

Parameters:

layout, - The layout dto

getViewLocation

java.lang.String getViewLocation()

Contains the document url describing the UI.

Returns:

the document url

setViewLocation

void setViewLocation(java.lang.String documentURL)

Set the viewLocation location on component start.

Parameters:

documentURL - , the url of the FXML document

getDocumentURL

java.net.URL getDocumentURL()

The document URL describing the UI.

Returns:

the document url

getType

UIType getType()

Distinguish component types.

Returns:

the type of the component.

setUIType

void setUIType(UIType type)

Set the UI type to distinguish component types

Parameters:

type, - PROGRAMMATIC / DECLARATIVE type

updatePositions

void updatePositions(int pos,
                     int of)

defines the position of an active perspective in workspace

Parameters:

pos - the current position of the perspective

of - the total amount of active perspectives

isLast

boolean isLast()

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

Returns:

true if perspective is the last visible perspective while initialisation