Module org.jfree.chart

Package org.jfree.chart.title

Class ImageTitle

java.lang.Object

org.jfree.chart.block.AbstractBlock

org.jfree.chart.title.Title

org.jfree.chart.title.ImageTitle

All Implemented Interfaces:

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

public class ImageTitle
extends Title

A chart title that displays an image. This is useful, for example, if you have an image of your corporate logo and want to use as a footnote or part of a title in a chart you create.

ImageTitle needs an image passed to it in the constructor. For ImageTitle to work, you must have already loaded this image from its source (disk or URL). It is recommended you use something like Toolkit.getDefaultToolkit().getImage() to get the image. Then, use MediaTracker or some other message to make sure the image is fully loaded from disk.

SPECIAL NOTE: this class fails to serialize, so if you are relying on your charts to be serializable, please avoid using this class.

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
ImageTitle(Image image)	Creates a new image title.
ImageTitle(Image image, int height, int width, RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, RectangleInsets padding)	Creates a new image title with the given image scaled to the given width and height in the given location.
ImageTitle(Image image, RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)	Creates a new image title.

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.
protected org.jfree.chart.block.Size2D	drawHorizontal(Graphics2D g2, Rectangle2D chartArea)	Draws the title on a Java 2D graphics device (such as the screen or a printer).
protected org.jfree.chart.block.Size2D	drawVertical(Graphics2D g2, Rectangle2D chartArea)	Draws the title on a Java 2D graphics device (such as the screen or a printer).
boolean	equals(Object obj)	Tests this ImageTitle for equality with an arbitrary object.
Image	getImage()	Returns the image for the title.
int	hashCode()	Returns a hash code for this instance.
void	setImage(Image image)	Sets the image for the title and notifies registered listeners that the title has been modified.

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

addChangeListener, clone, getHorizontalAlignment, getNotify, getPosition, getVerticalAlignment, isVisible, notifyListeners, receive, 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

ImageTitle

public ImageTitle(Image image)

Creates a new image title.

Parameters:

image - the image (null not permitted).

ImageTitle

public ImageTitle(Image image,
                  RectangleEdge position,
                  HorizontalAlignment horizontalAlignment,
                  VerticalAlignment verticalAlignment)

Creates a new image title.

Parameters:

image - the image (null not permitted).

position - the title position.

horizontalAlignment - the horizontal alignment.

verticalAlignment - the vertical alignment.

ImageTitle

public ImageTitle(Image image,
                  int height,
                  int width,
                  RectangleEdge position,
                  HorizontalAlignment horizontalAlignment,
                  VerticalAlignment verticalAlignment,
                  RectangleInsets padding)

Creates a new image title with the given image scaled to the given width and height in the given location.

Parameters:

image - the image (null not permitted).

height - the height used to draw the image.

width - the width used to draw the image.

position - the title position.

horizontalAlignment - the horizontal alignment.

verticalAlignment - the vertical alignment.

padding - the amount of space to leave around the outside of the title.

Method Detail

getImage

public Image getImage()

Returns the image for the title.

Returns:

The image for the title (never null).

setImage

public void setImage(Image image)

Sets the image for the title and notifies registered listeners that the title has been modified.

Parameters:

image - the new image (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).

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.

drawHorizontal

protected org.jfree.chart.block.Size2D drawHorizontal(Graphics2D g2,
                                                      Rectangle2D chartArea)

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

Parameters:

g2 - the graphics device.

chartArea - the area within which the title (and plot) should be drawn.

Returns:

The size of the area used by the title.

drawVertical

protected org.jfree.chart.block.Size2D drawVertical(Graphics2D g2,
                                                    Rectangle2D chartArea)

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

Parameters:

g2 - the graphics device.

chartArea - the area within which the title (and plot) should be drawn.

Returns:

The size of the area used by the title.

draw

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.

equals

public boolean equals(Object obj)

Tests this ImageTitle for equality with an arbitrary object. Returns true if:

• obj is an instance of ImageTitle;
• obj references the same image as this ImageTitle;
• super.equals(obj) returns true;

Overrides:

equals in class Title

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class Title

Returns:

A has code.