bibliothek.gui.dock.common
Interface CMaximizeBehavior

public interface CMaximizeBehavior

The maximize-behavior is used by the MaximizedMode to decide, what happens when the user maximizes or un-maximizes some CDockable.
Clients can use CControl.setMaximizeBehavior(CMaximizeBehavior) to change the behavior.

Author:

Benjamin Sigg

Field Summary

static CMaximizeBehavior	STACKED
static CMaximizeBehavior	TOPMOST A behavior that allows only one Dockable to be maximized at a time.

Method Summary

Dockable	getMaximizingElement(Dockable dockable) Gets the element which must be maximized when the user requests that dockable is maximized.
Dockable	getMaximizingElement(Dockable old, Dockable dockable) Gets the element which would be maximized if old is currently maximized, and dockable is or will not be maximized.

Field Detail

TOPMOST

static final CMaximizeBehavior TOPMOST

A behavior that allows only one Dockable to be maximized at a time.

STACKED

static final CMaximizeBehavior STACKED

Method Detail

getMaximizingElement

Dockable getMaximizingElement(Dockable dockable)

Gets the element which must be maximized when the user requests that dockable is maximized. Normally dockable itself is returned, or a parent DockStation of dockable.

Parameters:

dockable - some element, not null

Returns:

the element that must be maximized, might be dockable itself, not null

getMaximizingElement

Dockable getMaximizingElement(Dockable old,
                              Dockable dockable)

Gets the element which would be maximized if old is currently maximized, and dockable is or will not be maximized.

Parameters:

old - some element

dockable - some element, might be old

Returns:

the element which would be maximized if dockable is no longer maximized, can be null