org.jfree.chart.entity

Class ChartEntity

public class ChartEntity extends Object implements Cloneable, PublicCloneable, Serializable

A class that captures information about some component of a chart (a bar, line etc).
Constructor Summary
ChartEntity(Shape area)
Creates a new chart entity.
ChartEntity(Shape area, String toolTipText)
Creates a new chart entity.
ChartEntity(Shape area, String toolTipText, String urlText)
Creates a new entity.
Method Summary
Objectclone()
Returns a clone of the entity.
booleanequals(Object obj)
Tests the entity for equality with an arbitrary object.
ShapegetArea()
Returns the area occupied by the entity (in Java 2D space).
StringgetImageMapAreaTag(ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)
Returns an HTML image map tag for this entity.
StringgetShapeCoords()
Returns the shape coordinates as a string.
StringgetShapeType()
Returns a string describing the entity area.
StringgetToolTipText()
Returns the tool tip text for the entity.
StringgetURLText()
Returns the URL text for the entity.
voidsetArea(Shape area)
Sets the area for the entity.
voidsetToolTipText(String text)
Sets the tool tip text.
voidsetURLText(String text)
Sets the URL text.
StringtoString()
Returns a string representation of the chart entity, useful for debugging.

Constructor Detail

ChartEntity

public ChartEntity(Shape area)
Creates a new chart entity.

Parameters: area the area (null not permitted).

ChartEntity

public ChartEntity(Shape area, String toolTipText)
Creates a new chart entity.

Parameters: area the area (null not permitted). toolTipText the tool tip text (null permitted).

ChartEntity

public ChartEntity(Shape area, String toolTipText, String urlText)
Creates a new entity.

Parameters: area the area (null not permitted). toolTipText the tool tip text (null permitted). urlText the URL text for HTML image maps (null permitted).

Method Detail

clone

public Object clone()
Returns a clone of the entity.

Returns: A clone.

Throws: CloneNotSupportedException if there is a problem cloning the entity.

equals

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

Parameters: obj the object to test against (null permitted).

Returns: A boolean.

getArea

public Shape getArea()
Returns the area occupied by the entity (in Java 2D space).

Returns: The area (never null).

getImageMapAreaTag

public String getImageMapAreaTag(ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)
Returns an HTML image map tag for this entity. The returned fragment should be XHTML 1.0 compliant.

Parameters: toolTipTagFragmentGenerator a generator for the HTML fragment that will contain the tooltip text (null not permitted if this entity contains tooltip information). urlTagFragmentGenerator a generator for the HTML fragment that will contain the URL reference (null not permitted if this entity has a URL).

Returns: The HTML tag.

getShapeCoords

public String getShapeCoords()
Returns the shape coordinates as a string.

Returns: The shape coordinates (never null).

getShapeType

public String getShapeType()
Returns a string describing the entity area. This string is intended for use in an AREA tag when generating an image map.

Returns: The shape type (never null).

getToolTipText

public String getToolTipText()
Returns the tool tip text for the entity.

Returns: The tool tip text (possibly null).

getURLText

public String getURLText()
Returns the URL text for the entity.

Returns: The URL text (possibly null).

setArea

public void setArea(Shape area)
Sets the area for the entity.

This class conveys information about chart entities back to a client. Setting this area doesn't change the entity (which has already been drawn).

Parameters: area the area (null not permitted).

setToolTipText

public void setToolTipText(String text)
Sets the tool tip text.

Parameters: text the text (null permitted).

setURLText

public void setURLText(String text)
Sets the URL text.

Parameters: text the text (null permitted).

toString

public String toString()
Returns a string representation of the chart entity, useful for debugging.

Returns: A string.