public class

HighLowItemLabelGenerator

extends Object
implements Serializable Cloneable XYItemLabelGenerator XYToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.HighLowItemLabelGenerator

Class Overview

A standard item label generator for plots that use data from a OHLCDataset.

Summary

Public Constructors
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.
Public Methods
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.
int hashCode()
Returns a hash code for this instance.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.labels.XYItemLabelGenerator
From interface org.jfree.chart.labels.XYToolTipGenerator

Public Constructors

public HighLowItemLabelGenerator ()

Creates an item label generator using the default date and number formats.

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

Public Methods

public Object clone ()

Returns an independent copy of the generator.

Returns
  • A clone.
Throws
CloneNotSupportedException if cloning is not supported.

public boolean equals (Object obj)

Tests if this object is equal to another.

Parameters
obj the other object.
Returns
  • A boolean.

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

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.

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.