org.quickstart.api.componentLayout

Interface PerspectiveLayout<M,B>

Type Parameters:

M - type of root component

B - type of target components

public interface PerspectiveLayout<M,B>

Defines layout of a perspective and the container for included editors and views (target components); for use in perspectives handle method.

Author:

Andy Moncsek

Method Summary

Modifier and Type	Method and Description
M	getRootComponent() Get the ' layoutwrapper' for perspective; a layout component is a component which can contain UI subcomponents.
java.util.Map<java.lang.String,B>	getTargetLayoutComponents() Returns map of target components and ids key - id value - target component.
void	registerRootComponent(M comp) Set Layout-Wrapper for perspective; this wrapper contains wrappers for editors and views, define a valid component which is valid to hold subcomponents.
void	registerTargetLayoutComponent(java.lang.String id, B target) Register a target component; a target component defines a wrapper where editors and views can "live" in; you can define a target for each editor or view component; create an root component, a complex layout an register all components where editors/views should displayed in.

Method Detail

registerRootComponent

void registerRootComponent(M comp)

Set Layout-Wrapper for perspective; this wrapper contains wrappers for editors and views, define a valid component which is valid to hold subcomponents.

Parameters:

comp - the new root component

getRootComponent

M getRootComponent()

Get the ' layoutwrapper' for perspective; a layout component is a component which can contain UI subcomponents.

Returns:

the toolkit root component where all other UI components are included

getTargetLayoutComponents

java.util.Map<java.lang.String,B> getTargetLayoutComponents()

Returns map of target components and ids key - id value - target component.

Returns:

a map with all target UI components

registerTargetLayoutComponent

void registerTargetLayoutComponent(java.lang.String id,
                                   B target)

Register a target component; a target component defines a wrapper where editors and views can "live" in; you can define a target for each editor or view component; create an root component, a complex layout an register all components where editors/views should displayed in.

Parameters:

id - the id

target - the target