public class

ImageTitle

extends Title

java.lang.Object
↳	org.jfree.chart.block.AbstractBlock
	↳	org.jfree.chart.title.Title
		↳	org.jfree.chart.title.ImageTitle

Class Overview

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.

Summary

[Expand]

Inherited Fields

From class org.jfree.chart.title.Title

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

Public Methods
Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
Object	draw(Graphics2D g2, Rectangle2D area, Object params) Draws the block within the specified area.
void	draw(Graphics2D g2, Rectangle2D area) 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.

Protected Methods
Size2D	drawHorizontal(Graphics2D g2, Rectangle2D chartArea) Draws the title on a Java 2D graphics device (such as the screen or a printer).
Size2D	drawVertical(Graphics2D g2, Rectangle2D chartArea) Draws the title on a Java 2D graphics device (such as the screen or a printer).

[Expand]

Inherited Methods

From class org.jfree.chart.title.Title

void	addChangeListener(TitleChangeListener listener) Registers an object for notification of changes to the title.
Object	clone() Returns a clone of the title.
abstract void	draw(Graphics2D g2, Rectangle2D area) Draws the title on a Java 2D graphics device (such as the screen or a printer).
boolean	equals(Object obj) Tests an object for equality with this title.
HorizontalAlignment	getHorizontalAlignment() Returns the horizontal alignment of the title.
boolean	getNotify() Returns the flag that indicates whether or not the notification mechanism is enabled.
RectangleEdge	getPosition() Returns the position of the title.
VerticalAlignment	getVerticalAlignment() Returns the vertical alignment of the title.
int	hashCode() Returns a hashcode for the title.
boolean	isVisible() Returns a flag that controls whether or not the title should be drawn.
void	notifyListeners(TitleChangeEvent event) Notifies all registered listeners that the chart title has changed in some way.
void	removeChangeListener(TitleChangeListener listener) Unregisters an object for notification of changes to the chart title.
void	setHorizontalAlignment(HorizontalAlignment alignment) Sets the horizontal alignment for the title and sends a `TitleChangeEvent` to all registered listeners.
void	setNotify(boolean flag) Sets the flag that indicates whether or not the notification mechanism is enabled.
void	setPosition(RectangleEdge position) Sets the position for the title and sends a `TitleChangeEvent` to all registered listeners.
void	setVerticalAlignment(VerticalAlignment alignment) Sets the vertical alignment for the title, and notifies any registered listeners of the change.
void	setVisible(boolean visible) Sets a flag that controls whether or not the title should be drawn, and sends a `TitleChangeEvent` to all registered listeners.

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

Public Constructors

public ImageTitle (Image image)

Creates a new image title.

Parameters

image	the image (`null` not permitted).

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.

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.

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 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 title on a Java 2D graphics device (such as the screen or a printer).

Parameters

g2	the graphics device.
area	the area allocated for the title.

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;


  
      Parameters
      
        
          obj
          the object (null permitted).
        
      
  
  
      Returns
      A boolean.






 
    
      
        public 
         
         
         
         
        Image
      
      getImage
      ()
    
      
        


        
  

      
    
      
  Returns the image for the title.
  
      Returns
      The image for the title (never null).

  

    





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

        
      
  

    








Protected Methods





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

  

    





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

  

    










Generated by Doclava.

g2	the graphics device.
chartArea	the area within which the title (and plot) should be drawn.

Classes

ImageTitle

Class Overview

Summary

Public Constructors

public ImageTitle (Image image)

Parameters

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

Parameters

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

Parameters

Public Methods

public Size2D arrange (Graphics2D g2, RectangleConstraint constraint)

Parameters

Returns

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 Image getImage ()

Returns

public void setImage (Image image)

Parameters

Protected Methods

protected Size2D drawHorizontal (Graphics2D g2, Rectangle2D chartArea)

Parameters

Returns

protected Size2D drawVertical (Graphics2D g2, Rectangle2D chartArea)

Parameters

Returns