Class JToolTip

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JToolTip
All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible
public classJToolTipextendsJComponentimplementsAccessible
Used to display a "Tip" for a Component. Typically components provide api to automate the process of usingToolTips. For example, any Swing component can use theJComponentsetToolTipText method to specify the text for a standard tooltip. A component that wants to create a customToolTip display can overrideJComponent'screateToolTip method and use a subclass of this class.

SeeHow to Use Tool Tips inThe Java Tutorial for further documentation.

Warning: Swing is not thread safe. For more information seeSwing's Threading Policy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to thejava.beans package. Please seeXMLEncoder.

Since:
1.2
See Also:

  • Constructor Details

    • JToolTip

      public JToolTip()
      Creates a tool tip.

  • Method Details

    • getUI

      public ToolTipUI getUI()
      Returns the L&F object that renders this component.
      Overrides:
      getUI in class JComponent
      Returns:
      theToolTipUI object that renders this component

    • updateUI

      public void updateUI()
      Resets the UI property to a value from the current look and feel.
      Overrides:
      updateUI in class JComponent
      See Also:

    • getUIClassID

      public String getUIClassID()
      Returns the name of the L&F class that renders this component.
      Overrides:
      getUIClassID in class JComponent
      Returns:
      the string "ToolTipUI"
      See Also:

    • setTipText

      @BeanProperty(preferred=true,description="Sets the text of the tooltip")public void setTipText(String tipText)
      Sets the text to show when the tool tip is displayed. The stringtipText may benull.
      Parameters:
      tipText - theString to display

    • getTipText

      public String getTipText()
      Returns the text that is shown when the tool tip is displayed. The returned value may benull.
      Returns:
      theString that is displayed

    • setComponent

      @BeanProperty(description="Sets the component that the tooltip describes.")public void setComponent(JComponent c)
      Specifies the component that the tooltip describes. The componentc may benull and will have no effect.

      This is a bound property.

      Parameters:
      c - theJComponent being described
      See Also:

    • getComponent

      public JComponent getComponent()
      Returns the component the tooltip applies to. The returned value may benull.
      Returns:
      the component that the tooltip describes
      See Also:

    • paramString

      protected String paramString()
      Returns a string representation of thisJToolTip. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull.
      Overrides:
      paramString in class JComponent
      Returns:
      a string representation of thisJToolTip

    • getAccessibleContext

      public AccessibleContext getAccessibleContext()
      Gets the AccessibleContext associated with this JToolTip. For tool tips, the AccessibleContext takes the form of an AccessibleJToolTip. A new AccessibleJToolTip instance is created if necessary.
      Specified by:
      getAccessibleContext in interface Accessible
      Overrides:
      getAccessibleContext in class Component
      Returns:
      an AccessibleJToolTip that serves as the AccessibleContext of this JToolTip