pub.vlsolutions.swing.docking

Class CompoundDockable

java.lang.Object

pub.vlsolutions.swing.docking.CompoundDockable

All Implemented Interfaces:

Dockable

public class CompoundDockable
extends java.lang.Object
implements Dockable

Describes a Dockable that can contain sub-dockables.

This class allows dockable nesting, with full support for workspace save and restore.

Currently this class is associated to a CompoundDockingPanel component : you insert dockables into it with an initial addDockable(CompoundDockable) invocation from DockingDesktop, and further dockables with split/createTab calls.

Example :

   DockingDesktop desk = ...
   desk.addDockable(dockable1);
   desk.split(dockable1, dockable2, DockingConstants.SPLIT_RIGHT);
   // now let's add a compound dockable
   CompoundDockable compound = new CompoundDockable(new DockKey("Compound!"));
   desk.split(dockable1, compound);
   // and add a tab into it
   desk.addDockable(compound, dockable3); // initial nesting : new API call
   desk.createTab(dockable3, dockable4, 1); // a tab, using standard API
 

CompoundDockables are displayed as SingleDockableContainers (with a title bar). Don't forget to properly initialize the DockKey of this dockable to have it well presented on screen (name, tooltip, icon).

Since:

2.1

Author:

Lilian Chamontin, VLSolutions

Constructor Summary

Constructors

Constructor and Description
CompoundDockable(DockKey key) Constructs a new CompoundDockable with a given key

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Component	getComponent() Returns the component used by this dockable.
DockKey	getDockKey() Returns the key used to describe this dockable

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundDockable

public CompoundDockable(DockKey key)

Constructs a new CompoundDockable with a given key

Method Detail

getDockKey

public DockKey getDockKey()

Returns the key used to describe this dockable

Specified by:

getDockKey in interface Dockable

getComponent

public final java.awt.Component getComponent()

Returns the component used by this dockable.

Implementation note : this method always returns a CompoundDockingPanel.

Specified by:

getComponent in interface Dockable