public class

StandardPieToolTipGenerator

extends AbstractPieItemLabelGenerator
implements Serializable Cloneable PieToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractPieItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardPieToolTipGenerator

Class Overview

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

Summary

Constants
String DEFAULT_SECTION_LABEL_FORMAT This constant is deprecated. As of 1.0.7, use DEFAULT_TOOLTIP_FORMAT instead.
String DEFAULT_TOOLTIP_FORMAT The default tooltip format.
Public Constructors
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.
Public Methods
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.
[Expand]
Inherited Methods
From class org.jfree.chart.labels.AbstractPieItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.PieToolTipGenerator

Constants

public static final String DEFAULT_SECTION_LABEL_FORMAT

This constant is deprecated.
As of 1.0.7, use DEFAULT_TOOLTIP_FORMAT instead.

The default section label format.

Constant Value: "{0} = {1}"

public static final String DEFAULT_TOOLTIP_FORMAT

The default tooltip format.

Constant Value: "{0}: ({1}, {2})"

Public Constructors

public StandardPieToolTipGenerator ()

Creates an item label generator using default number formatters.

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

public StandardPieToolTipGenerator (String labelFormat)

Creates a pie tool tip generator for the default locale.

Parameters
labelFormat the label format (null not permitted).

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

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

Public Methods

public Object clone ()

Returns an independent copy of the generator.

Returns
  • A clone.
Throws
CloneNotSupportedException should not happen.

public String generateToolTip (PieDataset dataset, Comparable key)

Generates a tool tip text item for one section in a pie chart.

Parameters
dataset the dataset (null not permitted).
key the section key (null not permitted).
Returns
  • The tool tip text (possibly null).