Module java.desktop
Package javax.swing

Class JToolTip

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible

    public class JToolTip
extends JComponent
implements Accessible
    Used to display a "Tip" for a Component. Typically components provide api to automate the process of using ToolTips. For example, any Swing component can use the JComponent setToolTipText method to specify the text for a standard tooltip. A component that wants to create a custom ToolTip display can override JComponent's createToolTip method and use a subclass of this class.

    See How to Use Tool Tips in The Java Tutorial for further documentation.

    Warning: Swing is not thread safe. For more information see Swing'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 the java.beans package. Please see XMLEncoder.

    Since:
    1.2
    See Also:
    JComponent.setToolTipText(java.lang.String), JComponent.createToolTip(), Serialized Form

    • Constructor Detail

      • JToolTip

        public JToolTip​()
        Creates a tool tip.

    • Method Detail

      • getUI

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

      • 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 string tipText may be null.
        Parameters:
        tipText - the String to display

      • getTipText

        public String getTipText​()
        Returns the text that is shown when the tool tip is displayed. The returned value may be null.
        Returns:
        the String 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 component c may be null and will have no effect.

        This is a bound property.

        Parameters:
        c - the JComponent being described
        See Also:
        JComponent.createToolTip()

      • getComponent

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

      • paramString

        protected String paramString​()
        Returns a string representation of this JToolTip. 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 be null.
        Overrides:
        paramString in class JComponent
        Returns:
        a string representation of this JToolTip

      • 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