pub.vlsolutions.swing.docking

Interface DockableContainer

All Known Subinterfaces:

SingleDockableContainer, TabbedDockableContainer

All Known Implementing Classes:

AutoHideExpandPanel, DetachedDockView, DockTabbedPane, DockView, DockViewAsTab, MaximizedDockView, MaximizedDockViewAsTab, TabbedDockView

public interface DockableContainer

A DockableContainer is the base interface of GUI components used to display Dockable components.

The components are usually displayed with decorations (a title bar, docking state management buttons, a drop shadow, ...)

This interface is meant for API extenders that would like to create new kind of containers (via the sub-interfaces SingleDockableContainer and TabbedDockableContainer and the DockableContainerFactory).

Usually, a DockableContainer also contains (or implements) one ore more DockableDragSources in order to achieve drag and drop operations.

Version:

1.0

Author:

Lilian Chamontin, vlsolutions.

See Also:

DockableDragSource, DockableContainerFactory

Method Summary

Methods

Modifier and Type	Method and Description
void	installDocking(DockingDesktop desktop) Invoked once after creation, in order to let this component register its DockableDragSources to the DockingDesktop, and have a reference of this Desktop.
void	uninstallDocking(DockingDesktop desktop) Called once, when the dockablecontainer is no longer used by the desktop, in order to releases resources and listeners taken on installDocking().

Method Detail

installDocking

void installDocking(DockingDesktop desktop)

Invoked once after creation, in order to let this component register its DockableDragSources to the DockingDesktop, and have a reference of this Desktop.

basic implementation use a single DragSource, and thus calls desk.installDockableDragSource(dragSource).

uninstallDocking

void uninstallDocking(DockingDesktop desktop)

Called once, when the dockablecontainer is no longer used by the desktop, in order to releases resources and listeners taken on installDocking().