org.jfree.chart.block
Class LabelBlock

java.lang.Object
  org.jfree.chart.block.AbstractBlock
      org.jfree.chart.block.LabelBlock

All Implemented Interfaces:

Serializable, Cloneable, Block, org.jfree.ui.Drawable, org.jfree.util.PublicCloneable

public class LabelBlock
extends AbstractBlock
implements Block, org.jfree.util.PublicCloneable

A block containing a label.

See Also:

Serialized Form

Field Summary

static Paint

DEFAULT_PAINT The default color.

Constructor Summary

LabelBlock(String label)
Creates a new label block.

LabelBlock(String text, Font font)
Creates a new label block.

LabelBlock(String text, Font font, Paint paint)
Creates a new label block.

Method Summary

org.jfree.ui.Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
Object	clone() Returns a clone of this LabelBlock instance.
void	draw(Graphics2D g2, Rectangle2D area) Draws the block.
Object	draw(Graphics2D g2, Rectangle2D area, Object params) Draws the block within the specified area.
boolean	equals(Object obj) Tests this LabelBlock for equality with an arbitrary object.
org.jfree.text.TextBlockAnchor	getContentAlignmentPoint() Returns the content alignment point.
Font	getFont() Returns the font.
Paint	getPaint() Returns the paint.
org.jfree.ui.RectangleAnchor	getTextAnchor() Returns the text anchor (never null).
String	getToolTipText() Returns the tool tip text.
String	getURLText() Returns the URL text.
void	setContentAlignmentPoint(org.jfree.text.TextBlockAnchor anchor) Sets the content alignment point.
void	setFont(Font font) Sets the font and regenerates the label.
void	setPaint(Paint paint) Sets the paint and regenerates the label.
void	setTextAnchor(org.jfree.ui.RectangleAnchor anchor) Sets the text anchor.
void	setToolTipText(String text) Sets the tool tip text.
void	setURLText(String text) Sets the URL text.

Methods inherited from class org.jfree.chart.block.AbstractBlock

arrange, calculateTotalHeight, calculateTotalWidth, drawBorder, getBorder, getBounds, getContentXOffset, getContentYOffset, getFrame, getHeight, getID, getMargin, getPadding, getWidth, setBorder, setBorder, setBounds, setFrame, setHeight, setID, setMargin, setMargin, setPadding, setPadding, setWidth, toContentConstraint, trimBorder, trimMargin, trimPadding, trimToContentHeight, trimToContentWidth

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.chart.block.Block

arrange, getBounds, getID, setBounds, setID

Field Detail

DEFAULT_PAINT

public static final Paint DEFAULT_PAINT

The default color.

Constructor Detail

LabelBlock

public LabelBlock(String label)

Creates a new label block.

Parameters:

label - the label (null not permitted).

LabelBlock

public LabelBlock(String text,
                  Font font)

Creates a new label block.

Parameters:

text - the text for the label (null not permitted).

font - the font (null not permitted).

LabelBlock

public LabelBlock(String text,
                  Font font,
                  Paint paint)

Creates a new label block.

Parameters:

text - the text for the label (null not permitted).

font - the font (null not permitted).

paint - the paint (null not permitted).

Method Detail

getFont

public Font getFont()

Returns the font.

Returns:

The font (never null).

See Also:

setFont(Font)

setFont

public void setFont(Font font)

Sets the font and regenerates the label.

Parameters:

font - the font (null not permitted).

See Also:

getFont()

getPaint

public Paint getPaint()

Returns the paint.

Returns:

The paint (never null).

See Also:

setPaint(Paint)

setPaint

public void setPaint(Paint paint)

Sets the paint and regenerates the label.

Parameters:

paint - the paint (null not permitted).

See Also:

getPaint()

getToolTipText

public String getToolTipText()

Returns the tool tip text.

Returns:

The tool tip text (possibly null).

See Also:

setToolTipText(String)

setToolTipText

public void setToolTipText(String text)

Sets the tool tip text.

Parameters:

text - the text (null permitted).

See Also:

getToolTipText()

getURLText

public String getURLText()

Returns the URL text.

Returns:

The URL text (possibly null).

See Also:

setURLText(String)

setURLText

public void setURLText(String text)

Sets the URL text.

Parameters:

text - the text (null permitted).

See Also:

getURLText()

getContentAlignmentPoint

public org.jfree.text.TextBlockAnchor getContentAlignmentPoint()

Returns the content alignment point.

Returns:

The content alignment point (never null).

Since:

1.0.13

setContentAlignmentPoint

public void setContentAlignmentPoint(org.jfree.text.TextBlockAnchor anchor)

Sets the content alignment point.

Parameters:

anchor - the anchor used to determine the alignment point (never null).

Since:

1.0.13

getTextAnchor

public org.jfree.ui.RectangleAnchor getTextAnchor()

Returns the text anchor (never null).

Returns:

The text anchor.

Since:

1.0.13

setTextAnchor

public void setTextAnchor(org.jfree.ui.RectangleAnchor anchor)

Sets the text anchor.

Parameters:

anchor - the anchor (null not permitted).

Since:

1.0.13

arrange

public org.jfree.ui.Size2D arrange(Graphics2D g2,
                                   RectangleConstraint constraint)

Arranges the contents of the block, within the given constraints, and returns the block size.

Specified by:

arrange in interface Block

Overrides:

arrange in class AbstractBlock

Parameters:

g2 - the graphics device.

constraint - the constraint (null not permitted).

Returns:

The block size (in Java2D units, never null).

draw

public void draw(Graphics2D g2,
                 Rectangle2D area)

Draws the block.

Specified by:

draw in interface org.jfree.ui.Drawable

Parameters:

g2 - the graphics device.

area - the area.

draw

public Object draw(Graphics2D g2,
                   Rectangle2D area,
                   Object params)

Draws the block within the specified area.

Specified by:

draw in interface Block

Parameters:

g2 - the graphics device.

area - the area.

params - ignored (null permitted).

Returns:

Always null.

equals

public boolean equals(Object obj)

Tests this LabelBlock for equality with an arbitrary object.

Overrides:

equals in class AbstractBlock

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this LabelBlock instance.

Specified by:

clone in interface org.jfree.util.PublicCloneable

Overrides:

clone in class AbstractBlock

Returns:

A clone.

Throws:

CloneNotSupportedException - if there is a problem cloning.