org.jfree.chart.labels

Class HighLowItemLabelGenerator

public class HighLowItemLabelGenerator extends 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
Objectclone()
Returns an independent copy of the generator.
booleanequals(Object obj)
Tests if this object is equal to another.
StringgenerateLabel(XYDataset dataset, int series, int category)
Generates a label for the specified item.
StringgenerateToolTip(XYDataset dataset, int series, int item)
Generates a tooltip text item for a particular item within a series.
inthashCode()
Returns a hash code for this instance.

Constructor Detail

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 Detail

clone

public Object clone()
Returns an independent copy of the generator.

Returns: A clone.

Throws: CloneNotSupportedException if cloning is not supported.

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.

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.

Parameters: dataset the dataset. series the series (zero-based index). item the item (zero-based index).

Returns: The tooltip text.

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: A hash code.