bibliothek.gui.dock.common.group
Interface CGroupBehaviorCallback


public interface CGroupBehaviorCallback

A set of information and methods for the CGroupBehavior.

Author:
Benjamin Sigg

Method Summary
 Location getLocation(Dockable dockable)
          Gets the current location of dockable.
 LocationModeManager<? extends LocationMode> getManager()
          Gets the LocationModeManager which is handling this callback.
 void setLocation(Dockable dockable, Location location)
          Sets the location of dockable.
 void setMode(Dockable dockable, ExtendedMode mode)
          Sets the ExtendedMode of dockable using all available history information.
 

Method Detail

getManager

LocationModeManager<? extends LocationMode> getManager()
Gets the LocationModeManager which is handling this callback.

Returns:
the manager, not null

setMode

void setMode(Dockable dockable,
             ExtendedMode mode)
Sets the ExtendedMode of dockable using all available history information.
Note: LocationModes may decide that more than one Dockable must be moved in order to accomplish the goal, any cached location information about Dockables shoud be considered invalid once this method has been executed.

Parameters:
dockable - the element whose mode is going to change
mode - the new mode

getLocation

Location getLocation(Dockable dockable)
Gets the current location of dockable.

Parameters:
dockable - some item whose location is requested
Returns:
the location, may be null

setLocation

void setLocation(Dockable dockable,
                 Location location)
Sets the location of dockable.
Note: LocationModes may decide that more than one Dockable must be moved in order to accomplish the goal, any cached location information about Dockables shoud be considered invalid once this method has been executed.

Parameters:
dockable - the element whose location is going to be set
location - the new location