javax.swing

Class ToolTipManager

java.lang.Object

java.awt.event.MouseAdapter

javax.swing.ToolTipManager

All Implemented Interfaces:

MouseListener, MouseMotionListener, EventListener

public class ToolTipManager
extends MouseAdapter
implements MouseMotionListener

This class is responsible for the registration of JToolTips to Components and for displaying them when appropriate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ToolTipManager.insideTimerAction This ActionListener is associated with the Timer that listens to whether it is time for the JToolTip to be displayed after the mouse has entered the JComponent.
protected class	ToolTipManager.outsideTimerAction This Actionlistener is associated with the Timer that listens to whether the mouse cursor has re-entered the JComponent in time for an immediate redisplay of the JToolTip.
protected class	ToolTipManager.stillInsideTimerAction This ActionListener is associated with the Timer that listens to whether the JToolTip can be hidden after four seconds.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	heavyWeightPopupEnabled heavyWeightPopupEnabled
protected boolean	lightWeightPopupEnabled lightWeightPopupEnabled

Method Summary

Methods

Modifier and Type	Method and Description
int	getDismissDelay() This method returns the time the ToolTip will be shown before being hidden.
int	getInitialDelay() This method returns the initial delay before the ToolTip is shown when the mouse enters a Component.
int	getReshowDelay() This method returns the amount of delay where if the mouse re-enters a Component, the tooltip will be shown immediately.
boolean	isEnabled() This method returns whether ToolTips are enabled.
boolean	isLightWeightPopupEnabled() This method returns whether LightweightToolTips are enabled.
void	mouseDragged(MouseEvent event) This method is called when the mouse is dragged in a JComponent registered with the ToolTipManager.
void	mouseEntered(MouseEvent event) This method is called whenever the mouse enters a JComponent registered with the ToolTipManager.
void	mouseExited(MouseEvent event) This method is called when the mouse exits a JComponent registered with the ToolTipManager.
void	mouseMoved(MouseEvent event) This method is called when the mouse is moved in a JComponent registered with the ToolTipManager.
void	mousePressed(MouseEvent event) This method is called when the mouse is pressed on a JComponent registered with the ToolTipManager.
void	registerComponent(JComponent component) This method registers a JComponent with the ToolTipManager.
void	setDismissDelay(int delay) Sets the time the ToolTip will be shown before being hidden.
void	setEnabled(boolean enabled) This method sets whether ToolTips are enabled or disabled for all JComponents.
void	setInitialDelay(int delay) Sets the initial delay before the ToolTip is shown when the mouse enters a Component.
void	setLightWeightPopupEnabled(boolean enabled) This method sets whether LightweightToolTips are enabled.
void	setReshowDelay(int delay) Sets the amount of delay where if the mouse re-enters a Component, the tooltip will be shown immediately.
static ToolTipManager	sharedInstance() This method returns the shared instance of ToolTipManager used by all JComponents.
void	unregisterComponent(JComponent component) This method unregisters a JComponent with the ToolTipManager.

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mouseReleased

Methods inherited from class java.lang.Object

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

Field Detail

lightWeightPopupEnabled

protected boolean lightWeightPopupEnabled

lightWeightPopupEnabled

heavyWeightPopupEnabled

protected boolean heavyWeightPopupEnabled

heavyWeightPopupEnabled

Method Detail

sharedInstance

public static ToolTipManager sharedInstance()

This method returns the shared instance of ToolTipManager used by all JComponents.

Returns:

The shared instance of ToolTipManager.

setEnabled

public void setEnabled(boolean enabled)

This method sets whether ToolTips are enabled or disabled for all JComponents.

Parameters:

enabled - Whether ToolTips are enabled or disabled for all JComponents.

isEnabled

public boolean isEnabled()

This method returns whether ToolTips are enabled.

Returns:

Whether ToolTips are enabled.

isLightWeightPopupEnabled

public boolean isLightWeightPopupEnabled()

This method returns whether LightweightToolTips are enabled.

Returns:

Whether LighweightToolTips are enabled.

setLightWeightPopupEnabled

public void setLightWeightPopupEnabled(boolean enabled)

This method sets whether LightweightToolTips are enabled. If you mix Lightweight and Heavyweight components, you must set this to false to ensure that the ToolTips popup above all other components.

Parameters:

enabled - Whether LightweightToolTips will be enabled.

getInitialDelay

public int getInitialDelay()

This method returns the initial delay before the ToolTip is shown when the mouse enters a Component.

Returns:

The initial delay before the ToolTip is shown.

setInitialDelay

public void setInitialDelay(int delay)

Sets the initial delay before the ToolTip is shown when the mouse enters a Component.

Parameters:

delay - The initial delay before the ToolTip is shown.

Throws:

IllegalArgumentException - if delay is less than zero.

getDismissDelay

public int getDismissDelay()

This method returns the time the ToolTip will be shown before being hidden.

Returns:

The time the ToolTip will be shown before being hidden.

setDismissDelay

public void setDismissDelay(int delay)

Sets the time the ToolTip will be shown before being hidden.

Parameters:

delay - the delay (in milliseconds) before tool tips are hidden.

Throws:

IllegalArgumentException - if delay is less than zero.

getReshowDelay

public int getReshowDelay()

This method returns the amount of delay where if the mouse re-enters a Component, the tooltip will be shown immediately.

Returns:

The reshow delay.

setReshowDelay

public void setReshowDelay(int delay)

Sets the amount of delay where if the mouse re-enters a Component, the tooltip will be shown immediately.

Parameters:

delay - The reshow delay (in milliseconds).

Throws:

IllegalArgumentException - if delay is less than zero.

registerComponent

public void registerComponent(JComponent component)

This method registers a JComponent with the ToolTipManager.

Parameters:

component - The JComponent to register with the ToolTipManager.

unregisterComponent

public void unregisterComponent(JComponent component)

This method unregisters a JComponent with the ToolTipManager.

Parameters:

component - The JComponent to unregister with the ToolTipManager.

mouseEntered

public void mouseEntered(MouseEvent event)

This method is called whenever the mouse enters a JComponent registered with the ToolTipManager. When the mouse enters within the period of time specified by the reshow delay, the tooltip will be displayed immediately. Otherwise, it must wait for the initial delay before displaying the tooltip.

Specified by:

mouseEntered in interface MouseListener

Overrides:

mouseEntered in class MouseAdapter

Parameters:

event - The MouseEvent.

mouseExited

public void mouseExited(MouseEvent event)

This method is called when the mouse exits a JComponent registered with the ToolTipManager. When the mouse exits, the tooltip should be hidden immediately.

Specified by:

mouseExited in interface MouseListener

Overrides:

mouseExited in class MouseAdapter

Parameters:

event - The MouseEvent.

mousePressed

public void mousePressed(MouseEvent event)

This method is called when the mouse is pressed on a JComponent registered with the ToolTipManager. When the mouse is pressed, the tooltip (if it is shown) must be hidden immediately.

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class MouseAdapter

Parameters:

event - The MouseEvent.

mouseDragged

public void mouseDragged(MouseEvent event)

This method is called when the mouse is dragged in a JComponent registered with the ToolTipManager.

Specified by:

mouseDragged in interface MouseMotionListener

Parameters:

event - The MouseEvent.

mouseMoved

public void mouseMoved(MouseEvent event)

This method is called when the mouse is moved in a JComponent registered with the ToolTipManager.

Specified by:

mouseMoved in interface MouseMotionListener

Parameters:

event - The MouseEvent.