Package org.jfree.chart.labels

Class StandardCategoryToolTipGenerator

java.lang.Object

org.jfree.chart.labels.AbstractCategoryItemLabelGenerator

org.jfree.chart.labels.StandardCategoryToolTipGenerator

All Implemented Interfaces:

Serializable, Cloneable, CategoryToolTipGenerator, org.jfree.util.PublicCloneable

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

Fields

Modifier and Type	Field	Description
static String	DEFAULT_TOOL_TIP_FORMAT_STRING	The default format string.

Constructor Summary

Constructors

Constructor	Description
StandardCategoryToolTipGenerator()	Creates a new generator with a default number formatter.
StandardCategoryToolTipGenerator(String labelFormat, DateFormat formatter)	Creates a new generator with the specified date formatter.
StandardCategoryToolTipGenerator(String labelFormat, NumberFormat formatter)	Creates a new generator with the specified number formatter.

Method Summary

Modifier and Type	Method	Description
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, equals, getDateFormat, getLabelFormat, getNumberFormat

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TOOL_TIP_FORMAT_STRING

public static final String DEFAULT_TOOL_TIP_FORMAT_STRING

The default format string.

See Also:

Constant Field Values

Constructor Details

StandardCategoryToolTipGenerator

public StandardCategoryToolTipGenerator()

Creates a new generator with a default number formatter.

StandardCategoryToolTipGenerator

public StandardCategoryToolTipGenerator(String labelFormat,
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(String labelFormat,
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 Details

generateToolTip

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