com.javadocking.visualizer
Class DockingMinimizer

java.lang.Object
  com.javadocking.visualizer.DockingMinimizer

All Implemented Interfaces:

Visualizer

public class DockingMinimizer
extends java.lang.Object
implements Visualizer

This visualizer shows minimized dockables in components that can be docked and moved around by themself.

Information on using docking minimizers is in How to Use Visualizers (Minimizers and Maximizers) in The Sanaware Developer Guide.

For the dockable that is minimized, a header is created with the method SwComponentFactory.createMinimizeHeader(Dockable, int) of the component factory of the docking manager DockingManager.getComponentFactory().

A dockable is created around this header. This small dockable is docked in the model by a Docker.

Author:

Heidi Rakels.

Constructor Summary

DockingMinimizer(Docker docker)
Constructs a visualizer that shows minimized dockables in components that can be docked and moved around by themselves.

Method Summary

boolean	canVisualizeDockable(Dockable dockableToVisualize) Determines if a dockable can be visualized by this visualizer.
protected java.lang.String	createMinimizedHeaderDockableID(Dockable dockable) Creates the ID for the dockable around the header component of a minimized dockable.
Docker	getDocker() Gets the object that docks the dockables around the minimized headers in docks.
int	getState() Determines the state of the dockables that are visualized by this visualizer.
Dockable	getVisualizedDockable(int index) Gets the visualized dockable with the specified index.
int	getVisualizedDockableCount() Gets the number of visualized dockables of this visualizer.
void	loadProperties(java.lang.String prefix, java.util.Properties properties, java.util.Map dockablesMap, java.awt.Window owner) Loads the properties for this visualizer.
void	removeVisualizedDockable(Dockable dockableToRemove) Removes the visualized dockables from this visualizer.
void	saveProperties(java.lang.String prefix, java.util.Properties properties) Saves the properties of this visualizer in the given properties object.
void	setDocker(Docker docker) Sets the object that docks the dockables around the minimized headers in docks.
void	visualizeDockable(Dockable dockableToVisualize) Adds a dockable to this visualizer.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockingMinimizer

public DockingMinimizer(Docker docker)

Constructs a visualizer that shows minimized dockables in components that can be docked and moved around by themselves.

Parameters:

docker - The object that docks the dockables around the minimized headers.

Method Detail

getState

public int getState()

Description copied from interface: Visualizer

Determines the state of the dockables that are visualized by this visualizer.

Specified by:

getState in interface Visualizer

Returns:

The state of the dockables that are visualized by this visualizer. The special state is a constant defined by DockableState, but not DockableState.NORMAL or DockableState.CLOSED.

canVisualizeDockable

public boolean canVisualizeDockable(Dockable dockableToVisualize)

Description copied from interface: Visualizer

Determines if a dockable can be visualized by this visualizer.

Specified by:

canVisualizeDockable in interface Visualizer

Parameters:

dockableToVisualize - The dockable whose content has to be visualized. May not be nul.

Returns:

True if the dockable can be visualized, lse otherwise.

visualizeDockable

public void visualizeDockable(Dockable dockableToVisualize)

Description copied from interface: Visualizer

Adds a dockable to this visualizer.

Specified by:

visualizeDockable in interface Visualizer

Parameters:

dockableToVisualize - The dockable whose content has to be visualized. May not be nul.

getVisualizedDockable

public Dockable getVisualizedDockable(int index)
                               throws java.lang.IndexOutOfBoundsException

Description copied from interface: Visualizer

Gets the visualized dockable with the specified index.

Specified by:

getVisualizedDockable in interface Visualizer

Returns:

The visualized dockable with the specified index.

Throws:

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

getVisualizedDockableCount

public int getVisualizedDockableCount()

Description copied from interface: Visualizer

Gets the number of visualized dockables of this visualizer.

Specified by:

getVisualizedDockableCount in interface Visualizer

Returns:

The number of visualized dockables of this visualizer.

removeVisualizedDockable

public void removeVisualizedDockable(Dockable dockableToRemove)

Description copied from interface: Visualizer

Removes the visualized dockables from this visualizer.

Specified by:

removeVisualizedDockable in interface Visualizer

loadProperties

public void loadProperties(java.lang.String prefix,
                           java.util.Properties properties,
                           java.util.Map dockablesMap,
                           java.awt.Window owner)
                    throws java.io.IOException

Description copied from interface: Visualizer

Loads the properties for this visualizer. The properties can be found in the given properties object. The property names for this visualizer start with the given prefix.

The dockables can be added to this visualizer. This is not obligatory. They can be found in the given dockables mapping.

This method should be called after the empty constructor to create the content of the visualizer. Don't call this method for a visualizer that already has a content.

Specified by:

loadProperties in interface Visualizer

Parameters:

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

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

dockablesMap - A mapping that contains the available dockables.

• map key: the ID of the dockable (java.lang.String).
• map value: the dockable (Dockable).

owner - The owner window of the visualizer in the dock model (DockModel).

Throws:

java.io.IOException - If an error occures while decoding the properties.

saveProperties

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

Description copied from interface: Visualizer

Saves the properties of this visualizer in the given properties object.

The property names for this visualizer should start with the given prefix.

Specified by:

saveProperties in interface Visualizer

Parameters:

prefix - The prefix for the property names.

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

createMinimizedHeaderDockableID

protected java.lang.String createMinimizedHeaderDockableID(Dockable dockable)

Creates the ID for the dockable around the header component of a minimized dockable.

Returns:

The ID for the dockable around the header component of a minimized dockable.

getDocker

public Docker getDocker()

Gets the object that docks the dockables around the minimized headers in docks.

Returns:

The object that docks the dockables around the minimized headers in docks.

setDocker

public void setDocker(Docker docker)

Sets the object that docks the dockables around the minimized headers in docks.

Parameters:

docker - The object that docks the dockables around the minimized headers in docks.