Home » openjdk-7 » javax » swing » [javadoc | source]
javax.swing
public class: ToolTipManager [javadoc | source]
java.lang.Object
   java.awt.event.MouseAdapter
      javax.swing.ToolTipManager

All Implemented Interfaces:
    MouseMotionListener, MouseListener, MouseWheelListener

Manages all the ToolTips in the system.

ToolTipManager contains numerous properties for configuring how long it will take for the tooltips to become visible, and how long till they hide. Consider a component that has a different tooltip based on where the mouse is, such as JTree. When the mouse moves into the JTree and over a region that has a valid tooltip, the tooltip will become visibile after initialDelay milliseconds. After dismissDelay milliseconds the tooltip will be hidden. If the mouse is over a region that has a valid tooltip, and the tooltip is currently visible, when the mouse moves to a region that doesn't have a valid tooltip the tooltip will be hidden. If the mouse then moves back into a region that has a valid tooltip within reshowDelay milliseconds, the tooltip will immediately be shown, otherwise the tooltip will be shown again after initialDelay milliseconds.

Nested Class Summary:
protected class  ToolTipManager.insideTimerAction   
protected class  ToolTipManager.outsideTimerAction   
protected class  ToolTipManager.stillInsideTimerAction   
Field Summary
 Timer enterTimer     
 Timer exitTimer     
 Timer insideTimer     
 String toolTipText     
 Point preferredLocation     
 JComponent insideComponent     
 MouseEvent mouseEvent     
 boolean showImmediately     
transient  Popup tipWindow     
 JToolTip tip     
 boolean enabled     
protected  boolean lightWeightPopupEnabled     
protected  boolean heavyWeightPopupEnabled     
Constructor:
 ToolTipManager() 
Method from javax.swing.ToolTipManager Summary:
frameForComponent,   getDismissDelay,   getInitialDelay,   getReshowDelay,   hideTipWindow,   isEnabled,   isLightWeightPopupEnabled,   mouseDragged,   mouseEntered,   mouseExited,   mouseMoved,   mousePressed,   registerComponent,   setDismissDelay,   setEnabled,   setInitialDelay,   setLightWeightPopupEnabled,   setReshowDelay,   sharedInstance,   showTipWindow,   unregisterComponent
Methods from java.awt.event.MouseAdapter:
mouseClicked,   mouseDragged,   mouseEntered,   mouseExited,   mouseMoved,   mousePressed,   mouseReleased,   mouseWheelMoved
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.ToolTipManager Detail:
 static Frame frameForComponent(Component component) 
 public int getDismissDelay() 
    Returns the dismissal delay value.
 public int getInitialDelay() 
    Returns the initial delay value.
 public int getReshowDelay() 
    Returns the reshow delay property.
  void hideTipWindow() 
 public boolean isEnabled() 
    Returns true if this object is enabled.
 public boolean 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 event) 
    Called when the mouse is pressed and dragged. Does nothing.
 public  void mouseEntered(MouseEvent event) 
    Called when the mouse enters the region of a component. This determines whether the tool tip should be shown.
 public  void mouseExited(MouseEvent event) 
    Called when the mouse exits the region of a component. Any tool tip showing should be hidden.
 public  void mouseMoved(MouseEvent event) 
    Called when the mouse is moved. Determines whether the tool tip should be displayed.
 public  void mousePressed(MouseEvent event) 
    Called when the mouse is pressed. Any tool tip showing should be hidden.
 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.

 public  void setDismissDelay(int milliseconds) 
    Specifies the dismissal delay value.
 public  void setEnabled(boolean flag) 
    Enables or disables the tooltip.
 public  void setInitialDelay(int milliseconds) 
    Specifies the initial delay value.
 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.
 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.
 public static ToolTipManager sharedInstance() 
    Returns a shared ToolTipManager instance.
  void showTipWindow() 
 public  void unregisterComponent(JComponent component) 
    Removes a component from tooltip control.