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 HighLowItemLabelGenerator

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable, XYItemLabelGenerator, XYToolTipGenerator
public class HighLowItemLabelGenerator
extends java.lang.Object
implements XYItemLabelGenerator, XYToolTipGenerator, Cloneable, PublicCloneable, Serializable
A standard item label generator for plots that use data from a OHLCDataset.

Constructor Summary

HighLowItemLabelGenerator()
Creates an item label generator using the default date and number formats.
HighLowItemLabelGenerator(DateFormat dateFormatter, NumberFormat numberFormatter)
Creates a tool tip generator using the supplied date formatter.

Method Summary

Object
clone()
Returns an independent copy of the generator.
boolean
equals(Object obj)
Tests if this object is equal to another.
String
generateLabel(XYDataset dataset, int series, int category)
Generates a label for the specified item.
String
generateToolTip(XYDataset dataset, int series, int item)
Generates a tooltip text item for a particular item within a series.

Constructor Details

HighLowItemLabelGenerator

public HighLowItemLabelGenerator()
Creates an item label generator using the default date and number formats.

HighLowItemLabelGenerator

public HighLowItemLabelGenerator(DateFormat dateFormatter,
                                 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 Details

clone

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

equals

public boolean equals(Object obj)
Tests if this object is equal to another.
Parameters:
obj - the other object.
Returns:
A boolean.

generateLabel

public 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 interface XYItemLabelGenerator
Parameters:
dataset - the dataset (null not permitted).
series - the series index (zero-based).
category - the category index (zero-based).
Returns:
The label (possibly null).

generateToolTip

public String generateToolTip(XYDataset dataset,
                              int series,
                              int item)
Generates a tooltip text item for a particular item within a series.
Specified by:
generateToolTip in interface XYToolTipGenerator
Parameters:
dataset - the dataset.
series - the series (zero-based index).
item - the item (zero-based index).
Returns:
The tooltip text.

Overview Package Class Use Source Tree Index Deprecated About