Module org.jfree.chart

Package org.jfree.chart.entity

Class AxisEntity

java.lang.Object

org.jfree.chart.entity.ChartEntity

org.jfree.chart.entity.AxisEntity

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable

public class AxisEntity
extends ChartEntity

A class that captures information about an Axis belonging to a chart.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AxisEntity(Shape area, Axis axis)	Creates a new axis entity.
AxisEntity(Shape area, Axis axis, String toolTipText)	Creates a new axis entity.
AxisEntity(Shape area, Axis axis, String toolTipText, String urlText)	Creates a new axis entity.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a clone of the entity.
boolean	equals(Object obj)	Tests the entity for equality with an arbitrary object.
Axis	getAxis()	Returns the axis 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AxisEntity

public AxisEntity(Shape area,
                  Axis axis)

Creates a new axis entity.

Parameters:

area - the area (null not permitted).

axis - the axis (null not permitted).

AxisEntity

public AxisEntity(Shape area,
                  Axis axis,
                  String toolTipText)

Creates a new axis entity.

Parameters:

area - the area (null not permitted).

axis - the axis (null not permitted).

toolTipText - the tool tip text (null permitted).

AxisEntity

public AxisEntity(Shape area,
                  Axis axis,
                  String toolTipText,
                  String urlText)

Creates a new axis entity.

Parameters:

area - the area (null not permitted).

axis - the axis (null not permitted).

toolTipText - the tool tip text (null permitted).

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

Method Detail

getAxis

public Axis getAxis()

Returns the axis that occupies the entity area.

Returns:

The axis (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 PublicCloneable

Overrides:

clone in class ChartEntity

Returns:

A clone.

Throws:

CloneNotSupportedException - if there is a problem cloning the entity.