Class ToolTipManager
- All Implemented Interfaces:
- MouseListener,- MouseMotionListener,- MouseWheelListener,- EventListener
ToolTips in the system.
 
 ToolTipManager contains numerous properties for configuring how long it
 will take for the tooltips to become visible, and how long till they
 hide. Consider a component that has a different tooltip based on where
 the mouse is, such as JTree. When the mouse moves into the JTree and
 over a region that has a valid tooltip, the tooltip will become
 visible after initialDelay milliseconds. After
 dismissDelay milliseconds the tooltip will be hidden. If
 the mouse is over a region that has a valid tooltip, and the tooltip
 is currently visible, when the mouse moves to a region that doesn't have
 a valid tooltip the tooltip will be hidden. If the mouse then moves back
 into a region that has a valid tooltip within reshowDelay
 milliseconds, the tooltip will immediately be shown, otherwise the
 tooltip will be shown again after initialDelay milliseconds.
- Since:
- 1.2
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected classInside timer action.protected classOutside timer action.protected classStill inside timer action.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected booleanHeavyweight popup enabled.protected booleanLightweight popup enabled.
- 
Method SummaryModifier and TypeMethodDescriptionintReturns the dismissal delay value.intReturns the initial delay value.intReturns the reshow delay property.booleanReturns true if this object is enabled.booleanReturns true if lightweight (all-Java)Tooltipsare in use, or false if heavyweight (native peer)Tooltipsare being used.voidmouseDragged(MouseEvent event) Called when the mouse is pressed and dragged.voidmouseEntered(MouseEvent event) Called when the mouse enters the region of a component.voidmouseExited(MouseEvent event) Called when the mouse exits the region of a component.voidmouseMoved(MouseEvent event) Called when the mouse is moved.voidmousePressed(MouseEvent event) Called when the mouse is pressed.voidregisterComponent(JComponent component) Registers a component for tooltip management.voidsetDismissDelay(int milliseconds) Specifies the dismissal delay value.voidsetEnabled(boolean flag) Enables or disables the tooltip.voidsetInitialDelay(int milliseconds) Specifies the initial delay value.voidsetLightWeightPopupEnabled(boolean aFlag) When displaying theJToolTip, theToolTipManagerchooses to use a lightweightJPanelif it fits.voidsetReshowDelay(int milliseconds) Used to specify the amount of time before the user has to waitinitialDelaymilliseconds before a tooltip will be shown.static ToolTipManagerReturns a sharedToolTipManagerinstance.voidunregisterComponent(JComponent component) Removes a component from tooltip control.Methods declared in class java.awt.event.MouseAdaptermouseClicked, mouseReleased, mouseWheelMoved
- 
Field Details- 
lightWeightPopupEnabledprotected boolean lightWeightPopupEnabledLightweight popup enabled.
- 
heavyWeightPopupEnabledprotected boolean heavyWeightPopupEnabledHeavyweight popup enabled.
 
- 
- 
Method Details- 
setEnabledpublic void setEnabled(boolean flag) Enables or disables the tooltip.- Parameters:
- flag- true to enable the tip, false otherwise
 
- 
isEnabledpublic boolean isEnabled()Returns true if this object is enabled.- Returns:
- true if this object is enabled, false otherwise
 
- 
setLightWeightPopupEnabledpublic void setLightWeightPopupEnabled(boolean aFlag) When displaying theJToolTip, theToolTipManagerchooses to use a lightweightJPanelif it fits. This method allows you to disable this feature. You have to do disable it if your application mixes light weight and heavy weights components.- Parameters:
- aFlag- true if a lightweight panel is desired, false otherwise
 
- 
isLightWeightPopupEnabledpublic boolean isLightWeightPopupEnabled()Returns true if lightweight (all-Java)Tooltipsare in use, or false if heavyweight (native peer)Tooltipsare being used.- Returns:
- true if lightweight ToolTipsare in use
 
- 
setInitialDelaypublic void setInitialDelay(int milliseconds) Specifies the initial delay value.- Parameters:
- milliseconds- the number of milliseconds to delay (after the cursor has paused) before displaying the tooltip
- See Also:
 
- 
getInitialDelaypublic int getInitialDelay()Returns the initial delay value.- Returns:
- an integer representing the initial delay value, in milliseconds
- See Also:
 
- 
setDismissDelaypublic void setDismissDelay(int milliseconds) Specifies the dismissal delay value.- Parameters:
- milliseconds- the number of milliseconds to delay before taking away the tooltip
- See Also:
 
- 
getDismissDelaypublic int getDismissDelay()Returns the dismissal delay value.- Returns:
- an integer representing the dismissal delay value, in milliseconds
- See Also:
 
- 
setReshowDelaypublic void setReshowDelay(int milliseconds) Used to specify the amount of time before the user has to waitinitialDelaymilliseconds before a tooltip will be shown. That is, if the tooltip is hidden, and the user moves into a region of the same Component that has a valid tooltip withinmillisecondsmilliseconds the tooltip will immediately be shown. Otherwise, if the user moves into a region with a valid tooltip aftermillisecondsmilliseconds, the user will have to wait an additionalinitialDelaymilliseconds before the tooltip is shown again.- Parameters:
- milliseconds- time in milliseconds
- See Also:
 
- 
getReshowDelaypublic int getReshowDelay()Returns the reshow delay property.- Returns:
- reshow delay property
- See Also:
 
- 
registerComponentRegisters a component for tooltip management.This will register key bindings to show and hide the tooltip text only if componenthas focus bindings. This is done so that components that are not normally focus traversable, such asJLabel, are not made focus traversable as a result of invoking this method.- Parameters:
- component- a- JComponentobject to add
- See Also:
 
- 
unregisterComponentRemoves a component from tooltip control.- Parameters:
- component- a- JComponentobject to remove
 
- 
mouseEnteredCalled when the mouse enters the region of a component. This determines whether the tool tip should be shown.- Specified by:
- mouseEnteredin interface- MouseListener
- Parameters:
- event- the event in question
 
- 
mouseExitedCalled when the mouse exits the region of a component. Any tool tip showing should be hidden.- Specified by:
- mouseExitedin interface- MouseListener
- Parameters:
- event- the event in question
 
- 
mousePressedCalled when the mouse is pressed. Any tool tip showing should be hidden.- Specified by:
- mousePressedin interface- MouseListener
- Parameters:
- event- the event in question
 
- 
mouseDraggedCalled when the mouse is pressed and dragged. Does nothing.- Specified by:
- mouseDraggedin interface- MouseMotionListener
- Overrides:
- mouseDraggedin class- MouseAdapter
- Parameters:
- event- the event in question
 
- 
mouseMovedCalled when the mouse is moved. Determines whether the tool tip should be displayed.- Specified by:
- mouseMovedin interface- MouseMotionListener
- Overrides:
- mouseMovedin class- MouseAdapter
- Parameters:
- event- the event in question
 
 
-