org.jfree.chart.labels

Class BoxAndWhiskerXYToolTipGenerator

public class BoxAndWhiskerXYToolTipGenerator extends StandardXYToolTipGenerator implements XYToolTipGenerator, Cloneable, Serializable

An item label generator for plots that use data from a BoxAndWhiskerXYDataset.

The tooltip text and item label text are composed using a java.text.MessageFormat object, that can aggregate some or all of the following string values into a message.

0Series Name
1X (value or date)
2Mean
3Median
4Minimum
5Maximum
6Quartile 1
7Quartile 3
Field Summary
static StringDEFAULT_TOOL_TIP_FORMAT
The default tooltip format string.
Constructor Summary
BoxAndWhiskerXYToolTipGenerator()
Creates a default item label generator.
BoxAndWhiskerXYToolTipGenerator(String toolTipFormat, DateFormat dateFormat, NumberFormat numberFormat)
Creates a new item label generator.
Method Summary
protected Object[]createItemArray(XYDataset 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 if this object is equal to another.

Field Detail

DEFAULT_TOOL_TIP_FORMAT

public static final String DEFAULT_TOOL_TIP_FORMAT
The default tooltip format string.

Constructor Detail

BoxAndWhiskerXYToolTipGenerator

public BoxAndWhiskerXYToolTipGenerator()
Creates a default item label generator.

BoxAndWhiskerXYToolTipGenerator

public BoxAndWhiskerXYToolTipGenerator(String toolTipFormat, DateFormat dateFormat, NumberFormat numberFormat)
Creates a new item label generator. If the date formatter is not null, the x-values will be formatted as dates.

Parameters: toolTipFormat the tool tip format string (null not permitted). numberFormat the number formatter (null not permitted). dateFormat the date formatter (null permitted).

Method Detail

createItemArray

protected Object[] createItemArray(XYDataset 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 if this object is equal to another.

Parameters: obj the other object.

Returns: A boolean.

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