JToolTip (ELib API)

Overview Package Class Tree Deprecated Index Help Legend

PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes

javax.swing
Class JToolTip

java.lang.Object
 |
 +--java.awt.Component
 |
 +--java.awt.Container
 |
 +--javax.swing.JComponent
 |
 +--javax.swing.JToolTip

All Implemented Interfaces:: Accessible, java.awt.image.ImageObserver, MenuContainer, Serializable

public class JToolTip
extends JComponent
implements Accessible

Safe:

See Also:: Serialized Form

Field Summary

(package private) JComponent component

(package private) String tipText

private static String uiClassID

Fields inherited from class javax.swing.JComponent

_bounds, accessibleContext, listenerList, paintingChild, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

JToolTip()
Enabled: Creates a tool tip.

Method Summary

(package private) boolean alwaysOnTop()
Always returns true since tooltips, by definition, should always be on top of all other windows.

AccessibleContext getAccessibleContext()
Suppressed: Gets the AccessibleContext associated with this JToolTip.

JComponent getComponent()
Suppressed: Returns the component the tooltip applies to.

String getTipText()
Enabled: Returns the text that is shown when the tool tip is displayed.

javax.swing.plaf.ToolTipUI getUI()
Suppressed: Returns the L&F object that renders this component.

String getUIClassID()
Suppressed: Returns the name of the L&F class that renders this component.

protected String paramString()
Returns a string representation of this JToolTip.

void setComponent(JComponent c)
Enabled: Specifies the component that the tooltip describes.

void setTipText(String tipText)
Enabled: Sets the text to show when the tool tip is displayed.

void updateUI()
Suppressed: Resets the UI property to a value from the current look and feel.

private void writeObject(ObjectOutputStream s)
See readObject and writeObject in JComponent for more information about serialization in Swing.

Methods inherited from class javax.swing.JComponent

_paintImmediately, addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, checkIfChildObscuredBySibling, componentInputMapChanged, computeVisibleRect, computeVisibleRect, compWriteObjectNotify, contains, createToolTip, disable, enable, enableSerialization, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getCreatedDoubleBuffer, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getManagingFocusBackwardTraversalKeys, getManagingFocusForwardTraversalKeys, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getWriteObjCounter, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyBindings, processKeyBindingsForAllComponents, processKeyEvent, processMouseMotionEvent, putClientProperty, rectangleIsObscured, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setCreatedDoubleBuffer, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPaintingChild, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, setWriteObjCounter, shouldDebugGraphics, superProcessMouseMotionEvent, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, get, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, iterate, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, size, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, toString, transferFocus, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

uiClassID

private static final String uiClassID

See Also:: getUIClassID(), JComponent.readObject(java.io.ObjectInputStream)

tipText

String tipText

component

JComponent component

Constructor Detail

JToolTip

public JToolTip()

Enabled: Creates a tool tip.

Method Detail

getUI

public javax.swing.plaf.ToolTipUI getUI()

Suppressed: Returns the L&F object that renders this component.

Returns:: the ToolTipUI object that renders this component

updateUI

public void updateUI()

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

Overrides:: updateUI in class JComponent

See Also:: JComponent.updateUI()

getUIClassID

public String getUIClassID()

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

Overrides:: getUIClassID in class JComponent

Returns:: the string "ToolTipUI"
See Also:: JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setTipText

public void setTipText(String tipText)

Enabled: 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()

Enabled: 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

public void setComponent(JComponent c)

Enabled: 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()

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

Returns:: the component that the tooltip describes
See Also:: JComponent.createToolTip()

alwaysOnTop

boolean alwaysOnTop()

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

Overrides:: alwaysOnTop in class JComponent

Returns:: always returns false

writeObject

private void writeObject(ObjectOutputStream s)
 throws IOException

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

Parameters:: s - the ObjectOutputStream in which to write; IOException

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()

Suppressed: 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 JComponent

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