Package org.jfree.chart.labels

Class SymbolicXYItemLabelGenerator

java.lang.Object

org.jfree.chart.labels.SymbolicXYItemLabelGenerator

All Implemented Interfaces:

Serializable, Cloneable, XYLabelGenerator, XYToolTipGenerator, org.jfree.util.PublicCloneable

public class SymbolicXYItemLabelGenerator
extends Object
implements XYLabelGenerator, XYToolTipGenerator, Cloneable, org.jfree.util.PublicCloneable, Serializable

A standard item label generator for plots that use data from an XYDataset.

Author:

Anthony Boulestreau

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SymbolicXYItemLabelGenerator()

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns an independent copy of the generator.
boolean	equals(Object o)	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 data, int series, int item)	Generates a tool tip text item for a particular item within a series.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SymbolicXYItemLabelGenerator

public SymbolicXYItemLabelGenerator()

Method Details

generateToolTip

public String generateToolTip(XYDataset data,
int series,
int item)

Generates a tool tip text item for a particular item within a series.

Specified by:

generateToolTip in interface XYToolTipGenerator

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

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 XYLabelGenerator

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 Object clone()
             throws CloneNotSupportedException

Returns an independent copy of the generator.

Specified by:

clone in interface org.jfree.util.PublicCloneable

Returns:

A clone.

Throws:

CloneNotSupportedException - if cloning is not supported.

equals

public boolean equals(Object o)

Tests if this object is equal to another.

Overrides:

equals in class Object

Parameters:

o - the other object.

Returns:

A boolean.