javax.swing
Class ToolTipManager

java.lang.Object
  |
  +--java.awt.event.MouseAdapter
        |
        +--javax.swing.ToolTipManager

All Implemented Interfaces:

EventListener, MouseListener, MouseMotionListener

public class ToolTipManager

extends MouseAdapter

implements MouseMotionListener

Manages all the ToolTips in the system.

See Also:

JComponent.createToolTip()

Inner Class Summary

protected class	ToolTipManager.insideTimerAction
protected class	ToolTipManager.outsideTimerAction
protected class	ToolTipManager.stillInsideTimerAction

Field Summary

protected boolean	heavyWeightPopupEnabled
protected boolean	lightWeightPopupEnabled

Method Summary

int	getDismissDelay() Returns the dismisal delay value.
int	getInitialDelay() Returns the initial delay value.
int	getReshowDelay() Returns the reshow delay value.
boolean	isEnabled() Returns true if this object is enabled.
boolean	isLightWeightPopupEnabled() Returns true if lightweight (all-Java) Tooltips are in use, or false if heavyweight (native peer) Tooltips are being used.
void	mouseDragged(MouseEvent event) Invoked when a mouse button is pressed on a component and then dragged.
void	mouseEntered(MouseEvent event) Invoked when the mouse enters a component.
void	mouseExited(MouseEvent event) Invoked when the mouse exits a component.
void	mouseMoved(MouseEvent event) Invoked when the mouse button has been moved on a component (with no buttons no down).
void	mousePressed(MouseEvent event) Invoked when a mouse button has been pressed on a component.
void	registerComponent(JComponent component) Register a component for tooltip management.
void	setDismissDelay(int milliseconds) Specifies the dismisal delay value.
void	setEnabled(boolean flag) Enables or disables the tooltip.
void	setInitialDelay(int milliseconds) Specifies the initial delay value.
void	setLightWeightPopupEnabled(boolean aFlag) When displaying the JToolTip, the ToolTipManager choose to use a light weight JPanel if it fits.
void	setReshowDelay(int milliseconds) Specifies the time to delay before reshowing the tooltip.
static ToolTipManager	sharedInstance() Returns a shared ToolTipManager instance.
void	unregisterComponent(JComponent component) Remove a component from tooltip control.

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

heavyWeightPopupEnabled

protected boolean heavyWeightPopupEnabled

Method Detail

setEnabled

public void setEnabled(boolean flag)

Enables or disables the tooltip.

Parameters:

flag - true to enable the tip

isEnabled

public boolean isEnabled()

Returns true if this object is enabled.

Returns:

true if this object is enabled

setLightWeightPopupEnabled

public void setLightWeightPopupEnabled(boolean aFlag)

When displaying the JToolTip, the ToolTipManager choose to use a light weight JPanel if 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.

isLightWeightPopupEnabled

public boolean isLightWeightPopupEnabled()

Returns true if lightweight (all-Java) Tooltips are in use, or false if heavyweight (native peer) Tooltips are being used.

Returns:

true if lightweight ToolTips are in use

setInitialDelay

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

getInitialDelay()

getInitialDelay

public int getInitialDelay()

Returns the initial delay value.

Returns:

an int representing the initial delay value

See Also:

setInitialDelay(int)

setDismissDelay

public void setDismissDelay(int milliseconds)

Specifies the dismisal delay value.

Parameters:

milliseconds - the number of milliseconds to delay (after the cursor has moved on) before taking away the tooltip

See Also:

getDismissDelay()

getDismissDelay

public int getDismissDelay()

Returns the dismisal delay value.

Returns:

an int representing the dismisal delay value

See Also:

setDismissDelay(int)

setReshowDelay

public void setReshowDelay(int milliseconds)

Specifies the time to delay before reshowing the tooltip.

Parameters:

milliseconds - the time in milliseconds to delay before reshowing the tooltip if the cursor stops again

See Also:

getReshowDelay()

getReshowDelay

public int getReshowDelay()

Returns the reshow delay value.

Returns:

an int representing the reshow delay value

See Also:

setReshowDelay(int)

sharedInstance

public static ToolTipManager sharedInstance()

Returns a shared ToolTipManager instance.

Returns:

a shared ToolTipManager object

registerComponent

public void registerComponent(JComponent component)

Register a component for tooltip management.

This will register key bindings to show and hide the tooltip text only if component has focus bindings. This is done so that components that are not normally focus traversable, such as JLabel, are not made focus traversable as a result of invoking this method.

Parameters:

component - a JComponent object

See Also:

JComponent.isFocusTraversable()

unregisterComponent

public void unregisterComponent(JComponent component)

Remove a component from tooltip control.

Parameters:

component - a JComponent object

mouseEntered

public void mouseEntered(MouseEvent event)

Description copied from class: MouseAdapter

Invoked when the mouse enters a component.

Overrides:

mouseEntered in class MouseAdapter

mouseExited

public void mouseExited(MouseEvent event)

Description copied from class: MouseAdapter

Invoked when the mouse exits a component.

Overrides:

mouseExited in class MouseAdapter

mousePressed

public void mousePressed(MouseEvent event)

Description copied from class: MouseAdapter

Invoked when a mouse button has been pressed on a component.

Overrides:

mousePressed in class MouseAdapter

mouseDragged

public void mouseDragged(MouseEvent event)

Description copied from interface: MouseMotionListener

Invoked when a mouse button is pressed on a component and then dragged. Mouse drag events will continue to be delivered to the component where the first originated until the mouse button is released (regardless of whether the mouse position is within the bounds of the component).

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent event)

Description copied from interface: MouseMotionListener

Invoked when the mouse button has been moved on a component (with no buttons no down).

Specified by:

mouseMoved in interface MouseMotionListener