public class

BoxAndWhiskerXYToolTipGenerator

extends StandardXYToolTipGenerator
implements Serializable Cloneable XYToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractXYItemLabelGenerator
     ↳ org.jfree.chart.labels.StandardXYToolTipGenerator
       ↳ org.jfree.chart.labels.BoxAndWhiskerXYToolTipGenerator

Class Overview

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

Summary

Constants
String DEFAULT_TOOL_TIP_FORMAT The default tooltip format string.
[Expand]
Inherited Constants
From class org.jfree.chart.labels.StandardXYToolTipGenerator
Public Constructors
BoxAndWhiskerXYToolTipGenerator()
Creates a default item label generator.
BoxAndWhiskerXYToolTipGenerator(String toolTipFormat, DateFormat dateFormat, NumberFormat numberFormat)
Creates a new item label generator.
Public Methods
boolean equals(Object obj)
Tests if this object is equal to another.
Protected Methods
Object[] createItemArray(XYDataset 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.StandardXYToolTipGenerator
From class org.jfree.chart.labels.AbstractXYItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.XYToolTipGenerator

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 BoxAndWhiskerXYToolTipGenerator ()

Creates a default item label generator.

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).
dateFormat the date formatter (null permitted).
numberFormat the number formatter (null not permitted).

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