org.jfree.chart.title
Class ImageTitle
- Block, Cloneable, Drawable, Serializable
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.
ImageTitle(Image image) - Creates a new image title.
|
ImageTitle(Image image, RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment) - 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.
|
Size2D | arrange(Graphics2D g2, 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 Size2D | drawHorizontal(Graphics2D g2, Rectangle2D chartArea) - Draws the title on a Java 2D graphics device (such as the screen or a
printer).
|
protected 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.
|
void | setImage(Image image) - Sets the image for the title and notifies registered listeners that the
title has been modified.
|
addChangeListener , clone , draw , equals , getHorizontalAlignment , getNotify , getPosition , getVerticalAlignment , hashCode , notifyListeners , removeChangeListener , setHorizontalAlignment , setNotify , setPosition , setVerticalAlignment |
arrange , arrange , calculateTotalHeight , calculateTotalWidth , clone , drawBorder , equals , 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 |
ImageTitle
public ImageTitle(Image image)
Creates a new image title.
image
- the image (null
not permitted).
ImageTitle
public ImageTitle(Image image,
RectangleEdge position,
HorizontalAlignment horizontalAlignment,
VerticalAlignment verticalAlignment)
Creates a new image title.
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.
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.
arrange
public Size2D arrange(Graphics2D g2,
RectangleConstraint constraint)
Arranges the contents of the block, within the given constraints, and
returns the block size.
- arrange in interface Block
- arrange in interface AbstractBlock
g2
- the graphics device.constraint
- the constraint (null
not permitted).
- 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).
- draw in interface Title
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.
- draw in interface Block
g2
- the graphics device.area
- the area.params
- ignored (null
permitted).
drawHorizontal
protected Size2D drawHorizontal(Graphics2D g2,
Rectangle2D chartArea)
Draws the title on a Java 2D graphics device (such as the screen or a
printer).
g2
- the graphics device.chartArea
- the area within which the title (and plot) should be
drawn.
- The size of the area used by the title.
drawVertical
protected Size2D drawVertical(Graphics2D g2,
Rectangle2D chartArea)
Draws the title on a Java 2D graphics device (such as the screen or a
printer).
g2
- the graphics device.chartArea
- the area within which the title (and plot) should be
drawn.
- The size of the area used by the title.
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
;
- equals in interface Title
obj
- the object (null
permitted).
getImage
public Image getImage()
Returns the image for the title.
- 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.
image
- the new image (null
not permitted).