org.jacpfx.rcp.componentLayout

Class PerspectiveLayout

java.lang.Object

org.jacpfx.rcp.componentLayout.PerspectiveLayout

All Implemented Interfaces:

org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node>

Direct Known Subclasses:

FXMLPerspectiveLayout, FXPerspectiveLayout

public abstract class PerspectiveLayout
extends java.lang.Object
implements org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node>

The basic perspective layout to set the root and the child nodes of a perspective. Use registerChildNodes to define and register containers where subcomponents can be added.

Author:

Andy Moncsek

Constructor Summary

Constructors

Constructor and Description
PerspectiveLayout()
PerspectiveLayout(javafx.scene.Node rootComponent)

Method Summary

Modifier and Type	Method and Description
javafx.scene.Node	getRootComponent() Get the ' layoutwrapper' for perspective; a layout component is a component which can contain UI subcomponents.
java.util.Map<java.lang.String,javafx.scene.Node>	getTargetLayoutComponents() Returns map of target component and ids key - id value - target component.
void	registerTargetLayoutComponent(java.lang.String id, javafx.scene.Node 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 component where editors/views should displayed in.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jacpfx.api.componentLayout.PerspectiveLayoutInterface

registerRootComponent

Constructor Detail

PerspectiveLayout

public PerspectiveLayout()

PerspectiveLayout

public PerspectiveLayout(javafx.scene.Node rootComponent)

Method Detail

getRootComponent

public final javafx.scene.Node getRootComponent()

Description copied from interface: org.jacpfx.api.componentLayout.PerspectiveLayoutInterface

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

Specified by:

getRootComponent in interface org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node>

Returns:

the toolkit root component where all other UI component are included

getTargetLayoutComponents

public final java.util.Map<java.lang.String,javafx.scene.Node> getTargetLayoutComponents()

Description copied from interface: org.jacpfx.api.componentLayout.PerspectiveLayoutInterface

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

Specified by:

getTargetLayoutComponents in interface org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node>

Returns:

a map with all target UI component

registerTargetLayoutComponent

public final void registerTargetLayoutComponent(java.lang.String id,
                                                javafx.scene.Node target)

Description copied from interface: org.jacpfx.api.componentLayout.PerspectiveLayoutInterface

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 component where editors/views should displayed in.

Specified by:

registerTargetLayoutComponent in interface org.jacpfx.api.componentLayout.PerspectiveLayoutInterface<javafx.scene.Node,javafx.scene.Node>

Parameters:

id - the id

target - the target