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 java.beans.XMLEncoder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	JToolTip.AccessibleJToolTip This class implements accessibility support for the `JToolTip` class.

Field Summary

Modifier and Type	Field and Description
pack-priv JComponent	component Hides java.awt.Container.component.
pack-priv String	tipText
private static final String	uiClassID Hides javax.swing.JComponent.uiClassID.

Inherited from javax.swing.JComponent:: DEBUG_GRAPHICS_LOADED focusController ivSourceComponent listenerList paintingChild TOOL_TIP_TEXT_KEY ui UNDEFINED_CONDITION WHEN_ANCESTOR_OF_FOCUSED_COMPONENT WHEN_FOCUSED WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Access	Constructor and Description
public	JToolTip() Creates a tool tip.

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	alwaysOnTop() Overrides javax.swing.JComponent.alwaysOnTop. Always returns true since tooltips, by definition, should always be on top of all other windows.
public AccessibleContext	Returns: an AccessibleJToolTip that serves as the AccessibleContext of this JToolTip getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JToolTip.
public JComponent	Returns: the component that the tooltip describes getComponent() Returns the component the tooltip applies to.
public String	Returns: the `String` that is displayed getTipText() Returns the text that is shown when the tool tip is displayed.
public ToolTipUI	Returns: the `ToolTipUI` object that renders this component getUI() Overrides javax.swing.JComponent.getUI. Returns the L&F object that renders this component.
public String	Returns: the string "ToolTipUI" getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the L&F class that renders this component.
protected String	Returns: a string representation of this `JToolTip` paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this `JToolTip`.
public void	setComponent(JComponent the `JComponent` being described c) Specifies the component that the tooltip describes.
public void	setTipText(String the `String` to display tipText) Sets the text to show when the tool tip is displayed.
public void	updateUI() Overrides javax.swing.JComponent.updateUI. Resets the UI property to a value from the current look and feel.
private void	writeObject(ObjectOutputStream s) Hides javax.swing.JComponent.writeObject. See `readObject` and `writeObject` in `JComponent` for more information about serialization in Swing.

Inherited from javax.swing.JComponent:: _paintImmediately addAncestorListener addNotify addVetoableChangeListener checkIfChildObscuredBySibling clientPropertyChanged componentInputMapChanged computeVisibleRect computeVisibleRect compWriteObjectNotify contains createToolTip disable dndDone dropLocationForPoint enable firePropertyChange firePropertyChange firePropertyChange fireVetoableChange getActionForKeyStroke getActionMap getActionMap getAlignmentX getAlignmentY getAncestorListeners getAutoscrolls getBaseline getBaselineResizeBehavior getBorder getBounds getClientProperty getComponentGraphics getComponentPopupMenu getConditionForKeyStroke getCreatedDoubleBuffer getDebugGraphicsOptions getDefaultLocale getFontMetrics getGraphics getGraphicsInvoked getHeight getInheritsPopupMenu getInputMap getInputMap getInputMap getInputVerifier getInsets getInsets getListeners getLocation getManagingFocusBackwardTraversalKeys getManagingFocusForwardTraversalKeys getMaximumSize getMinimumSize getNextFocusableComponent getPopupLocation getPreferredSize getRegisteredKeyStrokes getRootPane getSize getToolTipLocation getToolTipText getToolTipText getTopLevelAncestor getTransferHandler getVerifyInputWhenFocusTarget getVetoableChangeListeners getVisibleRect getWidth getWriteObjCounter getX getY grabFocus hide isDoubleBuffered isLightweightComponent isManagingFocus isOpaque isOptimizedDrawingEnabled isPainting isPaintingForPrint isPaintingOrigin isPaintingTile isRequestFocusEnabled isValidateRoot paint paintBorder paintChildren paintComponent paintForceDoubleBuffered paintImmediately paintImmediately paintToOffscreen print printAll printBorder printChildren printComponent processComponentKeyEvent processKeyBinding processKeyBindings processKeyBindingsForAllComponents processKeyEvent processMouseEvent processMouseMotionEvent putClientProperty rectangleIsObscured registerKeyboardAction registerKeyboardAction removeAncestorListener removeNotify removeVetoableChangeListener repaint repaint requestDefaultFocus requestFocus requestFocus requestFocusInWindow requestFocusInWindow resetKeyboardActions reshape revalidate safelyGetGraphics safelyGetGraphics scrollRectToVisible setActionMap setAlignmentX setAlignmentY setAutoscrolls setBackground setBorder setComponentPopupMenu setCreatedDoubleBuffer setDebugGraphicsOptions setDefaultLocale setDoubleBuffered setDropLocation setEnabled setFocusTraversalKeys setFont setForeground setInheritsPopupMenu setInputMap setInputVerifier setMaximumSize setMinimumSize setNextFocusableComponent setOpaque setPaintingChild setPreferredSize setRequestFocusEnabled setToolTipText setTransferHandler setUI setUIProperty setVerifyInputWhenFocusTarget setVisible setWriteObjCounter shouldDebugGraphics superProcessMouseMotionEvent unregisterKeyboardAction update

Field Detail

component	back to summary
pack-priv JComponent component Hides java.awt.Container.component.

tipText	back to summary
pack-priv String tipText

uiClassID back to summary

uiClassID	back to summary
private static final String uiClassID Hides javax.swing.JComponent.uiClassID. See Also `getUIClassID`, `readObject`

private static final String uiClassID

Hides javax.swing.JComponent.uiClassID.

See Also: getUIClassID, readObject

Constructor Detail

JToolTip	back to summary
public JToolTip() Creates a tool tip.

Method Detail

alwaysOnTop	back to summary
pack-priv boolean alwaysOnTop() Overrides javax.swing.JComponent.alwaysOnTop. Always returns true since tooltips, by definition, should always be on top of all other windows.

alwaysOnTop

back to summary

pack-priv boolean alwaysOnTop()

Overrides javax.swing.JComponent.alwaysOnTop.

Always returns true since tooltips, by definition, should always be on top of all other windows.

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.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. Returns:AccessibleContext an AccessibleJToolTip that serves as the AccessibleContext of this JToolTip

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.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.

Returns:AccessibleContext: an AccessibleJToolTip that serves as the AccessibleContext of this JToolTip

getComponent back to summary

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

public JComponent getComponent()

Returns the component the tooltip applies to. The returned value may be null.

Returns:JComponent: the component that the tooltip describes
See Also: JComponent#createToolTip

getTipText back to summary

getTipText	back to summary
public String getTipText() Returns the text that is shown when the tool tip is displayed. The returned value may be `null`. Returns:String the `String` that is displayed

public String getTipText()

Returns the text that is shown when the tool tip is displayed. The returned value may be null.

Returns:String: the String that is displayed

getUI back to summary

getUI	back to summary
public ToolTipUI getUI() Overrides javax.swing.JComponent.getUI. Returns the L&F object that renders this component. Returns:ToolTipUI the `ToolTipUI` object that renders this component

public ToolTipUI getUI()

Overrides javax.swing.JComponent.getUI.

Returns the L&F object that renders this component.

Returns:ToolTipUI: the ToolTipUI object that renders this component

getUIClassID back to summary

getUIClassID	back to summary
public String getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the L&F class that renders this component. Returns:String the string "ToolTipUI" See Also `JComponent#getUIClassID`, `UIDefaults#getUI`

public String getUIClassID()

Overrides javax.swing.JComponent.getUIClassID.

Returns the name of the L&F class that renders this component.

Returns:String: the string "ToolTipUI"
See Also: JComponent#getUIClassID, UIDefaults#getUI

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.JComponent.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`. Returns:String a string representation of this `JToolTip`

protected String paramString()

Overrides javax.swing.JComponent.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.

Returns:String: a string representation of this JToolTip

setComponent back to summary

setComponent	back to summary
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:JComponent the `JComponent` being described Annotations @BeanProperty description:Sets the component that the tooltip describes. See Also `JComponent#createToolTip`

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:JComponent: the JComponent being described

Annotations

@BeanProperty
description:Sets the component that the tooltip describes.

See Also

JComponent#createToolTip

setTipText back to summary

setTipText	back to summary
public void setTipText(String tipText) Sets the text to show when the tool tip is displayed. The string `tipText` may be `null`. Parameters tipText:String the `String` to display Annotations @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:String: the String to display

Annotations

@BeanProperty
preferred:true
description:Sets the text of the tooltip

updateUI back to summary

updateUI	back to summary
public void updateUI() Overrides javax.swing.JComponent.updateUI. Resets the UI property to a value from the current look and feel. See Also `JComponent#updateUI`

public void updateUI()

Overrides javax.swing.JComponent.updateUI.

Resets the UI property to a value from the current look and feel.

See Also: JComponent#updateUI

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream s) throws IOException Hides javax.swing.JComponent.writeObject. See `readObject` and `writeObject` in `JComponent` for more information about serialization in Swing. Annotations @Serial Exceptions IOException: Doc from java.awt.Container.writeObject. if an I/O error occurs

private void writeObject(ObjectOutputStream s) throws IOException

Hides javax.swing.JComponent.writeObject.

See readObject and writeObject in JComponent for more information about serialization in Swing.

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.writeObject.

if an I/O error occurs

javax.swing back to summary

protected Class JToolTip.AccessibleJToolTip

Class Inheritance

extends AccessibleJComponent

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.JToolTip.AccessibleJToolTip

Annotations

@SuppressWarnings:serial

This class implements accessibility support for the JToolTip class. It provides an implementation of the Java Accessibility API appropriate to tool tip user-interface elements.

Warning

Field Summary

Inherited from javax.swing.JComponent.AccessibleJComponent:: accessibleFocusHandler

Constructor Summary

Access	Constructor and Description
protected	AccessibleJToolTip() Constructs an `AccessibleJToolTip`.

Method Summary

Modifier and Type	Method and Description
public String	Returns: a localized String describing this object. getAccessibleDescription() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleDescription. Get the accessible description of this object.
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object.

Inherited from javax.swing.JComponent.AccessibleJComponent:: addPropertyChangeListener getAccessibleChild getAccessibleChildrenCount getAccessibleExtendedComponent getAccessibleKeyBinding getAccessibleName getAccessibleStateSet getBorderTitle getTitledBorderText getToolTipText removePropertyChangeListener

Constructor Detail

AccessibleJToolTip	back to summary
protected AccessibleJToolTip() Constructs an `AccessibleJToolTip`.

Method Detail

getAccessibleDescription	back to summary
public String getAccessibleDescription() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleDescription. Get the accessible description of this object. Returns:String a localized String describing this object.

getAccessibleDescription

back to summary

public String getAccessibleDescription()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleDescription.

Get the accessible description of this object.

Returns:String: a localized String describing this object.

getAccessibleRole	back to summary
public AccessibleRole getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object. Returns:AccessibleRole an instance of AccessibleRole describing the role of the object

getAccessibleRole

back to summary

public AccessibleRole getAccessibleRole()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole.

Get the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object

public Class JToolTip

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JToolTip.AccessibleJToolTip

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail