Summary: Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

LabelBlock

extends AbstractBlock
implements Block

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

Class Overview

A block containing a label.

Summary

Fields
public static final Paint	DEFAULT_PAINT	The default color.

Public Constructors
	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.

Public Methods
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.
Object	draw(Graphics2D g2, Rectangle2D area, Object params) Draws the block within the specified area.
void	draw(Graphics2D g2, Rectangle2D area) Draws the block.
boolean	equals(Object obj) Tests this `LabelBlock` for equality with an arbitrary object.
TextBlockAnchor	getContentAlignmentPoint() Returns the content alignment point.
Font	getFont() Returns the font.
Paint	getPaint() Returns the paint.
RectangleAnchor	getTextAnchor() Returns the text anchor (never `null`).
String	getToolTipText() Returns the tool tip text.
String	getURLText() Returns the URL text.
void	setContentAlignmentPoint(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(RectangleAnchor anchor) Sets the text anchor.
void	setToolTipText(String text) Sets the tool tip text.
void	setURLText(String text) Sets the URL text.

[Expand]

Inherited Methods

From class org.jfree.chart.block.AbstractBlock

Size2D	arrange(Graphics2D g2) Arranges the contents of the block, with no constraints, and returns the block size.
Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
double	calculateTotalHeight(double contentHeight) Adds the margin, border and padding to the specified content height.
double	calculateTotalWidth(double contentWidth) Adds the margin, border and padding to the specified content width.
Object	clone() Returns a clone of this block.
void	drawBorder(Graphics2D g2, Rectangle2D area) Draws the border around the perimeter of the specified area.
boolean	equals(Object obj) Tests this block for equality with an arbitrary object.
BlockBorder	getBorder() This method is deprecated. Use `getFrame()` instead.
Rectangle2D	getBounds() Returns the current bounds of the block.
double	getContentXOffset() Returns the x-offset for the content within the block.
double	getContentYOffset() Returns the y-offset for the content within the block.
BlockFrame	getFrame() Returns the current frame (border).
double	getHeight() Returns the natural height of the block, if this is known in advance.
String	getID() Returns the id.
RectangleInsets	getMargin() Returns the margin.
RectangleInsets	getPadding() Returns the padding.
double	getWidth() Returns the natural width of the block, if this is known in advance.
void	setBorder(BlockBorder border) This method is deprecated. Use `setFrame(BlockFrame)` instead.
void	setBorder(double top, double left, double bottom, double right) Sets a black border with the specified line widths.
void	setBounds(Rectangle2D bounds) Sets the bounds of the block.
void	setFrame(BlockFrame frame) Sets the frame (or border).
void	setHeight(double height) Sets the natural width of the block, if this is known in advance.
void	setID(String id) Sets the id for the block.
void	setMargin(RectangleInsets margin) Sets the margin (use RectangleInsets#ZERO_INSETS for no padding).
void	setMargin(double top, double left, double bottom, double right) Sets the margin.
void	setPadding(double top, double left, double bottom, double right) Sets the padding.
void	setPadding(RectangleInsets padding) Sets the padding (use RectangleInsets#ZERO_INSETS for no padding).
void	setWidth(double width) Sets the natural width of the block, if this is known in advance.
RectangleConstraint	toContentConstraint(RectangleConstraint c) Returns a constraint for the content of this block that will result in the bounds of the block matching the specified constraint.
Rectangle2D	trimBorder(Rectangle2D area) Reduces the specified area by the amount of space consumed by the border.
Rectangle2D	trimMargin(Rectangle2D area) Reduces the specified area by the amount of space consumed by the margin.
Rectangle2D	trimPadding(Rectangle2D area) Reduces the specified area by the amount of space consumed by the padding.
double	trimToContentHeight(double fixedHeight) Calculate the height available for content after subtracting the margin, border and padding space from the specified fixed height.
double	trimToContentWidth(double fixedWidth) Calculate the width available for content after subtracting the margin, border and padding space from the specified fixed width.

From class java.lang.Object

From interface org.jfree.chart.block.Block

Fields

public static final Paint DEFAULT_PAINT

The default color.

Public Constructors

public LabelBlock (String label)

Creates a new label block.

Parameters

label	the label (`null` not permitted).

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).

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).

Public Methods

public Size2D arrange (Graphics2D g2, RectangleConstraint constraint)

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

Parameters

g2	the graphics device.
constraint	the constraint (`null` not permitted).

Returns

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

public Object clone ()

Returns a clone of this LabelBlock instance.

Returns

A clone.

Throws

CloneNotSupportedException	if there is a problem cloning.

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

Draws the block within the specified area.

Parameters

g2	the graphics device.
area	the area.
params	ignored (`null` permitted).

Returns

Always null.

public void draw (Graphics2D g2, Rectangle2D area)

Draws the block.

Parameters

g2	the graphics device.
area	the area.

public boolean equals (Object obj)

Tests this LabelBlock for equality with an arbitrary object.

Parameters

obj	the object (`null` permitted).

Returns

A boolean.

public TextBlockAnchor getContentAlignmentPoint ()

Returns the content alignment point.

Returns

The content alignment point (never null).

public Font getFont ()

Returns the font.

Returns

The font (never null).

public Paint getPaint ()

Returns the paint.

Returns

The paint (never null).

public RectangleAnchor getTextAnchor ()

Returns the text anchor (never null).

Returns

The text anchor.

public String getToolTipText ()

Returns the tool tip text.

Returns

The tool tip text (possibly null).

public String getURLText ()

Returns the URL text.

Returns

The URL text (possibly null).

public void setContentAlignmentPoint (TextBlockAnchor anchor)

Sets the content alignment point.

Parameters

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

public void setFont (Font font)

Sets the font and regenerates the label.

Parameters

font	the font (`null` not permitted).

public void setPaint (Paint paint)

Sets the paint and regenerates the label.

Parameters

paint	the paint (`null` not permitted).

public void setTextAnchor (RectangleAnchor anchor)

Sets the text anchor.

Parameters

anchor	the anchor (`null` not permitted).

public void setToolTipText (String text)

Sets the tool tip text.

Parameters

text	the text (`null` permitted).

public void setURLText (String text)

Sets the URL text.

Parameters

text	the text (`null` permitted).

Interfaces

Classes

LabelBlock

Class Overview

Summary

Fields

public static final Paint DEFAULT_PAINT

Public Constructors

public LabelBlock (String label)

Parameters

public LabelBlock (String text, Font font)

Parameters

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

Parameters

Public Methods

public Size2D arrange (Graphics2D g2, RectangleConstraint constraint)

Parameters

Returns

public Object clone ()

Returns

Throws

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

Parameters

Returns

public void draw (Graphics2D g2, Rectangle2D area)

Parameters

public boolean equals (Object obj)

Parameters

Returns

public TextBlockAnchor getContentAlignmentPoint ()

Returns

public Font getFont ()

Returns

See Also

public Paint getPaint ()

Returns

See Also

public RectangleAnchor getTextAnchor ()

Returns

public String getToolTipText ()

Returns

See Also

public String getURLText ()

Returns

See Also

public void setContentAlignmentPoint (TextBlockAnchor anchor)

Parameters

public void setFont (Font font)

Parameters

See Also

public void setPaint (Paint paint)

Parameters

See Also

public void setTextAnchor (RectangleAnchor anchor)

Parameters

public void setToolTipText (String text)

Parameters

See Also

public void setURLText (String text)

Parameters

See Also