org.jfree.chart.tooltips
Class HighLowToolTipGenerator

java.lang.Object
  |
  +--org.jfree.chart.tooltips.HighLowToolTipGenerator
All Implemented Interfaces:
java.io.Serializable, ToolTipGenerator, XYToolTipGenerator

public class HighLowToolTipGenerator
extends java.lang.Object
implements XYToolTipGenerator, 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
 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
clone, 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.

equals

public boolean equals(java.lang.Object o)
Tests if this object is equal to another.

Overrides:
equals in class java.lang.Object
Parameters:
o - the other object.
Returns:
A boolean.