com.javadocking.dock.factory
Interface CompositeDockFactory

All Superinterfaces:
DockFactory
All Known Implementing Classes:
CompositeTabDockFactory, SplitDockFactory

public interface CompositeDockFactory
extends DockFactory

This dock factory creates composite docks. When a composite dock is created, this composite dock needs a child dock factory. This interface provides the methods to get and set the child dock factory for the created composite docks.

Author:
Heidi Rakels.

Method Summary
 DockFactory getChildDockFactory()
          Gets the child dock factory.
 void setChildDockFactory(DockFactory childDockFactory)
          Sets the child dock factory.
 
Methods inherited from interface com.javadocking.dock.factory.DockFactory
createDock, getDockPreferredSize, loadProperties, saveProperties
 

Method Detail

getChildDockFactory

DockFactory getChildDockFactory()
Gets the child dock factory. This is the factory that creates the child docks for the composite docks that this factory creates (CompositeDock.setChildDockFactory(DockFactory)).

Returns:
The child dock factory for the created composite docks.

setChildDockFactory

void setChildDockFactory(DockFactory childDockFactory)
Sets the child dock factory. This is the factory that creates the child docks for the composite docks that this factory creates (CompositeDock.setChildDockFactory(DockFactory)).

Parameters:
childDockFactory - The child dock factory for the created composite docks. Should not be null.
Throws:
java.lang.IllegalArgumentException - When the dock factory is null.