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
booleanequals(Object obj)
Tests this entity for equality with an arbitrary object.
PieDatasetgetDataset()
Returns the dataset this entity refers to.
intgetPieIndex()
Returns the pie index.
intgetSectionIndex()
Returns the section index.
ComparablegetSectionKey()
Returns the section key.
inthashCode()
Returns a hash code for this instance.
voidsetDataset(PieDataset dataset)
Sets the dataset 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

equals

public boolean equals(Object obj)
Tests this entity for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getDataset

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

Returns: The dataset.

See Also: setDataset

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.

See Also: PieSectionEntity

getSectionIndex

public int getSectionIndex()
Returns the section index.

Returns: The section index.

See Also: PieSectionEntity

getSectionKey

public Comparable getSectionKey()
Returns the section key.

Returns: The section key.

See Also: setSectionKey

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: A hash code.

setDataset

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

Parameters: dataset the dataset.

See Also: getDataset

setPieIndex

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

Parameters: index the new index value.

See Also: getPieIndex

setSectionIndex

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

Parameters: index the section index.

See Also: getSectionIndex

setSectionKey

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

Parameters: key the section key.

See Also: getSectionKey

toString

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

Returns: A string representing the entity.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.