com.hfg.graphics

Class TextUtil

java.lang.Object

com.hfg.graphics.TextUtil

public class TextUtil
extends Object

Text utility functions.

Constructor Summary

Constructors

Constructor and Description
TextUtil()

Method Summary

Modifier and Type	Method and Description
static Rectangle	getStringBaselineRect(String inString, Font inFont) Calculate the bounding rectangle for the specified string and font where the bottom of the rectangle is at the baseline and using the default of 96 ppi.
static Rectangle	getStringBaselineRect(String inString, Font inFont, DisplayPPI inPPI) Calculate the bounding rectangle for the specified string and font where the bottom of the rectangle is at the baseline.
static Rectangle	getStringRect(String inString, Font inFont) Calculate the bounding rectangle for the specified string and font using the default of 96 ppi.
static Rectangle	getStringRect(String inString, Font inFont, DisplayPPI inPPI) Calculate the bounding rectangle for the specified string and font.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextUtil

public TextUtil()

Method Detail

getStringRect

public static Rectangle getStringRect(String inString,
                                      Font inFont)

Calculate the bounding rectangle for the specified string and font using the default of 96 ppi.

Parameters:

inString - the text for which to calculate the bounding rectangle

inFont - the text for which to calculate the bounding rectangle

Returns:

the bounding rectangle for the specified text and font

getStringRect

public static Rectangle getStringRect(String inString,
                                      Font inFont,
                                      DisplayPPI inPPI)

Calculate the bounding rectangle for the specified string and font.

Parameters:

inString - the text for which to calculate the bounding rectangle

inFont - the text for which to calculate the bounding rectangle

Returns:

the bounding rectangle for the specified text and font

getStringBaselineRect

public static Rectangle getStringBaselineRect(String inString,
                                              Font inFont)

Calculate the bounding rectangle for the specified string and font where the bottom of the rectangle is at the baseline and using the default of 96 ppi. Even strings that don't contain characters that go below the baseline will still have a descent area included in the bounding rectangle if the standard getStringRect() is used.

Parameters:

inString - the text for which to calculate the bounding rectangle

inFont - the text for which to calculate the bounding rectangle

Returns:

the bounding baselined rectangle for the specified text and font

getStringBaselineRect

public static Rectangle getStringBaselineRect(String inString,
                                              Font inFont,
                                              DisplayPPI inPPI)

Calculate the bounding rectangle for the specified string and font where the bottom of the rectangle is at the baseline. Even strings that don't contain characters that go below the baseline will still have a descent area included in the bounding rectangle if the standard getStringRect() is used.

Parameters:

inString - the text for which to calculate the bounding rectangle

inFont - the text for which to calculate the bounding rectangle

inPPI - the pixels per inch of the display device

Returns:

the bounding baselined rectangle for the specified text and font