Package org.jfree.chart.labels
Class HighLowItemLabelGenerator
- java.lang.Object
-
- org.jfree.chart.labels.HighLowItemLabelGenerator
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,XYItemLabelGenerator
,XYToolTipGenerator
,PublicCloneable
public class HighLowItemLabelGenerator extends java.lang.Object implements XYItemLabelGenerator, XYToolTipGenerator, java.lang.Cloneable, PublicCloneable, java.io.Serializable
A standard item label generator for plots that use data from aOHLCDataset
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.text.DateFormat
dateFormatter
The date formatter.private java.text.NumberFormat
numberFormatter
The number formatter.private static long
serialVersionUID
For serialization.
-
Constructor Summary
Constructors Constructor Description HighLowItemLabelGenerator()
Creates an item label generator using the default date and number formats.HighLowItemLabelGenerator(java.text.DateFormat dateFormatter, java.text.NumberFormat numberFormatter)
Creates a tool tip generator using the supplied date formatter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Returns an independent copy of the generator.boolean
equals(java.lang.Object obj)
Tests if this object is equal to another.java.lang.String
generateLabel(XYDataset dataset, int series, int category)
Generates a label for the specified item.java.lang.String
generateToolTip(XYDataset dataset, int series, int item)
Generates a tooltip text item for a particular item within a series.int
hashCode()
Returns a hash code for this instance.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
dateFormatter
private java.text.DateFormat dateFormatter
The date formatter.
-
numberFormatter
private java.text.NumberFormat numberFormatter
The number formatter.
-
-
Constructor Detail
-
HighLowItemLabelGenerator
public HighLowItemLabelGenerator()
Creates an item label generator using the default date and number formats.
-
HighLowItemLabelGenerator
public HighLowItemLabelGenerator(java.text.DateFormat dateFormatter, java.text.NumberFormat numberFormatter)
Creates a tool tip generator using the supplied date formatter.- Parameters:
dateFormatter
- the date formatter (null
not permitted).numberFormatter
- the number formatter (null
not permitted).
-
-
Method Detail
-
generateToolTip
public java.lang.String generateToolTip(XYDataset dataset, int series, int item)
Generates a tooltip text item for a particular item within a series.- Specified by:
generateToolTip
in interfaceXYToolTipGenerator
- Parameters:
dataset
- the dataset.series
- the series (zero-based index).item
- the item (zero-based index).- Returns:
- The tooltip text.
-
generateLabel
public java.lang.String generateLabel(XYDataset dataset, int series, int category)
Generates a label for the specified item. The label is typically a formatted version of the data value, but any text can be used.- Specified by:
generateLabel
in interfaceXYItemLabelGenerator
- Parameters:
dataset
- the dataset (null
not permitted).series
- the series index (zero-based).category
- the category index (zero-based).- Returns:
- The label (possibly
null
).
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns an independent copy of the generator.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classjava.lang.Object
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if cloning is not supported.
-
equals
public boolean equals(java.lang.Object obj)
Tests if this object is equal to another.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the other object.- Returns:
- A boolean.
-
hashCode
public int hashCode()
Returns a hash code for this instance.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- A hash code.
-
-