org.jfree.chart.labels
Interface CategoryItemLabelGenerator

All Known Implementing Classes:
IntervalCategoryItemLabelGenerator, StandardCategoryItemLabelGenerator

public interface CategoryItemLabelGenerator

Interface for a label (including tooltips) generator for plots that use data from a CategoryDataset.

Author:
David Gilbert

Method Summary
 java.lang.Object clone()
          Returns an independent copy of the generator.
 java.lang.String generateItemLabel(CategoryDataset data, int series, int category)
          Generates a label for an item in the dataset.
 java.lang.String generateToolTip(CategoryDataset data, int series, int category)
          Generates a tooltip text item for a particular category within a series.
 

Method Detail

generateToolTip

public java.lang.String generateToolTip(CategoryDataset data,
                                        int series,
                                        int category)
Generates a tooltip text item for a particular category within a series.

Parameters:
data - the dataset.
series - the series index (zero-based).
category - the category index (zero-based).
Returns:
The tooltip text.

generateItemLabel

public java.lang.String generateItemLabel(CategoryDataset data,
                                          int series,
                                          int category)
Generates a label for an item in the dataset. This is typically used to display a formatted value, but any text can be used.

Parameters:
data - the dataset.
series - the series index (zero-based).
category - the category index (zero-based).
Returns:
The label.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns an independent copy of the generator.

Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - if cloning is not supported.