org.quickstart.rcp.component

Class EmbeddedFXComponent

java.lang.Object

org.quickstart.rcp.component.AComponent

org.quickstart.rcp.component.ASubComponent

org.quickstart.rcp.component.EmbeddedFXComponent

All Implemented Interfaces:

java.lang.Comparable<org.quickstart.api.component.Component<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>>, javafx.fxml.Initializable, org.quickstart.api.component.Component<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>, org.quickstart.api.component.Declarative, org.quickstart.api.component.SubComponent<javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>, org.quickstart.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

Direct Known Subclasses:

EmbeddedFXComponent

public abstract class EmbeddedFXComponent
extends ASubComponent
implements org.jacpfx.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>, org.jacpfx.api.component.Declarative, javafx.fxml.Initializable

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

Author:

Andy Moncsek

Field Summary

Fields inherited from class org.jacpfx.rcp.component.AComponent

context, globalMessageQueue

Constructor Summary

Constructors

Constructor and Description
EmbeddedFXComponent()

Method Summary

Modifier and Type	Method and Description
java.net.URL	getDocumentURL() The document URL describing the UI.
javafx.scene.Node	getRoot() Returns the 'root' ui component created by the handle method.
org.quickstart.api.util.UIType	getType() Distinguish component types.
java.lang.String	getViewLocation() Contains the document url describing the UI.
void	initialize(java.net.URL url, java.util.ResourceBundle resourceBundle)
void	setRoot(javafx.scene.Node root) Set the 'root' ui component created by the handle method.
void	setUIType(org.jacpfx.api.util.UIType type) Set the UI type to distinguish component types
void	setViewLocation(java.lang.String document) Set the viewLocation location on component start.

Methods inherited from class org.jacpfx.rcp.component.ASubComponent

getComponent, getContext, getNextIncomingMessage, getParentId, hasIncomingMessage, initEnv, initWorker, interruptWorker, isBlocked, lock, putIncomingMessage, release, setComponent

Methods inherited from class org.jacpfx.rcp.component.AComponent

compareTo, equals, getLocaleID, getResourceBundleLocation, hashCode, isStarted, setLocaleID, setResourceBundleLocation, setStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.quickstart.api.component.UIComponent

getComponentViewHandle

Methods inherited from interface org.quickstart.api.component.SubComponent

getComponent, getNextIncomingMessage, getParentId, hasIncomingMessage, initEnv, isBlocked, lock, putIncomingMessage, release, setComponent

Methods inherited from interface org.quickstart.api.component.Component

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

EmbeddedFXComponent

public EmbeddedFXComponent()

Method Detail

getRoot

public final javafx.scene.Node getRoot()

Returns the 'root' ui component created by the handle method.

Specified by:

getRoot in interface org.quickstart.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

Returns:

the root component

setRoot

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

Set the 'root' ui component created by the handle method.

Specified by:

setRoot in interface org.quickstart.api.component.UIComponent<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>

getViewLocation

public final java.lang.String getViewLocation()

Contains the document url describing the UI.

Specified by:

getViewLocation in interface org.quickstart.api.component.Declarative

Returns:

the document url

setViewLocation

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

Set the viewLocation location on component start.

Specified by:

setViewLocation in interface org.quickstart.api.component.Declarative

Parameters:

document - , 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.quickstart.api.component.Declarative

Returns:

the document url

getType

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

Distinguish component types.

Specified by:

getType in interface org.quickstart.api.component.Declarative

Returns:

the type of the component.

setUIType

public void setUIType(org.quickstart.api.util.UIType type)

Set the UI type to distinguish component types

Specified by:

setUIType in interface org.quickstart.api.component.Declarative