bibliothek.gui.dock.common.location
Class CRectangleLocation

java.lang.Object
  bibliothek.gui.dock.common.CLocation
      bibliothek.gui.dock.common.location.AbstractStackholdingLocation
          bibliothek.gui.dock.common.location.CRectangleLocation

public class CRectangleLocation
extends AbstractStackholdingLocation

A location describing a normalized element by giving its relative position and size (relative meaning that the element is positioned in a rectangle of size 1/1).

Author:

Benjamin Sigg

Constructor Summary

CRectangleLocation(CSplitLocation parent, double x, double y, double width, double height)
Creates a new location.

Method Summary

CLocation	aside() Returns a CLocation that describes the location of an element that should be inserted next to this location.
ExtendedMode	findMode() Gets the mode this location represents.
DockableProperty	findProperty(DockableProperty successor) Gets a path describing this location in terms of the DockingFrames.
String	findRoot() Gets the name of the station this location belongs to.
String	toString()

Methods inherited from class bibliothek.gui.dock.common.location.AbstractStackholdingLocation

expandProperty, stack, stack

Methods inherited from class bibliothek.gui.dock.common.CLocation

base, base, external, findProperty, maximized, maximized, maximized, maximized, minimized, minimized, normalized, working

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CRectangleLocation

public CRectangleLocation(CSplitLocation parent,
                          double x,
                          double y,
                          double width,
                          double height)

Creates a new location.

Parameters:

parent - the parent that knows the id of the root station

x - the relative x-coordinate, a value between 0 and 1 is preferred

y - the relative y-coordinate, a value between 0 and 1 is preferred

width - the relative width, a value between 0 and 1 is preferred

height - the relative height, a value between 0 and 1 is preferred

Method Detail

findRoot

public String findRoot()

Description copied from class: CLocation

Gets the name of the station this location belongs to. This can be the id of any CStation.

Specified by:

findRoot in class CLocation

Returns:

the name of the station or null if this location does not have enough information to find the root

findMode

public ExtendedMode findMode()

Description copied from class: CLocation

Gets the mode this location represents.

Specified by:

findMode in class CLocation

Returns:

the mode or null

findProperty

public DockableProperty findProperty(DockableProperty successor)

Description copied from class: CLocation

Gets a path describing this location in terms of the DockingFrames.

Specified by:

findProperty in class CLocation

Parameters:

successor - the path of the elements above this location or null

Returns:

the path to this location or null

aside

public CLocation aside()

Description copied from class: CLocation

Returns a CLocation that describes the location of an element that should be inserted next to this location.

Specified by:

aside in class CLocation

Returns:

the new location

toString

public String toString()

Overrides:

toString in class Object