bibliothek.gui.dock.station.split
Class Leaf

java.lang.Object
  extended by bibliothek.gui.dock.station.split.SplitNode
      extended by bibliothek.gui.dock.station.split.Leaf

public class Leaf
extends SplitNode

Represents a leaf in the tree that is the structure of a SplitDockStation. A leaf also represents a single Dockable which is shown on the owner-station.

Author:
Benjamin Sigg

Field Summary
 
Fields inherited from class bibliothek.gui.dock.station.split.SplitNode
height, width, x, y
 
Constructor Summary
Leaf(SplitDockAccess access)
          Creates a new leaf.
Leaf(SplitDockAccess access, DockableDisplayer displayer)
          Creates a new leaf.
 
Method Summary
 void evolve(SplitDockTree.Key key)
          Creates or replaces children according to the values found in key.
 DockableDisplayer getDisplayer()
          Gets the displayer of this leaf.
 Node getDividerNode(int x, int y)
          Gets the Node whose divider area contains the point x/y.
 Dockable getDockable()
          Gets the Dockable which is shown on the displayer of this leaf.
 Leaf getLeaf(Dockable dockable)
          Gets the leaf which represents dockable.
 Dimension getMinimumSize()
          Gets the minimal size of this node.
 PutInfo getPut(int x, int y, double factorW, double factorH, Dockable drop)
          Determines where to drop the Dockable drop if the mouse is at location x/y.
 SplitNode read(Map<Integer,Dockable> children, DataInputStream in)
          Reads an earlier written node from the stream in.
 void setDisplayer(DockableDisplayer displayer)
          Sets the displayer whose size and location will be determined by this leaf.
 SplitDockTree.Key submit(SplitDockTree tree)
          Writes the contents of this node into tree.
 void updateBounds(double x, double y, double width, double height, double factorW, double factorH)
          Updates the bounds of this node.
 void visit(SplitNodeVisitor visitor)
          Invokes one of the methods of the visitor for every child in the subtree with this as root.
 void write(Map<Dockable,Integer> children, DataOutputStream out)
          Writes the structure of the subtree with this as root into out.
 
Methods inherited from class bibliothek.gui.dock.station.split.SplitNode
above, create, getAccess, getBounds, getHeight, getParent, getRoot, getSize, getWidth, getX, getY, intersection, readChild, relativeSidePut, setParent, writeChild
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Leaf

public Leaf(SplitDockAccess access)
Creates a new leaf.

Parameters:
access - the access to the private functions of the owning SplitDockStation

Leaf

public Leaf(SplitDockAccess access,
            DockableDisplayer displayer)
Creates a new leaf.

Parameters:
access - the access to the private functions of the owning SplitDockStation
displayer - the displayer whose size and location will be determined by this leaf.
Method Detail

getMinimumSize

public Dimension getMinimumSize()
Description copied from class: SplitNode
Gets the minimal size of this node.

Specified by:
getMinimumSize in class SplitNode
Returns:
the minimal size in pixel

setDisplayer

public void setDisplayer(DockableDisplayer displayer)
Sets the displayer whose size and location will be determined by this leaf.

Parameters:
displayer - the displayer, must not be null

getDisplayer

public DockableDisplayer getDisplayer()
Gets the displayer of this leaf.

Returns:
the displayer
See Also:
setDisplayer(DockableDisplayer)

getDockable

public Dockable getDockable()
Gets the Dockable which is shown on the displayer of this leaf.

Returns:
the Dockable

updateBounds

public void updateBounds(double x,
                         double y,
                         double width,
                         double height,
                         double factorW,
                         double factorH)
Description copied from class: SplitNode
Updates the bounds of this node. If the node represents a Component, then the bounds of the component have to be updated as well.

Overrides:
updateBounds in class SplitNode
Parameters:
x - the relative x-coordinate
y - the relative y-coordinate
width - the relative width of the node
height - the relative height of the node
factorW - a factor to be multiplied with x and width to get the size of the node in pixel
factorH - a factor to be multiplied with y and height to get the size of the node in pixel

getPut

public PutInfo getPut(int x,
                      int y,
                      double factorW,
                      double factorH,
                      Dockable drop)
Description copied from class: SplitNode
Determines where to drop the Dockable drop if the mouse is at location x/y.

Specified by:
getPut in class SplitNode
Parameters:
x - the x-coordinate of the mouse
y - the y-coordinate of the mouse
factorW - a factor to be multiplied with the relative x and width to get the size in pixel.
factorH - a factor to be multiplied with the relative y and height to get the size in pixel.
drop - the Dockable which will be dropped
Returns:
where to drop the dockable or null if the dockable can't be dropped

evolve

public void evolve(SplitDockTree.Key key)
Description copied from class: SplitNode
Creates or replaces children according to the values found in key.

Specified by:
evolve in class SplitNode
Parameters:
key - the key to read

submit

public SplitDockTree.Key submit(SplitDockTree tree)
Description copied from class: SplitNode
Writes the contents of this node into tree.

Specified by:
submit in class SplitNode
Parameters:
tree - the tree to write into
Returns:
the key of this node

getLeaf

public Leaf getLeaf(Dockable dockable)
Description copied from class: SplitNode
Gets the leaf which represents dockable.

Specified by:
getLeaf in class SplitNode
Parameters:
dockable - the Dockable whose leaf is searched
Returns:
the leaf or null if no leaf was found

getDividerNode

public Node getDividerNode(int x,
                           int y)
Description copied from class: SplitNode
Gets the Node whose divider area contains the point x/y. Only searches in the subtree with this node as root.

Specified by:
getDividerNode in class SplitNode
Parameters:
x - the x-coordinate
y - the y-coordinate
Returns:
the Node containing the point, if no Node was found, null is returned

visit

public void visit(SplitNodeVisitor visitor)
Description copied from class: SplitNode
Invokes one of the methods of the visitor for every child in the subtree with this as root.

Specified by:
visit in class SplitNode
Parameters:
visitor - the visitor

read

public SplitNode read(Map<Integer,Dockable> children,
                      DataInputStream in)
               throws IOException
Description copied from class: SplitNode
Reads an earlier written node from the stream in.

Specified by:
read in class SplitNode
Parameters:
children - a map of substitutions for ids that are found in the stream.
in - the source
Returns:
the newly created node
Throws:
IOException - if the stream throws an exception
See Also:
SplitNode.write(Map, DataOutputStream)

write

public void write(Map<Dockable,Integer> children,
                  DataOutputStream out)
           throws IOException
Description copied from class: SplitNode
Writes the structure of the subtree with this as root into out.

Specified by:
write in class SplitNode
Parameters:
children - a map that contains for every Dockable an id. This id will be written into out to represent the Dockable.
out - the stream to fill
Throws:
IOException - if the stream throws an exception