Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ToolTipManager.AccessibilityKeyListener
protected class	ToolTipManager.insideTimerAction Inside timer action.
private class	ToolTipManager.MoveBeforeEnterListener
protected class	ToolTipManager.outsideTimerAction Outside timer action.
protected class	ToolTipManager.stillInsideTimerAction Still inside timer action.

Field Summary

Modifier and Type	Field and Description
private KeyListener	accessibilityKeyListener
pack-priv boolean	enabled
pack-priv Timer	enterTimer
pack-priv Timer	exitTimer
private FocusListener	focusChangeListener
protected boolean	heavyWeightPopupEnabled Heavyweight popup enabled.
private KeyStroke	hideTip
pack-priv JComponent	insideComponent
pack-priv Timer	insideTimer
protected boolean	lightWeightPopupEnabled Lightweight popup enabled.
private static ToolTipManager	manager
pack-priv MouseEvent	mouseEvent
private MouseMotionListener	moveBeforeEnterListener
private Rectangle	popupFrameRect
private Rectangle	popupRect
private KeyStroke	postTip
pack-priv Point	preferredLocation
pack-priv boolean	showImmediately
pack-priv JToolTip	tip
private boolean	tipShowing
pack-priv transient Popup	tipWindow
pack-priv String	toolTipText
private Window	window The Window tip is being displayed in. This will be non-null if the Window tip is in differs from that of insideComponent's Window.

Constructor Summary

Access	Constructor and Description
pack-priv	ToolTipManager()

Method Summary

Modifier and Type	Method and Description
private void	checkForTipChange(MouseEvent event) Checks to see if the tooltip needs to be changed in response to the MouseMoved event `event`.
private FocusListener	createFocusChangeListener()
pack-priv static Frame	frameForComponent(Component component)
public int	Returns: an integer representing the dismissal delay value, in milliseconds getDismissDelay() Returns the dismissal delay value.
private GraphicsConfiguration	getDrawingGC(Point toFind)
private int	getHeightAdjust(Rectangle a, Rectangle b)
public int	Returns: an integer representing the initial delay value, in milliseconds getInitialDelay() Returns the initial delay value.
private int	getPopupFitHeight(Rectangle popupRectInScreen, Component invoker)
private int	getPopupFitWidth(Rectangle popupRectInScreen, Component invoker)
public int	Returns: reshow delay property getReshowDelay() Returns the reshow delay property.
private int	getWidthAdjust(Rectangle a, Rectangle b)
private void	hide(JComponent source)
pack-priv void	hideTipWindow()
private void	initiateToolTip(MouseEvent event)
public boolean	Returns: true if this object is enabled, false otherwise isEnabled() Returns true if this object is enabled.
public boolean	Returns: true if lightweight `ToolTips` are in use isLightWeightPopupEnabled() Returns true if lightweight (all-Java) `Tooltips` are in use, or false if heavyweight (native peer) `Tooltips` are being used.
public void	mouseDragged(MouseEvent the event in question event) Overrides java.awt.event.MouseAdapter.mouseDragged. Implements java.awt.event.MouseMotionListener.mouseDragged. Called when the mouse is pressed and dragged.
public void	mouseEntered(MouseEvent the event in question event) Overrides java.awt.event.MouseAdapter.mouseEntered. Implements java.awt.event.MouseListener.mouseEntered. Called when the mouse enters the region of a component.
public void	mouseExited(MouseEvent the event in question event) Overrides java.awt.event.MouseAdapter.mouseExited. Implements java.awt.event.MouseListener.mouseExited. Called when the mouse exits the region of a component.
public void	mouseMoved(MouseEvent the event in question event) Overrides java.awt.event.MouseAdapter.mouseMoved. Implements java.awt.event.MouseMotionListener.mouseMoved. Called when the mouse is moved.
public void	mousePressed(MouseEvent the event in question event) Overrides java.awt.event.MouseAdapter.mousePressed. Implements java.awt.event.MouseListener.mousePressed. Called when the mouse is pressed.
public void	registerComponent(JComponent a `JComponent` object to add component) Registers a component for tooltip management.
public void	setDismissDelay(int the number of milliseconds to delay before taking away the tooltip milliseconds) Specifies the dismissal delay value.
public void	setEnabled(boolean true to enable the tip, false otherwise flag) Enables or disables the tooltip.
public void	setInitialDelay(int the number of milliseconds to delay (after the cursor has paused) before displaying the tooltip milliseconds) Specifies the initial delay value.
public void	setLightWeightPopupEnabled(boolean true if a lightweight panel is desired, false otherwise aFlag) When displaying the `JToolTip`, the `ToolTipManager` chooses to use a lightweight `JPanel` if it fits.
public void	setReshowDelay(int time in milliseconds milliseconds) Used to specify the amount of time before the user has to wait `initialDelay` milliseconds before a tooltip will be shown.
public static ToolTipManager	Returns: a shared `ToolTipManager` object sharedInstance() Returns a shared `ToolTipManager` instance.
private void	show(JComponent source)
pack-priv void	showTipWindow()
public void	unregisterComponent(JComponent a `JComponent` object to remove component) Removes a component from tooltip control.

