org.jfree.chart.tooltips
Class TimeSeriesToolTipGenerator

java.lang.Object
  |
  +--org.jfree.chart.tooltips.TimeSeriesToolTipGenerator

All Implemented Interfaces:

java.io.Serializable, ToolTipGenerator, XYToolTipGenerator

public class TimeSeriesToolTipGenerator

extends java.lang.Object

implements XYToolTipGenerator, java.io.Serializable

A standard tool tip generator for time series plots.

Author:

David Gilbert

See Also:

Serialized Form

Constructor Summary

TimeSeriesToolTipGenerator()
Default constructor.

TimeSeriesToolTipGenerator(java.text.DateFormat dateFormat, java.text.NumberFormat numberFormat)
Constructs a new tooltip generator using the specified number formats.

TimeSeriesToolTipGenerator(java.lang.String dateFormat, java.lang.String valueFormat)
Creates a tool tip generator with the specified date and number format strings.

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 tool tip text item for a particular item within a series.
java.text.DateFormat	getDateFormat() Returns the date formatter.
java.text.NumberFormat	getNumberFormat() Returns the number formatter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesToolTipGenerator

public TimeSeriesToolTipGenerator()

Default constructor.

TimeSeriesToolTipGenerator

public TimeSeriesToolTipGenerator(java.lang.String dateFormat,
                                  java.lang.String valueFormat)

Creates a tool tip generator with the specified date and number format strings.

Parameters:

dateFormat - the date format.

valueFormat - the value format.

TimeSeriesToolTipGenerator

public TimeSeriesToolTipGenerator(java.text.DateFormat dateFormat,
                                  java.text.NumberFormat numberFormat)

Constructs a new tooltip generator using the specified number formats.

Parameters:

dateFormat - the date formatter.

numberFormat - the number formatter.

Method Detail

getDateFormat

public java.text.DateFormat getDateFormat()

Returns the date formatter.

Returns:

the date formatter.

getNumberFormat

public java.text.NumberFormat getNumberFormat()

Returns the number formatter.

Returns:

the number formatter.

generateToolTip

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

Generates a tool tip text item for a particular item within a series.

Specified by:

generateToolTip in interface XYToolTipGenerator

Parameters:

data - the dataset.

series - the series number (zero-based index).

item - the item number (zero-based index).

Returns:

the tool tip 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.