com.sharkysoft.fig.extra.shape

Class TextOutline

java.lang.Object

com.sharkysoft.fig.extra.shape.ShapeAdaptor

com.sharkysoft.fig.extra.shape.TextOutline

All Implemented Interfaces:

Shape

public class TextOutline
extends ShapeAdaptor

Text outline represented as Shape.

Details: A TextOutline is an immutable Shape that represents the outline of a string rendered in a specific font. This class also encapsulates the outline's origin and rotation.

Field Summary

Fields inherited from class com.sharkysoft.fig.extra.shape.ShapeAdaptor

mShape

Constructor Summary

Constructors

Constructor and Description
TextOutline(Font iFont, String iText, Point2D iOrigin, double iRotation) Generates text outline as TextOutline.

Method Summary

Methods

Modifier and Type	Method and Description
static Shape	createShape(Font iFont, String iText)
static Shape	createShape(Font iFont, String iText, Point2D iOrigin, double iRotation) Generates text outline as generic Shape.
Font	getFont() Returns font.
Point2D	getOrigin() Returns origin.
double	getRotation() Returns rotation.
String	getText() Returns text.

Methods inherited from class com.sharkysoft.fig.extra.shape.ShapeAdaptor

contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, intersects, intersects

Methods inherited from class java.lang.Object

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

Constructor Detail

TextOutline

public TextOutline(Font iFont,
           String iText,
           Point2D iOrigin,
           double iRotation)

Generates text outline as TextOutline.

Details: Use this constructor to generate a TextOutline representing the given text rendered with the given rendering properties. See the factory method createShape for more information on how these rendering properties are used.

Parameters:

iFont - the font to render the text in

iText - the text to render

iOrigin - the text origin

iRotation - the text origin

Method Detail

createShape

public static Shape createShape(Font iFont,
                String iText,
                Point2D iOrigin,
                double iRotation)

Generates text outline as generic Shape.

Details: getShape is a factory that generates a generic Shape representing the outline of the given text rendered in the given font. The left end of the text's baseline is the Shape's origin, which may also be given. (This value defaults to (0, 0) if null.) The text may be rotated by the given angle about the Shape's origin.

Use this factory if you do not need the generated Shape to be an instance of TextOutline. Otherwise, use the standard constructor.

Parameters:

iFont - font for text

iText - text to render

iOrigin - origin of baseline

iRotation - slant of baseline

Returns:

the render outline

createShape

public static Shape createShape(Font iFont,
                String iText)

getFont

public Font getFont()

Returns font.

Details: getFont returns the font used for this outline, which was given in the constructor.

Returns:

the font

getText

public String getText()

Returns text.

Details: getText returns the text represented by this outline, which was given in the constructor.

Returns:

the text

getOrigin

public Point2D getOrigin()

Returns origin.

Details: getOrigin returns the origin of the text, which was given in the constructor.

Returns:

the origin

getRotation

public double getRotation()

Returns rotation.

Details: getRotation returns the rotation of this outline, which was given in the constructor.

Returns:

the rotation