org.jfree.chart.entity
Class XYItemEntity

java.lang.Object
  extended byorg.jfree.chart.entity.ChartEntity
      extended byorg.jfree.chart.entity.XYItemEntity

public class XYItemEntity
extends ChartEntity

A chart entity that represents one item within an XYPlot.

Author:
David Gilbert

Constructor Summary
XYItemEntity(java.awt.Shape area, java.lang.String toolTipText, int series, int item)
          Deprecated. Use alternative constructor.
XYItemEntity(java.awt.Shape area, java.lang.String toolTipText, java.lang.String urlText, int series, int item)
          Deprecated. Use alternative constructor.
XYItemEntity(java.awt.Shape area, XYDataset dataset, int series, int item, java.lang.String toolTipText, java.lang.String urlText)
          Creates a new entity.
 
Method Summary
 XYDataset getDataset()
          Returns the dataset this entity refers to.
 int getItem()
          Returns the item index.
 int getSeries()
          Returns the series index.
 void setDataset(XYDataset dataset)
          Sets the dataset this entity refers to.
 void setItem(int item)
          Sets the item index.
 void setSeries(int series)
          Sets the series index.
 
Methods inherited from class org.jfree.chart.entity.ChartEntity
getArea, getImageMapAreaTag, getShapeCoords, getShapeType, getToolTipText, getURLText, setArea, setToolTipText, setURLText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XYItemEntity

public XYItemEntity(java.awt.Shape area,
                    java.lang.String toolTipText,
                    int series,
                    int item)
Deprecated. Use alternative constructor.

Creates a new entity.

Parameters:
area - the area.
toolTipText - the tool tip text.
series - the series (zero-based index).
item - the item (zero-based index).

XYItemEntity

public XYItemEntity(java.awt.Shape area,
                    java.lang.String toolTipText,
                    java.lang.String urlText,
                    int series,
                    int item)
Deprecated. Use alternative constructor.

Creates a new entity.

Parameters:
area - the area.
toolTipText - the tool tip text.
urlText - the URL text for HTML image maps.
series - the series (zero-based index).
item - the item (zero-based index).

XYItemEntity

public XYItemEntity(java.awt.Shape area,
                    XYDataset dataset,
                    int series,
                    int item,
                    java.lang.String toolTipText,
                    java.lang.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 Detail

getDataset

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

Returns:
the dataset.

setDataset

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

Parameters:
dataset - the dataset.

getSeries

public int getSeries()
Returns the series index.

Returns:
the series index.

setSeries

public void setSeries(int series)
Sets the series index.

Parameters:
series - the series index (zero-based).

getItem

public int getItem()
Returns the item index.

Returns:
the item index.

setItem

public void setItem(int item)
Sets the item index.

Parameters:
item - the item index (zero-based).