org.jacpfx.rcp.context

Interface InternalContext

All Known Implementing Classes:

JacpContextImpl

public interface InternalContext

The internal context provides all setter methods on a context which is only for internal usage Created by Andy Moncsek on 17.12.14.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExecutionTarget() Returns the perspective in which the component should executed in.
java.lang.String	getReturnTargetAndClear() Returns the retrun target and clears the value
java.lang.String	getTargetLayout() Returns the target layout in parent perspective
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	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 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.

Method Detail

getExecutionTarget

java.lang.String getExecutionTarget()

Returns the perspective in which the component should executed in.

Returns:

a perspectiveId

getReturnTargetAndClear

java.lang.String getReturnTargetAndClear()

Returns the retrun target and clears the value

Returns:

an component id

setFXComponentLayout

void setFXComponentLayout(FXComponentLayout layout)

Set the FXComponentLayout

Parameters:

layout, - the fxcomponentLayout instance

setResourceBundle

void setResourceBundle(java.util.ResourceBundle resourceBundle)

Set the resource bundle

Parameters:

resourceBundle, - the resource bundle instance

setName

void setName(java.lang.String name)

Set the components name

Parameters:

name, - the component name

setParentId

void setParentId(java.lang.String parentId)

Set the parent id

Parameters:

parentId, - the parent id

setId

void setId(java.lang.String id)

Set the component id

Parameters:

id, - the component id

updateReturnTarget

void updateReturnTarget(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

updateActiveState

void updateActiveState(boolean active)

Set default active state of component.

Parameters:

active - ; the component active state.

updateExecutionTarget

void updateExecutionTarget(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

getTargetLayout

java.lang.String getTargetLayout()

Returns the target layout in parent perspective

Returns:

a target layout id