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

Class StandardCategoryItemLabelGenerator

Implemented Interfaces:
CategoryItemLabelGenerator, Cloneable, PublicCloneable, Serializable
Known Direct Subclasses:
IntervalCategoryItemLabelGenerator
public class StandardCategoryItemLabelGenerator
extends AbstractCategoryItemLabelGenerator
implements CategoryItemLabelGenerator, Cloneable, PublicCloneable, Serializable
A standard label generator that can be used with a CategoryItemRenderer.

Field Summary

static String
DEFAULT_LABEL_FORMAT_STRING
The default format string.

Constructor Summary

StandardCategoryItemLabelGenerator()
Creates a new generator with a default number formatter.
StandardCategoryItemLabelGenerator(String labelFormat, DateFormat formatter)
Creates a new generator with the specified date formatter.
StandardCategoryItemLabelGenerator(String labelFormat, NumberFormat formatter)
Creates a new generator with the specified number formatter.
StandardCategoryItemLabelGenerator(String labelFormat, NumberFormat formatter, NumberFormat percentFormatter)
Creates a new generator with the specified number formatter.

Method Summary

boolean
equals(Object obj)
Tests this generator for equality with an arbitrary object.
String
generateLabel(CategoryDataset dataset, int row, int column)
Generates the label for an item in a dataset.

Methods inherited from class org.jfree.chart.labels.AbstractCategoryItemLabelGenerator

clone, createItemArray, equals, generateColumnLabel, generateLabelString, generateRowLabel, getDateFormat, getLabelFormat, getNumberFormat

Field Details

DEFAULT_LABEL_FORMAT_STRING

public static final String DEFAULT_LABEL_FORMAT_STRING
The default format string.

Constructor Details

StandardCategoryItemLabelGenerator

public StandardCategoryItemLabelGenerator()
Creates a new generator with a default number formatter.

StandardCategoryItemLabelGenerator

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

StandardCategoryItemLabelGenerator

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

StandardCategoryItemLabelGenerator

public StandardCategoryItemLabelGenerator(String labelFormat,
                                          NumberFormat formatter,
                                          NumberFormat percentFormatter)
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).
percentFormatter - the percent formatter (null not permitted).
Since:
1.0.2

Method Details

equals

public boolean equals(Object obj)
Tests this generator for equality with an arbitrary object.
Overrides:
equals in interface AbstractCategoryItemLabelGenerator
Parameters:
obj - the object (null permitted).
Returns:
true if this generator is equal to obj, and false otherwise.

generateLabel

public String generateLabel(CategoryDataset dataset,
                            int row,
                            int column)
Generates the label 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.
Specified by:
generateLabel in interface CategoryItemLabelGenerator
Parameters:
dataset - the dataset (null not permitted).
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The label (possibly null).

Overview Package Class Use Source Tree Index Deprecated About