org.jfree.text

Class TextLine

Implemented Interfaces:
Serializable

public class TextLine
extends java.lang.Object
implements Serializable

A sequence of TextFragment objects that together form a line of text. A sequence of text lines is managed by the TextBlock class.
Author:
David Gilbert

Field Summary

protected static LogContext
logger
Access to logging facilities.

Constructor Summary

TextLine()
Creates a new empty line.
TextLine(String text)
Creates a new text line using the default font.
TextLine(String text, Font font)
Creates a new text line.
TextLine(String text, Font font, Paint paint)
Creates a new text line.

Method Summary

void
addFragment(TextFragment fragment)
Adds a text fragment to the text line.
Size2D
calculateDimensions(Graphics2D g2)
Calculates the width and height of the text line.
void
draw(Graphics2D g2, float anchorX, float anchorY, TextAnchor anchor, float rotateX, float rotateY, double angle)
Draws the text line.
boolean
equals(Object obj)
Tests this object for equality with an arbitrary object.
TextFragment
getFirstTextFragment()
Returns the first text fragment in the line.
TextFragment
getLastTextFragment()
Returns the last text fragment in the line.
int
hashCode()
Returns a hash code for this object.
void
removeFragment(TextFragment fragment)
Removes a fragment from the line.

Field Details

logger

protected static final LogContext logger
Access to logging facilities.

Constructor Details

TextLine

public TextLine()
Creates a new empty line.

TextLine

public TextLine(String text)
Creates a new text line using the default font.
Parameters:
text - the text (null not permitted).

TextLine

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

TextLine

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

Method Details

addFragment

public void addFragment(TextFragment fragment)
Adds a text fragment to the text line.
Parameters:
fragment - the text fragment (null not permitted).

calculateDimensions

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

draw

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

equals

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

getFirstTextFragment

public TextFragment getFirstTextFragment()
Returns the first text fragment in the line.
Returns:
The first text fragment in the line.

getLastTextFragment

public TextFragment getLastTextFragment()
Returns the last text fragment in the line.
Returns:
The last text fragment in the line.

hashCode

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

removeFragment

public void removeFragment(TextFragment fragment)
Removes a fragment from the line.
Parameters:
fragment - the fragment to remove.