Package org.jfree.chart.entity

Class ChartEntity

java.lang.Object
org.jfree.chart.entity.ChartEntity
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
CategoryItemEntity, ContourEntity, LegendItemEntity, PieSectionEntity, TickLabelEntity, XYItemEntity
public class ChartEntity
extends Object
implements Cloneable, Serializable
A class that captures information about some component of a chart (a bar, line etc).
See Also:
Serialized Form

  • Constructor Details

    • 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 Details

    • getArea

      public Shape getArea()
      Returns the area occupied by the entity (in Java 2D space).
      Returns:
      The area (never 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).

    • getToolTipText

      public String getToolTipText()
      Returns the tool tip text for the entity.
      Returns:
      The tool tip text (possibly null).

    • setToolTipText

      public void setToolTipText​(String text)
      Sets the tool tip text.
      Parameters:
      text - the text (null permitted).

    • getURLText

      public String getURLText()
      Returns the URL text for the entity.
      Returns:
      The URL text (possibly null).

    • setURLText

      public void setURLText​(String text)
      Sets the URL text.
      Parameters:
      text - the text (null permitted).

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

    • getShapeCoords

      public String getShapeCoords()
      Returns the shape coordinates as a string.
      Returns:
      The shape coordinates (never null).

    • getImageMapAreaTag

      public String getImageMapAreaTag​(ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)
      Returns an HTML image map tag tag for this entity.
      Parameters:
      toolTipTagFragmentGenerator - the generator for tooltip fragment.
      urlTagFragmentGenerator - the generator for the URL fragment.
      Returns:
      The HTML tag.

    • equals

      public boolean equals​(Object obj)
      Tests the entity for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to test against (null permitted).
      Returns:
      A boolean.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the entity.
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if there is a problem cloning the entity.