Package org.pushingpixels.radiance.component.api.common

Class RichTooltipManager

java.lang.Object

org.pushingpixels.radiance.component.api.common.RichTooltipManager

public class RichTooltipManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	RichTooltipManager.DismissTimerAction
private class	RichTooltipManager.InitialDelayTimerAction
static interface	RichTooltipManager.WithRichTooltip

Field Summary

Fields

Modifier and Type	Field	Description
private RichTooltipManager.WithRichTooltip	currentActiveTrackable
private javax.swing.Timer	dismissTimer
private javax.swing.Timer	initialDelayTimer
private java.awt.event.MouseEvent	lastMouseEvent
private java.awt.event.MouseEvent	lastMouseEventInCurrentActiveTrackableCoordinates
private RichTooltip	richTooltip
private static RichTooltipManager	sharedInstance
private JRichTooltipPanel	tip
private boolean	tipShowing
private javax.swing.Popup	tipWindow

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RichTooltipManager()

Method Summary

Modifier and Type	Method	Description
private void	checkForTipChange(java.awt.event.MouseEvent event, RichTooltipManager.WithRichTooltip component)
int	getDismissDelay()	Returns the dismissal delay value.
int	getInitialDelay()	Returns the initial delay value.
void	hideCurrentlyShowingTipIfNecessary()
private void	hideTipWindow()
private void	initiateToolTip(java.awt.event.MouseEvent original, RichTooltipManager.WithRichTooltip component)
private java.awt.event.MouseEvent	retarget(java.awt.event.MouseEvent original, java.awt.Component source, java.awt.Component target)
void	setDismissDelay(int milliseconds)	Specifies the dismissal delay value.
void	setInitialDelay(int milliseconds)	Specifies the initial delay value.
static RichTooltipManager	sharedInstance()	Returns a shared RichTooltipManager instance.
private void	showTipWindow(java.awt.event.MouseEvent mouseEvent)
private void	windDownTooltip()

Methods inherited from class java.lang.Object

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

Field Detail

initialDelayTimer

private javax.swing.Timer initialDelayTimer

dismissTimer

private javax.swing.Timer dismissTimer

richTooltip

private RichTooltip richTooltip

currentActiveTrackable

private RichTooltipManager.WithRichTooltip currentActiveTrackable

lastMouseEvent

private java.awt.event.MouseEvent lastMouseEvent

lastMouseEventInCurrentActiveTrackableCoordinates

private java.awt.event.MouseEvent lastMouseEventInCurrentActiveTrackableCoordinates

sharedInstance

private static final RichTooltipManager sharedInstance

tipWindow

private javax.swing.Popup tipWindow

tip

private JRichTooltipPanel tip

tipShowing

private boolean tipShowing

Constructor Detail

RichTooltipManager

private RichTooltipManager()

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)

retarget

private java.awt.event.MouseEvent retarget(java.awt.event.MouseEvent original,
                                           java.awt.Component source,
                                           java.awt.Component target)

showTipWindow

private void showTipWindow(java.awt.event.MouseEvent mouseEvent)

windDownTooltip

private void windDownTooltip()

hideTipWindow

private void hideTipWindow()

sharedInstance

public static RichTooltipManager sharedInstance()

Returns a shared RichTooltipManager instance.

Returns:

a shared RichTooltipManager object

hideCurrentlyShowingTipIfNecessary

public void hideCurrentlyShowingTipIfNecessary()

initiateToolTip

private void initiateToolTip(java.awt.event.MouseEvent original,
                             RichTooltipManager.WithRichTooltip component)

checkForTipChange

private void checkForTipChange(java.awt.event.MouseEvent event,
                               RichTooltipManager.WithRichTooltip component)