Package codedraw

Class TextFormat

java.lang.Object

codedraw.TextFormat

public final class TextFormat
extends Object

TextFormat is used to specify how CodeDraw formats, places and styles its drawn text. See also Image.drawText(double, double, String) and Image.drawText(double, double, String).

Constructor Summary

Constructors

Constructor	Description
TextFormat()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static String[]	getAllAvailableFontNames()	Creates a list of available fonts on the current system.
String	getFontName()	Defines the font of the drawn text.
int	getFontSize()	Defines the font size of the drawn text.
TextOrigin	getTextOrigin()	Defines the origin of the drawn text relative to the position specified in the Image.drawText(double, double, String) method.
Underline	getUnderline()	Defines the underline styling of the drawn text.
int	hashCode()
boolean	isBold()	Defines whether the drawn text is bold.
static boolean	isFontNameAvailable(String fontName)	Tests whether the font is available on the current system.
boolean	isItalic()	Defines whether the drawn text is italic.
boolean	isStrikethrough()	Defines whether the drawn text is strikethrough.
TextFormat	setBold(boolean isBold)	Defines whether the drawn text is bold.
TextFormat	setFontName(String fontName, String... fallbackFontNames)	Defines the font of the drawn text.
TextFormat	setFontNameToDefault()	Sets the font-name property to its default value Font.DIALOG.
TextFormat	setFontSize(int fontSize)	Defines the font size of the drawn text.
TextFormat	setItalic(boolean isItalic)	Defines whether the drawn text is italic.
TextFormat	setStrikethrough(boolean isStrikethrough)	Defines whether the drawn text is strikethrough.
TextFormat	setTextOrigin(TextOrigin textOrigin)	Defines the origin of the drawn text relative to the position specified in the Image.drawText(double, double, String) method.
TextFormat	setUnderlined(Underline underline)	Defines the underline styling of the drawn text.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TextFormat

public TextFormat()

Method Details

getTextOrigin

public TextOrigin getTextOrigin()

Defines the origin of the drawn text relative to the position specified in the Image.drawText(double, double, String) method. The default is TextOrigin.TOP_LEFT. See TextOrigin for a more detailed explanation.

Returns:

the text origin

setTextOrigin

public TextFormat setTextOrigin(TextOrigin textOrigin)

Defines the origin of the drawn text relative to the position specified in the Image.drawText(double, double, String) method. The default is TextOrigin.TOP_LEFT. See TextOrigin for a more detailed explanation.

Parameters:

textOrigin - Sets the text origin.

getFontSize

public int getFontSize()

Defines the font size of the drawn text. The default is 16.

Returns:

the font size.

setFontSize

public TextFormat setFontSize(int fontSize)

Defines the font size of the drawn text. The default is 16.

Parameters:

fontSize - Sets the font size.

getFontName

public String getFontName()

Defines the font of the drawn text. The default font is Font.DIALOG.

Returns:

the font name.

setFontName

public TextFormat setFontName(String fontName,
 String... fallbackFontNames)

Defines the font of the drawn text. If a given font is not available the next fallbackFontName will be used. If none of the fallbackFontNames are available the Font.DIALOG will be used. The default font is Font.DIALOG. To check which fonts are available you can call the static methods getAllAvailableFontNames() and isFontNameAvailable(String). The font chosen by this method can be found by calling getFontName() after setting one or several fonts.

Parameters:

fontName - Sets the font name.

fallbackFontNames - Defines alternative font names which are used in case fontName is not available.

setFontNameToDefault

public TextFormat setFontNameToDefault()

Sets the font-name property to its default value Font.DIALOG.

isBold

public boolean isBold()

Defines whether the drawn text is bold. The default is false (not bold).

Returns:

whether the drawn text is bold.

setBold

public TextFormat setBold(boolean isBold)

Defines whether the drawn text is bold. The default is false (not bold).

Parameters:

isBold - Sets whether the drawn text is bold.

isItalic

public boolean isItalic()

Defines whether the drawn text is italic. The default is false (not italic).

Returns:

whether the drawn text is italic.

setItalic

public TextFormat setItalic(boolean isItalic)

Defines whether the drawn text is italic. The default is false (not italic).

Parameters:

isItalic - Sets whether the drawn text is italic.

getUnderline

public Underline getUnderline()

Defines the underline styling of the drawn text. The default is Underline.NONE.

Returns:

the underline styling.

setUnderlined

public TextFormat setUnderlined(Underline underline)

Defines the underline styling of the drawn text. The default is Underline.NONE.

Parameters:

underline - Sets the underline styling.

isStrikethrough

public boolean isStrikethrough()

Defines whether the drawn text is strikethrough. The default is false (no strikethrough).

Returns:

whether the drawn text is strikethrough.

setStrikethrough

public TextFormat setStrikethrough(boolean isStrikethrough)

Defines whether the drawn text is strikethrough. The default is false (no strikethrough).

Parameters:

isStrikethrough - Sets whether the drawn text is strikethrough.

getAllAvailableFontNames

public static String[] getAllAvailableFontNames()

Creates a list of available fonts on the current system.

Returns:

an array of all available fonts.

isFontNameAvailable

public static boolean isFontNameAvailable(String fontName)

Tests whether the font is available on the current system. If this method returns for a given font, setFontName(String, String...) will not use the fallback fonts.

Parameters:

fontName - any font name.

Returns:

whether the font is available.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object