org.niffty
Class LogicalPlacement

java.lang.Object
  |
  +--org.niffty.LogicalPlacement

public class LogicalPlacement

extends java.lang.Object

A LogicalPlacement tag has horizontal, vertical and proximity values. Note that these are not screen pixels but values like "left" and "right".

Field Summary

static int	ABOVE
static int	BELOW
static int	CENTERED
static int	DEFAULT
static int	LEFT
static int	NOTE_SIDE
static int	OFFSET_SLIGHTLY
static int	RIGHT
static int	STEM_SIDE
static int	TOUCHING

Constructor Summary

LogicalPlacement()
Creates new LogicalPlacement with zero horizontal, vertical and proximity

LogicalPlacement(int horizontal, int vertical, int proximity)
Creates new LogicalPlacement with the given horizontal, vertical and proximity

Method Summary

int	getHorizontal() Return the horizontal value which is DEFAULT, LEFT, RIGHT, STEM_SIDE, NOTE_SIDE or CENTERED
int	getProximity() Return the proximity value which is DEFAULT, TOUCHING, OFFSET_SLIGHTLY.
int	getVertical() Return the vertical value which is DEFAULT, ABOVE, BELOW, STEM_SIDE, NOTE_SIDE or CENTERED.
java.lang.String	toString() Returns string as "(horizontal:value, vertical:value, proximity:value)"

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final int DEFAULT

See Also:

Constant Field Values

STEM_SIDE

public static final int STEM_SIDE

See Also:

Constant Field Values

NOTE_SIDE

public static final int NOTE_SIDE

See Also:

Constant Field Values

CENTERED

public static final int CENTERED

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

ABOVE

public static final int ABOVE

See Also:

Constant Field Values

BELOW

public static final int BELOW

See Also:

Constant Field Values

TOUCHING

public static final int TOUCHING

See Also:

Constant Field Values

OFFSET_SLIGHTLY

public static final int OFFSET_SLIGHTLY

See Also:

Constant Field Values

Constructor Detail

LogicalPlacement

public LogicalPlacement()

Creates new LogicalPlacement with zero horizontal, vertical and proximity

LogicalPlacement

public LogicalPlacement(int horizontal,
                        int vertical,
                        int proximity)

Creates new LogicalPlacement with the given horizontal, vertical and proximity

Parameters:

horizontal - horizontal placement. Must be DEFAULT, LEFT, RIGHT, STEM_SIDE, NOTE_SIDE or CENTERED.

vertical - vertical placement. Must be DEFAULT, ABOVE, BELOW, STEM_SIDE, NOTE_SIDE or CENTERED.

proximity - proximity. Must be DEFAULT, TOUCHING, OFFSET_SLIGHTLY.

Method Detail

getHorizontal

public int getHorizontal()

Return the horizontal value which is DEFAULT, LEFT, RIGHT, STEM_SIDE, NOTE_SIDE or CENTERED

getVertical

public int getVertical()

Return the vertical value which is DEFAULT, ABOVE, BELOW, STEM_SIDE, NOTE_SIDE or CENTERED.

getProximity

public int getProximity()

Return the proximity value which is DEFAULT, TOUCHING, OFFSET_SLIGHTLY.

toString

public java.lang.String toString()

Returns string as "(horizontal:value, vertical:value, proximity:value)"

Overrides:

toString in class java.lang.Object