Module platform

Package org.jfree.chart.labels

Class StandardXYItemLabelGenerator

java.lang.Object

org.jfree.chart.labels.AbstractXYItemLabelGenerator

org.jfree.chart.labels.StandardXYItemLabelGenerator

All Implemented Interfaces:

Serializable, Cloneable, XYItemLabelGenerator, PublicCloneable

public class StandardXYItemLabelGenerator
extends AbstractXYItemLabelGenerator
implements XYItemLabelGenerator, Cloneable, PublicCloneable, Serializable

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ITEM_LABEL_FORMAT	The default item label format.

Constructor Summary

Constructors

Constructor	Description
StandardXYItemLabelGenerator()	Creates an item label generator using default number formatters.
StandardXYItemLabelGenerator(String formatString)	Creates an item label generator using the specified number formatters.
StandardXYItemLabelGenerator(String formatString, DateFormat xFormat, DateFormat yFormat)	Creates a label generator using the specified date 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, NumberFormat xFormat, NumberFormat yFormat)	Creates an item label generator using the specified number formatters.

Method Summary

Modifier and Type	Method	Description
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.

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

createItemArray, generateLabelString, getFormatString, getNullYString, getXDateFormat, getXFormat, getYDateFormat, getYFormat, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_ITEM_LABEL_FORMAT

public static final String DEFAULT_ITEM_LABEL_FORMAT

The default item label format.

See Also:

• Constant Field Values

Constructor Details

StandardXYItemLabelGenerator

public StandardXYItemLabelGenerator()

Creates an item label generator using default number formatters.

StandardXYItemLabelGenerator

public StandardXYItemLabelGenerator(String formatString)

Creates an item label generator using the specified number formatters.

Parameters:

formatString - the item label format string (null not permitted).

StandardXYItemLabelGenerator

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

StandardXYItemLabelGenerator

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

StandardXYItemLabelGenerator

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

StandardXYItemLabelGenerator

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

Method Details

generateLabel

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

Generates the item label text for an item in a dataset.

Specified by:

generateLabel in interface XYItemLabelGenerator

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

clone

public Object clone()
             throws CloneNotSupportedException

Returns an independent copy of the generator.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractXYItemLabelGenerator

Returns:

A clone.

Throws:

CloneNotSupportedException - if cloning is not supported.

equals

public boolean equals(Object obj)

Tests this object for equality with an arbitrary object.

Overrides:

equals in class AbstractXYItemLabelGenerator

Parameters:

obj - the other object (null permitted).

Returns:

A boolean.