org.jacpfx.rcp.context

Class JacpContextImpl

java.lang.Object

org.jacpfx.rcp.context.JacpContextImpl

All Implemented Interfaces:

org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>, Context, InternalContext

public class JacpContextImpl
extends java.lang.Object
implements Context, InternalContext

Created with IntelliJ IDEA. User: Andy Moncsek Date: 24.06.13 Time: 21:36 JACP context object provides functionality to component context and basic features.

Constructor Summary

Constructors

Constructor and Description
JacpContextImpl(java.lang.String id, java.lang.String name, java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> globalMessageQueue)
JacpContextImpl(java.lang.String parentId, java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> globalMessageQueue)
JacpContextImpl(java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> globalMessageQueue)

Method Summary

Modifier and Type	Method and Description
AsyncHandler<?>	asyncHandler() The async handler allows to supply consumers, suppliers and function on worker thread and on FX thread
boolean	equals(java.lang.Object o)
FXComponentLayout	getComponentLayout() Retruns the component layout
javafx.event.EventHandler<javafx.event.Event>	getEventHandler(java.lang.Object message) Returns an event handler that handles messages to caller component
javafx.event.EventHandler<javafx.event.Event>	getEventHandler(java.lang.String targetId, java.lang.Object message) Returns an event handler that handles messages to target component
java.lang.String	getExecutionTarget() Returns the perspective in which the component should executed in.
java.lang.String	getFullyQualifiedId() Returns the fully qualified id like "parentId.componentId"
java.lang.String	getId() Returns the id of the component.
<T> ManagedFragmentHandler<T>	getManagedFragmentHandler(java.lang.Class<T> clazz) Returns a managed fragment handler, which contains part of an UI and can fully interact with CDI and it's parent component.
java.lang.String	getName() Returns the name of a component.
java.lang.String	getParentId() Returns the ID of parent component/perspective.
java.util.ResourceBundle	getResourceBundle() Returns the component resource bundle.
java.lang.String	getReturnTargetAndClear() Returns component id which is targeted by callback component return value; the return value will be handled like an average message and will be delivered to targeted component.
java.lang.String	getTargetLayout() Returns the target layout in parent perspective
int	hashCode()
void	hideModalDialog() hides the current modal dialog
boolean	isActive() Get the default active status of component.
void	send(java.lang.Object message) Send a message to caller component itself.
void	send(java.lang.String targetId, java.lang.Object message) Send a message to defined targetId.
void	setActive(boolean active) Set default active state of component.
void	setExecutionTarget(java.lang.String id) Defines the perspective in which the component should executed in.
void	setFXComponentLayout(FXComponentLayout layout) Set the FXComponentLayout
void	setId(java.lang.String id) Set the component id
void	setName(java.lang.String name) Set the components name
void	setParentId(java.lang.String parentId) Set the parent id
void	setResourceBundle(java.util.ResourceBundle resourceBundle) Set the resource bundle
void	setReturnTarget(java.lang.String returnTargetId) Set component targetId which is the target of a background component return value; the return value will be handled like an average message and will be delivered to targeted component.
void	setTargetLayout(java.lang.String targetLayout) Defines the target layoutId, where the UI component should appear in,the layout is registered in perspective and is a placeholder for the component.
void	showModalDialog(javafx.scene.Node node) shows the passed Node as modal dialog
void	updateActiveState(boolean active) Set default active state of component.
void	updateExecutionTarget(java.lang.String id) Defines the perspective in which the component should executed in.
void	updateReturnTarget(java.lang.String returnTargetId) Set component targetId which is the target of a background component return value; the return value will be handled like an average message and will be delivered to targeted component.

Methods inherited from class java.lang.Object

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

Constructor Detail

JacpContextImpl

public JacpContextImpl(java.lang.String id,
                       java.lang.String name,
                       java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> globalMessageQueue)

JacpContextImpl

public JacpContextImpl(java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> globalMessageQueue)

JacpContextImpl

public JacpContextImpl(java.lang.String parentId,
                       java.util.concurrent.TransferQueue<org.jacpfx.api.message.Message<javafx.event.Event,java.lang.Object>> globalMessageQueue)

Method Detail

getEventHandler

public final javafx.event.EventHandler<javafx.event.Event> getEventHandler(java.lang.Object message)

Returns an event handler that handles messages to caller component

Specified by:

getEventHandler in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

an JavaFX event handler.

getEventHandler

public final javafx.event.EventHandler<javafx.event.Event> getEventHandler(java.lang.String targetId,
                                                                           java.lang.Object message)

Returns an event handler that handles messages to target component

Specified by:

getEventHandler in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Parameters:

targetId - ; the targets component id.

message - ; the message to send to target.

Returns:

an JavaFX event handler.

send

public final void send(java.lang.String targetId,
                       java.lang.Object message)

Send a message to defined targetId.

Specified by:

send in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

send

public final void send(java.lang.Object message)

Send a message to caller component itself.

Specified by:

send in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

getId

public final java.lang.String getId()

Returns the id of the component.

Specified by:

getId in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the component id

getFullyQualifiedId

