Package org.jfree.chart.title

Class ImageTitle

java.lang.Object

org.jfree.chart.title.Title

org.jfree.chart.title.ImageTitle

All Implemented Interfaces:

Serializable, Cloneable

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

Author:

David Berry

See Also:

Serialized Form

Field Summary

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

BOTTOM, CENTER, DEFAULT_HORIZONTAL_ALIGNMENT, DEFAULT_POSITION, DEFAULT_SPACER, DEFAULT_VERTICAL_ALIGNMENT, EAST, LEFT, MIDDLE, NORTH, RIGHT, SOUTH, TOP, WEST

Constructor Summary

Constructors

Constructor	Description
ImageTitle(Image image)	Creates a new image title.
ImageTitle(Image image, int height, int width, org.jfree.ui.RectangleEdge position, org.jfree.ui.HorizontalAlignment horizontalAlignment, org.jfree.ui.VerticalAlignment verticalAlignment, org.jfree.ui.Spacer spacer)	Creates a new image title with the given image scaled to the given width and height in the given location.
ImageTitle(Image image, org.jfree.ui.RectangleEdge position, org.jfree.ui.HorizontalAlignment horizontalAlignment, org.jfree.ui.VerticalAlignment verticalAlignment)	Creates a new image title.

Method Summary

Modifier and Type	Method	Description
void	draw(Graphics2D g2, Rectangle2D titleArea)	Draws the title on a Java 2D graphics device (such as the screen or a printer).
Image	getImage()	Returns the image for the title.
float	getPreferredHeight(Graphics2D g2, float width)	Returns the preferred height of the title.
float	getPreferredWidth(Graphics2D g2, float height)	Returns the preferred width of the title.
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, equals, getHorizontalAlignment, getNotify, getPosition, getSpacer, getVerticalAlignment, hashCode, removeChangeListener, setHorizontalAlignment, setNotify, setPosition, setSpacer, setVerticalAlignment

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ImageTitle

public ImageTitle(Image image)

Creates a new image title.

Parameters:

image - the image.

ImageTitle

public ImageTitle(Image image,
org.jfree.ui.RectangleEdge position,
org.jfree.ui.HorizontalAlignment horizontalAlignment,
org.jfree.ui.VerticalAlignment verticalAlignment)

Creates a new image title.

Parameters:

image - the image.

position - the title position.

horizontalAlignment - the horizontal alignment.

verticalAlignment - the vertical alignment.

ImageTitle

public ImageTitle(Image image,
int height,
int width,
org.jfree.ui.RectangleEdge position,
org.jfree.ui.HorizontalAlignment horizontalAlignment,
org.jfree.ui.VerticalAlignment verticalAlignment,
org.jfree.ui.Spacer spacer)

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

Parameters:

image - the image (not null).

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.

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

Method Details

getImage

public Image getImage()

Returns the image for the title.

Returns:

the image for the title.

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

draw

public void draw(Graphics2D g2,
Rectangle2D titleArea)

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

Specified by:

draw in class Title

Parameters:

g2 - the graphics device.

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

getPreferredWidth

public float getPreferredWidth(Graphics2D g2,
float height)

Returns the preferred width of the title.

Specified by:

getPreferredWidth in class Title

Parameters:

g2 - the graphics device.

height - the height (ignored).

Returns:

the preferred width of the title.

getPreferredHeight

public float getPreferredHeight(Graphics2D g2,
float width)

Returns the preferred height of the title.

Specified by:

getPreferredHeight in class Title

Parameters:

g2 - the graphics device.

width - the width (ignored).

Returns:

the preferred height of the title.