ToolTipManager - Adobe ActionScript® 3 (AS3 Flex)

Пакет	mx.managers
Класс	public class ToolTipManager
Наследование	ToolTipManager EventDispatcher Object

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

ToolTipManager позволяет устанавливать базовую функцию ToolTip и функцию рекомендации ошибки, например задержку отображения и отключение ToolTip.

Связанные элементы API

mx.controls.ToolTip
mx.validators.Validator

Общедоступные свойства

Скрыть унаследованные общедоступные свойства

Показать унаследованные общедоступные свойства

	Свойство		Определено
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		currentTarget : DisplayObject [статические] UIComponent, в настоящее время отображающий ToolTip, или null, если таковые отсутствуют.	ToolTipManager
		currentToolTip : mx.core:IToolTip [статические] Объект ToolTip, видимый в настоящее время, или null если таковые отсутствуют.	ToolTipManager
		enabled : Boolean [статические] Если true, то при наведении пользователем указателя мыши на компоненты ToolTipManager будет автоматически отображать элементы ToolTip.	ToolTipManager
		hideDelay : Number [статические] Время в миллисекундах, которое Flex выжидает после отображения ToolTip до его скрытия.	ToolTipManager
		hideEffect : IAbstractEffect [статические] Эффект, воспроизводимый при скрытии ToolTip, или null, если ToolTip должен исчезнуть без эффекта.	ToolTipManager
		scrubDelay : Number [статические] Время в миллисекундах, необходимое пользователю при перемещении указателя мыши между элементами управления до повторного запуска Flex showDelay для отображения ToolTip.	ToolTipManager
		showDelay : Number [статические] Время в миллисекундах, которое Flex ожидает перед отображением поля ToolTip после того, как пользователь наводит указатель мыши на компонент, имеющий ToolTip.	ToolTipManager
		showEffect : IAbstractEffect [статические] Эффект, воспроизводимый при просмотре ToolTip, или null, если ToolTip должен появляться без эффекта.	ToolTipManager
		toolTipClass : Class [статические] Класс, используемый для создания ToolTip.	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 [статические] Создает экземпляр класса ToolTip с указанным текстом и отображает его в указанном месте в координатах рабочей области.	ToolTipManager
		destroyToolTip(toolTip:mx.core:IToolTip):void [статические] Удаляет указанный ToolTip, созданный методом createToolTip().	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

UIComponent, в настоящее время отображающий ToolTip, или 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, видимый в настоящее время, или 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 будет автоматически отображать элементы ToolTip. Если false, то элементы ToolTip не будут отображаться.

Значением по умолчанию является 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 выжидает после отображения ToolTip до его скрытия. После скрытия ToolTip в Flex пользователь должен убрать указатель мыши с компонента и затем, в случае необходимости повторного просмотра ToolTip, вновь навести его на компонент. Если для hideDelay установлено значение Infinity, то Flex не скрывает ToolTip, пока пользователь не запустит какое-либо событие, например переместит указатель мыши с компонента.

Значением по умолчанию является 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

Эффект, воспроизводимый при скрытии ToolTip, или null, если ToolTip должен исчезнуть без эффекта.

Значением по умолчанию является 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 для отображения ToolTip.

Этот параметр рекомендуется использовать, когда пользователь быстро переходит от одного элемента управления к другому; после отображения первого ToolTip Flex отобразит другие немедленно, без какого-либо ожидания. Чем меньше длительность scrubDelay, тем более вероятно, что пользователь будет ожидать время, указанное в showDelay для просмотра следующего ToolTip. Это свойство рекомендуется использовать тогда, когда на панели инструментов имеется несколько кнопок, и пользователь быстро сканирует их с целью просмотра кратких описаний их функций.

Значением по умолчанию является 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. Для немедленного появления 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

Эффект, воспроизводимый при просмотре ToolTip, или null, если ToolTip должен появляться без эффекта.

Значением по умолчанию является 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

Класс, используемый для создания ToolTip.

Значением по умолчанию является 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 с указанным текстом и отображает его в указанном месте в координатах рабочей области.

Всплывающие подсказки появляются на своем собственном уровне, поверх всех элементов, за исключением курсоров.

Стандартным способом использования всплывающих подсказок является разрешение ToolTipManager автоматически показывать и скрывать их при перемещении пользователем указателя мыши по объектам с установленным свойством toolTip. Отключить это автоматическое управление ToolTip можно путем установки для свойства ToolTipManager enabled значения false.

В отличие от предыдущего, этот метод – наряду с методом destroyToolTip() – дает возможность программного управления ToolTip. Их можно показывать в то время и в том месте, где это требуется, кроме того, если это необходимо, можно отображать сразу несколько подсказок. (ToolTipManager никогда не использует эту возможность, поскольку, как правило, это мешает пользователю).

Этот метод сначала создает новый экземпляр ToolTip и вызывает метод addChild() для его размещения на уровне ToolTip в SystemManager. Если у пользователя отображается рекомендация ошибки, то он устанавливает соответствующие стили. Затем он задает текст и размеры 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, чтобы обеспечить использование одного и того же StyleManager для ToolTip и для объекта.

Возвращает

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

Удаляет указанный ToolTip, созданный методом createToolTip().

Посредством этого метода вызывается метод removeChild() с целью удаления ToolTip с уровня ToolTip в SystemManager. Затем, если на этот элемент не будет сохранена ссылка, он будет удален сборщиком мусора.

Этот метод не следует вызывать на currentToolTip класса ToolTipManager.

Параметры

toolTip:mx.core:IToolTip — Удаляемый экземпляр ToolTip.

Юридическая информация | Политика конфиденциальности онлайн

ToolTipManager - AS3 Flex

Классы x

currentTarget

currentToolTip

enabled

hideDelay

hideEffect

scrubDelay

showDelay

showEffect

toolTipClass

createToolTip

destroyToolTip