JavaTM 2 Platform
Standard Ed. 5.0

javax.swing
类 ToolTipManager

java.lang.Object
  继承者 java.awt.event.MouseAdapter
      继承者 javax.swing.ToolTipManager
所有已实现的接口:
MouseListener, MouseMotionListener, EventListener

public class ToolTipManager
extends MouseAdapter
implements MouseMotionListener

管理系统中的所有 ToolTips

ToolTipManager 包含众多属性,用于配置该工具提示需要多长时间显示出来,需要多长时间隐藏。考虑一个在不同的鼠标位置(如 JTree)有不同工具提示的组件。在鼠标移动到 JTree 中和具有有效工具提示的区域上时,该工具提示将在 initialDelay 毫秒后显示出来。在 dismissDelay 毫秒后,将隐藏该工具提示。如果鼠标在具有有效工具提示的区域上,并且当前能看到该工具提示,则在鼠标移动到没有有效工具提示的区域时,将隐藏该工具提示。如果鼠标接下来在 reshowDelay 毫秒内移回具有有效工具提示的区域,则将立即显示该工具提示,否则在 initialDelay 毫秒后将再次显示该工具提示。

另请参见:
JComponent.createToolTip()

嵌套类摘要
protected  class ToolTipManager.insideTimerAction
           
protected  class ToolTipManager.outsideTimerAction
           
protected  class ToolTipManager.stillInsideTimerAction
           
 
字段摘要
protected  boolean heavyWeightPopupEnabled
           
protected  boolean lightWeightPopupEnabled
           
 
方法摘要
 int getDismissDelay()
          返回取消工具提示的延迟值。
 int getInitialDelay()
          返回初始延迟值。
 int getReshowDelay()
          返回重新显示延迟属性。
 boolean isEnabled()
          如果启用该对象,则返回 true。
 boolean isLightWeightPopupEnabled()
          如果使用轻量级(所有 Java)Tooltips,则返回 true;如果使用重量级(本机同位体)Tooltips,则返回 false。
 void mouseDragged(MouseEvent event)
          按下和拖动鼠标时调用。
 void mouseEntered(MouseEvent event)
          鼠标进入组件区域时调用。
 void mouseExited(MouseEvent event)
          鼠标退出组件区域时调用。
 void mouseMoved(MouseEvent event)
          移动鼠标时调用。
 void mousePressed(MouseEvent event)
          当按下鼠标时调用。
 void registerComponent(JComponent component)
          注册一个工具提示管理组件。
 void setDismissDelay(int milliseconds)
          指定取消工具提示的延迟值。
 void setEnabled(boolean flag)
          启用或禁用工具提示。
 void setInitialDelay(int milliseconds)
          指定初始延迟值。
 void setLightWeightPopupEnabled(boolean aFlag)
          显示 JToolTip 时,该 ToolTipManager 会选择使用一个轻量级 JPanel(如果合适)。
 void setReshowDelay(int milliseconds)
          在显示工具提示之前,用于指定用户必须等待 initialDelay 毫秒之前的时间。
static ToolTipManager sharedInstance()
          返回共享的 ToolTipManager 实例。
 void unregisterComponent(JComponent component)
          从工具提示控件中移除一个组件。
 
从类 java.awt.event.MouseAdapter 继承的方法
mouseClicked, mouseReleased
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

字段详细信息

lightWeightPopupEnabled

protected boolean lightWeightPopupEnabled

heavyWeightPopupEnabled

protected boolean heavyWeightPopupEnabled
方法详细信息

setEnabled

public void setEnabled(boolean flag)
启用或禁用工具提示。

参数:
flag - 要启用提示则为 true,否则为 false

isEnabled

public boolean isEnabled()
如果启用该对象,则返回 true。

返回:
如果启用该对象,则返回 true,否则,返回 false

setLightWeightPopupEnabled

public void setLightWeightPopupEnabled(boolean aFlag)
显示 JToolTip 时,该 ToolTipManager 会选择使用一个轻量级 JPanel(如果合适)。此方法允许您禁用该功能。如果应用程序混合轻量级组件和重量级组件,则必须真正禁用此功能。

