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 StandardPieToolTipGenerator

Implemented Interfaces:
Cloneable, PieToolTipGenerator, PublicCloneable, Serializable
public class StandardPieToolTipGenerator
extends AbstractPieItemLabelGenerator
implements PieToolTipGenerator, Cloneable, PublicCloneable, Serializable
A standard item label generator for plots that use data from a PieDataset.

For the label format, use {0} where the pie section key should be inserted, {1} for the absolute section value and {2} for the percent amount of the pie section, e.g. "{0} = {1} ({2})" will display as apple = 120 (5%).

Field Summary

static String
DEFAULT_SECTION_LABEL_FORMAT
Deprecated. As of 1.0.7, use DEFAULT_TOOLTIP_FORMAT instead.
static String
DEFAULT_TOOLTIP_FORMAT
The default tooltip format.

Constructor Summary

StandardPieToolTipGenerator()
Creates an item label generator using default number formatters.
StandardPieToolTipGenerator(Locale locale)
Creates a pie tool tip generator for the specified locale, using the default format string.
StandardPieToolTipGenerator(String labelFormat)
Creates a pie tool tip generator for the default locale.
StandardPieToolTipGenerator(String labelFormat, Locale locale)
Creates a pie tool tip generator for the specified locale.
StandardPieToolTipGenerator(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.
String
generateToolTip(PieDataset dataset, Comparable key)
Generates a tool tip text item for one section in a pie chart.

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

clone, createItemArray, equals, generateSectionLabel, getLabelFormat, getNumberFormat, getPercentFormat, hashCode

Field Details

DEFAULT_SECTION_LABEL_FORMAT

public static final String DEFAULT_SECTION_LABEL_FORMAT

Deprecated. As of 1.0.7, use DEFAULT_TOOLTIP_FORMAT instead.

The default section label format.

DEFAULT_TOOLTIP_FORMAT

public static final String DEFAULT_TOOLTIP_FORMAT
The default tooltip format.

Constructor Details

StandardPieToolTipGenerator

public StandardPieToolTipGenerator()
Creates an item label generator using default number formatters.

StandardPieToolTipGenerator

public StandardPieToolTipGenerator(Locale locale)
Creates a pie tool tip generator for the specified locale, using the default format string.
Parameters:
locale - the locale (null not permitted).
Since:
1.0.7

StandardPieToolTipGenerator

public StandardPieToolTipGenerator(String labelFormat)
Creates a pie tool tip generator for the default locale.
Parameters:
labelFormat - the label format (null not permitted).

StandardPieToolTipGenerator

public StandardPieToolTipGenerator(String labelFormat,
                                   Locale locale)
Creates a pie tool tip generator for the specified locale.
Parameters:
labelFormat - the label format (null not permitted).
locale - the locale (null not permitted).
Since:
1.0.7

StandardPieToolTipGenerator

public StandardPieToolTipGenerator(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.
Overrides:
clone in interface AbstractPieItemLabelGenerator
Returns:
A clone.

generateToolTip

public String generateToolTip(PieDataset dataset,
                              Comparable key)
Generates a tool tip text item for one section in a pie chart.
Specified by:
generateToolTip in interface PieToolTipGenerator
Parameters:
dataset - the dataset (null not permitted).
key - the section key (null not permitted).
Returns:
The tool tip text (possibly null).

Overview Package Class Use Source Tree Index Deprecated About