com.f1j.paint
Interface AlignFormat

All Known Subinterfaces:

AlignFormat, AlignFormat

public interface AlignFormat

extends FormatBase

The Alignment Format interface.

Inner Class Summary

static class	AlignFormat.EHorizontal Horizontal alignment enumeration
static class	AlignFormat.EOrientation Orientation enumeration
static class	AlignFormat.EProperty Align format property enumeration
static class	AlignFormat.EVertical Vertical alignment enumeration

Field Summary

static AlignFormat.EProperty	eHorizontalAlignment Horizontal Alignment Property
static AlignFormat.EHorizontal	eHorizontalCenter Horizontal Align Center
static AlignFormat.EHorizontal	eHorizontalJustify Horizontal Align Justify
static AlignFormat.EHorizontal	eHorizontalLeft Horizontal Align Left
static AlignFormat.EHorizontal	eHorizontalRight Horizontal Align Right
static AlignFormat.EProperty	eOrientation Orientation Property
static AlignFormat.EOrientation	eOrientationClockwise Text is rotated clockwise
static AlignFormat.EOrientation	eOrientationCounterClockwise Text is rotated counter clockwise
static AlignFormat.EOrientation	eOrientationCustom Text is rotated to a custom value
static AlignFormat.EOrientation	eOrientationNone No orientation, use normal text
static AlignFormat.EOrientation	eOrientationTopToBottom Text is stacked top to bottom
static AlignFormat.EProperty	eVerticalAlignment Vertical Alignment Property
static AlignFormat.EVertical	eVerticalBottom Vertical Align Bottom
static AlignFormat.EVertical	eVerticalCenter Vertical Align Center
static AlignFormat.EVertical	eVerticalJustify Vertical Align Justify
static AlignFormat.EVertical	eVerticalTop Vertical Align Top
static AlignFormat.EProperty	eWordWrap WordWrap Property

Method Summary

AlignFormat.EHorizontal	getHorizontalAlignment() Gets the horizontal alignment.
AlignFormat.EOrientation	getOrientation() Gets the text orientation.
short	getRotation() Gets the text rotation as a custom value.
AlignFormat.EVertical	getVerticalAlignment() Gets the vertical alignment.
boolean	isWordWrap() Returns whether word wrap is enabled.
void	setHorizontalAlignment(AlignFormat.EHorizontal alignment) Sets the horizontal alignment.
void	setOrientation(AlignFormat.EOrientation orientation) Sets the orientation.
void	setRotation(short rotation) Sets the text rotation as a custom value.
void	setVerticalAlignment(AlignFormat.EVertical alignment) Sets the vertical alignment.
void	setWordWrap(boolean wrap) Sets the wordwrap attribute.

Methods inherited from interface com.f1j.util.FormatBase

isUndefined, isUndefined, isUsed, setUndefined, undefineAll, useAll

Field Detail

eHorizontalAlignment

public static final AlignFormat.EProperty eHorizontalAlignment

Horizontal Alignment Property

eOrientation

public static final AlignFormat.EProperty eOrientation

Orientation Property

eWordWrap

public static final AlignFormat.EProperty eWordWrap

WordWrap Property

eVerticalAlignment

public static final AlignFormat.EProperty eVerticalAlignment

Vertical Alignment Property

eHorizontalLeft

public static final AlignFormat.EHorizontal eHorizontalLeft

Horizontal Align Left

eHorizontalCenter

public static final AlignFormat.EHorizontal eHorizontalCenter

Horizontal Align Center

eHorizontalRight

public static final AlignFormat.EHorizontal eHorizontalRight

Horizontal Align Right

eHorizontalJustify

public static final AlignFormat.EHorizontal eHorizontalJustify

Horizontal Align Justify

eVerticalTop

public static final AlignFormat.EVertical eVerticalTop

Vertical Align Top

eVerticalCenter

public static final AlignFormat.EVertical eVerticalCenter

Vertical Align Center

eVerticalBottom

public static final AlignFormat.EVertical eVerticalBottom

Vertical Align Bottom

eVerticalJustify

public static final AlignFormat.EVertical eVerticalJustify

Vertical Align Justify

eOrientationNone

public static final AlignFormat.EOrientation eOrientationNone

No orientation, use normal text

eOrientationTopToBottom

public static final AlignFormat.EOrientation eOrientationTopToBottom

Text is stacked top to bottom

eOrientationCounterClockwise

public static final AlignFormat.EOrientation eOrientationCounterClockwise

Text is rotated counter clockwise

eOrientationClockwise

public static final AlignFormat.EOrientation eOrientationClockwise

Text is rotated clockwise

eOrientationCustom

public static final AlignFormat.EOrientation eOrientationCustom

Text is rotated to a custom value

Method Detail

getHorizontalAlignment

public AlignFormat.EHorizontal getHorizontalAlignment()

Gets the horizontal alignment.

Returns:

the EHorizontal value

getOrientation

public AlignFormat.EOrientation getOrientation()

Gets the text orientation.

Returns:

the EOrientation value

getRotation

public short getRotation()

Gets the text rotation as a custom value.

Returns:

the rotation value

getVerticalAlignment

public AlignFormat.EVertical getVerticalAlignment()

Gets the vertical alignment.

Returns:

the EVertical value

isWordWrap

public boolean isWordWrap()

Returns whether word wrap is enabled.

Returns:

boolean. true = word wrap is enabled.

See Also:

setWordWrap(boolean)

setHorizontalAlignment

public void setHorizontalAlignment(AlignFormat.EHorizontal alignment)

Sets the horizontal alignment.

Parameters:

alignment - The EHorizontal value.

setOrientation

public void setOrientation(AlignFormat.EOrientation orientation)

Sets the orientation.

Parameters:

orientation - The EOrientation value.

setRotation

public void setRotation(short rotation)
                 throws InvalidArgumentException,
                        F1Exception

Sets the text rotation as a custom value.

Parameters:

rotation - The rotation value.

setVerticalAlignment

public void setVerticalAlignment(AlignFormat.EVertical alignment)

Sets the vertical alignment.

Parameters:

alignment - The EVertical value.

setWordWrap

public void setWordWrap(boolean wrap)

Sets the wordwrap attribute.

Parameters:

wrap - boolean true or false.

See Also:

isWordWrap()