org.jfree.chart.entity

Class JFreeChartEntity

java.lang.Object

org.jfree.chart.entity.ChartEntity

org.jfree.chart.entity.JFreeChartEntity

All Implemented Interfaces:

Serializable, Cloneable, org.jfree.util.PublicCloneable

public class JFreeChartEntity
extends ChartEntity

A class that captures information about an entire chart.

Since:

1.0.13

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JFreeChartEntity(Shape area, JFreeChart chart) Creates a new chart entity.
JFreeChartEntity(Shape area, JFreeChart chart, String toolTipText) Creates a new chart entity.
JFreeChartEntity(Shape area, JFreeChart chart, String toolTipText, String urlText) Creates a new chart entity.

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a clone of the entity.
boolean	equals(Object obj) Tests the entity for equality with an arbitrary object.
JFreeChart	getChart() Returns the chart that occupies the entity area.
int	hashCode() Returns a hash code for this instance.
String	toString() Returns a string representation of the chart entity, useful for debugging.

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JFreeChartEntity

public JFreeChartEntity(Shape area,
                        JFreeChart chart)

Creates a new chart entity.

Parameters:

area - the area (null not permitted).

chart - the chart (null not permitted).

JFreeChartEntity

public JFreeChartEntity(Shape area,
                        JFreeChart chart,
                        String toolTipText)

Creates a new chart entity.

Parameters:

area - the area (null not permitted).

chart - the chart (null not permitted).

toolTipText - the tool tip text (null permitted).

JFreeChartEntity

public JFreeChartEntity(Shape area,
                        JFreeChart chart,
                        String toolTipText,
                        String urlText)

Creates a new chart entity.

Parameters:

area - the area (null not permitted).

chart - the chart (null not permitted).

toolTipText - the tool tip text (null permitted).

urlText - the URL text for HTML image maps (null permitted).

Method Detail

getChart

public JFreeChart getChart()

Returns the chart that occupies the entity area.

Returns:

The chart (never null).

toString

public String toString()

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

Overrides:

toString in class ChartEntity

Returns:

A string.

equals

public boolean equals(Object obj)

Tests the entity for equality with an arbitrary object.

Overrides:

equals in class ChartEntity

Parameters:

obj - the object to test against (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class ChartEntity

Returns:

A hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the entity.

Specified by:

clone in interface org.jfree.util.PublicCloneable

Overrides:

clone in class ChartEntity

Returns:

A clone.

Throws:

CloneNotSupportedException - if there is a problem cloning the entity.