public class

BubbleXYItemLabelGenerator

extends AbstractXYItemLabelGenerator
implements Serializable XYItemLabelGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.AbstractXYItemLabelGenerator
     ↳ org.jfree.chart.labels.BubbleXYItemLabelGenerator

Class Overview

An item label generator defined for use with the XYBubbleRenderer class, or any other class that uses an XYZDataset.

Summary

Constants
String DEFAULT_FORMAT_STRING The default item label format.
Public Constructors
BubbleXYItemLabelGenerator()
Creates a new tool tip generator using default number formatters for the x, y and z-values.
BubbleXYItemLabelGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat, NumberFormat zFormat)
Constructs a new tool tip generator using the specified number formatters.
BubbleXYItemLabelGenerator(String formatString, DateFormat xFormat, DateFormat yFormat, DateFormat zFormat)
Constructs a new item label generator using the specified date formatters.
Public Methods
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
String generateLabel(XYDataset dataset, int series, int item)
Generates an item label for a particular item within a series.
String generateLabelString(XYDataset dataset, int series, int item)
Generates a label string for an item in the dataset.
DateFormat getZDateFormat()
Returns the date formatter for the z-values.
NumberFormat getZFormat()
Returns the number formatter for the z-values.
int hashCode()
Returns a hash code for this instance.
Protected Methods
Object[] createItemArray(XYZDataset 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.AbstractXYItemLabelGenerator
From class java.lang.Object
From interface org.jfree.chart.labels.XYItemLabelGenerator

Constants

public static final String DEFAULT_FORMAT_STRING

The default item label format.

Constant Value: "{3}"

Public Constructors

public BubbleXYItemLabelGenerator ()

Creates a new tool tip generator using default number formatters for the x, y and z-values.

public BubbleXYItemLabelGenerator (String formatString, NumberFormat xFormat, NumberFormat yFormat, NumberFormat zFormat)

Constructs a new tool tip generator using the specified number formatters.

Parameters
formatString the format string.
xFormat the format object for the x values (null not permitted).
yFormat the format object for the y values (null not permitted).
zFormat the format object for the z values (null not permitted).

public BubbleXYItemLabelGenerator (String formatString, DateFormat xFormat, DateFormat yFormat, DateFormat zFormat)

Constructs a new item label generator using the specified date formatters.

Parameters
formatString the format string.
xFormat the format object for the x values (null not permitted).
yFormat the format object for the y values (null not permitted).
zFormat the format object for the z values (null not permitted).

Public Methods

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

Parameters
obj the other object (null permitted).
Returns
  • A boolean.

public String generateLabel (XYDataset dataset, int series, int item)

Generates an item label for a particular item within a series.

Parameters
dataset the dataset (null not permitted).
series the series index (zero-based).
item the item index (zero-based).
Returns
  • The item label (possibly null).

public String generateLabelString (XYDataset dataset, int series, int item)

Generates a label string for an item in the dataset.

Parameters
dataset the dataset (null not permitted).
series the series (zero-based index).
item the item (zero-based index).
Returns
  • The label (possibly null).

public DateFormat getZDateFormat ()

Returns the date formatter for the z-values.

Returns
  • The date formatter (possibly null).

public NumberFormat getZFormat ()

Returns the number formatter for the z-values.

Returns
  • The number formatter (possibly null).

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

Protected Methods

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