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 ToolTip
s. 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
.
Modifier and Type | Class and Description |
---|---|
protected class |
JToolTip.AccessibleJToolTip This class implements accessibility support for the |
JComponent.AccessibleJComponent
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
public JToolTip()
Creates a tool tip.
public ToolTipUI getUI()
Returns the L&F object that renders this component.
ToolTipUI
object that renders this componentpublic void updateUI()
Resets the UI property to a value from the current look and feel.
updateUI
in class JComponent
JComponent.updateUI()
public String getUIClassID()
Returns the name of the L&F class that renders this component.
getUIClassID
in class JComponent
JComponent.getUIClassID()
, UIDefaults.getUI(javax.swing.JComponent)
public void setTipText(String tipText)
Sets the text to show when the tool tip is displayed. The string tipText
may be null
.
tipText
- the String
to displaypublic String getTipText()
Returns the text that is shown when the tool tip is displayed. The returned value may be null
.
String
that is displayedpublic 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.
c
- the JComponent
being describedJComponent.createToolTip()
public JComponent getComponent()
Returns the component the tooltip applies to. The returned value may be null
.
JComponent.createToolTip()
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
.
paramString
in class JComponent
JToolTip
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.
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Component
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.