org.tigris.toolbar.layouts
Class DockingConstraints

java.lang.Object
  |
  +--org.tigris.toolbar.layouts.DockingConstraints

public class DockingConstraints
extends java.lang.Object

Class representing the edge and indicies at which a toolbar should be docked.

Author:
Christopher Bach

Field Summary
static int EAST
           
static int MAX
           
static int NORTH
           
static int SOUTH
           
static int WEST
           
 
Constructor Summary
DockingConstraints()
          Creates a DockingConstraints object with a default edge of NORTH, row of 0, and index of MAX.
DockingConstraints(int edge)
          Creates a DockingConstraints object at the specified edge with a default row of 0 and index of MAX.
DockingConstraints(int edge, int index)
          Creates a DockingConstraints object at the specified edge and index with a default row of 0.
DockingConstraints(int edge, int row, int index)
          Creates a DockingConstraints object at the specified edge, row, and index.
 
Method Summary
 int getEdge()
          Returns an int representing the edge in which the toolbar is docked.
 int getIndex()
          Returns an int representing the index within the row in which the toolbar is docked.
 int getRow()
          Returns an int representing the row index within the DockBoundary in which the toolbar is docked.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAX

public static final int MAX
See Also:
Constant Field Values

NORTH

public static final int NORTH
See Also:
Constant Field Values

SOUTH

public static final int SOUTH
See Also:
Constant Field Values

EAST

public static final int EAST
See Also:
Constant Field Values

WEST

public static final int WEST
See Also:
Constant Field Values
Constructor Detail

DockingConstraints

public DockingConstraints()
Creates a DockingConstraints object with a default edge of NORTH, row of 0, and index of MAX.


DockingConstraints

public DockingConstraints(int edge)
Creates a DockingConstraints object at the specified edge with a default row of 0 and index of MAX.


DockingConstraints

public DockingConstraints(int edge,
                          int index)
Creates a DockingConstraints object at the specified edge and index with a default row of 0.


DockingConstraints

public DockingConstraints(int edge,
                          int row,
                          int index)
Creates a DockingConstraints object at the specified edge, row, and index.

Method Detail

getEdge

public int getEdge()
Returns an int representing the edge in which the toolbar is docked.


getRow

public int getRow()
Returns an int representing the row index within the DockBoundary in which the toolbar is docked.


getIndex

public int getIndex()
Returns an int representing the index within the row in which the toolbar is docked.