net.sf.doolin.gui.docking
Class DockDescription

java.lang.Object
  net.sf.doolin.gui.docking.DockDescription

All Implemented Interfaces:

Serializable

public class DockDescription
extends Object
implements Serializable

Description for the docked views in a window. It can stored and restored.

Author:

Damien Coraboeuf

See Also:

Serialized Form

Constructor Summary

DockDescription(String className, boolean leaf, String position, Dimension size)
Constructor.

Method Summary

void	add(DockDescription description) Adds a child to this dock
String	getClassName() Gets the class of the dock
List<DockDescription>	getDescriptions() Gets the list of children dock descriptions.
String	getPosition() Gets the position of this dock
Dimension	getSize() Gets the size of this dock
List<String>	getViewIds() Gets the list of view IDs that the window contains.
boolean	isLeaf() Checks if this dock is a leaf
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DockDescription

public DockDescription(String className,
                       boolean leaf,
                       String position,
                       Dimension size)

Constructor.

Parameters:

className - Class of the dock

leaf - true if this dock is a leaf

position - Position of the dock relatively to its parent

size - Size of this dock

Method Detail

add

public void add(DockDescription description)

Adds a child to this dock

Parameters:

description - Child dock description

getClassName

public String getClassName()

Gets the class of the dock

Returns:

Class

getDescriptions

public List<DockDescription> getDescriptions()

Gets the list of children dock descriptions.

Returns:

List of children dock descriptions.

getPosition

public String getPosition()

Gets the position of this dock

Returns:

Position

getSize

public Dimension getSize()

Gets the size of this dock

Returns:

Size

getViewIds

public List<String> getViewIds()

Gets the list of view IDs that the window contains.

Returns:

List of view IDs

isLeaf

public boolean isLeaf()

Checks if this dock is a leaf

Returns:

true if this dock is a leaf

toString

public String toString()

Overrides:

toString in class Object