bibliothek.gui.dock.common.grouping

Interface CGroupingBehavior

All Known Implementing Classes:

DefaultCGroupingBehavior

public interface CGroupingBehavior

CGroupingBehavior allows clients to define how Dockables organize themselves in groups. A CGroupingBehavior is able to rewrite the location of Dockables, hence every time the user changes the ExtendedMode of a Dockable the grouping behavior can put the Dockable at a new location.
There is a distinction between CGroupingBehavior and CGroupBehavior: this class is all about bringing groups together, while CGroupBehavior defines how groups of Dockables move around together.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
DockableGrouping	getGrouping(Dockable dockable) Gets the grouping algorithm that should be used for dockable.

Method Detail

getGrouping

DockableGrouping getGrouping(Dockable dockable)

Gets the grouping algorithm that should be used for dockable. This method may be called multiple times for the same dockable. It should either always return the same DockableGrouping, or it should return an object that does not contains any state.

Parameters:

dockable - the element whose grouping information is requested

Returns:

the grouping information, or null if there is no special behavior defined for dockable