com.bonzaiengine.font

Enum Anchor

java.lang.Object

java.lang.Enum<Anchor>

com.bonzaiengine.font.Anchor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Anchor>

public enum Anchor
extends java.lang.Enum<Anchor>

Anchor enumeration used to position text (or objects).

Enum Constant Summary

Enum Constants

Enum Constant and Description
BotCenter
BotLeft
BotRight
Center
Left
Right
TopCenter
TopLeft
TopRight

Method Summary

Modifier and Type	Method and Description
void	getCenteringOffset(Vec2 dst, Size area, Size contents)
void	getPositioningOffset(Vec2 dst, int w, int h)
void	getPositioningOffset(Vec2 dst, Size size)
boolean	isBotAlign()
boolean	isLeftAlign()
boolean	isRightAlign()
boolean	isTopAlign()
static Anchor	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Anchor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TopLeft

public static final Anchor TopLeft

TopCenter

public static final Anchor TopCenter

TopRight

public static final Anchor TopRight

Left

public static final Anchor Left

Center

public static final Anchor Center

Right

public static final Anchor Right

BotLeft

public static final Anchor BotLeft

BotCenter

public static final Anchor BotCenter

BotRight

public static final Anchor BotRight

Method Detail

values

public static Anchor[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Anchor c : Anchor.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Anchor valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isTopAlign

public boolean isTopAlign()

isBotAlign

public boolean isBotAlign()

isLeftAlign

public boolean isLeftAlign()

isRightAlign

public boolean isRightAlign()

getCenteringOffset

public void getCenteringOffset(Vec2 dst,
                               Size area,
                               Size contents)

getPositioningOffset

public final void getPositioningOffset(Vec2 dst,
                                       Size size)

getPositioningOffset

public void getPositioningOffset(Vec2 dst,
                                 int w,
                                 int h)