public class

BoxAndWhiskerToolTipGenerator

extends StandardCategoryToolTipGenerator
implements Serializable Cloneable CategoryToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardCategoryToolTipGenerator
       ↳ org.jfree.chart.labels.BoxAndWhiskerToolTipGenerator

Class Overview

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

Summary

Constants
String DEFAULT_TOOL_TIP_FORMAT The default tooltip format string.
[Expand]
Inherited Constants
From class org.jfree.chart.labels.StandardCategoryToolTipGenerator
Public Constructors
BoxAndWhiskerToolTipGenerator()
Creates a default tool tip generator.
BoxAndWhiskerToolTipGenerator(String format, NumberFormat formatter)
Creates a tool tip formatter.
Public Methods
boolean equals(Object obj)
Tests if this object is equal to another.
Protected Methods
Object[] createItemArray(CategoryDataset dataset, int series, int item)
Creates the array of items that can be passed to the MessageFormat class for creating labels.
[Expand]
Inherited Methods
From class org.jfree.chart.labels.StandardCategoryToolTipGenerator
From class org.jfree.chart.labels.AbstractCategoryItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.CategoryToolTipGenerator

Constants

public static final String DEFAULT_TOOL_TIP_FORMAT

The default tooltip format string.

Constant Value: "X: {1} Mean: {2} Median: {3} Min: {4} Max: {5} Q1: {6} Q3: {7} "

Public Constructors

public BoxAndWhiskerToolTipGenerator ()

Creates a default tool tip generator.

public BoxAndWhiskerToolTipGenerator (String format, NumberFormat formatter)

Creates a tool tip formatter.

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

Public Methods

public boolean equals (Object obj)

Tests if this object is equal to another.

Parameters
obj the other object.
Returns
  • A boolean.

Protected Methods

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