org.argouml.swingext
Class Vertical

java.lang.Object
  |
  +--org.argouml.swingext.Orientation
        |
        +--org.argouml.swingext.Vertical

public class Vertical

extends Orientation

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 =
    = x         |             |   |                 |             |   |height
                +-------------+   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.
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

Vertical

protected Vertical()

Method Detail

getInstance

public static Orientation getInstance()

Get an instance of an Orientation object.

Returns:

An instance of Orientation.

getPerpendicular

public 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.

Specified by:

getPerpendicular in class Orientation

Returns:

A vertical or horizontal orientation.

getLength

public int getLength(java.awt.Dimension dim)

Get the length of a Dimension.

Specified by:

getLength in class Orientation

Returns:

The length of the Dimension.

getLength

public int getLength(java.awt.Component comp)

Get the length of a Component.

Specified by:

getLength in class Orientation

Returns:

The length of the Component.

getLengthMinusInsets

public int getLengthMinusInsets(java.awt.Container cont)

Get the usable length of a Container minus its insets.

Specified by:

getLengthMinusInsets in class Orientation

Returns:

The length of the Component.

getBreadth

public int getBreadth(java.awt.Dimension dim)

Get the breadth of a Dimension.

Specified by:

getBreadth in class Orientation

Returns:

The breadth of the Dimension.

getBreadth

public int getBreadth(java.awt.Component comp)

Get the breadth of a Component.

Specified by:

getBreadth in class Orientation

Returns:

The breadth of the Component.

getPosition

public int getPosition(java.awt.Point point)

Get the position of a Point.

Specified by:

getPosition in class Orientation

Returns:

The position of the Point.

getOffset

public int getOffset(java.awt.Point point)

Get the offset of a Point.

Specified by:

getOffset in class Orientation

Returns:

The position of the Point.

getLastUsablePosition

public int getLastUsablePosition(java.awt.Container cont)

Determines the last usable position in a Container. This takes into account the Insets of the Container.

Specified by:

getLastUsablePosition in class Orientation

Returns:

The offset of the Container.

getFirstUsableOffset

public int getFirstUsableOffset(java.awt.Container cont)

Determines the first usable offset in a Container. This takes into account the Insets of the Container.

Specified by:

getFirstUsableOffset in class Orientation

Returns:

The offset of the Container.

newPoint

public java.awt.Point newPoint(int position,
                               int offset)

Generate a new Point object from position and offset values.

Specified by:

newPoint in class Orientation

Returns:

The newly created Point object.

getPosition

public int getPosition(java.awt.Component comp)

Get the position of a Component.

Specified by:

getPosition in class Orientation

Returns:

The position of the Component.

getPosition

public int getPosition(java.awt.event.MouseEvent me)

Get the position of a MouseEvent.

Specified by:

getPosition in class Orientation

Returns:

The position of the MouseEvent.

addLength

public 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.

Specified by:

addLength in class Orientation

Returns:

The resulting Dimension.

addToPosition

public 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.

Specified by:

addToPosition in class Orientation

Returns:

The resulting Point.

setLength

public 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.

Specified by:

setLength in class Orientation

Returns:

The resulting Dimension.

setLength

public 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.

Specified by:

setLength in class Orientation

Returns:

The resulting Dimension.

setBreadth

public 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.

Specified by:

setBreadth in class Orientation

Returns:

The resulting Dimension.

setBreadth

public 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.

Specified by:

setBreadth in class Orientation

Returns:

The resulting Dimension.

setPosition

public 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.

Specified by:

setPosition in class Orientation

Returns:

The resulting Point.

getCursor

public java.awt.Cursor getCursor()

Get a cursor object pointing in the same direction as the orientation.

Specified by:

getCursor in class Orientation

Returns:

The resulting Cursor.

getStartArrowButton

public ArrowButton getStartArrowButton()

Get an arrow button pointing to the start of the orientation.

Specified by:

getStartArrowButton in class Orientation

Returns:

The resulting ArrowButton.

getEndArrowButton

public ArrowButton getEndArrowButton()

Get an arrow button pointing to the end of the orientation.

Specified by:

getEndArrowButton in class Orientation

Returns:

The resulting ArrowButton.