org.jfree.chart.tooltips
Class StandardXYZToolTipGenerator

java.lang.Object
  |
  +--org.jfree.chart.tooltips.StandardXYToolTipGenerator
        |
        +--org.jfree.chart.tooltips.StandardXYZToolTipGenerator

All Implemented Interfaces:

java.io.Serializable, ToolTipGenerator, XYToolTipGenerator, XYZToolTipGenerator

public class StandardXYZToolTipGenerator

extends StandardXYToolTipGenerator

implements XYZToolTipGenerator

A standard tool tip generator for use with XYZDataset data.

Author:

David Gilbert

See Also:

Serialized Form

Constructor Summary

StandardXYZToolTipGenerator()
Creates a tool tip generator using default number formatters.

StandardXYZToolTipGenerator(java.text.NumberFormat xFormat, java.text.NumberFormat yFormat, java.text.NumberFormat zFormat)
Cnstructs a tool tip generator using the specified number formatters.

Method Summary

boolean	equals(java.lang.Object o) Tests if this object is equal to another.
java.lang.String	generateToolTip(XYZDataset data, int series, int item) Generates a tool tip text item for a particular item within a series.
java.text.NumberFormat	getZFormat() Returns the number formatter for the z-values.

Methods inherited from class org.jfree.chart.tooltips.StandardXYToolTipGenerator

generateToolTip, getXFormat, getYFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.chart.tooltips.XYToolTipGenerator

generateToolTip

Constructor Detail

StandardXYZToolTipGenerator

public StandardXYZToolTipGenerator()

Creates a tool tip generator using default number formatters.

StandardXYZToolTipGenerator

public StandardXYZToolTipGenerator(java.text.NumberFormat xFormat,
                                   java.text.NumberFormat yFormat,
                                   java.text.NumberFormat zFormat)

Cnstructs a tool tip generator using the specified number formatters.

Parameters:

xFormat - the format object for the x values.

yFormat - the format object for the y values.

zFormat - the format object for the z values.

Method Detail

getZFormat

public java.text.NumberFormat getZFormat()

Returns the number formatter for the z-values.

Returns:

the number formatter for the z-values.

generateToolTip

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

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

Specified by:

generateToolTip in interface XYZToolTipGenerator

Parameters:

data - the dataset.

series - the series index (zero-based).

item - the item index (zero-based).

Returns:

the tooltip text.

equals

public boolean equals(java.lang.Object o)

Tests if this object is equal to another.

Overrides:

equals in class StandardXYToolTipGenerator

Parameters:

o - the other object.

Returns:

A boolean.