Various utilities to aid components that are aware of their
horizontal/vertical orientation. The Singleton pattern is used to
ensure that only one instance of a horizontal and one instance of a
vertical
Orientation
exist.
Operations performed using length or breadth are transposed to
width and height depending on whether this is a vertical or
horizontal orientation.
Horizontal treats length as width, breadth as height, position as x
and offset as y.
Vertical treats length as height, breadth as width, position as y
and offset as x.
HORIZONTAL VERTICAL
A
|
position = y
|
V
+-------------+ A +-------------+ A
| | | | | |
<--position--> | | breadth = height | | length =
= x | | | | | |height
+-------------+ V +-------------+ V
<-- length--> <--breadth-->
= width = width
addLength
public Dimension addLength(Dimension original,
Component add)
Create a new Dimension
from an existing
Dimension
with its length increased by the length
of a Component
.
addLength
public Dimension addLength(Dimension original,
Dimension add)
Create a new Dimension
from an existing
Dimension
with its length increased by the length
of another Dimension
.
addLength
public abstract Dimension addLength(Dimension original,
int add)
Create a new Dimension
from an existing
Dimension
with its length increased by a given
value.
addToPosition
public Point addToPosition(Point original,
Component add)
Create a new Point
from an existing
Point
with its length increased by the length of a
Component
.
addToPosition
public Point addToPosition(Point original,
Dimension add)
Create a new Point
from an existing
Point
with its length increased by the length of a
Dimension
.
addToPosition
public abstract Point addToPosition(Point original,
int add)
Create a new Point
from an existing
Point
with its position increased by a given
value.
getBreadth
public abstract int getBreadth(Component comp)
Get the breadth of a Component
.
- The breadth of the
Component
.
getBreadth
public abstract int getBreadth(Dimension dim)
Get the breadth of a Dimension
.
- The breadth of the
Dimension
.
getCursor
public abstract Cursor getCursor()
Get a cursor object pointing in the same direction as the orientation.
getEndArrowButton
public abstract ArrowButton getEndArrowButton()
Get an arrow button pointing to the end of the orientation.
- The resulting
ArrowButton
.
getFirstUsableOffset
public abstract int getFirstUsableOffset(Container cont)
Determines the first usable offset in a
Container
. This takes into account the
Insets
of the Container
.
- The offset of the
Container
.
getLastUsablePosition
public abstract int getLastUsablePosition(Container cont)
Determines the last usable position in a
Container
. This takes into account the
Insets
of the Container
.
- The offset of the
Container
.
getLength
public abstract int getLength(Component comp)
Get the length of a Component
.
- The length of the
Component
.
getLength
public abstract int getLength(Dimension dim)
Get the length of a Dimension
.
- The length of the
Dimension
.
getLengthMinusInsets
public abstract int getLengthMinusInsets(Container cont)
Get the usable length of a Container
minus its
insets
.
- The length of the
Component
.
getOffset
public abstract int getOffset(Point point)
Get the offset of a Point
.
getPerpendicular
public abstract Orientation getPerpendicular()
Get an instance of an
Orientation
perpendicular to
this instance.
If called on a horizontal instance then a vertical instance is
returned.
If called on a vertical instance then a horizontal instance is
returned.
- A vertical or horizontal orientation.
getPosition
public abstract int getPosition(Component comp)
Get the position of a Component
.
- The position of the
Component
.
getPosition
public abstract int getPosition(MouseEvent me)
Get the position of a MouseEvent
.
- The position of the
MouseEvent
.
getPosition
public abstract int getPosition(Point point)
Get the position of a Point
.
- The position of the
Point
.
getStartArrowButton
public abstract ArrowButton getStartArrowButton()
Get an arrow button pointing to the start of the orientation.
- The resulting
ArrowButton
.
newPoint
public abstract Point newPoint(int position,
int offset)
Generate a new Point
object from position and offset values.
- The newly created
Point
object.
setBreadth
public abstract Dimension setBreadth(Dimension original,
Dimension breadth)
Create a new Dimension
from an existing
Dimension
with its breadth changed to the breadth
of another given Dimension
.
setBreadth
public abstract Dimension setBreadth(Dimension original,
int breadth)
Create a new Dimension
from an existing
Dimension
with its breadth changed to a given
value.
setLength
public abstract Dimension setLength(Dimension original,
Dimension length)
Create a new Dimension
from an existing
Dimension
with its length changed to the length of
another given Dimension
.
setLength
public abstract Dimension setLength(Dimension original,
int length)
Create a new Dimension
from an existing
Dimension
with its length changed to a given
value.
setPosition
public abstract Point setPosition(Point original,
int position)
Create a new Point
from an existing
Point
with its position changed to a given value.
subtractFromPosition
public Point subtractFromPosition(Point original,
Component subtract)
Create a new Point
from an existing
Point
with its length decreased by the length of a
Component
.
subtractFromPosition
public Point subtractFromPosition(Point original,
Dimension subtract)
Create a new Point
from an existing
Point
with its length decreased by the length of a
Dimension
.
subtractFromPosition
public Point subtractFromPosition(Point original,
int subtract)
Create a new Point
from an existing
Point
with its position decreased by a given
value.
subtractLength
public Dimension subtractLength(Dimension original,
Component subtract)
Create a new Dimension
from an existing
Dimension
with its length decreased by the length
of a Component
.
subtractLength
public Dimension subtractLength(Dimension original,
Dimension subtract)
Create a new Dimension
from an existing
Dimension
with its length decreased by the length
of another Dimension
.
subtractLength
public Dimension subtractLength(Dimension original,
int subtract)
Create a new Dimension
from an existing
Dimension
with its length decreased by a given
value.