Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.labels

Class AbstractXYItemLabelGenerator

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
BubbleXYItemLabelGenerator, StandardXYItemLabelGenerator, StandardXYToolTipGenerator
public class AbstractXYItemLabelGenerator
extends java.lang.Object
implements Cloneable, Serializable
A base class for creating item label generators.

Constructor Summary

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

Method Summary

Object
clone()
Returns an independent copy of the generator.
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.
boolean
equals(Object obj)
Tests this object for equality with an arbitrary object.
String
generateLabelString(XYDataset dataset, int series, int item)
Generates a label string for an item in the dataset.
String
getFormatString()
Returns the format string (this controls the overall structure of the label).
DateFormat
getXDateFormat()
Returns the date formatter for the x-values.
NumberFormat
getXFormat()
Returns the number formatter for the x-values.
DateFormat
getYDateFormat()
Returns the date formatter for the y-values.
NumberFormat
getYFormat()
Returns the number formatter for the y-values.

Constructor Details

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator()
Creates an item label generator using default number formatters.

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator(String formatString,
                                       DateFormat xFormat,
                                       DateFormat 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 permitted).
yFormat - the format object for the y values (null not permitted).

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator(String formatString,
                                       DateFormat 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 permitted).
yFormat - the format object for the y values (null not permitted).

AbstractXYItemLabelGenerator

protected AbstractXYItemLabelGenerator(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).
Since:
1.0.4

AbstractXYItemLabelGenerator

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

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns an independent copy of the generator.
Returns:
A clone.

createItemArray

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:
An array of three items from the dataset formatted as String objects (never null).

equals

public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
Parameters:
obj - the other object (null permitted).
Returns:
A boolean.

generateLabelString

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

getFormatString

public String getFormatString()
Returns the format string (this controls the overall structure of the label).
Returns:
The format string (never null).

getXDateFormat

public DateFormat getXDateFormat()
Returns the date formatter for the x-values.
Returns:
The date formatter (possibly null).

getXFormat

public NumberFormat getXFormat()
Returns the number formatter for the x-values.
Returns:
The number formatter (possibly null).

getYDateFormat

public DateFormat getYDateFormat()
Returns the date formatter for the y-values.
Returns:
The date formatter (possibly null).

getYFormat

public NumberFormat getYFormat()
Returns the number formatter for the y-values.
Returns:
The number formatter (possibly null).

Overview Package Class Use Source Tree Index Deprecated About