org.jacp.javafx2.rcp.component
Class AFX2Component

java.lang.Object
  extended by org.jacp.javafx2.rcp.component.AFXComponent
All Implemented Interfaces:
org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>, org.jacp.api.component.IExtendedComponent<javafx.scene.Node>, org.jacp.api.component.IHandleable<javafx.event.Event,java.lang.Object>, org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>, org.jacp.api.component.IVComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

public abstract class AFX2Component
extends java.lang.Object
implements org.jacp.api.component.IVComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

represents a basic FX2 component to extend from, uses this abstract class to create UI components

Author:
Andy Moncsek

Constructor Summary
AFX2Component()
           
 
Method Summary
 org.jacp.api.action.IActionListener<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> getActionListener()
          
 java.lang.String getExecutionTarget()
          
 java.lang.String getId()
          
 java.lang.String getName()
          
 org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> getNextIncomingMessage()
          
 java.lang.String getParentId()
           
 javafx.scene.Node getRoot()
          
<C> C
handle(org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
           
abstract  javafx.scene.Node handleAction(org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
           
 boolean hasIncomingMessage()
          
 boolean isActive()
          
 boolean isBlocked()
          
 boolean isStarted()
          
 void onStart(org.jacp.api.componentLayout.IBaseLayout<javafx.scene.Node> layout)
          
abstract  void onStartComponent(FX2ComponentLayout layout)
          Handle menu, bars and other UI components on component start.
 void onTearDown(org.jacp.api.componentLayout.IBaseLayout<javafx.scene.Node> layout)
          
abstract  void onTearDownComponent(FX2ComponentLayout layout)
          Clean up menu, bars and other components on component teardown.
 javafx.scene.Node postHandle(javafx.scene.Node node, org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
          
abstract  javafx.scene.Node postHandleAction(javafx.scene.Node node, org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
           
 void putIncomingMessage(org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
          
 void setActive(boolean active)
          
 void setBlocked(boolean blocked)
          
 void setExecutionTarget(java.lang.String target)
          
 void setId(java.lang.String id)
          
 void setMessageQueue(java.util.concurrent.BlockingQueue<org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object>> messageQueue)
          
 void setName(java.lang.String name)
          
 void setParentId(java.lang.String parentId)
           
 void setRoot(javafx.scene.Node root)
          
 void setStarted(boolean isActive)
          
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AFX2Component

public AFX2Component()
Method Detail

setRoot

public final void setRoot(javafx.scene.Node root)

Specified by:
setRoot in interface org.jacp.api.component.IVComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getRoot

public final javafx.scene.Node getRoot()

Specified by:
getRoot in interface org.jacp.api.component.IVComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getExecutionTarget

public final java.lang.String getExecutionTarget()

Specified by:
getExecutionTarget in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setExecutionTarget

public final void setExecutionTarget(java.lang.String target)

Specified by:
setExecutionTarget in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

hasIncomingMessage

public final boolean hasIncomingMessage()

Specified by:
hasIncomingMessage in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

putIncomingMessage

public final void putIncomingMessage(org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)

Specified by:
putIncomingMessage in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getNextIncomingMessage

public final org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> getNextIncomingMessage()

Specified by:
getNextIncomingMessage in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

isBlocked

public final boolean isBlocked()

Specified by:
isBlocked in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setBlocked

public final void setBlocked(boolean blocked)

Specified by:
setBlocked in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getActionListener

public final org.jacp.api.action.IActionListener<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> getActionListener()

Specified by:
getActionListener in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getId

public final java.lang.String getId()

Specified by:
getId in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setId

public final void setId(java.lang.String id)

Specified by:
setId in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

isActive

public final boolean isActive()

Specified by:
isActive in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setActive

public final void setActive(boolean active)

Specified by:
setActive in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setStarted

public final void setStarted(boolean isActive)

Specified by:
setStarted in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

isStarted

public final boolean isStarted()

Specified by:
isStarted in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getName

public final java.lang.String getName()

Specified by:
getName in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setName

public final void setName(java.lang.String name)

Specified by:
setName in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getParentId

public java.lang.String getParentId()
Specified by:
getParentId in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setParentId

public void setParentId(java.lang.String parentId)
Specified by:
setParentId in interface org.jacp.api.component.ISubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

setMessageQueue

public final void setMessageQueue(java.util.concurrent.BlockingQueue<org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object>> messageQueue)

Specified by:
setMessageQueue in interface org.jacp.api.component.IComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

handle

public final <C> C handle(org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
Specified by:
handle in interface org.jacp.api.component.IHandleable<javafx.event.Event,java.lang.Object>

postHandle

public final javafx.scene.Node postHandle(javafx.scene.Node node,
                                          org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)

Specified by:
postHandle in interface org.jacp.api.component.IVComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

handleAction

public abstract javafx.scene.Node handleAction(org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
Parameters:
action -
Returns:
a node
See Also:
IHandleable.handle(IAction)

postHandleAction

public abstract javafx.scene.Node postHandleAction(javafx.scene.Node node,
                                                   org.jacp.api.action.IAction<javafx.event.Event,java.lang.Object> action)
Parameters:
node -
action -
Returns:
a node
See Also:
{@inheritDoc}

onStart

public final void onStart(org.jacp.api.componentLayout.IBaseLayout<javafx.scene.Node> layout)

Specified by:
onStart in interface org.jacp.api.component.IExtendedComponent<javafx.scene.Node>

onTearDown

public void onTearDown(org.jacp.api.componentLayout.IBaseLayout<javafx.scene.Node> layout)

Specified by:
onTearDown in interface org.jacp.api.component.IExtendedComponent<javafx.scene.Node>

onStartComponent

public abstract void onStartComponent(FX2ComponentLayout layout)
Handle menu, bars and other UI components on component start.

Parameters:
menuBar -
bars -

onTearDownComponent

public abstract void onTearDownComponent(FX2ComponentLayout layout)
Clean up menu, bars and other components on component teardown.

Parameters:
menuBar -
bars -