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 AbstractPieItemLabelGenerator

Implemented Interfaces:
Serializable
Known Direct Subclasses:
StandardPieSectionLabelGenerator, StandardPieToolTipGenerator
public class AbstractPieItemLabelGenerator
extends java.lang.Object
implements Serializable
A base class used for generating pie chart item labels.

Constructor Summary

AbstractPieItemLabelGenerator(String labelFormat, NumberFormat numberFormat, NumberFormat percentFormat)
Creates an item label generator using the specified number formatters.

Method Summary

Object
clone()
Returns an independent copy of the generator.
protected Object[]
createItemArray(PieDataset dataset, Comparable key)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
boolean
equals(Object obj)
Tests the generator for equality with an arbitrary object.
protected String
generateSectionLabel(PieDataset dataset, Comparable key)
Generates a label for a pie section.
String
getLabelFormat()
Returns the label format string.
NumberFormat
getNumberFormat()
Returns the number formatter.
NumberFormat
getPercentFormat()
Returns the percent formatter.

Constructor Details

AbstractPieItemLabelGenerator

protected AbstractPieItemLabelGenerator(String labelFormat,
                                        NumberFormat numberFormat,
                                        NumberFormat percentFormat)
Creates an item label generator using the specified number formatters.
Parameters:
labelFormat - the label format string (null not permitted).
numberFormat - the format object for the values (null not permitted).
percentFormat - the format object for the percentages (null not permitted).

Method Details

clone

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

createItemArray

protected Object[] createItemArray(PieDataset dataset,
                                   Comparable key)
Creates the array of items that can be passed to the MessageFormat class for creating labels. The returned array contains four values:
  • result[0] = the section key converted to a String;
  • result[1] = the formatted data value;
  • result[2] = the formatted percentage (of the total);
  • result[3] = the formatted total value.
Parameters:
dataset - the dataset (null not permitted).
key - the key (null not permitted).
Returns:
The items (never null).

equals

public boolean equals(Object obj)
Tests the generator for equality with an arbitrary object.
Parameters:
obj - the object to test against (null permitted).
Returns:
A boolean.

generateSectionLabel

protected String generateSectionLabel(PieDataset dataset,
                                      Comparable key)
Generates a label for a pie section.
Parameters:
dataset - the dataset (null not permitted).
key - the section key (null not permitted).
Returns:
The label (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 formatter (never null).

getPercentFormat

public NumberFormat getPercentFormat()
Returns the percent formatter.
Returns:
The formatter (never null).

Overview Package Class Use Source Tree Index Deprecated About