Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| # Header And More
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jfree.chart.labels
Class SymbolicXYItemLabelGenerator

    java.lang.Object
      org.jfree.chart.labels.SymbolicXYItemLabelGenerator

All Implemented Interfaces:
  java.io.Serializable, java.lang.Cloneable, XYItemLabelGenerator, XYToolTipGenerator, org.jfree.util.PublicCloneable

    public class SymbolicXYItemLabelGenerator

extends java.lang.Object
implements XYItemLabelGenerator, XYToolTipGenerator, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable

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

See Also:
  Serialized Form

Constructor Summary
`SymbolicXYItemLabelGenerator()`

Method Summary
`java.lang.Object` | `clone()` Returns an independent copy of the generator.
`boolean` | `equals(java.lang.Object obj)` Tests if this object is equal to another.
`java.lang.String` | `generateLabel(XYDataset dataset, int series, int category)` Generates a label for the specified item.
`java.lang.String` | `generateToolTip(XYDataset data, int series, int item)` Generates a tool tip text item for a particular item within a series.
`int` | `hashCode()` Returns a hash code for this instance.

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### SymbolicXYItemLabelGenerator

    public SymbolicXYItemLabelGenerator()

Method Detail

### generateToolTip

    public java.lang.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 java.lang.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`).

### clone

    public java.lang.Object clone()
                           throws java.lang.CloneNotSupportedException

  Returns an independent copy of the generator.

  Specified by:
    `clone` in interface `org.jfree.util.PublicCloneable`
  Overrides:
    `clone` in class `java.lang.Object`
  Returns:
    A clone.
  Throws:
    `java.lang.CloneNotSupportedException` - if cloning is not supported.

### equals

    public boolean equals(java.lang.Object obj)

  Tests if this object is equal to another.

  Overrides:
    `equals` in class `java.lang.Object`
  Parameters:
    `obj` - the other object.
  Returns:
    A boolean.

### hashCode

    public int hashCode()

  Returns a hash code for this instance.

  Overrides:
    `hashCode` in class `java.lang.Object`
  Returns:
    A hash code.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| # Footer And More
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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