Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.entity

Class XYItemEntity

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable
public class XYItemEntity
extends ChartEntity
A chart entity that represents one item within an XYPlot.

Constructor Summary

XYItemEntity(Shape area, XYDataset dataset, int series, int item, String toolTipText, String urlText)
Creates a new entity.

Method Summary

boolean
equals(Object obj)
Tests the entity for equality with an arbitrary object.
XYDataset
getDataset()
Returns the dataset this entity refers to.
int
getItem()
Returns the item index.
int
getSeriesIndex()
Returns the series index.
void
setDataset(XYDataset dataset)
Sets the dataset this entity refers to.
void
setItem(int item)
Sets the item index.
void
setSeriesIndex(int series)
Sets the series index.
String
toString()
Returns a string representation of this instance, useful for debugging purposes.

Methods inherited from class org.jfree.chart.entity.ChartEntity

clone, equals, getArea, getImageMapAreaTag, getShapeCoords, getShapeType, getToolTipText, getURLText, hashCode, setArea, setToolTipText, setURLText, toString

Constructor Details

XYItemEntity

public XYItemEntity(Shape area,
                    XYDataset dataset,
                    int series,
                    int item,
                    String toolTipText,
                    String urlText)
Creates a new entity.
Parameters:
area - the area.
dataset - the dataset.
series - the series (zero-based index).
item - the item (zero-based index).
toolTipText - the tool tip text.
urlText - the URL text for HTML image maps.

Method Details

equals

public boolean equals(Object obj)
Tests the entity for equality with an arbitrary object.
Overrides:
equals in interface ChartEntity
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getDataset

public XYDataset getDataset()
Returns the dataset this entity refers to.
Returns:
The dataset.

getItem

public int getItem()
Returns the item index.
Returns:
The item index.

getSeriesIndex

public int getSeriesIndex()
Returns the series index.
Returns:
The series index.

setDataset

public void setDataset(XYDataset dataset)
Sets the dataset this entity refers to.
Parameters:
dataset - the dataset.

setItem

public void setItem(int item)
Sets the item index.
Parameters:
item - the item index (zero-based).

setSeriesIndex

public void setSeriesIndex(int series)
Sets the series index.
Parameters:
series - the series index (zero-based).

toString

public String toString()
Returns a string representation of this instance, useful for debugging purposes.
Overrides:
toString in interface ChartEntity
Returns:
A string.

Overview Package Class Use Source Tree Index Deprecated About