org.jfree.chart.entity

Class PieSectionEntity

public class PieSectionEntity extends ChartEntity implements Serializable

A chart entity that represents one section within a pie plot.
Constructor Summary
PieSectionEntity(Shape area, PieDataset dataset, int pieIndex, int sectionIndex, Comparable sectionKey, String toolTipText, String urlText)
Creates a new pie section entity.
Method Summary
PieDatasetgetDataset()
Returns the datset this entity refers to.
intgetPieIndex()
Returns the pie index.
intgetSectionIndex()
Returns the section index.
ComparablegetSectionKey()
Returns the section key.
voidsetDataset(PieDataset dataset)
Sets the datset this entity refers to.
voidsetPieIndex(int index)
Sets the pie index.
voidsetSectionIndex(int index)
Sets the section index.
voidsetSectionKey(Comparable key)
Sets the section key.
StringtoString()
Returns a string representing the entity.

Constructor Detail

PieSectionEntity

public PieSectionEntity(Shape area, PieDataset dataset, int pieIndex, int sectionIndex, Comparable sectionKey, String toolTipText, String urlText)
Creates a new pie section entity.

Parameters: area the area. dataset the pie dataset. pieIndex the pie index (zero-based). sectionIndex the section index (zero-based). sectionKey the section key. toolTipText the tool tip text. urlText the URL text for HTML image maps.

Method Detail

getDataset

public PieDataset getDataset()
Returns the datset this entity refers to.

Returns: The dataset.

getPieIndex

public int getPieIndex()
Returns the pie index. For a regular pie chart, the section index is 0. For a pie chart containing multiple pie plots, the pie index is the row or column index from which the pie data is extracted.

Returns: The pie index.

getSectionIndex

public int getSectionIndex()
Returns the section index.

Returns: The section index.

getSectionKey

public Comparable getSectionKey()
Returns the section key.

Returns: The section key.

setDataset

public void setDataset(PieDataset dataset)
Sets the datset this entity refers to.

Parameters: dataset the dataset.

setPieIndex

public void setPieIndex(int index)
Sets the pie index.

Parameters: index the new index value.

setSectionIndex

public void setSectionIndex(int index)
Sets the section index.

Parameters: index the section index.

setSectionKey

public void setSectionKey(Comparable key)
Sets the section key.

Parameters: key the section key.

toString

public String toString()
Returns a string representing the entity.

Returns: A string representing the entity.