org.openimaj.image.typography

Class FontRenderer<T,Q extends FontStyle<T>>

java.lang.Object

org.openimaj.image.typography.FontRenderer<T,Q>

Type Parameters:

T - type of image pixels

Q - type of FontStyle

Direct Known Subclasses:

GeneralFontRenderer, MathMLFontRenderer

public abstract class FontRenderer<T,Q extends FontStyle<T>>
extends Object

The FontRenderer represents an object capable of rendering text with a given font and style to an image.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
FontRenderer()

Method Summary

Modifier and Type	Method and Description
static <T> Rectangle	getBounds(AttributedString text, ImageRenderer<T,?> imageRenderer) Calculate the bounding box of the given AttributedString.
Rectangle	getBounds(String string, int x, int y, Q sty) Calculate the bounding box of the rendered text with the given style.
abstract Rectangle	getSize(String string, Q style) Calculate the bounding box of the rendered text with the given style.
static <T> void	renderText(ImageRenderer<T,?> renderer, AttributedString text, int x, int y) Render the given AttributedString to the image starting at (x,y).
abstract void	renderText(ImageRenderer<T,?> renderer, String text, int x, int y, Q style) Render the given text string to the image starting at (x, y) with the given style.

Methods inherited from class java.lang.Object

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

Constructor Detail

FontRenderer

public FontRenderer()

Method Detail

renderText

public abstract void renderText(ImageRenderer<T,?> renderer,
                                String text,
                                int x,
                                int y,
                                Q style)

Render the given text string to the image starting at (x, y) with the given style.

Parameters:

renderer - the renderer

text - the text

x - the x-ordinate

y - the y-ordinate

style - the style

getSize

public abstract Rectangle getSize(String string,
                                  Q style)

Calculate the bounding box of the rendered text with the given style.

Parameters:

string - the text

style - the style

Returns:

the bounding box

getBounds

public Rectangle getBounds(String string,
                           int x,
                           int y,
                           Q sty)

Calculate the bounding box of the rendered text with the given style.

Parameters:

string - the text

x - the x to render the font

y - the y to render the font

sty - the style

Returns:

the bounding box

renderText

public static <T> void renderText(ImageRenderer<T,?> renderer,
                                  AttributedString text,
                                  int x,
                                  int y)

Render the given AttributedString to the image starting at (x,y).

Type Parameters:

T - the pixel type of the image

Parameters:

renderer - the image renderer

text - the text

x - the x-ordinate

y - the y-ordinate

getBounds

public static <T> Rectangle getBounds(AttributedString text,
                                      ImageRenderer<T,?> imageRenderer)

Calculate the bounding box of the given AttributedString. The image will not be modified by this call, but is used to properly configure the styles for bounds estimation.

Type Parameters:

T - the pixel type

Parameters:

text - the text

imageRenderer - the target image renderer

Returns:

the bounding box