Class RichToolTipManager
- java.lang.Object
-
- java.awt.event.MouseAdapter
-
- org.pushingpixels.flamingo.api.common.RichToolTipManager
-
- All Implemented Interfaces:
MouseListener,MouseMotionListener,MouseWheelListener,EventListener
public class RichToolTipManager extends MouseAdapter implements MouseMotionListener
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classRichToolTipManager.DismissTimerActionprotected classRichToolTipManager.InitialDelayTimerActionstatic classRichToolTipManager.JTrackableComponent
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetDismissDelay()Returns the dismissal delay value.intgetInitialDelay()Returns the initial delay value.voidmouseDragged(MouseEvent event)voidmouseEntered(MouseEvent event)voidmouseExited(MouseEvent event)voidmouseMoved(MouseEvent event)voidmousePressed(MouseEvent event)voidregisterComponent(RichToolTipManager.JTrackableComponent comp)Registers a component for tooltip management.voidsetDismissDelay(int milliseconds)Specifies the dismissal delay value.voidsetInitialDelay(int milliseconds)Specifies the initial delay value.static RichToolTipManagersharedInstance()Returns a sharedToolTipManagerinstance.voidunregisterComponent(RichToolTipManager.JTrackableComponent comp)Removes a component from tooltip control.-
Methods inherited from class java.awt.event.MouseAdapter
mouseClicked, mouseReleased, mouseWheelMoved
-
-
-
-
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 sharedToolTipManagerinstance.- Returns:
- a shared
ToolTipManagerobject
-
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
componenthas focus bindings. This is done so that components that are not normally focus traversable, such asJLabel, are not made focus traversable as a result of invoking this method.- Parameters:
comp- aJComponentobject to add- See Also:
Component.isFocusTraversable()
-
unregisterComponent
public void unregisterComponent(RichToolTipManager.JTrackableComponent comp)
Removes a component from tooltip control.- Parameters:
comp- aJComponentobject to remove
-
mouseEntered
public void mouseEntered(MouseEvent event)
- Specified by:
mouseEnteredin interfaceMouseListener- Overrides:
mouseEnteredin classMouseAdapter
-
mouseExited
public void mouseExited(MouseEvent event)
- Specified by:
mouseExitedin interfaceMouseListener- Overrides:
mouseExitedin classMouseAdapter
-
mousePressed
public void mousePressed(MouseEvent event)
- Specified by:
mousePressedin interfaceMouseListener- Overrides:
mousePressedin classMouseAdapter
-
mouseDragged
public void mouseDragged(MouseEvent event)
- Specified by:
mouseDraggedin interfaceMouseMotionListener- Overrides:
mouseDraggedin classMouseAdapter
-
mouseMoved
public void mouseMoved(MouseEvent event)
- Specified by:
mouseMovedin interfaceMouseMotionListener- Overrides:
mouseMovedin classMouseAdapter
-
-