pub.vlsolutions.swing.docking

Class DockableContainerFactory

java.lang.Object

pub.vlsolutions.swing.docking.DockableContainerFactory

Direct Known Subclasses:

DefaultDockableContainerFactory

public abstract class DockableContainerFactory
extends java.lang.Object

An abstract factory used by the DockingDesktop to create instance of Dockable containers.

This factory enables API Extenders to change part of the behaviour on the DockingDesktop (mostly about look and feel issues) without modifying the code of that central class.

Version:

1.1

Author:

Lilian Chamontin, vlsolutions.

See Also:

DockableContainer, : the default implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockableContainerFactory.ParentType

Constructor Summary

Constructors

Constructor and Description
DockableContainerFactory()

Method Summary

Methods

Modifier and Type	Method and Description
SingleDockableContainer	createDockableContainer(Dockable dockable, boolean c) Deprecated. use the other createDockableContainer method (#createDockableContainer(Dockable, int)
abstract SingleDockableContainer	createDockableContainer(Dockable dockable, DockableContainerFactory.ParentType parentType) This method is called by the DockingDesktop whenever a dockable is inserted in its containment hierachy.
abstract FloatingDockableContainer	createFloatingDockableContainer(java.awt.Window owner) This method is called when a dockable is detached from the DockingDesktop and put in the FLOATING state.
abstract TabbedDockableContainer	createTabbedDockableContainer() This method is called when a tab insertion is requested by the DockingDesktop.
abstract DockViewTitleBar	createTitleBar() This method is invoked when a dockable container needs to install a title bar.
static DockableContainerFactory	getFactory() Returns the current factory.
static void	setFactory(DockableContainerFactory f) Changes the factory to be used by DockingDesktop.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockableContainerFactory

public DockableContainerFactory()

Method Detail

createDockableContainer

public abstract SingleDockableContainer createDockableContainer(Dockable dockable,
                                              DockableContainerFactory.ParentType parentType)

This method is called by the DockingDesktop whenever a dockable is inserted in its containment hierachy.

createDockableContainer

public SingleDockableContainer createDockableContainer(Dockable dockable,
                                              boolean c)

Deprecated. use the other createDockableContainer method (#createDockableContainer(Dockable, int)

createTabbedDockableContainer

public abstract TabbedDockableContainer createTabbedDockableContainer()

This method is called when a tab insertion is requested by the DockingDesktop.

createFloatingDockableContainer

public abstract FloatingDockableContainer createFloatingDockableContainer(java.awt.Window owner)

This method is called when a dockable is detached from the DockingDesktop and put in the FLOATING state.

The floating container must be an instanceof Dialog or Window.

createTitleBar

public abstract DockViewTitleBar createTitleBar()

This method is invoked when a dockable container needs to install a title bar.

This method is used by the standard implementation of Docking (DockView, etc) but is optional for other implementations, as currently the titlebar isn't specified as a core component of the docking framework (i.e. it is not an interface).

Since:

2.1.3

getFactory

public static DockableContainerFactory getFactory()

Returns the current factory.

it no factory has been provided, it will fall back on DefaultDockableContainerFactory

setFactory

public static void setFactory(DockableContainerFactory f)

Changes the factory to be used by DockingDesktop.

Note that this change is not propagated to already docked components.