Class StringMetrics

java.lang.Object

org.jjazz.uiutilities.api.StringMetrics

public class StringMetrics
extends Object

Compute string metrics.

Try to cache data whenever possible.

Method Summary

Modifier and Type	Method	Description
static StringMetrics	create(Font font)	Create a StringMetrics which uses a shared Graphics2D instance from a bufferedImage.
static StringMetrics	create(Graphics2D g2)	Create a StringMetrics from g2 and g2.getFont().
static StringMetrics	create(Graphics2D g2, Font font)	Create a StringMetrics.
double	getHeight(String text)	get the height of this text, including the leading (interline space).
double	getHeightNoLeading(String text)	Get the height of this text, excluding the leading (interline space).
Rectangle2D	getLogicalBounds(String text)	Return a rectangle in baseline relative coordinates, include the leading (interline spacing).
Rectangle2D	getLogicalBoundsNoLeading(String text)	Return a rectangle in baseline relative coordinates, excluding the leading (interline spacing).
Rectangle2D	getLogicalBoundsNoLeadingNoDescent(String text)	Return a rectangle in baseline relative coordinates, excluding the descent and the leading (interline spacing).
double	getWidth(String text)

Methods inherited from class java.lang.Object

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

Method Details

create

public static StringMetrics create(Font font)

Create a StringMetrics which uses a shared Graphics2D instance from a bufferedImage.

Parameters:

font -

Returns:

Might be a cached instance.

create

public static StringMetrics create(Graphics2D g2)

Create a StringMetrics from g2 and g2.getFont().

Parameters:

g2 -

Returns:

Might be a cached instance.

create

public static StringMetrics create(Graphics2D g2,
 Font font)

Create a StringMetrics.

Parameters:

g2 -

font -

Returns:

Might be a cached instance.

getLogicalBounds

public Rectangle2D getLogicalBounds(String text)

Return a rectangle in baseline relative coordinates, include the leading (interline spacing).

If this method is called several times in a row with the same text, the cached result is returned.

Parameters:

text -

Returns:

getLogicalBoundsNoLeading

public Rectangle2D getLogicalBoundsNoLeading(String text)

Return a rectangle in baseline relative coordinates, excluding the leading (interline spacing).

If this method is called several times in a row with the same text, the cached result is returned.

Parameters:

text -

Returns:

getLogicalBoundsNoLeadingNoDescent

public Rectangle2D getLogicalBoundsNoLeadingNoDescent(String text)

Return a rectangle in baseline relative coordinates, excluding the descent and the leading (interline spacing).

See LineMetrics or FontMetrics for more info about descent/leading.

If this method is called several times in a row with the same text, the cached result is returned.

Parameters:

text -

Returns:

getWidth

public double getWidth(String text)

getHeight

public double getHeight(String text)

get the height of this text, including the leading (interline space).

Parameters:

text -

Returns:

getHeightNoLeading

public double getHeightNoLeading(String text)

Get the height of this text, excluding the leading (interline space).

Parameters:

text -

Returns: