org.jfree.chart.labels

Class StandardXYZToolTipGenerator

public class StandardXYZToolTipGenerator extends StandardXYToolTipGenerator implements XYZToolTipGenerator, Serializable

A standard item label generator for use with XYZDataset data. Each value can be formatted as a number or as a date.
Field Summary
static StringDEFAULT_TOOL_TIP_FORMAT
The default tooltip format.
Constructor Summary
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.
Method Summary
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.
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
StringgenerateLabelString(XYDataset dataset, int series, int item)
Generates a label string for an item in the dataset.
StringgenerateToolTip(XYZDataset dataset, int series, int item)
Generates a tool tip text item for a particular item within a series.
DateFormatgetZDateFormat()
Returns the date formatter for the z-values.
NumberFormatgetZFormat()
Returns the number formatter for the z-values.

Field Detail

DEFAULT_TOOL_TIP_FORMAT

public static final String DEFAULT_TOOL_TIP_FORMAT
The default tooltip format.

Constructor Detail

StandardXYZToolTipGenerator

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

StandardXYZToolTipGenerator

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).

StandardXYZToolTipGenerator

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).

Method Detail

createItemArray

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).

equals

public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.

Parameters: obj the other object (null permitted).

Returns: A boolean.

generateLabelString

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).

generateToolTip

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).

getZDateFormat

public DateFormat getZDateFormat()
Returns the date formatter for the z-values.

Returns: The date formatter (possibly null).

getZFormat

public NumberFormat getZFormat()
Returns the number formatter for the z-values.

Returns: The number formatter (possibly null).

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.