com.vlsolutions.swing.docking

Class CompoundDockable

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

Constructor Summary

CompoundDockable(DockKey key)
Constructs a new CompoundDockable with a given key

Method Summary

Component
getComponent()
Returns the component used by this dockable.
DockKey
getDockKey()
Returns the key used to describe this dockable

Constructor Details

CompoundDockable

public CompoundDockable(DockKey key)
Constructs a new CompoundDockable with a given key

Method Details

getComponent

public final Component getComponent()
Returns the component used by this dockable.

Implementation note : this method always returns a CompoundDockingPanel.

Specified by:
getComponent in interface Dockable

getDockKey

public DockKey getDockKey()
Returns the key used to describe this dockable
Specified by:
getDockKey in interface Dockable

© Copyright 2004-2006 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications