FileDocCategorySizeDatePackage
JToolTip.javaAPI DocJava SE 6 API8212Tue Jun 10 00:26:40 BST 2008javax.swing

JToolTip

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 JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

see
JComponent#setToolTipText
see
JComponent#createToolTip
version
1.51 08/08/06
author
Dave Moore
author
Rich Shiavi

Fields Summary
private static final String
uiClassID
String
tipText
JComponent
component
Constructors Summary
public JToolTip()
Creates a tool tip.


         
      
        setOpaque(true);
        updateUI();
    
Methods Summary
booleanalwaysOnTop()
Always returns true since tooltips, by definition, should always be on top of all other windows.

	return true;
    
public javax.accessibility.AccessibleContextgetAccessibleContext()
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.

return
an AccessibleJToolTip that serves as the AccessibleContext of this JToolTip

        if (accessibleContext == null) {
            accessibleContext = new AccessibleJToolTip();
        }
        return accessibleContext;
    
public javax.swing.JComponentgetComponent()
Returns the component the tooltip applies to. The returned value may be null.

return
the component that the tooltip describes
see
JComponent#createToolTip

        return component;
    
public java.lang.StringgetTipText()
Returns the text that is shown when the tool tip is displayed. The returned value may be null.

return
the String that is displayed

        return tipText;
    
public javax.swing.plaf.ToolTipUIgetUI()
Returns the L&F object that renders this component.

return
the ToolTipUI object that renders this component

        return (ToolTipUI)ui;
    
public java.lang.StringgetUIClassID()
Returns the name of the L&F class that renders this component.

return
the string "ToolTipUI"
see
JComponent#getUIClassID
see
UIDefaults#getUI

        return uiClassID;
    
protected java.lang.StringparamString()
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.

return
a string representation of this JToolTip

        String tipTextString = (tipText != null ?
				tipText : "");

        return super.paramString() +
        ",tipText=" + tipTextString;
    
public voidsetComponent(javax.swing.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.

param
c the JComponent being described
see
JComponent#createToolTip
beaninfo
bound: true description: Sets the component that the tooltip describes.

        JComponent oldValue = this.component;

        component = c;
        firePropertyChange("component", oldValue, c);
    
public voidsetTipText(java.lang.String tipText)
Sets the text to show when the tool tip is displayed. The string tipText may be null.

param
tipText the String to display
beaninfo
preferred: true bound: true description: Sets the text of the tooltip

        String oldValue = this.tipText;
        this.tipText = tipText;
        firePropertyChange("tiptext", oldValue, tipText);
    
public voidupdateUI()
Resets the UI property to a value from the current look and feel.

see
JComponent#updateUI

        setUI((ToolTipUI)UIManager.getUI(this));
    
private voidwriteObject(java.io.ObjectOutputStream s)
See readObject and writeObject in JComponent for more information about serialization in Swing.

        s.defaultWriteObject();
        if (getUIClassID().equals(uiClassID)) {
            byte count = JComponent.getWriteObjCounter(this);
            JComponent.setWriteObjCounter(this, --count);
            if (count == 0 && ui != null) {
                ui.installUI(this);
            }
        }