public class

StandardXYItemLabelGenerator

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

Class Overview

A standard item label generator for plots that use data from an XYDataset.

Summary

Constants
String DEFAULT_ITEM_LABEL_FORMAT The default item label format.
Public Constructors
StandardXYItemLabelGenerator()
Creates an item label generator using default number formatters.
StandardXYItemLabelGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified number formatters.
StandardXYItemLabelGenerator(String formatString, DateFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified formatters.
StandardXYItemLabelGenerator(String formatString, NumberFormat xFormat, DateFormat yFormat)
Creates an item label generator using the specified formatters (a number formatter for the x-values and a date formatter for the y-values).
StandardXYItemLabelGenerator(String formatString, DateFormat xFormat, DateFormat yFormat)
Creates a label generator using the specified date formatters.
Public Methods
Object clone()
Returns an independent copy of the generator.
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
String generateLabel(XYDataset dataset, int series, int item)
Generates the item label text for an item in a dataset.
[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_ITEM_LABEL_FORMAT

The default item label format.

Constant Value: "{2}"

Public Constructors

public StandardXYItemLabelGenerator ()

Creates an item label generator using default number formatters.

public StandardXYItemLabelGenerator (String formatString, NumberFormat xFormat, NumberFormat yFormat)

Creates an item label generator using the specified number formatters.

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

public StandardXYItemLabelGenerator (String formatString, DateFormat xFormat, NumberFormat yFormat)

Creates an item label generator using the specified formatters.

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

public StandardXYItemLabelGenerator (String formatString, NumberFormat xFormat, DateFormat yFormat)

Creates an item label generator using the specified formatters (a number formatter for the x-values and a date formatter for the y-values).

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

public StandardXYItemLabelGenerator (String formatString, DateFormat xFormat, DateFormat yFormat)

Creates a label generator using the specified date formatters.

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

Public Methods

public Object clone ()

Returns an independent copy of the generator.

Returns
  • A clone.
Throws
CloneNotSupportedException if cloning is not supported.

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 the item label text for an item in a dataset.

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