public final java.lang.String getFullyQualifiedId()

Returns the fully qualified id like "parentId.componentId"

Specified by:

getFullyQualifiedId in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

The qualified Id

setId

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

Set the component id

Specified by:

setId in interface InternalContext

getParentId

public java.lang.String getParentId()

Returns the ID of parent component/perspective.

Specified by:

getParentId in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

a component id

setParentId

public final void setParentId(java.lang.String parentId)

Set the parent id

Specified by:

setParentId in interface InternalContext

getName

public java.lang.String getName()

Returns the name of a component.

Specified by:

getName in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the component name

setName

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

Set the components name

Specified by:

setName in interface InternalContext

getResourceBundle

public final java.util.ResourceBundle getResourceBundle()

Returns the component resource bundle.

Specified by:

getResourceBundle in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the defined resource bundle

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle resourceBundle)

Set the resource bundle

Specified by:

setResourceBundle in interface InternalContext

isActive

public boolean isActive()

Get the default active status of component.

Specified by:

isActive in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Returns:

the active state of component

setActive

public void setActive(boolean active)

Set default active state of component.

Specified by:

setActive in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Parameters:

active - ; the component active state.

updateActiveState

public void updateActiveState(boolean active)

Set default active state of component.

Specified by:

updateActiveState in interface InternalContext

Parameters:

active - ; the component active state.

getManagedFragmentHandler

public <T> ManagedFragmentHandler<T> getManagedFragmentHandler(java.lang.Class<T> clazz)

Returns a managed fragment handler, which contains part of an UI and can fully interact with CDI and it's parent component.

Specified by:

getManagedFragmentHandler in interface Context

Type Parameters:

T - the type of the managed fragment

Parameters:

clazz - the class of the requested managed fragment

Returns:

a managedFragmentHandler which gives access to the fragments controller and UI node

showModalDialog

public void showModalDialog(javafx.scene.Node node)

shows the passed Node as modal dialog

Specified by:

showModalDialog in interface Context

Parameters:

node - the Node to show in dialog

hideModalDialog

public void hideModalDialog()

hides the current modal dialog

Specified by:

hideModalDialog in interface Context

getComponentLayout

public FXComponentLayout getComponentLayout()

Retruns the component layout

Specified by:

getComponentLayout in interface Context

Returns:

The ComponentLayout handler

setFXComponentLayout

public void setFXComponentLayout(FXComponentLayout layout)

Set the FXComponentLayout

Specified by:

setFXComponentLayout in interface InternalContext

getReturnTargetAndClear

public final java.lang.String getReturnTargetAndClear()

Returns component id which is targeted by callback component return value; the return value will be handled like an average message and will be delivered to targeted component.

Specified by:

getReturnTargetAndClear in interface InternalContext

Returns:

the target id

setReturnTarget

public final void setReturnTarget(java.lang.String returnTargetId)
                           throws java.lang.IllegalStateException

Set component targetId which is the target of a background component return value; the return value will be handled like an average message and will be delivered to targeted component.

Specified by:

setReturnTarget in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Parameters:

returnTargetId - ; represents a component id to return the value to

Throws:

java.lang.IllegalStateException

updateReturnTarget

public final void updateReturnTarget(java.lang.String returnTargetId)
                              throws java.lang.IllegalStateException

Set component targetId which is the target of a background component return value; the return value will be handled like an average message and will be delivered to targeted component.

Specified by:

updateReturnTarget in interface InternalContext

Parameters:

returnTargetId - ; represents a component id to return the value to

Throws:

java.lang.IllegalStateException

getExecutionTarget

public java.lang.String getExecutionTarget()

Returns the perspective in which the component should executed in.

Specified by:

getExecutionTarget in interface InternalContext

Returns:

a perspectiveId

setExecutionTarget

public void setExecutionTarget(java.lang.String id)
                        throws java.lang.IllegalStateException

Defines the perspective in which the component should executed in.

Specified by:

setExecutionTarget in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Throws:

java.lang.IllegalStateException

updateExecutionTarget

public void updateExecutionTarget(java.lang.String id)
                           throws java.lang.IllegalStateException

Defines the perspective in which the component should executed in.

Specified by:

updateExecutionTarget in interface InternalContext

Throws:

java.lang.IllegalStateException

asyncHandler

public AsyncHandler<?> asyncHandler()

The async handler allows to supply consumers, suppliers and function on worker thread and on FX thread

Specified by:

asyncHandler in interface Context

Returns:

an @see {AsyncHandler} instance

getTargetLayout

public final java.lang.String getTargetLayout()

Returns the target layout in parent perspective

Specified by:

getTargetLayout in interface InternalContext

Returns:

a target layout id

setTargetLayout

public void setTargetLayout(java.lang.String targetLayout)
                     throws java.lang.IllegalStateException

Defines the target layoutId, where the UI component should appear in,the layout is registered in perspective and is a placeholder for the component.

Specified by:

setTargetLayout in interface org.jacpfx.api.context.JacpContext<javafx.event.EventHandler<javafx.event.Event>,java.lang.Object>

Throws:

java.lang.IllegalStateException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object