public interface

CategoryItemLabelGenerator

org.jfree.chart.labels.CategoryItemLabelGenerator
Known Indirect Subclasses

Class Overview

A category item label generator is an object that can be assigned to a CategoryItemRenderer and that assumes responsibility for creating text items to be used as labels for the items in a CategoryPlot.

To assist with cloning charts, classes that implement this interface should also implement the org.jfree.util.PublicCloneable interface.

Summary

Public Methods
abstract String generateColumnLabel(CategoryDataset dataset, int column)
Generates a label for the specified row.
abstract String generateLabel(CategoryDataset dataset, int row, int column)
Generates a label for the specified item.
abstract String generateRowLabel(CategoryDataset dataset, int row)
Generates a label for the specified row.

Public Methods

public abstract String generateColumnLabel (CategoryDataset dataset, int column)

Generates a label for the specified row.

Parameters
dataset the dataset (null not permitted).
column the column index (zero-based).
Returns
  • The label.

public abstract String generateLabel (CategoryDataset dataset, int row, int column)

Generates a label for the specified item. The label is typically a formatted version of the data value, but any text can be used.

Parameters
dataset the dataset (null not permitted).
row the row index (zero-based).
column the column index (zero-based).
Returns
  • The label (possibly null).

public abstract String generateRowLabel (CategoryDataset dataset, int row)

Generates a label for the specified row.

Parameters
dataset the dataset (null not permitted).
row the row index (zero-based).
Returns
  • The label.