org.openimaj.image.typography

Class FontStyle<T>

java.lang.Object

org.openimaj.image.typography.FontStyle<T>

Type Parameters:

T - the pixel type

Direct Known Subclasses:

GeneralFontStyle, HersheyFontStyle, MathMLFontStyle

public class FontStyle<T>
extends Object

Base class for the representation of font styles.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FontStyle.FontStyleAttribute Attributes for styling AttributedStrings.
static class	FontStyle.HorizontalAlignment Horizontal alignment options
static class	FontStyle.VerticalAlignment Vertical alignment options

Field Summary

Fields

Modifier and Type	Field and Description
protected float	angle Angle in radians for drawing the associated text
static AttributedCharacterIterator.Attribute	ANGLE Attribute for rotating the text.
protected T	colour Stroke colour for drawing the associated text
static AttributedCharacterIterator.Attribute	COLOUR Attribute for stroke colour.
protected Font<?>	font The font
static AttributedCharacterIterator.Attribute	FONT Attribute for the font.
static AttributedCharacterIterator.Attribute	FONT_SIZE Attribute for font size.
protected int	fontSize Font size in pixels
static AttributedCharacterIterator.Attribute	HORIZONTAL_ALIGNMENT Attribute for horizontal alignment.
protected FontStyle.HorizontalAlignment	horizontalAlignment horizontal alignment of the text
protected boolean	italic should the associated text be rendered in italic?
static AttributedCharacterIterator.Attribute	ITALIC Attribute for italic text.
static AttributedCharacterIterator.Attribute	VERTICAL_ALIGNMENT Attribute for vertical alignment.
protected FontStyle.VerticalAlignment	verticalAlignment vertical alignment of the text

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FontStyle(Font<?> font, ImageRenderer<T,?> renderer)
	FontStyle(Font<?> font, T col)

Method Summary

Methods

Modifier and Type	Method and Description
float	getAngle()
T	getColour()
Font<?>	getFont()
int	getFontSize()
FontStyle.HorizontalAlignment	getHorizontalAlignment()
FontRenderer<T,FontStyle<T>>	getRenderer(ImageRenderer<T,?> renderer) Get the renderer suitable for rendering text with this style into the given image.
FontStyle.VerticalAlignment	getVerticalAlignment()
boolean	isItalic()
void	parseAttributes(Map<? extends AttributedCharacterIterator.Attribute,Object> attrs) Parse the attributes map and set this FontStyle accordingly.
static <T> FontStyle<T>	parseAttributes(Map<? extends AttributedCharacterIterator.Attribute,Object> attrs, ImageRenderer<T,?> renderer) Construct a new FontStyle from the given attribute map, suitable for rendering into the given image.
void	setAngle(float angle)
void	setColour(T colour)
void	setFont(Font<?> font)
void	setFontSize(int fontSize)
void	setHorizontalAlignment(FontStyle.HorizontalAlignment horizontalAlignment)
void	setItalic(boolean italic)
void	setVerticalAlignment(FontStyle.VerticalAlignment verticalAlignment)

Methods inherited from class java.lang.Object

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

Field Detail

FONT

public static final AttributedCharacterIterator.Attribute FONT

Attribute for the font. Value should be a Font.

ITALIC

public static final AttributedCharacterIterator.Attribute ITALIC

Attribute for italic text. Value should be Boolean.

ANGLE

public static final AttributedCharacterIterator.Attribute ANGLE

Attribute for rotating the text. Value should be a Number in radians.

COLOUR

public static final AttributedCharacterIterator.Attribute COLOUR

Attribute for stroke colour. Value should be of type .

HORIZONTAL_ALIGNMENT

public static final AttributedCharacterIterator.Attribute HORIZONTAL_ALIGNMENT

Attribute for horizontal alignment. Must be an instance of FontStyle.HorizontalAlignment

VERTICAL_ALIGNMENT

public static final AttributedCharacterIterator.Attribute VERTICAL_ALIGNMENT

Attribute for vertical alignment. Must be an instance of FontStyle.VerticalAlignment

FONT_SIZE

public static final AttributedCharacterIterator.Attribute FONT_SIZE

Attribute for font size. Must be a Number in pixels.

font

protected Font<?> font

The font

italic

protected boolean italic

should the associated text be rendered in italic?

angle

protected float angle

Angle in radians for drawing the associated text

colour

protected T colour

Stroke colour for drawing the associated text

horizontalAlignment

protected FontStyle.HorizontalAlignment horizontalAlignment

horizontal alignment of the text

verticalAlignment

protected FontStyle.VerticalAlignment verticalAlignment

vertical alignment of the text

fontSize

protected int fontSize

Font size in pixels

Constructor Detail

FontStyle

protected FontStyle(Font<?> font,
         ImageRenderer<T,?> renderer)

FontStyle

public FontStyle(Font<?> font,
         T col)

Parameters:

font -

col -

Method Detail

parseAttributes

public void parseAttributes(Map<? extends AttributedCharacterIterator.Attribute,Object> attrs)

Parse the attributes map and set this FontStyle accordingly. Subclasses should override this method to add extra attributes.

Parameters:

attrs - the attribute map

getRenderer

public FontRenderer<T,FontStyle<T>> getRenderer(ImageRenderer<T,?> renderer)

Get the renderer suitable for rendering text with this style into the given image.

Parameters:

renderer - the image renderer

Returns:

the renderer

parseAttributes

public static <T> FontStyle<T> parseAttributes(Map<? extends AttributedCharacterIterator.Attribute,Object> attrs,
                               ImageRenderer<T,?> renderer)

Construct a new FontStyle from the given attribute map, suitable for rendering into the given image.

Type Parameters:

T - the pixel type.

Parameters:

attrs - the attribute map

renderer - the image renderer

Returns:

the FontStyle

getFont

public Font<?> getFont()

Returns:

the font

setFont

public void setFont(Font<?> font)

Parameters:

font - the font to set

isItalic

public boolean isItalic()

Returns:

the italic

setItalic

public void setItalic(boolean italic)

Parameters:

italic - the italic to set

getAngle

public float getAngle()

Returns:

the angle

setAngle

public void setAngle(float angle)

Parameters:

angle - the angle to set

getColour

public T getColour()

Returns:

the colour

setColour

public void setColour(T colour)

Parameters:

colour - the colour to set

getHorizontalAlignment

public FontStyle.HorizontalAlignment getHorizontalAlignment()

Returns:

the horizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(FontStyle.HorizontalAlignment horizontalAlignment)

Parameters:

horizontalAlignment - the horizontalAlignment to set

getVerticalAlignment

public FontStyle.VerticalAlignment getVerticalAlignment()

Returns:

the verticalAlignment

setVerticalAlignment

public void setVerticalAlignment(FontStyle.VerticalAlignment verticalAlignment)

Parameters:

verticalAlignment - the verticalAlignment to set

getFontSize

public int getFontSize()

Returns:

the fontSize

setFontSize

public void setFontSize(int fontSize)

Parameters:

fontSize - the fontSize to set