bibliothek.gui.dock.layout
Class AbstractDockableProperty

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

All Implemented Interfaces:

DockableProperty

Direct Known Subclasses:

FlapDockProperty, ScreenDockProperty, SplitDockFullScreenProperty, SplitDockPathProperty, SplitDockPlaceholderProperty, SplitDockProperty, StackDockProperty

public abstract class AbstractDockableProperty
extends Object
implements DockableProperty

A simple implementation of DockableProperty which provides only the basic features.

Author:

Benjamin Sigg

Constructor Summary

AbstractDockableProperty()

Method Summary

protected void	copy(AbstractDockableProperty copy) Copies the fields of this property to copy.
boolean	equals(Object obj)
boolean	equalsNoSuccessor(DockableProperty property) Tells whether this describes the same position as property, not checking the successor.
DockableProperty	getSuccessor() Gets the property which should be used for the child of this dockable DockStation.
int	hashCode()
void	setSuccessor(DockableProperty properties) Sets the property which will be used if this property was used and there is not yet a leaf in the tree of DockStations and Dockables reached. For example: there is a DockStation root, a dockable DockStation node which is a child of root and a Dockable leaf which is a child of node. A DockableProperty called one would describe the relationship between root and node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.dock.layout.DockableProperty

copy, getFactoryID, load, load, store, store

Constructor Detail

AbstractDockableProperty

public AbstractDockableProperty()

Method Detail

getSuccessor

public DockableProperty getSuccessor()

Description copied from interface: DockableProperty

Gets the property which should be used for the child of this dockable DockStation.

Specified by:

getSuccessor in interface DockableProperty

Returns:

the property for the child, or null

See Also:

DockableProperty.setSuccessor(DockableProperty)

setSuccessor

public void setSuccessor(DockableProperty properties)

Description copied from interface: DockableProperty

Sets the property which will be used if this property was used and there is not yet a leaf in the tree of DockStations and Dockables reached.
For example: there is a DockStation root, a dockable DockStation node which is a child of root and a Dockable leaf which is a child of node.
A DockableProperty called one would describe the relationship between root and node. Another DockableProperty called two would describe the relationship between node and leaf. In this case, the successor of one would be two.

Specified by:

setSuccessor in interface DockableProperty

Parameters:

properties - the location of a child

copy

protected void copy(AbstractDockableProperty copy)

Copies the fields of this property to copy.

Parameters:

copy - the copy of this

equalsNoSuccessor

public boolean equalsNoSuccessor(DockableProperty property)

Description copied from interface: DockableProperty

Tells whether this describes the same position as property, not checking the successor.

Specified by:

equalsNoSuccessor in interface DockableProperty

Parameters:

property - the property to check

Returns:

true if this is the same as property

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object