public class

StandardXYToolTipGenerator

extends AbstractXYItemLabelGenerator
implements Serializable Cloneable XYToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractXYItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardXYToolTipGenerator
Known Direct Subclasses

Class Overview

A standard tool tip generator for use with an XYItemRenderer.

Summary

Constants
String DEFAULT_TOOL_TIP_FORMAT The default tooltip format.
Public Constructors
StandardXYToolTipGenerator()
Creates a tool tip generator using default number formatters.
StandardXYToolTipGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat)
Creates a tool tip generator using the specified number formatters.
StandardXYToolTipGenerator(String formatString, DateFormat xFormat, NumberFormat yFormat)
Creates a tool tip generator using the specified number formatters.
StandardXYToolTipGenerator(String formatString, NumberFormat xFormat, DateFormat yFormat)
Creates a tool tip generator using the specified formatters (a number formatter for the x-values and a date formatter for the y-values).
StandardXYToolTipGenerator(String formatString, DateFormat xFormat, DateFormat yFormat)
Creates a tool tip generator using the specified date formatters.
Public Methods
Object clone()
Returns an independent copy of the generator.
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
String generateToolTip(XYDataset dataset, int series, int item)
Generates the tool tip text for an item in a dataset.
static StandardXYToolTipGenerator getTimeSeriesInstance()
Returns a tool tip generator that formats the x-values as dates and the y-values as numbers.
[Expand]
Inherited Methods
From class org.jfree.chart.labels.AbstractXYItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.XYToolTipGenerator

Constants

public static final String DEFAULT_TOOL_TIP_FORMAT

The default tooltip format.

Constant Value: "{0}: ({1}, {2})"

Public Constructors

public StandardXYToolTipGenerator ()

Creates a tool tip generator using default number formatters.

public StandardXYToolTipGenerator (String formatString, NumberFormat xFormat, NumberFormat yFormat)

Creates a tool tip generator using the specified number formatters.

Parameters
formatString the item label format string (null not permitted).
xFormat the format object for the x values (null not permitted).
yFormat the format object for the y values (null not permitted).

public StandardXYToolTipGenerator (String formatString, DateFormat xFormat, NumberFormat yFormat)

Creates a tool tip generator using the specified number formatters.

Parameters
formatString the label format string (null not permitted).
xFormat the format object for the x values (null not permitted).
yFormat the format object for the y values (null not permitted).

public StandardXYToolTipGenerator (String formatString, NumberFormat xFormat, DateFormat yFormat)

Creates a tool tip generator using the specified formatters (a number formatter for the x-values and a date formatter for the y-values).

Parameters
formatString the item label format string (null not permitted).
xFormat the format object for the x values (null permitted).
yFormat the format object for the y values (null not permitted).

public StandardXYToolTipGenerator (String formatString, DateFormat xFormat, DateFormat yFormat)

Creates a tool tip generator using the specified date formatters.

Parameters
formatString the label format string (null not permitted).
xFormat the format object for the x values (null not permitted).
yFormat the format object for the y values (null not permitted).

Public Methods

public Object clone ()

Returns an independent copy of the generator.

Returns
  • A clone.
Throws
CloneNotSupportedException if cloning is not supported.

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

Parameters
obj the other object (null permitted).
Returns
  • A boolean.

public String generateToolTip (XYDataset dataset, int series, int item)

Generates the tool tip text for an item in a dataset.

Parameters
dataset the dataset (null not permitted).
series the series index (zero-based).
item the item index (zero-based).
Returns
  • The tooltip text (possibly null).

public static StandardXYToolTipGenerator getTimeSeriesInstance ()

Returns a tool tip generator that formats the x-values as dates and the y-values as numbers.

Returns
  • A tool tip generator (never null).