bibliothek.gui.dock.station.split
Interface SplitDockAccess


public interface SplitDockAccess

Provides access to some internal methods and attributes of a SplitDockStation. An access is granted only to a few selected friend classes.

Author:
Benjamin Sigg

Method Summary
 void add(DockableDisplayer displayer)
          Adds a displayer to the list of all known displayers.
 PutInfo checkPutInfo(PutInfo info)
          Checks whether info is valid or not.
 Leaf createLeaf(Dockable dockable)
          Adds dockable to the list of children, generates a title and a Leaf for dockable, but does not add the leaf to this station.
 boolean drop(Dockable dockable, SplitDockProperty property, SplitNode root)
          Tries to add Dockable such that the boundaries given by property are full filled.
 DockableDisplayer getFullScreenDockable()
          Gets the DockableDisplayer which is currently in fullscreen-mode.
 SplitDockStation getOwner()
          Gets the station to which this object grants access.
 double validateDivider(double divider, Node node)
          Tests whether the given value of the divider is a legal value or not.
 

Method Detail

getOwner

SplitDockStation getOwner()
Gets the station to which this object grants access.

Returns:
the owner

getFullScreenDockable

DockableDisplayer getFullScreenDockable()
Gets the DockableDisplayer which is currently in fullscreen-mode.

Returns:
the displayer, may be null

validateDivider

double validateDivider(double divider,
                       Node node)
Tests whether the given value of the divider is a legal value or not.

Parameters:
divider - The value of the divider
node - the node for which the divider is validated
Returns:
a legal value, as near as possible to divider.

add

void add(DockableDisplayer displayer)
Adds a displayer to the list of all known displayers.

Parameters:
displayer - the new displayer

createLeaf

Leaf createLeaf(Dockable dockable)
Adds dockable to the list of children, generates a title and a Leaf for dockable, but does not add the leaf to this station. The location of the leaf has be set by the caller.

Parameters:
dockable - the new child of this station.
Returns:
the Leaf for dockable

drop

boolean drop(Dockable dockable,
             SplitDockProperty property,
             SplitNode root)
Tries to add Dockable such that the boundaries given by property are full filled.

Parameters:
dockable - a new child of this station
property - the preferred location of the child
root - the root of all possible parents where the child could be inserted
Returns:
true if the child could be added, false if no location could be found

checkPutInfo

PutInfo checkPutInfo(PutInfo info)
Checks whether info is valid or not.

Parameters:
info - the preferred drop location
Returns:
info if it is valid, null otherwise