com.jidesoft.docking
Class DockingManagerGroup

java.lang.Object
  com.jidesoft.docking.DockingManagerGroup

public class DockingManagerGroup
extends Object

This class is used to create a multiple-exclusion scope for a set of DockingManagers. Creating a set of DockingManagers with the same DockingManagerGroup object means that only one DockableFrame can be active among all those DockingManagers

Field Summary

protected Vector<DockingManager>

_managers

Constructor Summary

DockingManagerGroup()
Creates a new DockingManagerGroup.

Method Summary

void	add(DockingManager b) Adds the DockingManager to the group.
void	clearSelection() Clears the selection such that none of the DockingManagers in the DockingManagerGroup are selected.
DockingManager	getActive() Returns the model of the active DockingManager.
int	getDockingManagerCount() Returns the number of DockingManagers in the group.
Enumeration<DockingManager>	getElements() Returns all the DockingManagers that are participating in this group.
boolean	isSelected(DockingManager m) Returns whether a DockingManager is selected.
void	remove(DockingManager b) Removes the DockingManager from the group.
void	setSelected(DockingManager m, boolean b) Sets the selected value for the DockingManager.

Methods inherited from class java.lang.Object

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

Field Detail

_managers

protected Vector<DockingManager> _managers

Constructor Detail

DockingManagerGroup

public DockingManagerGroup()

Creates a new DockingManagerGroup.

Method Detail

add

public void add(DockingManager b)

Adds the DockingManager to the group.

Parameters:

b - the DockingManager to be added

remove

public void remove(DockingManager b)

Removes the DockingManager from the group.

Parameters:

b - the DockingManager to be removed

clearSelection

public void clearSelection()

Clears the selection such that none of the DockingManagers in the DockingManagerGroup are selected.

getElements

public Enumeration<DockingManager> getElements()

Returns all the DockingManagers that are participating in this group.

Returns:

an Enumeration of the DockingManagers in this group

getActive

public DockingManager getActive()

Returns the model of the active DockingManager.

Returns:

the active DockingManager.

setSelected

public void setSelected(DockingManager m,
                        boolean b)

Sets the selected value for the DockingManager. Only one DockingManager in the group may be active at a time.

Parameters:

m - the DockingManager

b - true if this DockingManager is to be active, otherwise false

isSelected

public boolean isSelected(DockingManager m)

Returns whether a DockingManager is selected.

Parameters:

m - the DockingManager.

Returns:

true if the DockingManager is active, otherwise returns false

getDockingManagerCount

public int getDockingManagerCount()

Returns the number of DockingManagers in the group.

Returns:

the DockingManager count