bibliothek.gui.dock.common.location

Class TreeLocationRoot

java.lang.Object

bibliothek.gui.dock.common.CLocation

bibliothek.gui.dock.common.location.AbstractStackholdingLocation

bibliothek.gui.dock.common.location.AbstractTreeLocation

bibliothek.gui.dock.common.location.TreeLocationRoot

public class TreeLocationRoot
extends AbstractTreeLocation

The root of a path of turns, leading to the location of an element, beginning at the "normalized-area".

Author:

Benjamin Sigg

Property Summary

Type	Property and Description
protected SplitDockPathProperty	findParent Asks the parent, or in the case of the root creates, the DockableProperty describing the this location.

Properties inherited from class bibliothek.gui.dock.common.CLocation

findProperty

Constructor Summary

Constructors

Constructor and Description
TreeLocationRoot(CSplitLocation root, double size, Side side, long nodeId) Creates a new location.

Method Summary

Modifier and Type	Method and Description
protected SplitDockPathProperty	findParentProperty() Asks the parent, or in the case of the root creates, the DockableProperty describing the this location.
String	findRoot() Gets the name of the station this location belongs to.
CSplitLocation	getParent() Gets the parent location of this location.
String	toString()

Methods inherited from class bibliothek.gui.dock.common.location.AbstractTreeLocation

aside, east, east, findMode, findProperty, getNodeId, getSide, getSize, leaf, north, north, south, south, west, west

Methods inherited from class bibliothek.gui.dock.common.location.AbstractStackholdingLocation

stack, stack

Methods inherited from class bibliothek.gui.dock.common.CLocation

base, base, equals, expandProperty, expandProperty, external, findProperty, hashCode, maximized, maximized, maximized, maximized, minimized, minimized, normalized, working

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Property Detail

findParent

protected SplitDockPathProperty findParentProperty

Specified by:

findParentProperty in class AbstractTreeLocation

Constructor Detail

TreeLocationRoot

public TreeLocationRoot(CSplitLocation root,
                        double size,
                        Side side,
                        long nodeId)

Creates a new location.

Parameters:

root - the location that knows to which SplitDockStation this location belongs

size - the relative size of this location

side - the side which is occupied by this location

nodeId - the unique identifier of the new node, can be -1

See Also:

AbstractTreeLocation.AbstractTreeLocation(double, Side, long)

Method Detail

getParent

public CSplitLocation getParent()

Description copied from class: CLocation

Gets the parent location of this location. Some root-locations may never have a parent.

Specified by:

getParent in class CLocation

Returns:

the parent location, can be null

findRoot

public String findRoot()

Description copied from class: CLocation

Gets the name of the station this location belongs to. This can be the id of any CStation.

Specified by:

findRoot in class CLocation

Returns:

the name of the station or null if this location does not have enough information to find the root

findParentProperty

protected SplitDockPathProperty findParentProperty()

Description copied from class: AbstractTreeLocation

Asks the parent, or in the case of the root creates, the DockableProperty describing the this location.

Specified by:

findParentProperty in class AbstractTreeLocation

toString

public String toString()

Overrides:

toString in class AbstractTreeLocation