com.javadocking.dockable
Interface CompositeDockable

All Superinterfaces:

Dockable

All Known Implementing Classes:

DefaultCompositeDockable

public interface CompositeDockable
extends Dockable

A dockable that is composed of multiple, different dockables. It is possible to select one of the dockables.

Author:

Heidi Rakels.

Method Summary

Dockable	getDockable(int index) Gets the child dockable with the specified index.
int	getDockableCount() Gets the number of child dockables of this composite dockable.
Dockable	getSelectedDockable() Gets the selected dockable.

Methods inherited from interface com.javadocking.dockable.Dockable

addDockingListener, addPropertyChangeListener, fireDockingChanged, fireDockingWillChange, getActions, getContent, getDescription, getDock, getDockingModes, getIcon, getID, getLastDockingMode, getPossibleStates, getState, getTitle, getVisualizer, isWithHeader, removeDockingListener, removePropertyChangeListener, setDock, setLastDockingMode, setState

Method Detail

getDockableCount

int getDockableCount()

Gets the number of child dockables of this composite dockable.

Returns:

The number of child dockables of this composite dockable.

getDockable

Dockable getDockable(int index)
                     throws java.lang.IndexOutOfBoundsException

Gets the child dockable with the specified index.

Returns:

The child dockable with the specified index.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of range (index < 0 || index >= getDockableCount()).

getSelectedDockable

Dockable getSelectedDockable()

Gets the selected dockable. This dockable should be one of the child dockables. If no dockable is selected, null is returned.

Returns:

The selected dockable. Null if no dockable is selected.