com.vlsolutions.swing.docking

Class RelativeDockablePosition

public class RelativeDockablePosition extends Object

This class is an immutable object used to remember the relative positionning of docked components.

x, y, w, h fields are expressed with double values varying from 0 to 1.

Objects of this class are used to reposition a Dockable on the desktop, based on lazy constraints : As the desktop is a mix of horizontal and vertical split panes ({@link SplitContainer}) it is not always possible to put a dockable exactly where you want given a set of x,y, w, and h constraints.

Field Summary
static RelativeDockablePositionBOTTOM
convenience field referencing the BOTTOM border of the DockingDesktop
static RelativeDockablePositionBOTTOM_CENTER
convenience field referencing the CENTER part of the BOTTOM border of the DockingDesktop
static RelativeDockablePositionBOTTOM_LEFT
convenience field referencing the TOP-RIGHT corner of the DockingDesktop
static RelativeDockablePositionBOTTOM_RIGHT
convenience field referencing the TOP-RIGHT corner of the DockingDesktop
static RelativeDockablePositionLEFT
convenience field referencing the LEFT border of the DockingDesktop
static RelativeDockablePositionLEFT_CENTER
convenience field referencing the CENTER part of the LEFT border of the DockingDesktop
static RelativeDockablePositionRIGHT
convenience field referencing the RIGHT border of the DockingDesktop
static RelativeDockablePositionRIGHT_CENTER
convenience field referencing the CENTER part of the RIGHT border of the DockingDesktop
static RelativeDockablePositionTOP
convenience field referencing the TOP border of the DockingDesktop
static RelativeDockablePositionTOP_CENTER
convenience field referencing the CENTER part of TOP border of the DockingDesktop
static RelativeDockablePositionTOP_LEFT
convenience field referencing the TOP-LEFT corner of the DockingDesktop
static RelativeDockablePositionTOP_RIGHT
convenience field referencing the TOP-RIGHT corner of the DockingDesktop
Constructor Summary
RelativeDockablePosition()
Constructs an empty relative position (all fields are initialized with 0.0 values)
RelativeDockablePosition(double x, double y, double w, double h)
Constructs a relative position with given location and size.
Method Summary
doublegetHeight()
Returns the relative height of the dockable
doublegetWidth()
Returns the relative width of the dockable
doublegetX()
Returns the relative x position of the dockable
doublegetY()
Returns the relative y position of the dockable
StringtoString()
Returns a meaningfull string representation of this RelativeDockablePosition

Field Detail

BOTTOM

public static final RelativeDockablePosition BOTTOM
convenience field referencing the BOTTOM border of the DockingDesktop

BOTTOM_CENTER

public static final RelativeDockablePosition BOTTOM_CENTER
convenience field referencing the CENTER part of the BOTTOM border of the DockingDesktop

BOTTOM_LEFT

public static final RelativeDockablePosition BOTTOM_LEFT
convenience field referencing the TOP-RIGHT corner of the DockingDesktop

BOTTOM_RIGHT

public static final RelativeDockablePosition BOTTOM_RIGHT
convenience field referencing the TOP-RIGHT corner of the DockingDesktop

LEFT

public static final RelativeDockablePosition LEFT
convenience field referencing the LEFT border of the DockingDesktop

LEFT_CENTER

public static final RelativeDockablePosition LEFT_CENTER
convenience field referencing the CENTER part of the LEFT border of the DockingDesktop

RIGHT

public static final RelativeDockablePosition RIGHT
convenience field referencing the RIGHT border of the DockingDesktop

RIGHT_CENTER

public static final RelativeDockablePosition RIGHT_CENTER
convenience field referencing the CENTER part of the RIGHT border of the DockingDesktop

TOP

public static final RelativeDockablePosition TOP
convenience field referencing the TOP border of the DockingDesktop

TOP_CENTER

public static final RelativeDockablePosition TOP_CENTER
convenience field referencing the CENTER part of TOP border of the DockingDesktop

TOP_LEFT

public static final RelativeDockablePosition TOP_LEFT
convenience field referencing the TOP-LEFT corner of the DockingDesktop

TOP_RIGHT

public static final RelativeDockablePosition TOP_RIGHT
convenience field referencing the TOP-RIGHT corner of the DockingDesktop

Constructor Detail

RelativeDockablePosition

public RelativeDockablePosition()
Constructs an empty relative position (all fields are initialized with 0.0 values)

RelativeDockablePosition

public RelativeDockablePosition(double x, double y, double w, double h)
Constructs a relative position with given location and size.

Please remember that the values must be between 0 and 1, as they designate relative coordinates position/size.

Throws: IllegalArgumentException if values are not in the given bounds

Method Detail

getHeight

public double getHeight()
Returns the relative height of the dockable

getWidth

public double getWidth()
Returns the relative width of the dockable

getX

public double getX()
Returns the relative x position of the dockable

getY

public double getY()
Returns the relative y position of the dockable

toString

public String toString()
Returns a meaningfull string representation of this RelativeDockablePosition
© Copyright 2004-2005 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications