org.jfree.chart.labels

Class SymbolicXYItemLabelGenerator

public class SymbolicXYItemLabelGenerator extends Object implements XYItemLabelGenerator, XYToolTipGenerator, Cloneable, PublicCloneable, Serializable

A standard item label generator for plots that use data from an XYDataset.
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 data, int series, int item)
Generates a tool tip text item for a particular item within a series.
inthashCode()
Returns a hash code for this instance.

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 data, int series, int item)
Generates a tool tip text item for a particular item within a series.

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

Returns: The tool tip text (possibly null).

hashCode

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

Returns: A hash code.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.