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
| Modifier and Type | Field and Description |
|---|---|
protected org.jacpfx.api.component.Injectable |
perspective |
| Constructor and Description |
|---|
AFXPerspective() |
| 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
|
public final boolean isStarted()
isStarted in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>public final void setStarted(boolean started)
org.jacpfx.api.component.ComponentBasesetStarted in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>public final java.lang.String getLocaleID()
getLocaleID in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>public final void setLocaleID(java.lang.String localeID)
setLocaleID in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>public final java.lang.String getResourceBundleLocation()
getResourceBundleLocation in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>public final void setResourceBundleLocation(java.lang.String resourceBundleLocation)
setResourceBundleLocation in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>resourceBundleLocation - . The location of the resource bundle.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)
init in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>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)
postInit in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final void handlePerspective(org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action)
handlePerspective in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final void registerComponent(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component)
org.jacpfx.api.component.RootComponentregisterComponent 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>>public final void addComponent(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component)
org.jacpfx.api.component.RootComponentaddComponent 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>>public final void unregisterComponent(org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> component)
org.jacpfx.api.component.RootComponentunregisterComponent 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>>public final void removeAllCompnents()
org.jacpfx.api.component.RootComponentremoveAllCompnents 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>>public final void initComponents(org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action)
org.jacpfx.api.component.RootComponentinitComponents 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>>public final java.util.List<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> getSubcomponents()
org.jacpfx.api.component.PerspectivegetSubcomponents in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node> getIPerspectiveLayout()
org.jacpfx.api.component.PerspectivegetIPerspectiveLayout in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final void setIPerspectiveLayout(org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node> layout)
org.jacpfx.api.component.PerspectivesetIPerspectiveLayout in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final java.util.concurrent.BlockingQueue<org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>> getComponentDelegateQueue()
org.jacpfx.api.component.PerspectivegetComponentDelegateQueue in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final java.util.concurrent.BlockingQueue<org.jacpfx.api.message.DelegateDTO<javafx.event.Event,java.lang.Object>> getMessageDelegateQueue()
org.jacpfx.api.component.PerspectivegetMessageDelegateQueue in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> getMessageQueue()
org.jacpfx.api.component.PerspectivegetMessageQueue in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>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()
org.jacpfx.api.component.RootComponentgetComponentHandler 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>>public final java.lang.String getViewLocation()
org.jacpfx.api.component.PerspectivegetViewLocation in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final void setViewLocation(java.lang.String documentURL)
org.jacpfx.api.component.PerspectivesetViewLocation in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>documentURL - , the url of the FXML documentpublic final void initialize(java.net.URL url,
java.util.ResourceBundle resourceBundle)
initialize in interface javafx.fxml.Initializablepublic final java.net.URL getDocumentURL()
getDocumentURL in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final org.jacpfx.api.util.UIType getType()
getType in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final void setUIType(org.jacpfx.api.util.UIType type)
setUIType in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final org.jacpfx.api.component.Injectable getPerspective()
org.jacpfx.api.component.PerspectivegetPerspective in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public final org.jacpfx.api.context.JacpContext getContext()
org.jacpfx.api.component.ComponentBasegetContext in interface org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>public final int compareTo(org.jacpfx.api.component.ComponentBase o)
compareTo in interface java.lang.Comparable<org.jacpfx.api.component.ComponentBase<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>>public void updatePositions(int pos,
int of)
org.jacpfx.api.component.PerspectiveupdatePositions in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>pos - the current position of the perspectiveof - the total amount of active perspectivespublic boolean isLast()
org.jacpfx.api.component.PerspectiveisLast in interface org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Object