org.jfree.chart
Class LegendTitle

java.lang.Object
  |
  +--org.jfree.chart.AbstractTitle
        |
        +--org.jfree.chart.LegendTitle
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public abstract class LegendTitle
extends AbstractTitle

A chart title that displays a legend for the data in the chart.

The title can be populated with legend items manually, or you can assign a reference to the chart, in which case the legend items will be automatically created to match the dataset.

Author:
David Gilbert
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.jfree.chart.AbstractTitle
BOTTOM, CENTER, DEFAULT_HORIZONTAL_ALIGNMENT, DEFAULT_POSITION, DEFAULT_SPACER, DEFAULT_VERTICAL_ALIGNMENT, EAST, LEFT, MIDDLE, NORTH, RIGHT, SOUTH, TOP, WEST
 
Constructor Summary
LegendTitle()
          Constructs a new, empty LegendTitle.
LegendTitle(LegendItemLayout layout)
          Creates a new legend title.
 
Method Summary
 void addLegendItem(LegendItem item)
          Adds a legend item to the LegendTitle.
 void draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
          Draws the title on a Java 2D graphics device (such as the screen or a printer).
 
Methods inherited from class org.jfree.chart.AbstractTitle
addChangeListener, clone, equals, getHorizontalAlignment, getNotify, getPosition, getPreferredHeight, getPreferredWidth, getSpacer, getVerticalAlignment, isValidHorizontalAlignment, isValidPosition, isValidVerticalAlignment, notifyListeners, removeChangeListener, setHorizontalAlignment, setNotify, setPosition, setSpacer, setVerticalAlignment
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LegendTitle

public LegendTitle()
Constructs a new, empty LegendTitle.


LegendTitle

public LegendTitle(LegendItemLayout layout)
Creates a new legend title.

Parameters:
layout - the layout.
Method Detail

addLegendItem

public void addLegendItem(LegendItem item)
Adds a legend item to the LegendTitle.

Parameters:
item - the item to add.

draw

public void draw(java.awt.Graphics2D g2,
                 java.awt.geom.Rectangle2D area)
Draws the title on a Java 2D graphics device (such as the screen or a printer). Currently it does nothing.

Specified by:
draw in class AbstractTitle
Parameters:
g2 - the graphics device.
area - the area for the chart and all its titles.