Inherited from java.awt.event.MouseAdapter:: mouseClicked mouseReleased mouseWheelMoved

Field Detail

accessibilityKeyListener	back to summary
private KeyListener accessibilityKeyListener

enabled	back to summary
pack-priv boolean enabled

enterTimer	back to summary
pack-priv Timer enterTimer

exitTimer	back to summary
pack-priv Timer exitTimer

focusChangeListener	back to summary
private FocusListener focusChangeListener

heavyWeightPopupEnabled	back to summary
protected boolean heavyWeightPopupEnabled Heavyweight popup enabled.

hideTip	back to summary
private KeyStroke hideTip

insideComponent	back to summary
pack-priv JComponent insideComponent

insideTimer	back to summary
pack-priv Timer insideTimer

lightWeightPopupEnabled	back to summary
protected boolean lightWeightPopupEnabled Lightweight popup enabled.

manager	back to summary
private static ToolTipManager manager

mouseEvent	back to summary
pack-priv MouseEvent mouseEvent

moveBeforeEnterListener	back to summary
private MouseMotionListener moveBeforeEnterListener

popupFrameRect	back to summary
private Rectangle popupFrameRect

popupRect	back to summary
private Rectangle popupRect

postTip	back to summary
private KeyStroke postTip

preferredLocation	back to summary
pack-priv Point preferredLocation

showImmediately	back to summary
pack-priv boolean showImmediately

tip	back to summary
pack-priv JToolTip tip

tipShowing	back to summary
private boolean tipShowing

tipWindow	back to summary
pack-priv transient Popup tipWindow

toolTipText	back to summary
pack-priv String toolTipText

window	back to summary
private Window window The Window tip is being displayed in. This will be non-null if the Window tip is in differs from that of insideComponent's Window.

Constructor Detail

ToolTipManager	back to summary
pack-priv ToolTipManager() Annotations @SuppressWarnings:deprecation

Method Detail

checkForTipChange	back to summary
private void checkForTipChange(MouseEvent event) Checks to see if the tooltip needs to be changed in response to the MouseMoved event `event`.

createFocusChangeListener	back to summary
private FocusListener createFocusChangeListener()

frameForComponent	back to summary
pack-priv static Frame frameForComponent(Component component)

getDismissDelay back to summary

getDismissDelay	back to summary
public int getDismissDelay() Returns the dismissal delay value. Returns:int an integer representing the dismissal delay value, in milliseconds See Also `setDismissDelay`

public int getDismissDelay()

Returns the dismissal delay value.

Returns:int: an integer representing the dismissal delay value, in milliseconds
See Also: setDismissDelay

getDrawingGC	back to summary
private GraphicsConfiguration getDrawingGC(Point toFind)

getHeightAdjust	back to summary
private int getHeightAdjust(Rectangle a, Rectangle b)

getInitialDelay back to summary

getInitialDelay	back to summary
public int getInitialDelay() Returns the initial delay value. Returns:int an integer representing the initial delay value, in milliseconds See Also `setInitialDelay`

public int getInitialDelay()

Returns the initial delay value.

Returns:int: an integer representing the initial delay value, in milliseconds
See Also: setInitialDelay

getPopupFitHeight	back to summary
private int getPopupFitHeight(Rectangle popupRectInScreen, Component invoker)

getPopupFitWidth	back to summary
private int getPopupFitWidth(Rectangle popupRectInScreen, Component invoker)

getReshowDelay back to summary

getReshowDelay	back to summary
public int getReshowDelay() Returns the reshow delay property. Returns:int reshow delay property See Also `setReshowDelay`

public int getReshowDelay()

Returns the reshow delay property.

Returns:int: reshow delay property
See Also: setReshowDelay

getWidthAdjust	back to summary
private int getWidthAdjust(Rectangle a, Rectangle b)

hide	back to summary
private void hide(JComponent source)

hideTipWindow	back to summary
pack-priv void hideTipWindow()

initiateToolTip	back to summary
private void initiateToolTip(MouseEvent event)

isEnabled	back to summary
public boolean isEnabled() Returns true if this object is enabled. Returns:boolean true if this object is enabled, false otherwise

isEnabled

back to summary

public boolean isEnabled()

Returns true if this object is enabled.

Returns:boolean: true if this object is enabled, false otherwise

isLightWeightPopupEnabled back to summary

