public class

StandardPieSectionLabelGenerator

extends AbstractPieItemLabelGenerator
implements Serializable Cloneable PieSectionLabelGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractPieItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardPieSectionLabelGenerator

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 The default section label format.
Public Constructors
StandardPieSectionLabelGenerator()
Creates a new section label generator using DEFAULT_SECTION_LABEL_FORMAT as the label format string, and platform default number and percentage formatters.
StandardPieSectionLabelGenerator(Locale locale)
Creates a new instance for the specified locale.
StandardPieSectionLabelGenerator(String labelFormat)
Creates a new section label generator using the specified label format string, and platform default number and percentage formatters.
StandardPieSectionLabelGenerator(String labelFormat, Locale locale)
Creates a new instance for the specified locale.
StandardPieSectionLabelGenerator(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.
boolean equals(Object obj)
Tests the generator for equality with an arbitrary object.
AttributedString generateAttributedSectionLabel(PieDataset dataset, Comparable key)
Generates an attributed label for the specified series, or null if no attributed label is available (in which case, the string returned by generateSectionLabel(PieDataset, Comparable) will provide the fallback).
String generateSectionLabel(PieDataset dataset, Comparable key)
Generates a label for a pie section.
AttributedString getAttributedLabel(int section)
Returns the attributed label for a section, or null if none is defined.
void setAttributedLabel(int section, AttributedString label)
Sets the attributed label for a section.
[Expand]
Inherited Methods
From class org.jfree.chart.labels.AbstractPieItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.PieSectionLabelGenerator

Constants

public static final String DEFAULT_SECTION_LABEL_FORMAT

The default section label format.

Constant Value: "{0}"

Public Constructors

public StandardPieSectionLabelGenerator ()

Creates a new section label generator using DEFAULT_SECTION_LABEL_FORMAT as the label format string, and platform default number and percentage formatters.

public StandardPieSectionLabelGenerator (Locale locale)

Creates a new instance for the specified locale.

Parameters
locale the local (null not permitted).

public StandardPieSectionLabelGenerator (String labelFormat)

Creates a new section label generator using the specified label format string, and platform default number and percentage formatters.

Parameters
labelFormat the label format (null not permitted).

public StandardPieSectionLabelGenerator (String labelFormat, Locale locale)

Creates a new instance for the specified locale.

Parameters
labelFormat the label format (null not permitted).
locale the local (null not permitted).

public StandardPieSectionLabelGenerator (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 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.

public AttributedString generateAttributedSectionLabel (PieDataset dataset, Comparable key)

Generates an attributed label for the specified series, or null if no attributed label is available (in which case, the string returned by generateSectionLabel(PieDataset, Comparable) will provide the fallback). Only certain attributes are recognised by the code that ultimately displays the labels:

Parameters
dataset the dataset (null not permitted).
key the key.
Returns
  • An attributed label (possibly null).

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

public AttributedString getAttributedLabel (int section)

Returns the attributed label for a section, or null if none is defined.

Parameters
section the section index.
Returns
  • The attributed label.

public void setAttributedLabel (int section, AttributedString label)

Sets the attributed label for a section.

Parameters
section the section index.
label the label (null permitted).