org.jfree.chart.entity

Class XYAnnotationEntity

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable

public class XYAnnotationEntity
extends ChartEntity
implements Serializable

A chart entity that represents an annotation on an XYPlot.

Constructor Summary

XYAnnotationEntity(Shape hotspot, int rendererIndex, String toolTipText, String urlText)
Creates a new entity.

Method Summary

boolean
equals(Object obj)
Tests the entity for equality with an arbitrary object.
int
getRendererIndex()
Returns the renderer index.
void
setRendererIndex(int index)
Sets the renderer index.

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

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

Constructor Details

XYAnnotationEntity

public XYAnnotationEntity(Shape hotspot,
                          int rendererIndex,
                          String toolTipText,
                          String urlText)
Creates a new entity.
Parameters:
hotspot - the area.
rendererIndex - the rendererIndex (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.

getRendererIndex

public int getRendererIndex()
Returns the renderer index.
Returns:
The renderer index.

setRendererIndex

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