Package org.jfree.chart.labels

Class StandardXYZToolTipGenerator

java.lang.Object
org.jfree.chart.labels.AbstractXYItemLabelGenerator
org.jfree.chart.labels.StandardXYToolTipGenerator
org.jfree.chart.labels.StandardXYZToolTipGenerator
All Implemented Interfaces:
Serializable, Cloneable, XYToolTipGenerator, XYZToolTipGenerator, PublicCloneable
public class StandardXYZToolTipGenerator
extends StandardXYToolTipGenerator
implements XYZToolTipGenerator, Serializable
A standard item label generator for use with XYZDataset data. Each value can be formatted as a number or as a date.
See Also:
Serialized Form

  • Field Details

  • Constructor Details

    • StandardXYZToolTipGenerator

      public StandardXYZToolTipGenerator()
      Creates a new tool tip generator using default number formatters for the x, y and z-values.

    • StandardXYZToolTipGenerator

      public StandardXYZToolTipGenerator​(String formatString, NumberFormat xFormat, NumberFormat yFormat, NumberFormat zFormat)
      Constructs a new tool tip generator using the specified number formatters.
      Parameters:
      formatString - the format string.
      xFormat - the format object for the x values (null not permitted).
      yFormat - the format object for the y values (null not permitted).
      zFormat - the format object for the z values (null not permitted).

    • StandardXYZToolTipGenerator

      public StandardXYZToolTipGenerator​(String formatString, DateFormat xFormat, DateFormat yFormat, DateFormat zFormat)
      Constructs a new tool tip generator using the specified date formatters.
      Parameters:
      formatString - the format string.
      xFormat - the format object for the x values (null not permitted).
      yFormat - the format object for the y values (null not permitted).
      zFormat - the format object for the z values (null not permitted).

  • Method Details

    • getZFormat

      public NumberFormat getZFormat()
      Returns the number formatter for the z-values.
      Returns:
      The number formatter (possibly null).

    • getZDateFormat

      public DateFormat getZDateFormat()
      Returns the date formatter for the z-values.
      Returns:
      The date formatter (possibly null).

    • generateToolTip

      public String generateToolTip​(XYZDataset dataset, int series, int item)
      Generates a tool tip text item for a particular item within a series.
      Specified by:
      generateToolTip in interface XYZToolTipGenerator
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The tooltip text (possibly null).

    • generateLabelString

      public String generateLabelString​(XYDataset dataset, int series, int item)
      Generates a label string for an item in the dataset.
      Overrides:
      generateLabelString in class AbstractXYItemLabelGenerator
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The label (possibly null).

    • createItemArray

      protected Object[] createItemArray​(XYZDataset dataset, int series, int item)
      Creates the array of items that can be passed to the MessageFormat class for creating labels.
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The items (never null).

    • equals

      public boolean equals​(Object obj)
      Tests this object for equality with an arbitrary object.
      Overrides:
      equals in class StandardXYToolTipGenerator
      Parameters:
      obj - the other object (null permitted).
      Returns:
      A boolean.