pub.vlsolutions.swing.docking

Class AnchorManager

java.lang.Object

pub.vlsolutions.swing.docking.AnchorManager

public class AnchorManager
extends java.lang.Object

A helper class used to specify and enforce constraints within a container (DockingPanel or CompoundDockingPanel).

Constraints are currently defined as anchors (AnchorConstraints objects associated to Dockables).

Since:

2.1

Author:

Lilian Chamontin, VLSolutions

See Also:

AnchorConstraints

Constructor Summary

Constructors

Constructor and Description
AnchorManager(DockingContext context, java.awt.Container container) Constructs a new AnchorManager responsible for a container (desktop or compound)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Cleanup for this manager : removes references and listeners
AnchorConstraints	getDockableConstraints(Dockable dockable) Returns the anchor constraints associated to a given dockable
void	putDockableContraints(Dockable dockable, AnchorConstraints constraints) Associates an anchor constraints to a given dockable
AnchorConstraints	removeDockableConstraints(Dockable dockable) Removes an anchor constraints to a given dockable

Methods inherited from class java.lang.Object

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

Constructor Detail

AnchorManager

public AnchorManager(DockingContext context,
             java.awt.Container container)

Constructs a new AnchorManager responsible for a container (desktop or compound)

Parameters:

context - the context (can be taken from DockingDesktop.getDockingContext() used by this manager

container - the "top level" container managed (usually a DockingDesktop or a CompoundDockingPanel)

Method Detail

clear

public void clear()

Cleanup for this manager : removes references and listeners

putDockableContraints

public void putDockableContraints(Dockable dockable,
                         AnchorConstraints constraints)

Associates an anchor constraints to a given dockable

Parameters:

dockable - the dockable to anchor

constraints - associated anchor constraints

getDockableConstraints

public AnchorConstraints getDockableConstraints(Dockable dockable)

Returns the anchor constraints associated to a given dockable

Parameters:

dockable - the dockable to anchor

Returns:

the constraints for this dockable, or null if no constraints is associated

removeDockableConstraints

public AnchorConstraints removeDockableConstraints(Dockable dockable)

Removes an anchor constraints to a given dockable

Parameters:

dockable - the dockable whose anchor is to be removed