public class

StandardCategoryItemLabelGenerator

extends AbstractCategoryItemLabelGenerator
implements Serializable Cloneable CategoryItemLabelGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardCategoryItemLabelGenerator
Known Direct Subclasses

Class Overview

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

Summary

Constants
String DEFAULT_LABEL_FORMAT_STRING The default format string.
Public Constructors
StandardCategoryItemLabelGenerator()
Creates a new generator with a default number 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.
StandardCategoryItemLabelGenerator(String labelFormat, DateFormat formatter)
Creates a new generator with the specified date formatter.
Public Methods
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.
[Expand]
Inherited Methods
From class org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.CategoryItemLabelGenerator

Constants

public static final String DEFAULT_LABEL_FORMAT_STRING

The default format string.

Constant Value: "{2}"

Public Constructors

public StandardCategoryItemLabelGenerator ()

Creates a new generator with a default number formatter.

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

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

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

Public Methods

public boolean equals (Object obj)

Tests this generator for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • true if this generator is equal to obj, and false otherwise.

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.

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