public class CBaseLocation extends CLocation
CContentArea
.findProperty
Constructor and Description |
---|
CBaseLocation() |
CBaseLocation(CContentArea center) |
Modifier and Type | Method and Description |
---|---|
CLocation |
aside()
Deprecated.
see
CLocation.aside() for an explanation. |
CLocation |
expandProperty(DockableProperty property,
CLocationExpandStrategy strategy)
Tries to create a location that resembles
property . |
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.
|
CContentArea |
getContentArea()
Gets the contentarea to which this location relates.
|
CLocation |
getParent()
Gets the parent location of this location.
|
CFlapIndexLocation |
minimalEast()
Creates a location describing a minimized element at the right.
|
CFlapIndexLocation |
minimalEast(int index)
Creates a location describing a minimized element at the right.
|
CFlapIndexLocation |
minimalNorth()
Creates a location describing a minimized element at the top.
|
CFlapIndexLocation |
minimalNorth(int index)
Creates a location describing a minimized element at the top.
|
CFlapIndexLocation |
minimalSouth()
Creates a location describing a minimized element at the bottom.
|
CFlapIndexLocation |
minimalSouth(int index)
Creates a location describing a minimized element at the bottom.
|
CFlapIndexLocation |
minimalWest()
Creates a location describing a minimized element at the left.
|
CFlapIndexLocation |
minimalWest(int index)
Creates a location describing a minimized element at the left.
|
CContentAreaCenterLocation |
normal()
Gets a location that points to the center of the
CContentArea . |
TreeLocationRoot |
normalEast(double size)
Creates a location describing a normalized element at the east of
the normalized-area.
|
TreeLocationRoot |
normalNorth(double size)
Creates a location describing a normalized element at the north of
the normalized-area.
|
CRectangleLocation |
normalRectangle(double x,
double y,
double width,
double height)
Creates a location describing a normalized element at a given location.
|
TreeLocationRoot |
normalSouth(double size)
Creates a location describing a normalized element at the south of
the normalized-area.
|
TreeLocationRoot |
normalWest(double size)
Creates a location describing a normalized element at the west of
the normalized-area.
|
String |
toString() |
public CBaseLocation(CContentArea center)
public CBaseLocation()
public CContentArea getContentArea()
null
if the default center is meant.public CLocation getParent()
CLocation
public CContentAreaCenterLocation normal()
CContentArea
.public CRectangleLocation normalRectangle(double x, double y, double width, double height)
x
- the x-coordinate, a value between 0 and 1y
- the y-coordinate, a value between 0 and 1width
- the width, x + width
should be less or equal to 1height
- the height, y + height
should be less or equal to 1public TreeLocationRoot normalNorth(double size)
size
- the relative size of the element, a value between 0 (no space)
and 1 (all space).public TreeLocationRoot normalSouth(double size)
size
- the relative size of the element, a value between 0 (no space)
and 1 (all space).public TreeLocationRoot normalEast(double size)
size
- the relative size of the element, a value between 0 (no space)
and 1 (all space).public TreeLocationRoot normalWest(double size)
size
- the relative size of the element, a value between 0 (no space)
and 1 (all space).public CFlapIndexLocation minimalNorth()
public CFlapIndexLocation minimalNorth(int index)
index
- the location in the list of minimized elementspublic CFlapIndexLocation minimalSouth()
public CFlapIndexLocation minimalSouth(int index)
index
- the location in the list of minimized elementspublic CFlapIndexLocation minimalEast()
public CFlapIndexLocation minimalEast(int index)
index
- the location in the list of minimized elementspublic CFlapIndexLocation minimalWest()
public CFlapIndexLocation minimalWest(int index)
index
- the location in the list of minimized elementspublic DockableProperty findProperty(DockableProperty successor)
CLocation
findProperty
in class CLocation
successor
- the path of the elements above this location or null
null
, can also be successor
public ExtendedMode findMode()
CLocation
public CLocation expandProperty(DockableProperty property, CLocationExpandStrategy strategy)
CLocation
property
.expandProperty
in class CLocation
property
- some locationstrategy
- a strategy helping to convert the propertiesCLocation.findProperty()
would create
property
again, or null
in case that property
can't be usedpublic String findRoot()
CLocation
CStation
.@Deprecated public CLocation aside()
CLocation.aside()
for an explanation.CLocation
CLocation
that describes the location of an element
that should be inserted next to this location.