org.jacpfx.rcp.component

Class ASubComponent

java.lang.Object

org.jacpfx.rcp.component.ASubComponent

All Implemented Interfaces:

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

Direct Known Subclasses:

AStatelessCallbackComponent, EmbeddedFXComponent, EmbeddedStatefulComponent

public abstract class ASubComponent
extends java.lang.Object
implements org.jacpfx.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

the ASubComponent is the basic component for all components

Author:

Andy Moncsek

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>>	globalMessageQueue

Constructor Summary

Constructors

Constructor and Description
ASubComponent()

Method Summary

Modifier and Type	Method and Description
int	compareTo(org.jacpfx.api.component.ComponentBase o)
boolean	equals(java.lang.Object o)
org.jacpfx.api.component.ComponentHandle<?,javafx.event.Event,java.lang.Object>	getComponent() Returns the component handle class, this is the users implementation of the component.
org.jacpfx.api.context.JacpContext	getContext() Returns the component context object.
java.lang.String	getLocaleID() Represents the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.
org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>	getNextIncomingMessage() Returns next message in pipe.
java.lang.String	getResourceBundleLocation() Represents the location of your resource bundle file.
int	hashCode()
boolean	hasIncomingMessage() Returns true if component has message in pipe.
void	initEnv(java.lang.String parentId, java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> messageQueue) Set parentId and global message queue to component
void	initWorker(AEmbeddedComponentWorker worker)
void	interruptWorker()
boolean	isBlocked() Component is blocked when executed in thread.
boolean	isStarted() Get if component was activated, can occur if message was send before "init" message arrived.
void	lock() Lock Component for execution in thread.
void	putIncomingMessage(org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> action) Add new message to component.
void	release() Release lock after execution in thread.
<X extends org.jacpfx.api.component.ComponentHandle<?,javafx.event.Event,java.lang.Object>> void	setComponent(X handle) Set the component handle class.
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

Methods inherited from class java.lang.Object

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

Field Detail

globalMessageQueue

protected java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> globalMessageQueue

Constructor Detail

ASubComponent

public ASubComponent()

Method Detail

initEnv

public final void initEnv(java.lang.String parentId,
                          java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> messageQueue)

Set parentId and global message queue to component

Specified by:

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

hasIncomingMessage

public final boolean hasIncomingMessage()

Returns true if component has message in pipe.

Specified by:

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

Returns:

returns true if incoming message is in queue

putIncomingMessage

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

Add new message to component.

Specified by:

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

getNextIncomingMessage

public final org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object> getNextIncomingMessage()
                                                                                                 throws java.lang.InterruptedException

Returns next message in pipe.

Specified by:

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

Returns:

the next message to handle

Throws:

java.lang.InterruptedException - , the Exception will be thrown when main thread is interrupted and not delegated to the developer

isBlocked

public final boolean isBlocked()

Component is blocked when executed in thread.

Specified by:

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

Returns:

blocked state

lock

public final void lock()

Lock Component for execution in thread.

Specified by:

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

release

public final void release()

Release lock after execution in thread.

Specified by:

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

getContext

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

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.

getComponent

public final org.jacpfx.api.component.ComponentHandle<?,javafx.event.Event,java.lang.Object> getComponent()

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

Specified by:

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

Returns:

ComponentHandle, the component handle.

setComponent

public final <X extends org.jacpfx.api.component.ComponentHandle<?,javafx.event.Event,java.lang.Object>> void setComponent(X handle)

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

Specified by:

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

initWorker

public final void initWorker(AEmbeddedComponentWorker worker)

interruptWorker

public final void interruptWorker()

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.

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>>

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object