Class StandardXYZToolTipGenerator

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values
      • DEFAULT_TOOL_TIP_FORMAT

        public static final java.lang.String DEFAULT_TOOL_TIP_FORMAT
        The default tooltip format.
        See Also:
        Constant Field Values
      • zFormat

        private java.text.NumberFormat zFormat
        A number formatter for the z value - if this is null, then zDateFormat must be non-null.
      • zDateFormat

        private java.text.DateFormat zDateFormat
        A date formatter for the z-value - if this is null, then zFormat must be non-null.
    • Constructor Detail

      • StandardXYZToolTipGenerator

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

        public StandardXYZToolTipGenerator​(java.lang.String formatString,
                                           java.text.NumberFormat xFormat,
                                           java.text.NumberFormat yFormat,
                                           java.text.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​(java.lang.String formatString,
                                           java.text.DateFormat xFormat,
                                           java.text.DateFormat yFormat,
                                           java.text.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 Detail

      • getZFormat

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

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

        public java.lang.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 java.lang.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 java.lang.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​(java.lang.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.