bibliothek.gui.dock.station.split

Interface SplitLayoutManager

All Known Implementing Classes:

DefaultSplitLayoutManager

public interface SplitLayoutManager

A manager used to implement the behavior of a SplitDockStation. The SplitLayoutManager is responsible to define the actions that have to be taken on drop and move-events. It is also responsible to validate any movement of the dividers.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	calculateDivider(SplitDockStation station, PutInfo putInfo, Leaf origin, StationDropItem item) Calculates the value a divider should have if the Dockable of putInfo is added alongside of origin.
void	install(SplitDockStation station) Called by a SplitDockStation when this manager will be used by the station.
PutInfo	prepareDrop(SplitDockStation station, StationDropItem dockable) Call forwarded from DockStation.prepareDrop.
PutInfo	prepareMove(SplitDockStation station, StationDropItem dockable) Call forwarded from DockStation.prepareDrop if the operation is a move operation (if the dockable is already a child of this station).
void	uninstall(SplitDockStation station) Called by a SplitDockStation which used this manager and no longer does.
void	updateBounds(Root root, double x, double y, double factorW, double factorH) Called when the bounds of all DockableDisplayer of a station have to be updated.
double	validateDivider(SplitDockStation station, double divider, Node node) Tests whether the specified divider-value is legal or not.
PutInfo	validatePutInfo(SplitDockStation station, PutInfo info) Checks whether info is valid or not.
Dockable	willMakeFullscreen(SplitDockStation station, Dockable dockable) Called before the station changes its fullscreen-Dockable.

Method Detail

install

void install(SplitDockStation station)

Called by a SplitDockStation when this manager will be used by the station.

Parameters:

station - the invoking station

uninstall

void uninstall(SplitDockStation station)

Called by a SplitDockStation which used this manager and no longer does.

Parameters:

station - the invoking station

willMakeFullscreen

Dockable willMakeFullscreen(SplitDockStation station,
                            Dockable dockable)

Called before the station changes its fullscreen-Dockable.

Parameters:

station - the invoking station

dockable - the element which the station wants to make fullscreen, can be null

Returns:

the element which the station will made fullscreen, must either be a child of station or null.

prepareDrop

PutInfo prepareDrop(SplitDockStation station,
                    StationDropItem dockable)

Call forwarded from DockStation.prepareDrop. This method calculates where to drop a new Dockable.
This SplitLayoutManager may or may not set the CombinerTarget and CombinerSource of the created PutInfo. If there is no combiner information but the mouse is over the center or the title of a selected Leaf, then the SplitDockStation will create the missing information automatically. If there is already information set, then the station will silently assume that this manager did set the information and that the information is correct.

Parameters:

station - the calling station

dockable - the element that might be dropped

Returns:

where to drop dockable or null if the element should not be dropped

prepareMove

PutInfo prepareMove(SplitDockStation station,
                    StationDropItem dockable)

Call forwarded from DockStation.prepareDrop if the operation is a move operation (if the dockable is already a child of this station). This method calculates where to move a Dockable of station.

Parameters:

station - the calling station

dockable - the element that might be dropped

Returns:

where to drop dockable or null if the element should not be dropped

See Also:

prepareDrop(SplitDockStation, StationDropItem)

calculateDivider

void calculateDivider(SplitDockStation station,
                      PutInfo putInfo,
                      Leaf origin,
                      StationDropItem item)

Calculates the value a divider should have if the Dockable of putInfo is added alongside of origin. The result has to be stored directly in putInfo.

Parameters:

station - the station for which the calculation has to be done

putInfo - the new child of the station

origin - a leaf of this station or null

item - detailed information about the drag and drop operation that is going on

validateDivider

double validateDivider(SplitDockStation station,
                       double divider,
                       Node node)

Tests whether the specified divider-value is legal or not.

Parameters:

station - the station for which the divider is calculated

divider - the value of a divider on a Node

node - the Node for which the test is performed

Returns:

a legal value as near as possible to divider

validatePutInfo

PutInfo validatePutInfo(SplitDockStation station,
                        PutInfo info)

Checks whether info is valid or not.

Parameters:

station - the station for which info will be used

info - the preferred drop location

Returns:

a valid PutInfo, info or null.

updateBounds

void updateBounds(Root root,
                  double x,
                  double y,
                  double factorW,
                  double factorH)

Called when the bounds of all DockableDisplayer of a station have to be updated. Subclasses normally can just call Root.updateBounds(double, double, double, double, double, double, boolean) with width and height set to 1.0.

Parameters:

root - the root of a tree of Dockables

x - the left bound

y - the top bound

factorW - a factor with which all x-coordinates have to be multiplied in order to get coordinates in pixels. 0 if the basic station has no size.

factorH - a factor with which all y-coordinates have to be multiplied in order to get coordinates in pixels. 0 if the basic station has no size.