public class

ChartEntity

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.entity.ChartEntity
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A class that captures information about some component of a chart (a bar, line etc).

Summary

Public Constructors
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.
Public Methods
Object clone()
Returns a clone of the entity.
boolean equals(Object obj)
Tests the entity for equality with an arbitrary object.
Shape getArea()
Returns the area occupied by the entity (in Java 2D space).
String getImageMapAreaTag(ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)
Returns an HTML image map tag for this entity.
String getShapeCoords()
Returns the shape coordinates as a string.
String getShapeType()
Returns a string describing the entity area.
String getToolTipText()
Returns the tool tip text for the entity.
String getURLText()
Returns the URL text for the entity.
int hashCode()
Returns a hash code for this instance.
void setArea(Shape area)
Sets the area for the entity.
void setToolTipText(String text)
Sets the tool tip text.
void setURLText(String text)
Sets the URL text.
String toString()
Returns a string representation of the chart entity, useful for debugging.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ChartEntity (Shape area)

Creates a new chart entity.

Parameters
area the area (null not permitted).

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

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

Public Methods

public Object clone ()

Returns a clone of the entity.

Returns
  • A clone.
Throws
CloneNotSupportedException if there is a problem cloning the entity.

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.

public Shape getArea ()

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

Returns
  • The area (never null).

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.

public String getShapeCoords ()

Returns the shape coordinates as a string.

Returns
  • The shape coordinates (never null).

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

public String getToolTipText ()

Returns the tool tip text for the entity. Be aware that this text may have been generated from user supplied data, so for security reasons some form of filtering should be applied before incorporating this text into any HTML output.

Returns
  • The tool tip text (possibly null).

public String getURLText ()

Returns the URL text for the entity. Be aware that this text may have been generated from user supplied data, so some form of filtering should be applied before this "URL" is used in any output.

Returns
  • The URL text (possibly null).

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

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

public void setToolTipText (String text)

Sets the tool tip text.

Parameters
text the text (null permitted).

public void setURLText (String text)

Sets the URL text.

Parameters
text the text (null permitted).

public String toString ()

Returns a string representation of the chart entity, useful for debugging.

Returns
  • A string.