bibliothek.gui.dock.layout
Class DockLayoutComposition

java.lang.Object
  bibliothek.gui.dock.layout.DockLayoutComposition

public class DockLayoutComposition
extends java.lang.Object

A DockLayoutComposition describes all relations and positions of a set of DockElements. The DockLayoutComposition does not have any references to DockElements, but with the help of a DockSituation new trees of DockElements can be created.

Author:

Benjamin Sigg

Constructor Summary

DockLayoutComposition(DockLayoutInfo layout, java.util.List<DockLayout<?>> adjacent, java.util.List<DockLayoutComposition> children, boolean ignoreChildren)
Creates a new composition.

Method Summary

java.util.List<DockLayout<?>>	getAdjacent() Gets the additional information about the element.
DockLayout<?>	getAdjacent(java.lang.String factoryId) Searches for the DockLayout whose factory is set to factoryId.
java.util.List<DockLayoutComposition>	getChildren() Gets the list of all known children of this composition.
DockLayoutInfo	getLayout() Gets the layout which describes the element of this composition.
boolean	isIgnoreChildren() Tells that the children of this composition were ignored.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockLayoutComposition

public DockLayoutComposition(DockLayoutInfo layout,
                             java.util.List<DockLayout<?>> adjacent,
                             java.util.List<DockLayoutComposition> children,
                             boolean ignoreChildren)

Creates a new composition.

Parameters:

layout - the content of the element that is represented by this composition, can be null

adjacent - additional information about the element, can be null

children - the children of the station represented by this composition

ignoreChildren - whether the children should be ignored or not

Method Detail

getLayout

public DockLayoutInfo getLayout()

Gets the layout which describes the element of this composition.

Returns:

the layout, can be null to indicate that this composition was not loaded properly

getAdjacent

public java.util.List<DockLayout<?>> getAdjacent()

Gets the additional information about the element.

Returns:

the additional information or null

getAdjacent

public DockLayout<?> getAdjacent(java.lang.String factoryId)

Searches for the DockLayout whose factory is set to factoryId.

Parameters:

factoryId - the name of some AdjacentDockFactory.

Returns:

the matching layout or null if not found

getChildren

public java.util.List<DockLayoutComposition> getChildren()

Gets the list of all known children of this composition.

Returns:

the list of children

isIgnoreChildren

public boolean isIgnoreChildren()

Tells that the children of this composition were ignored.

Returns:

true if the children are to be ignored