Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.labels

Class BoxAndWhiskerToolTipGenerator

Implemented Interfaces:
CategoryToolTipGenerator, Cloneable, PublicCloneable, Serializable, CategoryToolTipGenerator
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 String
DEFAULT_TOOL_TIP_FORMAT
The default tooltip format string.

Fields inherited from class org.jfree.chart.labels.StandardCategoryToolTipGenerator

DEFAULT_TOOL_TIP_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.
boolean
equals(Object obj)
Tests if this object is equal to another.

Methods inherited from class org.jfree.chart.labels.StandardCategoryToolTipGenerator

equals, generateToolTip

Methods inherited from class org.jfree.chart.labels.AbstractCategoryItemLabelGenerator

clone, createItemArray, equals, generateColumnLabel, generateLabelString, generateRowLabel, getDateFormat, getLabelFormat, getNumberFormat

Field Details

DEFAULT_TOOL_TIP_FORMAT

public static final String DEFAULT_TOOL_TIP_FORMAT
The default tooltip format string.

Constructor Details

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 Details

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.
Overrides:
createItemArray in interface AbstractCategoryItemLabelGenerator
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.
Overrides:
equals in interface StandardCategoryToolTipGenerator
Parameters:
obj - the other object.
Returns:
A boolean.

Overview Package Class Use Source Tree Index Deprecated About