public class

StandardXYZToolTipGenerator

extends StandardXYToolTipGenerator
implements Serializable XYZToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractXYItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardXYToolTipGenerator
       ↳ org.jfree.chart.labels.StandardXYZToolTipGenerator

Class Overview

A standard item label generator for use with XYZDataset data. Each value can be formatted as a number or as a date.

Summary

Constants
String DEFAULT_TOOL_TIP_FORMAT The default tooltip format.
[Expand]
Inherited Constants
From class org.jfree.chart.labels.StandardXYToolTipGenerator
Public Constructors
StandardXYZToolTipGenerator()
Creates a new tool tip generator using default number formatters for the x, y and z-values.
StandardXYZToolTipGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat, NumberFormat zFormat)
Constructs a new tool tip generator using the specified number formatters.
StandardXYZToolTipGenerator(String formatString, DateFormat xFormat, DateFormat yFormat, DateFormat zFormat)
Constructs a new tool tip generator using the specified date formatters.
Public Methods
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
String generateLabelString(XYDataset dataset, int series, int item)
Generates a label string for an item in the dataset.
String generateToolTip(XYZDataset dataset, int series, int item)
Generates a tool tip text item for a particular item within a series.
DateFormat getZDateFormat()
Returns the date formatter for the z-values.
NumberFormat getZFormat()
Returns the number formatter for the z-values.
Protected Methods
Object[] createItemArray(XYZDataset dataset, int series, int item)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
[Expand]
Inherited Methods
From class org.jfree.chart.labels.StandardXYToolTipGenerator
From class org.jfree.chart.labels.AbstractXYItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.XYToolTipGenerator
From interface org.jfree.chart.labels.XYZToolTipGenerator

Constants

public static final String DEFAULT_TOOL_TIP_FORMAT

The default tooltip format.

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

Public Constructors

public StandardXYZToolTipGenerator ()

Creates a new tool tip generator using default number formatters for the x, y and z-values.

public StandardXYZToolTipGenerator (String formatString, NumberFormat xFormat, NumberFormat yFormat, NumberFormat zFormat)

Constructs a new tool tip generator using the specified number formatters.

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

public StandardXYZToolTipGenerator (String formatString, DateFormat xFormat, DateFormat yFormat, DateFormat zFormat)

Constructs a new tool tip generator using the specified date formatters.

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

Public Methods

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 generateLabelString (XYDataset dataset, int series, int item)

Generates a label string for an item in the dataset.

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

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

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

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 DateFormat getZDateFormat ()

Returns the date formatter for the z-values.

Returns
  • The date formatter (possibly null).

public NumberFormat getZFormat ()

Returns the number formatter for the z-values.

Returns
  • The number formatter (possibly null).

Protected Methods

protected Object[] createItemArray (XYZDataset dataset, int series, int item)

Creates the array of items that can be passed to the MessageFormat class for creating labels.

Parameters
dataset the dataset (null not permitted).
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The items (never null).