org.jfree.chart.labels
Class HighLowToolTipGenerator

java.lang.Object
  org.jfree.chart.labels.HighLowToolTipGenerator

All Implemented Interfaces:

java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable, XYToolTipGenerator

public class HighLowToolTipGenerator

extends java.lang.Object

implements XYToolTipGenerator, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable

A standard tooltip generator for plots that use data from a HighLowDataset.

Author:

David Gilbert

See Also:

Serialized Form

Constructor Summary

HighLowToolTipGenerator()
Creates a tool tip generator using the default date format.

HighLowToolTipGenerator(java.text.DateFormat formatter)
Creates a tool tip generator using the supplied date formatter.

Method Summary

java.lang.Object	clone() Returns an independent copy of the generator.
boolean	equals(java.lang.Object o) Tests if this object is equal to another.
java.lang.String	generateToolTip(XYDataset data, int series, int item) Generates a tooltip text item for a particular item within a series.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HighLowToolTipGenerator

public HighLowToolTipGenerator()

Creates a tool tip generator using the default date format.

HighLowToolTipGenerator

public HighLowToolTipGenerator(java.text.DateFormat formatter)

Creates a tool tip generator using the supplied date formatter.

Parameters:

formatter - the date formatter.

Method Detail

generateToolTip

public java.lang.String generateToolTip(XYDataset data,
                                        int series,
                                        int item)

Generates a tooltip text item for a particular item within a series.

Specified by:

generateToolTip in interface XYToolTipGenerator

Parameters:

data - the dataset.

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

the tooltip text.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns an independent copy of the generator.

Specified by:

clone in interface org.jfree.util.PublicCloneable

Returns:

A clone.

Throws:

java.lang.CloneNotSupportedException - if cloning is not supported.

equals

public boolean equals(java.lang.Object o)

Tests if this object is equal to another.

Parameters:

o - the other object.

Returns:

A boolean.