Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.labels

Interface CategoryItemLabelGenerator

Known Implementing Classes:
IntervalCategoryItemLabelGenerator, StandardCategoryItemLabelGenerator
public interface CategoryItemLabelGenerator
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.

Method Summary

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

Method Details

generateColumnLabel

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

generateLabel

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

generateRowLabel

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

Overview Package Class Use Source Tree Index Deprecated About