Module platform
Package org.jfree.chart.labels

Class IntervalXYToolTipGenerator

java.lang.Object
org.jfree.chart.labels.AbstractXYItemLabelGenerator
org.jfree.chart.labels.IntervalXYToolTipGenerator
All Implemented Interfaces:
Serializable, Cloneable, XYToolTipGenerator, PublicCloneable
public class IntervalXYToolTipGenerator extends AbstractXYItemLabelGenerator implements XYToolTipGenerator, Cloneable, PublicCloneable, Serializable
A tooltip generator for datasets that implement the IntervalXYDataset interface.
See Also:

  • Field Details

    • DEFAULT_TOOL_TIP_FORMAT

      public static final String DEFAULT_TOOL_TIP_FORMAT
      The default item label format.
      See Also:

  • Constructor Details

    • IntervalXYToolTipGenerator

      public IntervalXYToolTipGenerator()
      Creates a new tooltip generator using default number formatters.

    • IntervalXYToolTipGenerator

      public IntervalXYToolTipGenerator(String formatString, NumberFormat xFormat, NumberFormat yFormat)
      Creates a new tooltip generator using the specified number formatters.
      Parameters:
      formatString - the item label format string (null not permitted).
      xFormat - the format object for the x values (null not permitted).
      yFormat - the format object for the y values (null not permitted).

    • IntervalXYToolTipGenerator

      public IntervalXYToolTipGenerator(String formatString, DateFormat xFormat, NumberFormat yFormat)
      Creates a new tool tip generator using the specified formatters.
      Parameters:
      formatString - the item label format string (null not permitted).
      xFormat - the format object for the x values (null not permitted).
      yFormat - the format object for the y values (null not permitted).

    • IntervalXYToolTipGenerator

      public IntervalXYToolTipGenerator(String formatString, NumberFormat xFormat, DateFormat yFormat)
      Creates a new tool tip generator using the specified formatters (a number formatter for the x-values and a date formatter for the y-values).
      Parameters:
      formatString - the item label format string (null not permitted).
      xFormat - the format object for the x values (null permitted).
      yFormat - the format object for the y values (null not permitted).

    • IntervalXYToolTipGenerator

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

  • Method Details

    • createItemArray

      protected Object[] createItemArray(XYDataset dataset, int series, int item)
      Creates the array of items that can be passed to the MessageFormat class for creating labels.
      Overrides:
      createItemArray in class AbstractXYItemLabelGenerator
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      An array of seven items from the dataset formatted as String objects (never null).

    • generateToolTip

      public String generateToolTip(XYDataset dataset, int series, int item)
      Generates the tool tip text for an item in a dataset.
      Specified by:
      generateToolTip in interface XYToolTipGenerator
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The tool tip text (possibly null).

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns an independent copy of the generator.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class AbstractXYItemLabelGenerator
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if cloning is not supported.

    • equals

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