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 AbstractCategoryItemLabelGenerator

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable
Known Direct Subclasses:
StandardCategoryItemLabelGenerator, StandardCategoryToolTipGenerator
public abstract class AbstractCategoryItemLabelGenerator
extends java.lang.Object
implements PublicCloneable, Cloneable, Serializable
A base class that can be used to create a label or tooltip generator that can be assigned to a CategoryItemRenderer.

Constructor Summary

AbstractCategoryItemLabelGenerator(String labelFormat, DateFormat formatter)
Creates a label generator with the specified date formatter.
AbstractCategoryItemLabelGenerator(String labelFormat, NumberFormat formatter)
Creates a label generator with the specified number formatter.
AbstractCategoryItemLabelGenerator(String labelFormat, NumberFormat formatter, NumberFormat percentFormatter)
Creates a label generator with the specified number formatter.

Method Summary

Object
clone()
Returns an independent copy of the generator.
protected Object[]
createItemArray(CategoryDataset dataset, int row, int column)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
boolean
equals(Object obj)
Tests this object for equality with an arbitrary object.
String
generateColumnLabel(CategoryDataset dataset, int column)
Generates a label for the specified row.
protected String
generateLabelString(CategoryDataset dataset, int row, int column)
Generates a for the specified item.
String
generateRowLabel(CategoryDataset dataset, int row)
Generates a label for the specified row.
DateFormat
getDateFormat()
Returns the date formatter.
String
getLabelFormat()
Returns the label format string.
NumberFormat
getNumberFormat()
Returns the number formatter.

Constructor Details

AbstractCategoryItemLabelGenerator

protected AbstractCategoryItemLabelGenerator(String labelFormat,
                                             DateFormat formatter)
Creates a label generator with the specified date formatter.
Parameters:
labelFormat - the label format string (null not permitted).
formatter - the date formatter (null not permitted).

AbstractCategoryItemLabelGenerator

protected AbstractCategoryItemLabelGenerator(String labelFormat,
                                             NumberFormat formatter)
Creates a label generator with the specified number formatter.
Parameters:
labelFormat - the label format string (null not permitted).
formatter - the number formatter (null not permitted).

AbstractCategoryItemLabelGenerator

protected AbstractCategoryItemLabelGenerator(String labelFormat,
                                             NumberFormat formatter,
                                             NumberFormat percentFormatter)
Creates a label 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

clone

public Object clone()
            throws CloneNotSupportedException
Returns an independent copy of the generator.
Returns:
A clone.

createItemArray

protected Object[] createItemArray(CategoryDataset dataset,
                                   int row,
                                   int column)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
Parameters:
dataset - the dataset (null not permitted).
row - the row index (zero-based).
column - the column index (zero-based).
Returns:
The items (never null).

equals

public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
Parameters:
obj - the other object (null permitted).
Returns:
A boolean.

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.

generateLabelString

protected String generateLabelString(CategoryDataset dataset,
                                     int row,
                                     int column)
Generates a for the specified item.
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.

getDateFormat

public DateFormat getDateFormat()
Returns the date formatter.
Returns:
The date formatter (possibly null).

getLabelFormat

public String getLabelFormat()
Returns the label format string.
Returns:
The label format string (never null).

getNumberFormat

public NumberFormat getNumberFormat()
Returns the number formatter.
Returns:
The number formatter (possibly null).

Overview Package Class Use Source Tree Index Deprecated About