Package org.jfree.chart.entity

Class XYAnnotationEntity

java.lang.Object

org.jfree.chart.entity.ChartEntity

org.jfree.chart.entity.XYAnnotationEntity

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, PublicCloneable

public class XYAnnotationEntity
extends ChartEntity
implements java.io.Serializable

A chart entity that represents an annotation on an XYPlot.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private int	rendererIndex	The renderer index.
private static long	serialVersionUID	For serialization.

Constructor Summary

Constructors

Constructor	Description
XYAnnotationEntity(java.awt.Shape hotspot, int rendererIndex, java.lang.String toolTipText, java.lang.String urlText)	Creates a new entity.

Method Summary

Modifier and Type	Method	Description
boolean	canEqual(java.lang.Object other)	Ensures symmetry between super/subclass implementations of equals.
boolean	equals(java.lang.Object obj)	Tests the entity for equality with an arbitrary object.
int	getRendererIndex()	Returns the renderer index.
int	hashCode()	Returns a hash code for this instance.
void	setRendererIndex(int index)	Sets the renderer index.

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

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

For serialization.

See Also:

Constant Field Values

rendererIndex

private int rendererIndex

The renderer index.

Constructor Detail

XYAnnotationEntity

public XYAnnotationEntity(java.awt.Shape hotspot,
                          int rendererIndex,
                          java.lang.String toolTipText,
                          java.lang.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 Detail

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).

equals

public boolean equals(java.lang.Object obj)

Tests the entity for equality with an arbitrary object.

Overrides:

equals in class ChartEntity

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

canEqual

public boolean canEqual(java.lang.Object other)

Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.

Overrides:

canEqual in class ChartEntity

Parameters:

other - Object

Returns:

true ONLY if the parameter is THIS class type

hashCode

public int hashCode()

Description copied from class: ChartEntity

Returns a hash code for this instance.

Overrides:

hashCode in class ChartEntity

Returns:

A hash code.