参数:
aFlag - 如果需要轻量级面板,则为 true,否则为 false

isLightWeightPopupEnabled

public boolean isLightWeightPopupEnabled()
如果使用轻量级(所有 Java)Tooltips,则返回 true;如果使用重量级(本机同位体)Tooltips,则返回 false。

返回:
true 如果使用轻量级 ToolTips

setInitialDelay

public void setInitialDelay(int milliseconds)
指定初始延迟值。

参数:
milliseconds - (光标暂停之后)显示工具提示之前要延迟的毫秒数
另请参见:
getInitialDelay()

getInitialDelay

public int getInitialDelay()
返回初始延迟值。

返回:
一个表示该初始延迟值的整数,以毫秒为单位
另请参见:
setInitialDelay(int)

setDismissDelay

public void setDismissDelay(int milliseconds)
指定取消工具提示的延迟值。

参数:
milliseconds - 取消工具提示之前要延迟的毫秒数
另请参见:
getDismissDelay()

getDismissDelay

public int getDismissDelay()
返回取消工具提示的延迟值。

返回:
一个表示取消工具提示的延迟值的整数,以毫秒为单位
另请参见:
setDismissDelay(int)

setReshowDelay

public void setReshowDelay(int milliseconds)
在显示工具提示之前,用于指定用户必须等待 initialDelay 毫秒之前的时间。也就是说,如果隐藏工具提示,且用户在 milliseconds 毫秒内移动到同一个具有有效工具提示的组件,则立即显示该工具提示。否则,如果用户在 milliseconds 毫秒之后移动到具有有效工具提示的区域,则用户必须在再次显示该工具提示之前再等待 initialDelay 毫秒。

参数:
milliseconds - 以毫秒为单位的时间
另请参见:
getReshowDelay()

getReshowDelay

public int getReshowDelay()
返回重新显示延迟属性。

返回:
重新显示的延迟属性
另请参见:
setReshowDelay(int)

sharedInstance

public static ToolTipManager sharedInstance()
返回共享的 ToolTipManager 实例。

返回:
共享的 ToolTipManager 对象

registerComponent

public void registerComponent(JComponent component)
注册一个工具提示管理组件。

这将注册键绑定,以在仅当 component 具有焦点绑定时显示和隐藏工具提示文本。执行此操作,以使通常不是焦点遍历的组件(如 JLabel)不会因为调用此方法而进行焦点遍历。

参数:
component - 要添加的 JComponent 对象
另请参见:
Component.isFocusTraversable()

unregisterComponent

public void unregisterComponent(JComponent component)
从工具提示控件中移除一个组件。

参数:
component - 要移除的 JComponent 对象

mouseEntered

public void mouseEntered(MouseEvent event)
鼠标进入组件区域时调用。这确定是否应该显示该工具提示。

指定者:
接口 MouseListener 中的 mouseEntered
覆盖:
MouseAdapter 中的 mouseEntered
参数:
event - 相关事件

mouseExited

public void mouseExited(MouseEvent event)
鼠标退出组件区域时调用。任何显示的工具提示都应该隐藏。

指定者:
接口 MouseListener 中的 mouseExited
覆盖:
MouseAdapter 中的 mouseExited
参数:
event - 相关事件

mousePressed

public void mousePressed(MouseEvent event)
当按下鼠标时调用。任何工具提示显示都应该隐藏。

指定者:
接口 MouseListener 中的 mousePressed
覆盖:
MouseAdapter 中的 mousePressed
参数:
event - 相关事件

mouseDragged

public void mouseDragged(MouseEvent event)
按下和拖动鼠标时调用。不执行任何操作。

指定者:
接口 MouseMotionListener 中的 mouseDragged
参数:
event - 相关事件

mouseMoved

public void mouseMoved(MouseEvent event)
移动鼠标时调用。确定是否应该显示工具提示。

指定者:
接口 MouseMotionListener 中的 mouseMoved
参数:
event - 相关事件

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策