org.jfree.chart.entity

Class TitleEntity

public class TitleEntity extends ChartEntity

A class that captures information about a Title of a chart.

Since: 1.0.13

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

Constructor Detail

TitleEntity

public TitleEntity(Shape area, Title title)
Creates a new chart entity.

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

TitleEntity

public TitleEntity(Shape area, Title title, String toolTipText)
Creates a new chart entity.

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

TitleEntity

public TitleEntity(Shape area, Title title, String toolTipText, String urlText)
Creates a new entity.

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

getTitle

public Title getTitle()
Returns the title that occupies the entity area.

Returns: The title (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 chart entity, useful for debugging.

Returns: A string.

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