org.jfree.text

Class TextBlock

public class TextBlock extends Object implements Serializable

A list of TextLine objects that form a block of text.

Author: David Gilbert

See Also:

Constructor Summary
TextBlock()
Creates a new empty text block.
Method Summary
voidaddLine(String text, Font font, Paint paint)
Adds a line of text that will be displayed using the specified font.
voidaddLine(TextLine line)
Adds a TextLine to the block.
ShapecalculateBounds(Graphics2D g2, float anchorX, float anchorY, TextBlockAnchor anchor, float rotateX, float rotateY, double angle)
Returns the bounds of the text block.
Size2DcalculateDimensions(Graphics2D g2)
Returns the width and height of the text block.
voiddraw(Graphics2D g2, float x, float y, TextBlockAnchor anchor)
Draws the text block at a specific location.
voiddraw(Graphics2D g2, float anchorX, float anchorY, TextBlockAnchor anchor, float rotateX, float rotateY, double angle)
Draws the text block, aligning it with the specified anchor point and rotating it about the specified rotation point.
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
TextLinegetLastLine()
Returns the last line in the block.
HorizontalAlignmentgetLineAlignment()
Returns the alignment of the lines of text within the block.
ListgetLines()
Returns an unmodifiable list containing the lines for the text block.
inthashCode()
Returns a hash code for this object.
voidsetLineAlignment(HorizontalAlignment alignment)
Sets the alignment of the lines of text within the block.

Constructor Detail

TextBlock

public TextBlock()
Creates a new empty text block.

Method Detail

addLine

public void addLine(String text, Font font, Paint paint)
Adds a line of text that will be displayed using the specified font.

Parameters: text the text. font the font. paint the paint.

addLine

public void addLine(TextLine line)
Adds a TextLine to the block.

Parameters: line the line.

calculateBounds

public Shape calculateBounds(Graphics2D g2, float anchorX, float anchorY, TextBlockAnchor anchor, float rotateX, float rotateY, double angle)
Returns the bounds of the text block.

Parameters: g2 the graphics device (null not permitted). anchorX the x-coordinate for the anchor point. anchorY the y-coordinate for the anchor point. anchor the text block anchor (null not permitted). rotateX the x-coordinate for the rotation point. rotateY the y-coordinate for the rotation point. angle the rotation angle.

Returns: The bounds.

calculateDimensions

public Size2D calculateDimensions(Graphics2D g2)
Returns the width and height of the text block.

Parameters: g2 the graphics device.

Returns: The width and height.

draw

public void draw(Graphics2D g2, float x, float y, TextBlockAnchor anchor)
Draws the text block at a specific location.

Parameters: g2 the graphics device. x the x-coordinate for the anchor point. y the y-coordinate for the anchor point. anchor the anchor point.

draw

public void draw(Graphics2D g2, float anchorX, float anchorY, TextBlockAnchor anchor, float rotateX, float rotateY, double angle)
Draws the text block, aligning it with the specified anchor point and rotating it about the specified rotation point.

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 block that is aligned to the anchor point. rotateX the x-coordinate for the rotation point. rotateY the x-coordinate for the rotation point. angle the rotation (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.

getLastLine

public TextLine getLastLine()
Returns the last line in the block.

Returns: The last line in the block.

getLineAlignment

public HorizontalAlignment getLineAlignment()
Returns the alignment of the lines of text within the block.

Returns: The alignment (never null).

getLines

public List getLines()
Returns an unmodifiable list containing the lines for the text block.

Returns: A list of TextLine objects.

hashCode

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

Returns: A hash code.

setLineAlignment

public void setLineAlignment(HorizontalAlignment alignment)
Sets the alignment of the lines of text within the block.

Parameters: alignment the alignment (null not permitted).