org.jacpfx.api.component

Interface UIComponent<C,L,A,M>

Type Parameters:

C - defines the base component where others extend from

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>, SubComponent<L,A,M>

public interface UIComponent<C,L,A,M>
extends SubComponent<L,A,M>

Represents an basic UI component handled by a perspective. A UIComponent is an // * visible UI component displayed in a defined area of perspective.

Author:

Andy Moncsek

Method Summary

Modifier and Type	Method and Description
default <X extends ComponentView<C,A,M>> X	getComponentViewHandle() Returns the component handle class, this is the users implementation of the component.
java.net.URL	getDocumentURL() The document URL describing the UI.
C	getRoot() Returns the 'root' ui component created by the handle method.
UIType	getType() Distinguish component types.
java.lang.String	getViewLocation() Contains the document url describing the UI.
void	setRoot(C root) Set the 'root' ui component created by the handle method.
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.

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

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

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

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

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getRoot

C getRoot()

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

Returns:

the root component

setRoot

void setRoot(C root)

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

Parameters:

root, - the UI root

getComponentViewHandle

default <X extends ComponentView<C,A,M>> X getComponentViewHandle()

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

Parameters:

, - X extends an ComponentView

Returns:

ComponentHandle, the component handle.

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