Module org.jfree.chart

Package org.jfree.chart.title

Class CompositeTitle

java.lang.Object

org.jfree.chart.block.AbstractBlock

org.jfree.chart.title.Title

org.jfree.chart.title.CompositeTitle

All Implemented Interfaces:

Serializable, Cloneable, org.jfree.chart.block.Block, ChartElement, Drawable

public class CompositeTitle
extends Title
implements Cloneable, Serializable

A title that contains multiple titles within a BlockContainer.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jfree.chart.title.Title

DEFAULT_HORIZONTAL_ALIGNMENT, DEFAULT_PADDING, DEFAULT_POSITION, DEFAULT_VERTICAL_ALIGNMENT, visible

Constructor Summary

Constructors

Constructor	Description
CompositeTitle()	Creates a new composite title with a default border arrangement.
CompositeTitle(org.jfree.chart.block.BlockContainer container)	Creates a new title using the specified container.

Method Summary

Modifier and Type	Method	Description
org.jfree.chart.block.Size2D	arrange(Graphics2D g2, org.jfree.chart.block.RectangleConstraint constraint)	Arranges the contents of the block, within the given constraints, and returns the block size.
void	draw(Graphics2D g2, Rectangle2D area)	Draws the title on a Java 2D graphics device (such as the screen or a printer).
Object	draw(Graphics2D g2, Rectangle2D area, Object params)	Draws the block within the specified area.
boolean	equals(Object obj)	Tests this title for equality with an arbitrary object.
Paint	getBackgroundPaint()	Returns the background paint.
org.jfree.chart.block.BlockContainer	getContainer()	Returns the container holding the titles.
void	receive(ChartElementVisitor visitor)	Receives a chart element visitor.
void	setBackgroundPaint(Paint paint)	Sets the background paint and sends a TitleChangeEvent to all registered listeners.
void	setTitleContainer(org.jfree.chart.block.BlockContainer container)	Sets the title container.

Methods inherited from class org.jfree.chart.title.Title

addChangeListener, clone, getHorizontalAlignment, getNotify, getPosition, getVerticalAlignment, hashCode, isVisible, notifyListeners, removeChangeListener, setHorizontalAlignment, setNotify, setPosition, setVerticalAlignment, setVisible

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

arrange, calculateTotalHeight, calculateTotalWidth, drawBorder, getBounds, getContentXOffset, getContentYOffset, getFrame, getHeight, getID, getMargin, getPadding, getWidth, 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, notify, notifyAll, toString, wait, wait, wait

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

arrange, getBounds, getID, setBounds, setID

Constructor Detail

CompositeTitle

public CompositeTitle()

Creates a new composite title with a default border arrangement.

CompositeTitle

public CompositeTitle(org.jfree.chart.block.BlockContainer container)

Creates a new title using the specified container.

Parameters:

container - the container (null not permitted).

Method Detail

getBackgroundPaint

public Paint getBackgroundPaint()

Returns the background paint.

Returns:

The paint (possibly null).

setBackgroundPaint

public void setBackgroundPaint(Paint paint)

Sets the background paint and sends a TitleChangeEvent to all registered listeners. If you set this attribute to null, no background is painted (which makes the title background transparent).

Parameters:

paint - the background paint (null permitted).

getContainer

public org.jfree.chart.block.BlockContainer getContainer()

Returns the container holding the titles.

Returns:

The title container (never null).

setTitleContainer

public void setTitleContainer(org.jfree.chart.block.BlockContainer container)

Sets the title container.

Parameters:

container - the container (null not permitted).

arrange

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

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

Specified by:

arrange in interface org.jfree.chart.block.Block

Overrides:

arrange in class org.jfree.chart.block.AbstractBlock

Parameters:

g2 - the graphics device.

constraint - the constraint (null not permitted).

Returns:

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

receive

public void receive(ChartElementVisitor visitor)

Receives a chart element visitor.

Specified by:

receive in interface ChartElement

Overrides:

receive in class Title

Parameters:

visitor - the visitor (null not permitted).

draw

public void draw(Graphics2D g2,
                 Rectangle2D area)

Draws the title on a Java 2D graphics device (such as the screen or a printer).

Specified by:

draw in interface Drawable

Specified by:

draw in class Title

Parameters:

g2 - the graphics device.

area - the area allocated for the title.

draw

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

Draws the block within the specified area.

Specified by:

draw in interface org.jfree.chart.block.Block

Parameters:

g2 - the graphics device.

area - the area.

params - ignored (null permitted).

Returns:

Always null.

equals

public boolean equals(Object obj)

Tests this title for equality with an arbitrary object.

Overrides:

equals in class Title

Parameters:

obj - the object (null permitted).

Returns:

A boolean.