|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.argouml.swingext.Orientation | +--org.argouml.swingext.Vertical
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 and position as x.
Vertical treats length as height, breadth as width and position as y.
HORIZONTAL VERTICAL
A
|
position = y
|
V
+-------------+ A +-------------+ A
| | | | | |
<--position--> | | breadth = height | | length = height
= x | | | | | |
+-------------+ V +-------------+ V
<-- length--> <--breadth-->
= width = width
Constructor Summary | |
protected |
Vertical()
|
Method Summary | |
java.awt.Dimension |
addLength(java.awt.Dimension original,
int add)
Create a new Dimension from an existing Dimension with its length
increased by a given value. |
java.awt.Point |
addToPosition(java.awt.Point original,
int add)
Create a new Point from an existing Point with its position
increased by a given value. |
int |
getBreadth(java.awt.Component comp)
Get the breadth of a Component . |
int |
getBreadth(java.awt.Dimension dim)
Get the breadth of a Dimension . |
java.awt.Cursor |
getCursor()
Get a cursor object pointing in the same direction as the orientation. |
ArrowButton |
getEndArrowButton()
Get an arrow button pointing to the end of the orientation. |
int |
getFirstUsableOffset(java.awt.Container cont)
Determines the first usable offset in a Container . |
static Orientation |
getInstance()
Get an instance of an Orientation object. |
int |
getLastUsablePosition(java.awt.Container cont)
Determines the last usable position in a Container . |
int |
getLength(java.awt.Component comp)
Get the length of a Component . |
int |
getLength(java.awt.Dimension dim)
Get the length of a Dimension . |
int |
getLengthMinusInsets(java.awt.Container cont)
Get the usable length of a Container minus its insets . |
int |
getOffset(java.awt.Point point)
Get the offset of a Point . |
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. |
int |
getPosition(java.awt.Component comp)
Get the position of a Component . |
int |
getPosition(java.awt.event.MouseEvent me)
Get the position of a MouseEvent . |
int |
getPosition(java.awt.Point point)
Get the position of a Point . |
ArrowButton |
getStartArrowButton()
Get an arrow button pointing to the start of the orientation. |
java.awt.Point |
newPoint(int position,
int offset)
Generate a new Point object from position and offset values. |
java.awt.Dimension |
setBreadth(java.awt.Dimension original,
java.awt.Dimension breadth)
Create a new Dimension from an existing Dimension with its
breadth changed to the breadth of another given Dimension . |
java.awt.Dimension |
setBreadth(java.awt.Dimension original,
int breadth)
Create a new Dimension from an existing Dimension with its
breadth changed to a given value. |
java.awt.Dimension |
setLength(java.awt.Dimension original,
java.awt.Dimension length)
Create a new Dimension from an existing Dimension with its
length changed to the length of another given Dimension . |
java.awt.Dimension |
setLength(java.awt.Dimension original,
int length)
Create a new Dimension from an existing Dimension with its
length changed to a given value. |
java.awt.Point |
setPosition(java.awt.Point original,
int position)
Create a new Point from an existing Point with its
position changed to a given value. |
Methods inherited from class org.argouml.swingext.Orientation |
addLength, addLength, addToPosition, addToPosition, subtractFromPosition, subtractFromPosition, subtractFromPosition, subtractLength, subtractLength, subtractLength |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected Vertical()
Method Detail |
public static Orientation getInstance()
Orientation
object.Orientation
.public Orientation getPerpendicular()
Orientation
perpendicular to this instance.getPerpendicular
in class Orientation
public int getLength(java.awt.Dimension dim)
Dimension
.getLength
in class Orientation
Dimension
.public int getLength(java.awt.Component comp)
Component
.getLength
in class Orientation
Component
.public int getLengthMinusInsets(java.awt.Container cont)
Container
minus its insets
.getLengthMinusInsets
in class Orientation
Component
.public int getBreadth(java.awt.Dimension dim)
Dimension
.getBreadth
in class Orientation
Dimension
.public int getBreadth(java.awt.Component comp)
Component
.getBreadth
in class Orientation
Component
.public int getPosition(java.awt.Point point)
Point
.getPosition
in class Orientation
Point
.public int getOffset(java.awt.Point point)
Point
.getOffset
in class Orientation
Point
.public int getLastUsablePosition(java.awt.Container cont)
Container
. This takes into account
the Insets
of the Container
.getLastUsablePosition
in class Orientation
Container
.public int getFirstUsableOffset(java.awt.Container cont)
Container
. This takes into account
the Insets
of the Container
.getFirstUsableOffset
in class Orientation
Container
.public java.awt.Point newPoint(int position, int offset)
Point
object from position and offset values.newPoint
in class Orientation
Point
object.public int getPosition(java.awt.Component comp)
Component
.getPosition
in class Orientation
Component
.public int getPosition(java.awt.event.MouseEvent me)
MouseEvent
.getPosition
in class Orientation
MouseEvent
.public java.awt.Dimension addLength(java.awt.Dimension original, int add)
Dimension
from an existing Dimension
with its length
increased by a given value.addLength
in class Orientation
Dimension
.public java.awt.Point addToPosition(java.awt.Point original, int add)
Point
from an existing Point
with its position
increased by a given value.addToPosition
in class Orientation
Point
.public java.awt.Dimension setLength(java.awt.Dimension original, int length)
Dimension
from an existing Dimension
with its
length changed to a given value.setLength
in class Orientation
Dimension
.public java.awt.Dimension setLength(java.awt.Dimension original, java.awt.Dimension length)
Dimension
from an existing Dimension
with its
length changed to the length of another given Dimension
.setLength
in class Orientation
Dimension
.public java.awt.Dimension setBreadth(java.awt.Dimension original, int breadth)
Dimension
from an existing Dimension
with its
breadth changed to a given value.setBreadth
in class Orientation
Dimension
.public java.awt.Dimension setBreadth(java.awt.Dimension original, java.awt.Dimension breadth)
Dimension
from an existing Dimension
with its
breadth changed to the breadth of another given Dimension
.setBreadth
in class Orientation
Dimension
.public java.awt.Point setPosition(java.awt.Point original, int position)
Point
from an existing Point
with its
position changed to a given value.setPosition
in class Orientation
Point
.public java.awt.Cursor getCursor()
getCursor
in class Orientation
Cursor
.public ArrowButton getStartArrowButton()
getStartArrowButton
in class Orientation
ArrowButton
.public ArrowButton getEndArrowButton()
getEndArrowButton
in class Orientation
ArrowButton
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ArgoUML (c) 1996-2002 |