ToolTipManager - Adobe ActionScript® 3 (AS3 Flex) API 參考

套件	mx.managers
類別	public class ToolTipManager
繼承	ToolTipManager EventDispatcher Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The ToolTipManager lets you set basic ToolTip and error tip functionality, such as display delay and the disabling of ToolTips.

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		currentTarget : DisplayObject [靜態] The UIComponent that is currently displaying a ToolTip, or null if none is.	ToolTipManager
		currentToolTip : mx.core:IToolTip [靜態] The ToolTip object that is currently visible, or null if none is shown.	ToolTipManager
		enabled : Boolean [靜態] If true, the ToolTipManager will automatically show ToolTips when the user moves the mouse pointer over components.	ToolTipManager
		hideDelay : Number [靜態] The amount of time, in milliseconds, that Flex waits to hide the ToolTip after it appears.	ToolTipManager
		hideEffect : IAbstractEffect [靜態] The effect that plays when a ToolTip is hidden, or null if the ToolTip should disappear with no effect.	ToolTipManager
		scrubDelay : Number [靜態] The amount of time, in milliseconds, that a user can take when moving the mouse between controls before Flex again waits for the duration of showDelay to display a ToolTip.	ToolTipManager
		showDelay : Number [靜態] The amount of time, in milliseconds, that Flex waits before displaying the ToolTip box once a user moves the mouse over a component that has a ToolTip.	ToolTipManager
		showEffect : IAbstractEffect [靜態] The effect that plays when a ToolTip is shown, or null if the ToolTip should appear with no effect.	ToolTipManager
		toolTipClass : Class [靜態] The class to use for creating ToolTips.	ToolTipManager

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		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 [靜態] Creates an instance of the ToolTip class with the specified text and displays it at the specified location in stage coordinates.	ToolTipManager
		destroyToolTip(toolTip:mx.core:IToolTip):void [靜態] Destroys a specified ToolTip that was created by the createToolTip() method.	ToolTipManager
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	事件		摘要	定義自
		activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
		deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher

屬性詳細資訊

currentTarget

屬性

currentTarget:DisplayObject

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The UIComponent that is currently displaying a ToolTip, or null if none is.

實作
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

The ToolTip object that is currently visible, or null if none is shown.

實作
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

If true, the ToolTipManager will automatically show ToolTips when the user moves the mouse pointer over components. If false, no ToolTips will be shown.

預設值為 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

The amount of time, in milliseconds, that Flex waits to hide the ToolTip after it appears. Once Flex hides a ToolTip, the user must move the mouse off the component and then back onto it to see the ToolTip again. If you set hideDelay to Infinity, Flex does not hide the ToolTip until the user triggers an event, such as moving the mouse off of the component.

預設值為 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

The effect that plays when a ToolTip is hidden, or null if the ToolTip should disappear with no effect.

預設值為 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

The amount of time, in milliseconds, that a user can take when moving the mouse between controls before Flex again waits for the duration of showDelay to display a ToolTip.

This setting is useful if the user moves quickly from one control to another; after displaying the first ToolTip, Flex will display the others immediately rather than waiting. The shorter the setting for scrubDelay, the more likely that the user must wait for an amount of time specified by showDelay in order to see the next ToolTip. A good use of this property is if you have several buttons on a toolbar, and the user will quickly scan across them to see brief descriptions of their functionality.

預設值為 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

The amount of time, in milliseconds, that Flex waits before displaying the ToolTip box once a user moves the mouse over a component that has a ToolTip. To make the ToolTip appear instantly, set showDelay to 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

The effect that plays when a ToolTip is shown, or null if the ToolTip should appear with no effect.

預設值為 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

The class to use for creating ToolTips.

預設值為 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

Creates an instance of the ToolTip class with the specified text and displays it at the specified location in stage coordinates.

ToolTips appear in their own layer, on top of everything except cursors.

The standard way of using ToolTips is to let the ToolTipManager automatically show and hide them as the user moves the mouse over the objects that have the toolTip property set. You can turn off this automatic ToolTip management by setting the ToolTipManager's enabled property to false.

By contrast, this method—along with destroyToolTip()—gives you programmatic control over ToolTips. You can show them when and where you choose, and you can even show more than one at once if you need to. (The ToolTipManager never does this, because it is generally confusing to the user).

This method first creates a new instance of ToolTip and calls the addChild() method to put it into the SystemManager's toolTips layer. If you are showing an error tip, it sets the appropriate styles. Then it sets the text for the ToolTip, sizes the ToolTip based on its text, and positions it where you specified.

You must save the reference to the ToolTip that this method returns so that you can pass it to the destroyToolTip() method.

參數

	`text:String` — The text to display in the ToolTip instance.

	`x:Number` — The horizontal coordinate of the ToolTip in stage coordinates. In case of multiple stages, the relevant stage is determined from the `context` argument.

	`y:Number` — The vertical coordinate of the ToolTip in stage coordinates. In case of multiple stages, the relevant stage is determined from the `context` argument.

	`errorTipBorderStyle:String` (default = `null`) — The border style of an error tip. This method argument can be null, "errorTipRight", "errorTipAbove", or "errorTipBelow". If it is null, then the `createToolTip()` method creates a normal ToolTip. If it is "errorTipRight", "errorTipAbove", or "errorTipBelow", then the `createToolTip()` method creates an error tip, and this parameter determines where the arrow of the error tip points to (the error's target). For example, if you pass "errorTipRight", Flex positions the error tip (via the x and y arguments) to the right of the error target; the arrow is on the left edge of the error tip.

	`context:IUIComponent` (default = `null`) — Determines which StyleManager is used. Typically, you pass the object on which the ToolTip appears, so that the ToolTip's StyleManager is the same one that is used by that object.

傳回值

mx.core:IToolTip — The newly created ToolTip.

destroyToolTip

()

方法

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

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Destroys a specified ToolTip that was created by the createToolTip() method.

This method calls the removeChild() method to remove the specified ToolTip from the SystemManager's ToolTips layer. It will then be garbage-collected unless you keep a reference to it.

You should not call this method on the ToolTipManager's currentToolTip.

參數

toolTip:mx.core:IToolTip — The ToolTip instance to destroy.

法律聲明 | 線上隱私權政策

ToolTipManager - AS3 Flex

套件x

語言元素

附錄

套件 mx.managers

currentTarget

currentToolTip

enabled

hideDelay

hideEffect

scrubDelay

showDelay

showEffect

toolTipClass

createToolTip

destroyToolTip