com.vlsolutions.swing.docking
public class RelativeDockablePosition extends Object
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 (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 RelativeDockablePosition | BOTTOM convenience field referencing the BOTTOM border of the DockingDesktop |
| static RelativeDockablePosition | BOTTOM_CENTER convenience field referencing the CENTER part of the BOTTOM border of the DockingDesktop |
| static RelativeDockablePosition | BOTTOM_LEFT convenience field referencing the TOP-RIGHT corner of the DockingDesktop |
| static RelativeDockablePosition | BOTTOM_RIGHT convenience field referencing the TOP-RIGHT corner of the DockingDesktop |
| static RelativeDockablePosition | LEFT convenience field referencing the LEFT border of the DockingDesktop |
| static RelativeDockablePosition | LEFT_CENTER convenience field referencing the CENTER part of the LEFT border of the DockingDesktop |
| static RelativeDockablePosition | RIGHT convenience field referencing the RIGHT border of the DockingDesktop |
| static RelativeDockablePosition | RIGHT_CENTER convenience field referencing the CENTER part of the RIGHT border of the DockingDesktop |
| static RelativeDockablePosition | TOP convenience field referencing the TOP border of the DockingDesktop |
| static RelativeDockablePosition | TOP_CENTER convenience field referencing the CENTER part of TOP border of the DockingDesktop |
| static RelativeDockablePosition | TOP_LEFT convenience field referencing the TOP-LEFT corner of the DockingDesktop |
| static RelativeDockablePosition | TOP_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.
| |
| RelativeDockablePosition(Container relativeAncestorContainer, double x, double y, double w, double h) Constructs a relative position with a given location and size, relative to a container | |
| Method Summary | |
|---|---|
| int | getAnchors() Returns an integer value representing the anchoring of the dockable relatively to
its ancestor container.
|
| double | getHeight() Returns the relative height of the dockable |
| Container | getRelativeAncestorContainer() Returns the ancestor container used as a reference for the relative potionning
This can be a DockingPanel (top level ancestor) or CompoundDockingPanel (intermediate ancestor) |
| double | getWidth() Returns the relative width of the dockable |
| double | getX() Returns the relative x position of the dockable |
| double | getY() Returns the relative y position of the dockable |
| void | resetRelativePosition(Container relativeAncestorContainer, Dockable dockable) Updates the current relative ancestor container and anchor positionning |
| String | toString() Returns a meaningfull string representation of this RelativeDockablePosition |
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
For example a dockable at the top left angle of an ancestor container will have an "anchors" value or : AnchorConstraints.ANCHOR_TOP|AnchorConstraints.ANCHOR_LEFT
See Also: AnchorConstraints
This can be a DockingPanel (top level ancestor) or CompoundDockingPanel (intermediate ancestor)