org.jacpfx.api.context

Interface JacpContext<L,M>

Type Parameters:

L - defines the listener type

M - defines the basic message type

public interface JacpContext<L,M>

Created with IntelliJ IDEA. User: Andy Moncsek Date: 27.06.13 Time: 21:12 The JacpContext interface gives access to component basic meta data as well as listeners and other services.

Method Summary

Modifier and Type	Method and Description
L	getEventHandler(M message) Returns an event handler that handles messages to caller component
L	getEventHandler(java.lang.String targetId, M message) Returns an event handler that handles messages to target component
java.lang.String	getFullyQualifiedId() Returns the fully qualified id like "parentId.componentId"
java.lang.String	getId() Returns the id of the 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.
boolean	isActive() Get the default active status of component.
void	send(M message) Send a message to caller component itself.
void	send(java.lang.String targetId, M 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	setReturnTarget(java.lang.String componentTargetId) 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.

Method Detail

send

void send(M message)

Send a message to caller component itself.

Parameters:

message, - The message object.

send

void send(java.lang.String targetId,
          M message)

Send a message to defined targetId.

Parameters:

targetId, - The target id for the message.

message, - The message object.

getEventHandler

L getEventHandler(M message)

Returns an event handler that handles messages to caller component

Parameters:

message, - The message object.

Returns:

an JavaFX event handler.

getEventHandler

L getEventHandler(java.lang.String targetId,
                  M message)

Returns an event handler that handles messages to target component

Parameters:

message - ; the message to send to target.

targetId - ; the targets component id.

Returns:

an JavaFX event handler.

getId

java.lang.String getId()

Returns the id of the component.

Returns:

the component id

getParentId

java.lang.String getParentId()

Returns the ID of parent component/perspective.

Returns:

a component id

getFullyQualifiedId

java.lang.String getFullyQualifiedId()

Returns the fully qualified id like "parentId.componentId"

Returns:

The qualified Id

getName

java.lang.String getName()

Returns the name of a component.

Returns:

the component name

getResourceBundle

java.util.ResourceBundle getResourceBundle()

Returns the component resource bundle.

Returns:

the defined resource bundle

isActive

boolean isActive()

Get the default active status of component.

Returns:

the active state of component

setActive

void setActive(boolean active)

Set default active state of component.

Parameters:

active - ; the component active state.

setReturnTarget

void setReturnTarget(java.lang.String componentTargetId)
              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.

Parameters:

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

Throws:

java.lang.IllegalStateException

setExecutionTarget

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

Defines the perspective in which the component should executed in.

Parameters:

id, - the id of the parent perspective where the component should be executed in.

Throws:

java.lang.IllegalStateException

setTargetLayout

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.

Parameters:

targetLayout, - a target layout label.

Throws:

java.lang.IllegalStateException