org.jfree.chart.labels

Class BoxAndWhiskerToolTipGenerator

public class BoxAndWhiskerToolTipGenerator extends StandardCategoryToolTipGenerator implements CategoryToolTipGenerator, Cloneable, PublicCloneable, Serializable

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

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
BoxAndWhiskerToolTipGenerator()
Creates a default tool tip generator.
BoxAndWhiskerToolTipGenerator(String format, NumberFormat formatter)
Creates a tool tip formatter.
Method Summary
protected Object[]createItemArray(CategoryDataset 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

BoxAndWhiskerToolTipGenerator

public BoxAndWhiskerToolTipGenerator()
Creates a default tool tip generator.

BoxAndWhiskerToolTipGenerator

public BoxAndWhiskerToolTipGenerator(String format, NumberFormat formatter)
Creates a tool tip formatter.

Parameters: format the tool tip format string. formatter the formatter.

Method Detail

createItemArray

protected Object[] createItemArray(CategoryDataset 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.