用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: 正在从服务器检索数据...
正在从服务器检索数据...
mx.managers 

ToolTipManager  - AS3 Flex

mx.managers
public class ToolTipManager
继承ToolTipManager Inheritance EventDispatcher Inheritance Object

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

通过 ToolTipManager,您可以设置基本的工具提示和错误提示功能,如显示延迟和禁用的工具提示。

相关 API 元素



公共属性
 属性由以下参数定义
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  currentTarget : DisplayObject
[静态] 当前显示工具提示的 UIComponent;如果未显示工具提示,则为 null。
ToolTipManager
  currentToolTip : mx.core:IToolTip
[静态] 当前可见的 ToolTip 对象;如果未显示 ToolTip 对象,则为 null。
ToolTipManager
  enabled : Boolean
[静态] 如果为 true,则当用户将鼠标指针移至组件上方时,ToolTipManager 会自动显示工具提示。
ToolTipManager
  hideDelay : Number
[静态] 自工具提示出现时起,Flex 要隐藏此提示前所需等待的时间量(以毫秒为单位)。
ToolTipManager
  hideEffect : IAbstractEffect
[静态] 隐藏工具提示时播放的效果;如果工具提示在消失时不应显示任何效果,则为 null。
ToolTipManager
  scrubDelay : Number
[静态] 在 Flex 再次等待 showDelay 持续显示工具提示之前,用户在各控件间移动鼠标时可以花费的时间(以毫秒为单位)。
ToolTipManager
  showDelay : Number
[静态] 当用户将鼠标移至具有工具提示的组件上方时,Flex 等待 ToolTip 框出现所需的时间(以毫秒为单位)。
ToolTipManager
  showEffect : IAbstractEffect
[静态] 显示工具提示时播放的效果;如果工具提示在显示时不应显示任何效果,则为 null。
ToolTipManager
  toolTipClass : Class
[静态] 创建工具提示要用到的类。
ToolTipManager
公共方法
 方法由以下参数定义
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
EventDispatcher
  
createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip
[静态] 使用指定的文本创建 ToolTip 类的实例,然后在舞台坐标中的指定位置显示此实例。
ToolTipManager
  
[静态] 破坏由 createToolTip() 方法创建的指定 ToolTip。
ToolTipManager
 Inherited
将事件调度到事件流中。
EventDispatcher
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
EventDispatcher
 Inherited
表示对象是否已经定义了指定的属性。
Object
 Inherited
