Package org.pushingpixels.flamingo.api.common

Class RichTooltipManager

java.lang.Object

org.pushingpixels.flamingo.api.common.RichTooltipManager

public class RichTooltipManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RichTooltipManager.JTrackableComponent

Method Summary

Modifier and Type	Method	Description
int	getDismissDelay()	Returns the dismissal delay value.
int	getInitialDelay()	Returns the initial delay value.
void	hideCurrentlyShowingTipIfNecessary()
void	registerComponent(RichTooltipManager.JTrackableComponent comp)	Registers a component for tooltip management.
void	setDismissDelay(int milliseconds)	Specifies the dismissal delay value.
void	setInitialDelay(int milliseconds)	Specifies the initial delay value.
static RichTooltipManager	sharedInstance()	Returns a shared ToolTipManager instance.
void	unregisterComponent(RichTooltipManager.JTrackableComponent comp)	Removes a component from tooltip control.

Methods inherited from class java.lang.Object

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

Method Detail

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 integer representing the initial delay value, in milliseconds

See Also:

setInitialDelay(int)

setDismissDelay

public void setDismissDelay(int milliseconds)

Specifies the dismissal delay value.

Parameters:

milliseconds - the number of milliseconds to delay before taking away the tooltip

See Also:

getDismissDelay()

getDismissDelay

public int getDismissDelay()

Returns the dismissal delay value.

Returns:

an integer representing the dismissal delay value, in milliseconds

See Also:

setDismissDelay(int)

sharedInstance

public static RichTooltipManager sharedInstance()

Returns a shared ToolTipManager instance.

Returns:

a shared ToolTipManager object

registerComponent

public void registerComponent(RichTooltipManager.JTrackableComponent comp)

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:

comp - a JComponent object to add

See Also:

Component.isFocusTraversable()

unregisterComponent

public void unregisterComponent(RichTooltipManager.JTrackableComponent comp)

Removes a component from tooltip control.

Parameters:

comp - a JComponent object to remove

hideCurrentlyShowingTipIfNecessary

public void hideCurrentlyShowingTipIfNecessary()