isLightWeightPopupEnabled	back to summary
public boolean isLightWeightPopupEnabled() Returns true if lightweight (all-Java) `Tooltips` are in use, or false if heavyweight (native peer) `Tooltips` are being used. Returns:boolean true if lightweight `ToolTips` are in use

public boolean isLightWeightPopupEnabled()

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

Returns:boolean: true if lightweight ToolTips are in use

mouseDragged	back to summary
public void mouseDragged(MouseEvent event) Overrides java.awt.event.MouseAdapter.mouseDragged. Implements java.awt.event.MouseMotionListener.mouseDragged. Called when the mouse is pressed and dragged. Does nothing. Parameters event:MouseEvent the event in question

mouseDragged

back to summary

public void mouseDragged(MouseEvent event)

Overrides java.awt.event.MouseAdapter.mouseDragged.

Implements java.awt.event.MouseMotionListener.mouseDragged.

Called when the mouse is pressed and dragged. Does nothing.

Parameters

event:MouseEvent: the event in question

mouseEntered	back to summary
public void mouseEntered(MouseEvent event) Overrides java.awt.event.MouseAdapter.mouseEntered. Implements java.awt.event.MouseListener.mouseEntered. Called when the mouse enters the region of a component. This determines whether the tool tip should be shown. Parameters event:MouseEvent the event in question

mouseEntered

back to summary

public void mouseEntered(MouseEvent event)

Overrides java.awt.event.MouseAdapter.mouseEntered.

Implements java.awt.event.MouseListener.mouseEntered.

Called when the mouse enters the region of a component. This determines whether the tool tip should be shown.

Parameters

event:MouseEvent: the event in question

mouseExited	back to summary
public void mouseExited(MouseEvent event) Overrides java.awt.event.MouseAdapter.mouseExited. Implements java.awt.event.MouseListener.mouseExited. Called when the mouse exits the region of a component. Any tool tip showing should be hidden. Parameters event:MouseEvent the event in question

mouseExited

back to summary

public void mouseExited(MouseEvent event)

Overrides java.awt.event.MouseAdapter.mouseExited.

Implements java.awt.event.MouseListener.mouseExited.

Called when the mouse exits the region of a component. Any tool tip showing should be hidden.

Parameters

event:MouseEvent: the event in question

mouseMoved	back to summary
public void mouseMoved(MouseEvent event) Overrides java.awt.event.MouseAdapter.mouseMoved. Implements java.awt.event.MouseMotionListener.mouseMoved. Called when the mouse is moved. Determines whether the tool tip should be displayed. Parameters event:MouseEvent the event in question

mouseMoved

back to summary

public void mouseMoved(MouseEvent event)

Overrides java.awt.event.MouseAdapter.mouseMoved.

Implements java.awt.event.MouseMotionListener.mouseMoved.

Called when the mouse is moved. Determines whether the tool tip should be displayed.

Parameters

event:MouseEvent: the event in question

mousePressed	back to summary
public void mousePressed(MouseEvent event) Overrides java.awt.event.MouseAdapter.mousePressed. Implements java.awt.event.MouseListener.mousePressed. Called when the mouse is pressed. Any tool tip showing should be hidden. Parameters event:MouseEvent the event in question

mousePressed

back to summary

public void mousePressed(MouseEvent event)

Overrides java.awt.event.MouseAdapter.mousePressed.

Implements java.awt.event.MouseListener.mousePressed.

Called when the mouse is pressed. Any tool tip showing should be hidden.

Parameters

event:MouseEvent: the event in question

registerComponent back to summary

registerComponent	back to summary
public void registerComponent(JComponent component) Registers 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:JComponent a `JComponent` object to add See Also `JComponent#isFocusTraversable`

public void registerComponent(JComponent component)

Registers 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:JComponent: a JComponent object to add

See Also

JComponent#isFocusTraversable

setDismissDelay back to summary

public void setDismissDelay(int milliseconds)

Specifies the dismissal delay value.

Parameters

milliseconds:int: the number of milliseconds to delay before taking away the tooltip

See Also

getDismissDelay

setEnabled

back to summary

public void setEnabled(boolean flag)

Enables or disables the tooltip.

Parameters

flag:boolean: true to enable the tip, false otherwise

setInitialDelay back to summary

public void setInitialDelay(int milliseconds)

Specifies the initial delay value.

Parameters

milliseconds:int: the number of milliseconds to delay (after the cursor has paused) before displaying the tooltip

See Also

getInitialDelay

setLightWeightPopupEnabled back to summary

public void setLightWeightPopupEnabled(boolean aFlag)

When displaying the JToolTip, the ToolTipManager chooses to use a lightweight 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.

Parameters

aFlag:boolean: true if a lightweight panel is desired, false otherwise