表示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
表示指定的属性是否存在、是否可枚举。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
EventDispatcher
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。
Object
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
 Inherited
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。
EventDispatcher
事件
 事件 摘要 由以下参数定义
 Inherited[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。EventDispatcher
 Inherited[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。EventDispatcher
属性详细信息

currentTarget

属性
currentTarget:DisplayObject

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

当前显示工具提示的 UIComponent;如果未显示工具提示,则为 null



实现
    public static function get currentTarget():DisplayObject
    public static function set currentTarget(value:DisplayObject):void

currentToolTip

属性 
currentToolTip:mx.core:IToolTip

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

当前可见的 ToolTip 对象;如果未显示 ToolTip 对象,则为 null



实现
    public static function get currentToolTip():mx.core:IToolTip
    public static function set currentToolTip(value:mx.core:IToolTip):void

enabled

属性 
enabled:Boolean

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

如果为 true,则当用户将鼠标指针移至组件上方时,ToolTipManager 会自动显示工具提示。如果为 false,则不会显示任何工具提示。

默认值为 true。



实现
    public static function get enabled():Boolean
    public static function set enabled(value:Boolean):void

hideDelay

属性 
hideDelay:Number

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

自工具提示出现时起,Flex 要隐藏此提示前所需等待的时间量(以毫秒为单位)。Flex 隐藏某一工具提示后,用户必须将鼠标从该组件移开后再移回才能重新看到此工具提示。如果将 hideDelay 设为 Infinity,则只有在用户触发某个事件(如将鼠标从该组件移开)时,Flex 才会隐藏该工具提示。

默认值为 10000。



实现
    public static function get hideDelay():Number
    public static function set hideDelay(value:Number):void

hideEffect

属性 
hideEffect:IAbstractEffect

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

隐藏工具提示时播放的效果;如果工具提示在消失时不应显示任何效果,则为 null

默认值为 null。



实现
    public static function get hideEffect():IAbstractEffect
    public static function set hideEffect(value:IAbstractEffect):void

scrubDelay

属性 
scrubDelay:Number

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

在 Flex 再次等待 showDelay 持续显示工具提示之前,用户在各控件间移动鼠标时可以花费的时间(以毫秒为单位)。

当用户在各控件间快速移动鼠标时,此设置将非常有用;在第一个工具提示显示完毕后,Flex 将立即显示其他工具提示,而不会等待。scrubDelay 中设置的时间越短,用户越有可能必须等够 showDelay 中指定的时间才能看到下一个工具提示。当一个工具栏中有多个按钮,并且用户需要快速在这些按钮之间进行扫描以查看各个按钮的功能简述时,此属性非常适用。

默认值为 100。



实现
    public static function get scrubDelay():Number
    public static function set scrubDelay(value:Number):void

showDelay

属性 
showDelay:Number

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

当用户将鼠标移至具有工具提示的组件上方时,Flex 等待 ToolTip 框出现所需的时间(以毫秒为单位)。若要立即显示 ToolTip 框,请将 showDelay 设为 0。

默认值为 500。



实现
    public static function get showDelay():Number
    public static function set showDelay(value:Number):void

showEffect

属性 
showEffect:IAbstractEffect

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

显示工具提示时播放的效果;如果工具提示在显示时不应显示任何效果,则为 null

默认值为 null。



实现
    public static function get showEffect():IAbstractEffect
    public static function set showEffect(value:IAbstractEffect):void

toolTipClass

属性 
toolTipClass:Class

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

创建工具提示要用到的类。

默认值为 mx.controls.ToolTip。



实现
    public static function get toolTipClass():Class
    public static function set toolTipClass(value:Class):void
方法详细信息

createToolTip

()方法
public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

使用指定的文本创建 ToolTip 类的实例,然后在舞台坐标中的指定位置显示此实例。

ToolTip 在各自层中显示时,位于光标之下、其他所有对象之上。

使用 ToolTip 的标准方式是,允许 ToolTipManager 在用户将鼠标移动到设置了 toolTip 属性的对象上方时自动显示和隐藏工具提示。通过将 ToolTipManager 的 enabled 属性设为 false,可以关闭此 ToolTip 自动管理功能。

与此相反,将此方法与 destroyToolTip() 配合使用可以以编程方式控制 ToolTip。您可以在选择的时间和位置显示工具提示,如果需要,甚至还可以同时显示多个工具提示。(ToolTipManager 绝不执行此操作,因为这样通常会使用户感到迷惑。)

此方法首先会为创建一个新的 ToolTip 实例,然后调用 addChild() 方法将此实例放到 SystemManager 的工具提示层。如果出现错误提示,它会设置正确的样式。接着,它设置 ToolTip 的文本,根据文本大小调整 ToolTip 的大小,并将其放在指定的位置。

必须保存此方法返回的对 ToolTip 的引用,以便将其传递给 destroyToolTip() 方法。

参数

text:String — 要在 ToolTip 实例中显示的文本。
 
x:Number — ToolTip 在舞台坐标中的水平坐标。如果存在多个舞台,则根据 context 参数确定相关的舞台。
 
y:Number — ToolTip 在舞台坐标中的垂直坐标。如果存在多个舞台,则根据 context 参数确定相关的舞台。
 
errorTipBorderStyle:String (default = null) — 错误提示的边框样式。此方法参数可以是 null、“errorTipRight”、“errorTipAbove”或“errorTipBelow”。如果为 null,则 createToolTip() 方法将创建一个普通的 ToolTip。如果为“errorTipRight”、“errorTipAbove”或“errorTipBelow”,则 createToolTip() 方法将创建一个错误提示,而此参数将确定错误提示箭头的指向(错误的目标)。例如,如果传递“errorTipRight”,则 Flex 会将错误提示(通过 x 参数和 y 参数)放在错误目标的右侧;箭头位于错误提示的左边缘处。
 
context:IUIComponent (default = null) — 确定使用的 StyleManager。通常,您传递 ToolTip 显示时所在的对象,以便 ToolTip 的 StyleManager 与该对象所使用的 StyleManager 相同。

返回
mx.core:IToolTip — 新创建的 ToolTip。

destroyToolTip

()方法 
public static function destroyToolTip(toolTip:mx.core:IToolTip):void

语言版本: ActionScript 3.0
产品版本: Flex 3
运行时版本: Flash Player 9, AIR 1.1

破坏由 createToolTip() 方法创建的指定 ToolTip。

此方法可以调用 removeChild() 方法,以从 SystemManager 的 ToolTip 层中删除指定的工具提示。如果不保留对 ToolTip 的引用,随后就会将其作为垃圾进行回收。

您不应该对 ToolTipManager 的 currentToolTip 调用此方法。

参数

toolTip:mx.core:IToolTip — 要破坏的 ToolTip 实例。





[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。