ToolTipManager - Adobe ActionScript® 3 (AS3 Flex)

Pakiet	mx.managers
Klasa	public class ToolTipManager
Dziedziczenie	ToolTipManager EventDispatcher Object

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Powiązane elementy interfejsu API

mx.controls.ToolTip
mx.validators.Validator

Właściwości publiczne

Ukryj dziedziczone właściwości publiczne

Pokaż dziedziczone właściwości publiczne

	Właściwość		Zdefiniowane przez
		constructor : Object Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu.	Object
		currentTarget : DisplayObject [statyczny] The UIComponent that is currently displaying a ToolTip, or null if none is.	ToolTipManager
		currentToolTip : mx.core:IToolTip [statyczny] The ToolTip object that is currently visible, or null if none is shown.	ToolTipManager
		enabled : Boolean [statyczny] If true, the ToolTipManager will automatically show ToolTips when the user moves the mouse pointer over components.	ToolTipManager
		hideDelay : Number [statyczny] The amount of time, in milliseconds, that Flex waits to hide the ToolTip after it appears.	ToolTipManager
		hideEffect : IAbstractEffect [statyczny] The effect that plays when a ToolTip is hidden, or null if the ToolTip should disappear with no effect.	ToolTipManager
		scrubDelay : Number [statyczny] 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 [statyczny] 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 [statyczny] The effect that plays when a ToolTip is shown, or null if the ToolTip should appear with no effect.	ToolTipManager
		toolTipClass : Class [statyczny] The class to use for creating ToolTips.	ToolTipManager

Metody publiczne

Ukryj dziedziczone metody publiczne

Pokaż dziedziczone metody publiczne

	Metoda		Zdefiniowane przez
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Rejestruje obiekt detektora zdarzeń w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu.	EventDispatcher
		createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip [statyczny] 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 [statyczny] Destroys a specified ToolTip that was created by the createToolTip() method.	ToolTipManager
		dispatchEvent(event:Event):Boolean Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń.	EventDispatcher
		hasEventListener(type:String):Boolean Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń.	EventDispatcher
		hasOwnProperty(name:String):Boolean Wskazuje, czy dla obiektu zdefiniowano określoną właściwość.	Object
		isPrototypeOf(theClass:Object):Boolean Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr.	Object
		propertyIsEnumerable(name:String):Boolean Wskazuje, czy określona właściwość istnieje i jest przeliczalna.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Usuwa detektor z obiektu EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Ustawia dostępność właściwości dynamicznej używanej w pętlach.	Object
		toLocaleString():String Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych.	Object
		toString():String Zwraca ciąg reprezentujący określony obiekt.	Object
		valueOf():Object Zwraca pierwotną wartość dla określonego obiektu.	Object
		willTrigger(type:String):Boolean Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego elementach macierzystych.	EventDispatcher

Zdarzenia

Kliknij, aby uzyskać więcej informacji o zdarzeniach

Ukryj zdarzenia dziedziczone

Pokaż zdarzenia dziedziczone

	Zdarzenie		Podsumowanie	Zdefiniowane przez
		activate	[zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja środowiska wykonawczego AIR uzyskuje fokus w systemie operacyjnym i przechodzi w stan aktywny.	EventDispatcher
		deactivate	[zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja AIR traci fokus w systemie operacyjnym i przechodzi w stan nieaktywny.	EventDispatcher

Szczegół właściwości

currentTarget

właściwość

currentTarget:DisplayObject

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

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

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

currentToolTip

właściwość

currentToolTip:mx.core:IToolTip

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

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

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

enabled

właściwość

enabled:Boolean

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Wartością domyślną jest true.

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

hideDelay

właściwość

hideDelay:Number

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Wartością domyślną jest 10000.

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

hideEffect

właściwość

hideEffect:IAbstractEffect

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Wartością domyślną jest null.

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

scrubDelay

właściwość

scrubDelay:Number

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Wartością domyślną jest 100.

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

showDelay

właściwość

showDelay:Number

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Wartością domyślną jest 500.

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

showEffect

właściwość

showEffect:IAbstractEffect

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Wartością domyślną jest null.

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

toolTipClass

właściwość

toolTipClass:Class

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

The class to use for creating ToolTips.

Wartością domyślną jest mx.controls.ToolTip.

Implementacja
public static function get toolTipClass():Class
public static function set toolTipClass(value:Class):void

Szczegół metody

createToolTip

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Parametry

	`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.

Zwraca

mx.core:IToolTip — The newly created ToolTip.

destroyToolTip

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Parametry

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

Informacje prawne | Zasady prywatności online

ToolTipManager - AS3 Flex

Pakietyx

Elementy językowe

Dodatki

Pakiet mx.managers

currentTarget

currentToolTip

enabled

hideDelay

hideEffect

scrubDelay

showDelay

showEffect

toolTipClass

createToolTip

destroyToolTip