Package org.jfree.chart.labels
Class AbstractXYItemLabelGenerator
- java.lang.Object
-
- org.jfree.chart.labels.AbstractXYItemLabelGenerator
-
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
BubbleXYItemLabelGenerator
,IntervalXYItemLabelGenerator
,StandardXYItemLabelGenerator
,StandardXYToolTipGenerator
public class AbstractXYItemLabelGenerator extends Object implements Cloneable, Serializable
A base class for creating item label generators.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractXYItemLabelGenerator()
Creates an item label generator using default number formatters.protected
AbstractXYItemLabelGenerator(String formatString, DateFormat xFormat, DateFormat yFormat)
Creates an item label generator using the specified number formatters.protected
AbstractXYItemLabelGenerator(String formatString, DateFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified number formatters.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).protected
AbstractXYItemLabelGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat)
Creates an item label generator using the specified number formatters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 theMessageFormat
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).String
getNullYString()
Returns the string representing a null value.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.int
hashCode()
Returns a hash code for this instance.
-
-
-
Constructor Detail
-
AbstractXYItemLabelGenerator
protected AbstractXYItemLabelGenerator()
Creates an item label generator using default number formatters.
-
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).
-
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, 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).
-
-
Method Detail
-
getFormatString
public String getFormatString()
Returns the format string (this controls the overall structure of the label).- Returns:
- The format string (never
null
).
-
getXFormat
public NumberFormat getXFormat()
Returns the number formatter for the x-values.- Returns:
- The number formatter (possibly
null
).
-
getXDateFormat
public DateFormat getXDateFormat()
Returns the date formatter for the x-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
).
-
getYDateFormat
public DateFormat getYDateFormat()
Returns the date formatter for the y-values.- Returns:
- The date formatter (possibly
null
).
-
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
).
-
getNullYString
public String getNullYString()
Returns the string representing a null value.- Returns:
- The string representing a null value.
- Since:
- 1.0.10
-
createItemArray
protected Object[] createItemArray(XYDataset dataset, int series, int item)
Creates the array of items that can be passed to theMessageFormat
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 (nevernull
).
-
equals
public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
-
hashCode
public int hashCode()
Returns a hash code for this instance.
-
clone
public Object clone() throws CloneNotSupportedException
Returns an independent copy of the generator.- Overrides:
clone
in classObject
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- if cloning is not supported.
-
-