bibliothek.gui.dock.station.split

Interface SplitDividerStrategy

All Known Implementing Classes:

DefaultSplitDividerStrategy

public interface SplitDividerStrategy

The SplitDividerStrategy is responsible for resizing the children of a SplitDockStation. How exactly a SplitDividerStrategy accomplishes that goal is not defined, but usually that involves:

• Adding a MouseListener and a MouseMotionListener to the Component that is given during the installation.
• If the user presses the mouse the strategy will use SplitDockStation.getRoot() and SplitNode.getDividerNode(int, int) to find the Node that is below the mouse.
• By calling Node.getDividerAt(int, int) and Node.setDivider(double) the strategy can resize the children.
• Through SplitDockStation.getCurrentSplitLayoutManager() and SplitLayoutManager.validateDivider(SplitDockStation, double, Node) a strategy can make sure that a valid value for the divider property is chosen.

A strategy may offer additional services like changing the Cursor, or a strategy may not do anything at all.
Implementations should (but are not enforced to) respect some properties:

• SplitDockStation.isResizingEnabled(): whether the user is allowed to resize the children.
• SplitDockStation.isContinousDisplay(): whether resizing should happen immediately.

Clients usually do not need to implement this interface, and the framework offers only one default implementation. The interface will however remain, ready for clients with unforseen needs.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	install(SplitDockStation station, Component container) Informs this strategy that station is going to use it and that container must be monitored in order to receive MouseEvents.
void	paint(SplitDockStation station, Graphics g) Allows this strategy to paint onto the SplitDockStation.
void	uninstall(SplitDockStation station) Informs this strategy that it will no longer be used by station.

Method Detail

install

void install(SplitDockStation station,
             Component container)

Informs this strategy that station is going to use it and that container must be monitored in order to receive MouseEvents.

Parameters:

station - the station whose children are resized by this strategy

container - the component to monitor

uninstall

void uninstall(SplitDockStation station)

Informs this strategy that it will no longer be used by station.

Parameters:

station - the station that is no longer using this

paint

void paint(SplitDockStation station,
           Graphics g)

Allows this strategy to paint onto the SplitDockStation.

Parameters:

station - the station which is painted

g - the graphics context to use