ej.microui.display

Class RenderableString

java.lang.Object

ej.microui.display.RenderableString

public class RenderableString
extends java.lang.Object

This class associates a string with a font. The string rendering is accelerated because the couple string/font is fixed.

Constructor Summary

Constructors

Constructor and Description
RenderableString(java.lang.String string, Font font) Creates a renderable string for given string and font.

Method Summary

Modifier and Type	Method and Description
void	draw(GraphicsContext gc, int x, int y, int anchor) Draws the string using the font and given graphics context color.
Font	getFont() Gets the font used to draw the string.
int	getHeight() Gets the height of a line of text with this font and its y ratio.
java.lang.String	getString() Gets the string to draw.
int	getWidth() Gets the width of the string with the font.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderableString

public RenderableString(java.lang.String string,
                        Font font)

Creates a renderable string for given string and font.

Parameters:

string - the string to render

font - the font used to render the string

Throws:

java.lang.NullPointerException - when font or string is null

java.lang.IllegalArgumentException - when string is empty

Method Detail

getString

public java.lang.String getString()

Gets the string to draw.

Returns:

the string.

getFont

public Font getFont()

Gets the font used to draw the string.

Returns:

the font.

getWidth

public int getWidth()

Gets the width of the string with the font. Same specification than Font.stringWidth(String).

Returns:

the width taken by the string.

See Also:

Font.stringWidth(String)

getHeight

public int getHeight()

Gets the height of a line of text with this font and its y ratio. Same specification than Font.getHeight().

Returns:

height of a line of text with this font.

draw

public void draw(GraphicsContext gc,
                 int x,
                 int y,
                 int anchor)

Draws the string using the font and given graphics context color. Same specification than GraphicsContext.drawString(String, int, int, int)

Parameters:

gc - the graphics context where draw the string

x - the x coordinate of the anchor point.

y - the y coordinate of the anchor point.

anchor - position of the string around the anchor point.

See Also:

GraphicsContext.drawString(String, int, int, int)