Package org.jfree.chart.labels

Class StandardPieItemLabelGenerator

java.lang.Object
org.jfree.chart.labels.StandardPieItemLabelGenerator
All Implemented Interfaces:
Serializable, Cloneable, PieSectionLabelGenerator, PieToolTipGenerator
public class StandardPieItemLabelGenerator
extends Object
implements PieToolTipGenerator, PieSectionLabelGenerator, Cloneable, 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%).

See Also:
Serialized Form

  • Field Details

    • DEFAULT_TOOLTIP_FORMAT

      public static final String DEFAULT_TOOLTIP_FORMAT
      The default tooltip format.
      See Also:
      Constant Field Values

    • DEFAULT_SECTION_LABEL_FORMAT

      public static final String DEFAULT_SECTION_LABEL_FORMAT
      The default section label format.
      See Also:
      Constant Field Values

  • Constructor Details

    • StandardPieItemLabelGenerator

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

    • StandardPieItemLabelGenerator

      public StandardPieItemLabelGenerator​(String labelFormat)
      Creates an item label generator.
      Parameters:
      labelFormat - the label format.

    • StandardPieItemLabelGenerator

      public StandardPieItemLabelGenerator​(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

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

    • generateSectionLabel

      public String generateSectionLabel​(PieDataset dataset, Comparable key)
      Generates a label for a pie section.
      Specified by:
      generateSectionLabel in interface PieSectionLabelGenerator
      Parameters:
      dataset - the dataset (null not permitted).
      key - the section key (null not permitted).
      Returns:
      The label (possibly null).

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

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns an independent copy of the generator.
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - should not happen.