com.javadocking.dock.factory
Class ToolBarDockFactory

java.lang.Object
  com.javadocking.dock.factory.ToolBarDockFactory

All Implemented Interfaces:

DockFactory

public class ToolBarDockFactory
extends java.lang.Object
implements DockFactory

This dock factory creates always a line dock with the docking modes:

• DockingMode.HORIZONTAL_TOOLBAR and DockingMode.VERTICAL_TOOLBAR, or
• DockingMode.HORIZONTAL_MINIMIZE and DockingMode.VERTICAL_MINIMIZE.

Author:

Heidi Rakels

Constructor Summary

ToolBarDockFactory()

Method Summary

Dock	createDock(Dockable dockable, int dockingMode) Creates a tool bar dock.
java.awt.Dimension	getDockPreferredSize(Dockable dockable, int dockingMode) Gets the preferred size for the dock that will be created by this factory.
void	loadProperties(java.lang.String prefix, java.util.Properties properties) Sets the properties for this dock factory.
void	saveProperties(java.lang.String prefix, java.util.Properties properties) Saves the properties of this dock factory in the given properties object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolBarDockFactory

public ToolBarDockFactory()

Method Detail

createDock

public Dock createDock(Dockable dockable,
                       int dockingMode)

Creates a tool bar dock.

Specified by:

createDock in interface DockFactory

Parameters:

dockingMode - The docking mode should be

• DockingMode.HORIZONTAL_TOOLBAR,
• DockingMode.VERTICAL_TOOLBAR,
• DockingMode.HORIZONTAL_MINIMIZE, or
• DockingMode.VERTICAL_MINIMIZE.

Otherwise null is returned.

dockable - The dockable for which the dock is created.

Returns:

A dock for the given dockable.

getDockPreferredSize

public java.awt.Dimension getDockPreferredSize(Dockable dockable,
                                               int dockingMode)

Description copied from interface: DockFactory

Gets the preferred size for the dock that will be created by this factory.

Specified by:

getDockPreferredSize in interface DockFactory

Parameters:

dockable - The dockable for which the dock is created.

dockingMode - The docking mode that is used for docking the dockable. This integer should be a constant defined by DockingMode.

Returns:

A dock for the given dockable.

saveProperties

public void saveProperties(java.lang.String prefix,
                           java.util.Properties properties)

Description copied from interface: DockFactory

Saves the properties of this dock factory in the given properties object. The property names for this dock factory should start with the given prefix.

Specified by:

saveProperties in interface DockFactory

Parameters:

prefix - The prefix for the property names.

properties - The properties object to which the properties should be added.

loadProperties

public void loadProperties(java.lang.String prefix,
                           java.util.Properties properties)

Description copied from interface: DockFactory

Sets the properties for this dock factory. The properties can be found in the given properties object and the property names for this dock factory start with the given prefix.

Specified by:

loadProperties in interface DockFactory

Parameters:

prefix - The prefix of the names of the properties that have been intended for this dock factory.

properties - The properties object that contains the properties for this dock factory. It can contain also properties for other objects, but they will have another prefix.