Package quadbase.util

Interface IHint

public interface IHint
This interface is used to set/get properties associated with hints displayed for data points and hyperlinks. A handle to IHint for hyperlinks can be called by invoking gethHint() in IHyperLinkSet. A handle to IHint for data points can be called by invoking gethHint()) in IDataPointSet.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Color
    getBackgroundColor()
    Returns the background color of the information box used to display hints for data points and hyperlinks.
    Color
    getBorderColor()
    Returns the border color of the information box used to display hints for data points and hyperlinks.
    IText
    gethText()
    Gets a handle to the IText object used to set font properties for the hint string.
    Dimension
    getOffset()
    Gets the relative offsets (horizontal and vertical) of the hintbox
    PickData
    getPickData(int x, int y)
    Returns PickData for corresponding coordinate (x, y)
    boolean
    isEnabled()
    Returns whether or not the display of hints is enabled.
    void
    setBackgroundColor(Color c)
    Sets the background color for the hint information box.
    void
    setBorderColor(Color c)
    Sets the border color for the hint information box.
    void
    setEnabled(boolean b)
    Enables/Disables the display of hints.
    void
    setHintBoxInfo(IHintBoxInfo hintBoxInfo)
    Sets the display text for hint box
    void
    setOffset(Dimension offset)
    Sets the relative offsets of the hintbox

  • Method Details

    • setEnabled

      void setEnabled(boolean b)
      Enables/Disables the display of hints. 

       Associated QbChart properties: 
         SHOW_LINKHINT
         SHOW_DATAHINT
      Parameters:
      b - The boolean state for displaying hints.

    • isEnabled

      boolean isEnabled()
      Returns whether or not the display of hints is enabled.
      Returns:
      True if hint display is enabled, false otherwise.

    • getBackgroundColor

      Color getBackgroundColor()
      Returns the background color of the information box used to display hints for data points and hyperlinks.
      Returns:
      The background color for the hint information box.

    • setBackgroundColor

      void setBackgroundColor(Color c)
      Sets the background color for the hint information box.
      Parameters:
      c - The background Color object.

    • getBorderColor

      Color getBorderColor()
      Returns the border color of the information box used to display hints for data points and hyperlinks.
      Returns:
      The border color for the hint information box.

    • setBorderColor

      void setBorderColor(Color c)
      Sets the border color for the hint information box.
      Parameters:
      c - The border Color object.

    • getPickData

      PickData getPickData(int x, int y)
      Returns PickData for corresponding coordinate (x, y)
      Parameters:
      x - horizontal position of a chart
      y - vertical position of a chart
      Returns:
      PickData which contains data point information.
      See Also:

    • getOffset

      Dimension getOffset()
      Gets the relative offsets (horizontal and vertical) of the hintbox
      Returns:
      the offset as a Dimension object.

    • setOffset

      void setOffset(Dimension offset)
      Sets the relative offsets of the hintbox
      Parameters:
      offset - The Dimension object containing the horizontal and vertical offsets, in pixel units.

    • setHintBoxInfo

      void setHintBoxInfo(IHintBoxInfo hintBoxInfo)
      Sets the display text for hint box
      Parameters:
      hintBoxInfo - display text info for hint box
      See Also:

    • gethText

      IText gethText()
      Gets a handle to the IText object used to set font properties for the hint string.
      Returns:
      A handle to an object that implements IText
      See Also: