com.jrefinery.chart.tooltips
Class TimeSeriesToolTipGenerator

java.lang.Object
  |
  +--com.jrefinery.chart.tooltips.TimeSeriesToolTipGenerator
All Implemented Interfaces:
ToolTipGenerator, XYToolTipGenerator

public class TimeSeriesToolTipGenerator
extends java.lang.Object
implements XYToolTipGenerator

A standard tool tip generator for time series plots.

Author:
DG

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
 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, equals, 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.