org.jfree.text

Class TextFragment

Implemented Interfaces:
Serializable

public class TextFragment
extends java.lang.Object
implements Serializable

A text item, with an associated font, that fits on a single line (see TextLine). Instances of the class are immutable.
Author:
David Gilbert

Field Summary

static Font
DEFAULT_FONT
The default font.
static Paint
DEFAULT_PAINT
The default text color.
protected static LogContext
logger
Access to logging facilities.

Constructor Summary

TextFragment(String text)
Creates a new text fragment.
TextFragment(String text, Font font)
Creates a new text fragment.
TextFragment(String text, Font font, Paint paint)
Creates a new text fragment.
TextFragment(String text, Font font, Paint paint, float baselineOffset)
Creates a new text fragment.

Method Summary

float
calculateBaselineOffset(Graphics2D g2, TextAnchor anchor)
Calculates the vertical offset between the baseline and the specified text anchor.
Size2D
calculateDimensions(Graphics2D g2)
Calculates the dimensions of the text fragment.
void
draw(Graphics2D g2, float anchorX, float anchorY, TextAnchor anchor, float rotateX, float rotateY, double angle)
Draws the text fragment.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
float
getBaselineOffset()
Font
getFont()
Returns the font.
Paint
getPaint()
Returns the text paint.
String
getText()
Returns the text.
int
hashCode()
Returns a hash code for this object.

Field Details

DEFAULT_FONT

public static final Font DEFAULT_FONT
The default font.

DEFAULT_PAINT

public static final Paint DEFAULT_PAINT
The default text color.

logger

protected static final LogContext logger
Access to logging facilities.

Constructor Details

TextFragment

public TextFragment(String text)
Creates a new text fragment.
Parameters:
text - the text (null not permitted).

TextFragment

public TextFragment(String text,
                    Font font)
Creates a new text fragment.
Parameters:
text - the text (null not permitted).
font - the font (null not permitted).

TextFragment

public TextFragment(String text,
                    Font font,
                    Paint paint)
Creates a new text fragment.
Parameters:
text - the text (null not permitted).
font - the font (null not permitted).
paint - the text color (null not permitted).

TextFragment

public TextFragment(String text,
                    Font font,
                    Paint paint,
                    float baselineOffset)
Creates a new text fragment.
Parameters:
text - the text (null not permitted).
font - the font (null not permitted).
paint - the text color (null not permitted).
baselineOffset - the baseline offset.

Method Details

calculateBaselineOffset

public float calculateBaselineOffset(Graphics2D g2,
                                     TextAnchor anchor)
Calculates the vertical offset between the baseline and the specified text anchor.
Parameters:
g2 - the graphics device.
anchor - the anchor.
Returns:
the offset.

calculateDimensions

public Size2D calculateDimensions(Graphics2D g2)
Calculates the dimensions of the text fragment.
Parameters:
g2 - the graphics device.
Returns:
The width and height of the text.

draw

public void draw(Graphics2D g2,
                 float anchorX,
                 float anchorY,
                 TextAnchor anchor,
                 float rotateX,
                 float rotateY,
                 double angle)
Draws the text fragment.
Parameters:
g2 - the graphics device.
anchorX - the x-coordinate of the anchor point.
anchorY - the y-coordinate of the anchor point.
anchor - the location of the text that is aligned to the anchor point.
rotateX - the x-coordinate of the rotation point.
rotateY - the y-coordinate of the rotation point.
angle - the angle.

equals

public boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.
Parameters:
obj - the object to test against (null permitted).
Returns:
A boolean.

getBaselineOffset

public float getBaselineOffset()

getFont

public Font getFont()
Returns the font.
Returns:
The font (never null).

getPaint

public Paint getPaint()
Returns the text paint.
Returns:
The text paint (never null).

getText

public String getText()
Returns the text.
Returns:
The text (possibly null).

hashCode

public int hashCode()
Returns a hash code for this object.
Returns:
A hash code.