Package org.jfree.chart.labels

Class BubbleXYItemLabelGenerator

java.lang.Object
org.jfree.chart.labels.AbstractXYItemLabelGenerator
org.jfree.chart.labels.BubbleXYItemLabelGenerator
All Implemented Interfaces:
Serializable, Cloneable, XYItemLabelGenerator, PublicCloneable
public class BubbleXYItemLabelGenerator
extends AbstractXYItemLabelGenerator
implements XYItemLabelGenerator, PublicCloneable, Serializable
An item label generator defined for use with the XYBubbleRenderer class, or any other class that uses an XYZDataset.
See Also:
Serialized Form

  • Field Details

  • Constructor Details

    • BubbleXYItemLabelGenerator

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

    • BubbleXYItemLabelGenerator

      public BubbleXYItemLabelGenerator​(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).

    • BubbleXYItemLabelGenerator

      public BubbleXYItemLabelGenerator​(String formatString, DateFormat xFormat, DateFormat yFormat, DateFormat zFormat)
      Constructs a new item label 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).

    • generateLabel

      public String generateLabel​(XYDataset dataset, int series, int item)
      Generates an item label for a particular item within a series.
      Specified by:
      generateLabel in interface XYItemLabelGenerator
      Parameters:
      dataset - the dataset (null not permitted).
      series - the series index (zero-based).
      item - the item index (zero-based).
      Returns:
      The item label (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 AbstractXYItemLabelGenerator
      Parameters:
      obj - the other object (null permitted).
      Returns:
      A boolean.

    • hashCode

      public int hashCode()
      Returns a hash code for this instance.
      Overrides:
      hashCode in class AbstractXYItemLabelGenerator
      Returns:
      A hash code.