Class ParameterizedCompletionDescriptionToolTip

java.lang.Object
org.fife.ui.autocomplete.ParameterizedCompletionDescriptionToolTip

class ParameterizedCompletionDescriptionToolTip extends Object
A "tool tip" that displays information on the function or method currently being entered.
Version:
1.0
  • Field Details

    • ac

      private AutoCompletion ac
      The backing AutoCompletion.
    • tooltip

      private JWindow tooltip
      The actual tool tip.
    • descLabel

      private JLabel descLabel
      The label that holds the description.
    • pc

      The completion being described.
    • overflow

      private boolean overflow
  • Constructor Details

  • Method Details

    • isVisible

      public boolean isVisible()
      Returns whether this tool tip is visible.
      Returns:
      Whether this tool tip is visible.
      See Also:
    • setLocationRelativeTo

      public void setLocationRelativeTo(Rectangle r)
      Sets the location of this tool tip relative to the given rectangle.
      Parameters:
      r - The visual position of the caret (in screen coordinates).
    • setVisible

      public void setVisible(boolean visible)
      Toggles the visibility of this tool tip.
      Parameters:
      visible - Whether this tool tip should be visible.
      See Also:
    • updateText

      public boolean updateText(int selectedParam)
      Updates the text in the tool tip to have the current parameter displayed in bold.
      Parameters:
      selectedParam - The index of the selected parameter.
      Returns:
      Whether the text needed to be updated.
    • updateUI

      public void updateUI()
      Updates the LookAndFeel of this window and the description window.