org.jfree.chart.entity

Class PlotEntity

public class PlotEntity extends ChartEntity

A class that captures information about a plot.

Since: 1.0.13

Constructor Summary
PlotEntity(Shape area, Plot plot)
Creates a new plot entity.
PlotEntity(Shape area, Plot plot, String toolTipText)
Creates a new plot entity.
PlotEntity(Shape area, Plot plot, String toolTipText, String urlText)
Creates a new plot entity.
Method Summary
Objectclone()
Returns a clone of the entity.
booleanequals(Object obj)
Tests the entity for equality with an arbitrary object.
PlotgetPlot()
Returns the plot that occupies the entity area.
inthashCode()
Returns a hash code for this instance.
StringtoString()
Returns a string representation of the plot entity, useful for debugging.

Constructor Detail

PlotEntity

public PlotEntity(Shape area, Plot plot)
Creates a new plot entity.

Parameters: area the area (null not permitted). plot the plot (null not permitted).

PlotEntity

public PlotEntity(Shape area, Plot plot, String toolTipText)
Creates a new plot entity.

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

PlotEntity

public PlotEntity(Shape area, Plot plot, String toolTipText, String urlText)
Creates a new plot entity.

Parameters: area the area (null not permitted). plot the plot (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.

getPlot

public Plot getPlot()
Returns the plot that occupies the entity area.

Returns: The plot (never null).

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: A hash code.

toString

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

Returns: A string.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.