public class

StandardCategoryToolTipGenerator

extends AbstractCategoryItemLabelGenerator
implements Serializable CategoryToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardCategoryToolTipGenerator
Known Direct Subclasses

Class Overview

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

Summary

Constants
String DEFAULT_TOOL_TIP_FORMAT_STRING The default format string.
Public Constructors
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.
Public Methods
boolean equals(Object obj)
Tests this generator for equality with an arbitrary object.
String generateToolTip(CategoryDataset dataset, int row, int column)
Generates the tool tip text for an item in a dataset.
[Expand]
Inherited Methods
From class org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.CategoryToolTipGenerator

Constants

public static final String DEFAULT_TOOL_TIP_FORMAT_STRING

The default format string.

Constant Value: "({0}, {1}) = {2}"

Public Constructors

public StandardCategoryToolTipGenerator ()

Creates a new generator with a default number formatter.

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

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

Public Methods

public boolean equals (Object obj)

Tests this generator for equality with an arbitrary object.

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

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