org.jfree.chart.labels

Class StandardCategoryToolTipGenerator

public class StandardCategoryToolTipGenerator extends AbstractCategoryItemLabelGenerator implements CategoryToolTipGenerator, Serializable

A standard tool tip generator that can be used with a CategoryItemRenderer.
Field Summary
static StringDEFAULT_TOOL_TIP_FORMAT_STRING
The default format string.
Constructor Summary
StandardCategoryToolTipGenerator()
Creates a new generator with a default number formatter.
StandardCategoryToolTipGenerator(String labelFormat, NumberFormat formatter)
Creates a new generator with the specified number formatter.
StandardCategoryToolTipGenerator(String labelFormat, DateFormat formatter)
Creates a new generator with the specified date formatter.
Method Summary
booleanequals(Object obj)
Tests this generator for equality with an arbitrary object.
StringgenerateToolTip(CategoryDataset dataset, int row, int column)
Generates the tool tip text for an item in a dataset.

Field Detail

DEFAULT_TOOL_TIP_FORMAT_STRING

public static final String DEFAULT_TOOL_TIP_FORMAT_STRING
The default format string.

Constructor Detail

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 Detail

equals

public boolean equals(Object obj)
Tests this generator for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

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.

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

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.