org.jfree.chart.labels
Class StandardCategoryLabelGenerator

java.lang.Object
  extended byorg.jfree.chart.labels.AbstractCategoryItemLabelGenerator
      extended byorg.jfree.chart.labels.StandardCategoryLabelGenerator
All Implemented Interfaces:
CategoryLabelGenerator, java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
IntervalCategoryLabelGenerator

public class StandardCategoryLabelGenerator
extends AbstractCategoryItemLabelGenerator
implements CategoryLabelGenerator, java.lang.Cloneable, java.io.Serializable

A standard label generator that can be used with a CategoryItemRenderer.

See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_LABEL_FORMAT_STRING
          The default format string.
 
Constructor Summary
StandardCategoryLabelGenerator()
          Creates a new generator with a default number formatter.
StandardCategoryLabelGenerator(java.lang.String labelFormat, java.text.DateFormat formatter)
          Creates a new generator with the specified date formatter.
StandardCategoryLabelGenerator(java.lang.String labelFormat, java.text.NumberFormat formatter)
          Creates a new generator with the specified number formatter.
 
Method Summary
 java.lang.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
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jfree.chart.labels.CategoryLabelGenerator
generateColumnLabel, generateRowLabel
 

Field Detail

DEFAULT_LABEL_FORMAT_STRING

public static final java.lang.String DEFAULT_LABEL_FORMAT_STRING
The default format string.

See Also:
Constant Field Values
Constructor Detail

StandardCategoryLabelGenerator

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


StandardCategoryLabelGenerator

public StandardCategoryLabelGenerator(java.lang.String labelFormat,
                                      java.text.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).

StandardCategoryLabelGenerator

public StandardCategoryLabelGenerator(java.lang.String labelFormat,
                                      java.text.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).
Method Detail

generateLabel

public java.lang.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 CategoryLabelGenerator
Parameters:
dataset - the dataset (null not permitted).
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The label (possibly null).