Пакет | mx.effects |
Класс | public class EffectInstance |
Наследование | EffectInstance EventDispatcher Object |
Реализует | IEffectInstance |
Подклассы | ActionEffectInstance, AnimateInstance, CompositeEffectInstance, MaskEffectInstance, SoundEffectInstance, TweenEffectInstance |
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Разработчики эффектов должны создать класс экземпляров для пользовательских эффектов.
Связанные элементы API
Свойство | Определено | ||
---|---|---|---|
className : String [только для чтения]
Имя класса эффекта, например FadeInstance. | EffectInstance | ||
constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | ||
duration : Number
Продолжительность эффекта, в миллисекундах. | EffectInstance | ||
effect : IEffect
Объект IEffect, создавший данный объект IEffectInstance. | EffectInstance | ||
effectTargetHost : mx.effects:IEffectTargetHost
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных. | EffectInstance | ||
hideFocusRing : Boolean
Определяет, должен ли эффект скрыть кольцо фокуса при запуске. | EffectInstance | ||
playheadTime : Number
Текущая позиция эффекта. | EffectInstance | ||
propertyChanges : PropertyChanges
Указывает объект PropertyChanges, содержащий начальные и конечные значения для набора свойств, относящихся к целевым объектам эффекта. | EffectInstance | ||
repeatCount : int
Число повторов эффекта. | EffectInstance | ||
repeatDelay : int
Время ожидания (в миллисекундах) перед повторением эффекта. | EffectInstance | ||
startDelay : int
Время ожидания (в миллисекундах) перед запуском эффекта. | EffectInstance | ||
suspendBackgroundProcessing : Boolean
Если значение равно true, блокирует всю фоновую обработку во время воспроизведения эффекта. | EffectInstance | ||
target : Object
Объект UIComponent, к которому применяется данный эффект. | EffectInstance | ||
triggerEvent : Event
Событие (при наличии), запускающее воспроизведение эффекта. | EffectInstance |
Свойство | Определено | ||
---|---|---|---|
playCount : int = 0
Число воспроизведений экземпляра. | EffectInstance |
Метод | Определено | ||
---|---|---|---|
EffectInstance(target:Object)
Конструктор. | EffectInstance | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | ||
Посылает событие в поток событий. | EventDispatcher | ||
Прерывает экземпляр эффекта, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. | EffectInstance | ||
Вызывается методом end() по завершении воспроизведения эффекта. | EffectInstance | ||
Вызывается после завершения воспроизведения повторяющегося эффекта при каждой итерации. | EffectInstance | ||
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | ||
Показывает, определено ли заданное свойство для объекта. | Object | ||
Этот метод вызывается в случае запуска эффекта посредством EffectManager. | EffectInstance | ||
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | ||
Приостанавливает эффект до вызова метода resume(). | EffectInstance | ||
Воспроизводит экземпляр эффекта для целевого объекта. | EffectInstance | ||
Показывает наличие заданного свойства и его перечисляемость. | Object | ||
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | ||
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause(). | EffectInstance | ||
Воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта. | EffectInstance | ||
Задает доступность динамического свойства для операций цикла. | Object | ||
Воспроизводит экземпляр эффекта для целевого объекта после истечения периода startDelay. | EffectInstance | ||
Останавливает эффект, оставляя целевой объект в текущем состоянии. | EffectInstance | ||
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | ||
Возвращает строковое представление заданного объекта. | Object | ||
Возвращает элементарное значение заданного объекта. | Object | ||
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher |
className | свойство |
className:String
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Имя класса эффекта, например FadeInstance
.
Это короткое или неполное имя класса, в которое не входит имя пакета. Если требуется полное имя, следует воспользоваться методом getQualifiedClassName()
из пакета flash.utils.
Реализация
public function get className():String
duration | свойство |
effect | свойство |
effectTargetHost | свойство |
effectTargetHost:mx.effects:IEffectTargetHost
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных. Это свойство активирует экземпляр класса эффекта для взаимодействия с элементом управления на основе списка, в котором воспроизводится эффект.
Реализация
public function get effectTargetHost():mx.effects:IEffectTargetHost
public function set effectTargetHost(value:mx.effects:IEffectTargetHost):void
hideFocusRing | свойство |
hideFocusRing:Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Определяет, должен ли эффект скрыть кольцо фокуса при запуске. За сокрытие кольца фокуса несет ответственность целевой объект эффекта. Подклассы класса UIComponent скрывают кольцо фокуса автоматически. Если целевой объект эффекта не является подклассом класса UIComponent, к нему необходимо добавить функциональные возможности скрытия кольца фокуса.
Для скрытия кольца фокуса во время воспроизведения эффекта следует установить для этого свойства значение true
.
Для подклассов Effect значением по умолчанию является значение false
. Для подклассов MaskEffect значением по умолчанию является значение true
.
Реализация
public function get hideFocusRing():Boolean
public function set hideFocusRing(value:Boolean):void
playCount | свойство |
protected var playCount:int = 0
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Число воспроизведений экземпляра.
playheadTime | свойство |
playheadTime:Number
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Текущая позиция эффекта. Значение этого свойства находится в диапазоне от 0 до значения общей продолжительности, включающей значения параметров эффекта startDelay
, repeatCount
и repeatDelay
.
Реализация
public function get playheadTime():Number
public function set playheadTime(value:Number):void
propertyChanges | свойство |
propertyChanges:PropertyChanges
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает объект PropertyChanges, содержащий начальные и конечные значения для набора свойств, относящихся к целевым объектам эффекта. Это свойство устанавливается только в том случае, если для эффекта, создавшего данный экземпляр эффекта, был вызван метод captureStartValues()
.
Как правило, свойство propertyChanges
используется для создания эффекта, применяемого в качестве части перехода. При запуске перехода Flex автоматически вызывает метод captureStartValues()
. В переопределении метода Effectinstance.play()
для инициализации начальных и конечных значений эффекта можно проанализировать информацию в методе propertyChanges()
.
Реализация
public function get propertyChanges():PropertyChanges
public function set propertyChanges(value:PropertyChanges):void
repeatCount | свойство |
repeatCount:int
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Число повторов эффекта. Возможные значения – это любые целые числа, которые больше или равны 0.
Реализация
public function get repeatCount():int
public function set repeatCount(value:int):void
repeatDelay | свойство |
startDelay | свойство |
startDelay:int
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Время ожидания (в миллисекундах) перед запуском эффекта. Возможные значения – любые положительные целые числа или 0. Если эффект повторяется с использованием свойства repeatCount
, свойство startDelay
применяется только при первом воспроизведении эффекта.
Реализация
public function get startDelay():int
public function set startDelay(value:int):void
suspendBackgroundProcessing | свойство |
suspendBackgroundProcessing:Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Если значение равно true
, блокирует всю фоновую обработку во время воспроизведения эффекта. Фоновая обработка состоит из измерений, макетирования и обработки ответов, поступивших от сервера.
Реализация
public function get suspendBackgroundProcessing():Boolean
public function set suspendBackgroundProcessing(value:Boolean):void
target | свойство |
triggerEvent | свойство |
triggerEvent:Event
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Событие (при наличии), запускающее воспроизведение эффекта. Использование этого свойства рекомендовано в случае присвоения эффекту нескольких событий запуска.
Если эффект был воспроизведен программно с помощью вызова метода play()
, а не был запущен событием, это свойство имеет значение null
.
Реализация
public function get triggerEvent():Event
public function set triggerEvent(value:Event):void
EffectInstance | () | Конструктор |
end | () | метод |
public function end():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Прерывает экземпляр эффекта, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. Данный метод запускается посредством вызова метода Effect.end()
. В качестве части собственной реализации он вызывает метод finishEffect()
.
Когда этот метод вызывается как часть завершения эффекта, экземпляр эффекта отправляет событие effectEnd
.
Этот метод можно дополнительно переопределить в подклассе EffectInstance. В качестве части переопределения в конце переопределения после логики необходим вызов метода super.end()
.
finishEffect | () | метод |
public function finishEffect():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Вызывается методом end()
по завершении воспроизведения эффекта. Эта функция отправляет событие endEffect
для целевого объекта эффекта
Переопределение данного метода в подклассе невозможно. Необходимость в вызове данного метода при использовании эффектов отсутствует, но его вызов может потребоваться при создании подкласса эффекта.
finishRepeat | () | метод |
public function finishRepeat():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Вызывается после завершения воспроизведения повторяющегося эффекта при каждой итерации.
Переопределение данного метода в подклассе невозможно. Вызов данного метода при использовании эффектов не требуется.
initEffect | () | метод |
public function initEffect(event:Event):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Этот метод вызывается в случае запуска эффекта посредством EffectManager. Эта версия базового класса сохраняет событие, запустившее эффект, в свойстве triggerEvent
. Данный метод должен переопределяться в каждом подклассе.
Параметры
event:Event — Объект Event, отправленный для запуска эффекта. Например, для триггера mouseDownEffect событием является MouseEvent с типом MouseEvent.MOUSEDOWN.
|
pause | () | метод |
public function pause():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Приостанавливает эффект до вызова метода resume()
.
play | () | метод |
public function play():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Воспроизводит экземпляр эффекта для целевого объекта. Вызывает метод startEffect()
вместо запуска эффекта в EffectInstance.
В подклассе EffectInstance этот метод необходимо переопределить. В переопределении необходимо вызвать метод super.play()
для отправки из целевого объекта события effectStart
.
resume | () | метод |
public function resume():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause()
.
reverse | () | метод |
public function reverse():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта.
startEffect | () | метод |
public function startEffect():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Воспроизводит экземпляр эффекта для целевого объекта после истечения периода startDelay
. Вызывается классом Effect. При запуске EffectInstance эта функция используется вместо метода play()
.
stop | () | метод |
public function stop():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Останавливает эффект, оставляя целевой объект в текущем состоянии. Этот метод запускается вызовом метода Effect.stop()
. В качестве части собственной реализации он вызывает метод finishEffect()
.
Когда этот метод вызывается как часть завершения эффекта, экземпляр эффекта отправляет событие effectEnd
.
Tue Jun 12 2018, 11:34 AM Z