bibliothek.gui.dock.station.split

Class SplitDockStationLayout.Entry

java.lang.Object

bibliothek.gui.dock.station.split.SplitDockStationLayout.Entry

Direct Known Subclasses:

SplitDockStationLayout.Leaf, SplitDockStationLayout.Node

Enclosing class:

SplitDockStationLayout

public abstract static class SplitDockStationLayout.Entry
extends Object

An entry in a tree, either a node or a leaf.

Author:

Benjamin Sigg

Property Summary

Type	Property and Description
SplitDockPathProperty	createPath Creates a new path property which describes the location of this element.

Constructor Summary

Constructors

Constructor and Description
Entry(Path[] placeholders, PlaceholderMap placeholderMap, long id) Create a new entry

Method Summary

Modifier and Type	Method and Description
SplitDockStationLayout.Leaf	asLeaf() Returns this as leaf or null.
SplitDockStationLayout.Node	asNode() Returns this as node or null.
SplitDockPathProperty	createPathProperty() Creates a new path property which describes the location of this element.
long	getNodeId() Gets the unique id of this node.
SplitDockStationLayout.Node	getParent() Gets the parent of this entry, is null for the root entry.
PlaceholderMap	getPlaceholderMap() Gets the placeholder information of a potential child DockStation.
Path[]	getPlaceholders() Gets all the placeholders that are associated with this entry.
abstract boolean	isVisible() Whether this node or leaf is visible to the user.
protected void	setParent(SplitDockStationLayout.Node parent) Sets the parent of this entry.

Methods inherited from class java.lang.Object

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

Property Detail

createPath

public SplitDockPathProperty createPathProperty

Creates a new path property which describes the location of this element.

Constructor Detail

Entry

public Entry(Path[] placeholders,
             PlaceholderMap placeholderMap,
             long id)

Create a new entry

Parameters:

placeholders - the placeholders associated with this node or leaf

placeholderMap - placeholder information of a child DockStation

id - the unique id of this node or -1

Method Detail

setParent

protected void setParent(SplitDockStationLayout.Node parent)

Sets the parent of this entry.

Parameters:

parent - the parent

getParent

public SplitDockStationLayout.Node getParent()

Gets the parent of this entry, is null for the root entry.

Returns:

the parent.

getNodeId

public long getNodeId()

Gets the unique id of this node.

Returns:

the unique id or -1

asLeaf

public SplitDockStationLayout.Leaf asLeaf()

Returns this as leaf or null.

Returns:

this or null

asNode

public SplitDockStationLayout.Node asNode()

Returns this as node or null.

Returns:

this or null

isVisible

public abstract boolean isVisible()

Whether this node or leaf is visible to the user.

Returns:

true if this represents some graphical element or has a visible child

createPathProperty

public SplitDockPathProperty createPathProperty()

Creates a new path property which describes the location of this element.

getPlaceholders

public Path[] getPlaceholders()

Gets all the placeholders that are associated with this entry.

Returns:

the placeholders

getPlaceholderMap

public PlaceholderMap getPlaceholderMap()

Gets the placeholder information of a potential child DockStation.

Returns:

the placeholder map, can be null