JacpContext (jacpfx.API 2.0 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`L`	`getEventHandler(M message)` Returns an event handler that handles messages to caller component
`L`	`getEventHandler(String targetId, M message)` Returns an event handler that handles messages to target component
`String`	`getId()` Returns the id of the component.
`String`	`getName()` Returns the name of a component.
`String`	`getParentId()` Returns the ID of parent component/perspective.
`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(String targetId, M message)` Send a message to defined targetId.
`void`	`setActive(boolean active)` Set default active state of component.
`void`	`setExecutionTarget(String id)` Defines the perspective in which the component should executed in.
`void`	`setReturnTarget(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(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(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(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
```
String getId()
```
    Returns the id of the component.
    
    Returns:
    
    the component id
  - getParentId
```
String getParentId()
```
    Returns the ID of parent component/perspective.
    
    Returns:
    
    a component id
  - getName
```
String getName()
```
    Returns the name of a component.
    
    Returns:
    
    the component name
  - getResourceBundle
```
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(String componentTargetId)
              throws 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:
    
    IllegalStateException
  - setExecutionTarget
```
void setExecutionTarget(String id)
                 throws 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:
    
    IllegalStateException
  - setTargetLayout
```
void setTargetLayout(String targetLayout)
              throws 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:
    
    IllegalStateException

Interface JacpContext<L,M>

Method Summary

Method Detail

send

send

getEventHandler

getEventHandler

getId

getParentId

getName

getResourceBundle

isActive

setActive

setReturnTarget

setExecutionTarget

setTargetLayout