setReshowDelay back to summary

public void setReshowDelay(int milliseconds)

Used to specify the amount of time before the user has to wait initialDelay milliseconds 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 within milliseconds milliseconds the tooltip will immediately be shown. Otherwise, if the user moves into a region with a valid tooltip after milliseconds milliseconds, the user will have to wait an additional initialDelay milliseconds before the tooltip is shown again.

Parameters

milliseconds:int: time in milliseconds

See Also

getReshowDelay

sharedInstance back to summary

public static ToolTipManager sharedInstance()

Returns a shared ToolTipManager instance.

Returns:ToolTipManager: a shared ToolTipManager object

show	back to summary
private void show(JComponent source)

showTipWindow	back to summary
pack-priv void showTipWindow()

unregisterComponent back to summary

public void unregisterComponent(JComponent component)

Removes a component from tooltip control.

Parameters

component:JComponent: a JComponent object to remove

javax.swing back to summary

private Class ToolTipManager.AccessibilityKeyListener

Class Inheritance

extends KeyAdapter
implements MenuKeyListener

java.lang.Object
java.awt.event.KeyAdapter
javax.swing.ToolTipManager.AccessibilityKeyListener

All Implemented Interfaces

javax.swing.event.MenuKeyListener, java.util.EventListener

Constructor Summary

Access	Constructor and Description
private	AccessibilityKeyListener()

Method Summary

Modifier and Type	Method and Description
public void	keyPressed(KeyEvent e) Overrides java.awt.event.KeyAdapter.keyPressed. Implements java.awt.event.KeyListener.keyPressed. Invoked when a key has been pressed.
public void	menuKeyPressed(MenuKeyEvent e) Implements javax.swing.event.MenuKeyListener.menuKeyPressed. Invoked when a key has been pressed.
public void	menuKeyReleased(MenuKeyEvent e) Implements javax.swing.event.MenuKeyListener.menuKeyReleased. Invoked when a key has been released.
public void	menuKeyTyped(MenuKeyEvent e) Implements javax.swing.event.MenuKeyListener.menuKeyTyped. Invoked when a key has been typed.

Inherited from java.awt.event.KeyAdapter:: keyReleased keyTyped

Constructor Detail

AccessibilityKeyListener	back to summary
private AccessibilityKeyListener()

Method Detail

keyPressed

back to summary

public void keyPressed(KeyEvent e)

Overrides java.awt.event.KeyAdapter.keyPressed.

Implements java.awt.event.KeyListener.keyPressed.

Doc from java.awt.event.KeyAdapter.keyPressed.

Invoked when a key has been pressed.

menuKeyPressed

back to summary

public void menuKeyPressed(MenuKeyEvent e)

Implements javax.swing.event.MenuKeyListener.menuKeyPressed.

Doc from javax.swing.event.MenuKeyListener.menuKeyPressed.

Invoked when a key has been pressed.

Annotations

@Override

menuKeyReleased

back to summary

public void menuKeyReleased(MenuKeyEvent e)

Implements javax.swing.event.MenuKeyListener.menuKeyReleased.

Doc from javax.swing.event.MenuKeyListener.menuKeyReleased.

Invoked when a key has been released.

Annotations

@Override

menuKeyTyped

back to summary

public void menuKeyTyped(MenuKeyEvent e)

Implements javax.swing.event.MenuKeyListener.menuKeyTyped.

Doc from javax.swing.event.MenuKeyListener.menuKeyTyped.

Invoked when a key has been typed. This event occurs when a key press is followed by a key release.

Annotations

@Override

Method Summary

Modifier and Type	Method and Description
public void	actionPerformed(ActionEvent e) Implements java.awt.event.ActionListener.actionPerformed. Invoked when an action occurs.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

insideTimerAction	back to summary
protected insideTimerAction() Constructs an `insideTimerAction`.

Method Detail

actionPerformed

back to summary

public void actionPerformed(ActionEvent e)

Implements java.awt.event.ActionListener.actionPerformed.

Doc from java.awt.event.ActionListener.actionPerformed.

Invoked when an action occurs.

javax.swing back to summary

private Class ToolTipManager.MoveBeforeEnterListener

Class Inheritance

extends MouseMotionAdapter

java.lang.Object
java.awt.event.MouseMotionAdapter
javax.swing.ToolTipManager.MoveBeforeEnterListener

Constructor Summary

Access	Constructor and Description
private	MoveBeforeEnterListener()

Method Summary

Modifier and Type	Method and Description
public void	mouseMoved(MouseEvent e) Overrides java.awt.event.MouseMotionAdapter.mouseMoved. Implements java.awt.event.MouseMotionListener.mouseMoved. Invoked when the mouse button has been moved on a component (with no buttons no down).