org.jfree.chart.labels
Class StandardCategoryToolTipGenerator

java.lang.Object
  extended byorg.jfree.chart.labels.AbstractCategoryItemLabelGenerator
      extended byorg.jfree.chart.labels.StandardCategoryToolTipGenerator
All Implemented Interfaces:
CategoryToolTipGenerator, java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
BoxAndWhiskerToolTipGenerator, IntervalCategoryToolTipGenerator

public class StandardCategoryToolTipGenerator
extends AbstractCategoryItemLabelGenerator
implements CategoryToolTipGenerator

A standard tool tip generator that can be used with a CategoryItemRenderer.

See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_TOOL_TIP_FORMAT_STRING
          The default format string.
 
Constructor Summary
StandardCategoryToolTipGenerator()
          Creates a new generator with a default number formatter.
StandardCategoryToolTipGenerator(java.lang.String labelFormat, java.text.DateFormat formatter)
          Creates a new generator with the specified date formatter.
StandardCategoryToolTipGenerator(java.lang.String labelFormat, java.text.NumberFormat formatter)
          Creates a new generator with the specified number formatter.
 
Method Summary
 java.lang.String generateToolTip(CategoryDataset dataset, int row, int column)
          Generates the tool tip text for an item in a dataset.
 
Methods inherited from class org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
clone, createItemArray, equals, generateColumnLabel, generateLabelString, generateRowLabel, getDateFormat, getLabelFormat, getNumberFormat
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_TOOL_TIP_FORMAT_STRING

public static final java.lang.String DEFAULT_TOOL_TIP_FORMAT_STRING
The default format string.

See Also:
Constant Field Values
Constructor Detail

StandardCategoryToolTipGenerator

public StandardCategoryToolTipGenerator()
Creates a new generator with a default number formatter.


StandardCategoryToolTipGenerator

public StandardCategoryToolTipGenerator(java.lang.String labelFormat,
                                        java.text.NumberFormat formatter)
Creates a new generator with the specified number formatter.

Parameters:
labelFormat - the label format string (null not permitted).
formatter - the number formatter (null not permitted).

StandardCategoryToolTipGenerator

public StandardCategoryToolTipGenerator(java.lang.String labelFormat,
                                        java.text.DateFormat formatter)
Creates a new generator with the specified date formatter.

Parameters:
labelFormat - the label format string (null not permitted).
formatter - the date formatter (null not permitted).
Method Detail

generateToolTip

public java.lang.String generateToolTip(CategoryDataset dataset,
                                        int row,
                                        int column)
Generates the tool tip text for an item in a dataset. Note: in the current dataset implementation, each row is a series, and each column contains values for a particular category.

Specified by:
generateToolTip in interface CategoryToolTipGenerator
Parameters:
dataset - the dataset (null not permitted).
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The tooltip text (possibly null).