Пакет | mx.effects |
Интерфейс | public interface IEffect extends IAbstractEffect , IEventDispatcher |
Средство реализации | Effect |
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Связанные элементы API
Свойство | Определено | ||
---|---|---|---|
className : String [только для чтения]
Имя класса эффекта, например Fade. | IEffect | ||
customFilter : mx.effects:EffectTargetFilter
Указывает пользовательский объект фильтра типа EffectTargetFilter, используемый эффектом для определения целевых объектов, для которых должен воспроизводиться эффект. | IEffect | ||
duration : Number
Продолжительность эффекта в миллисекундах. | IEffect | ||
effectTargetHost : mx.effects:IEffectTargetHost
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных. | IEffect | ||
filter : String
Указывает алгоритм фильтрации целевых объектов для эффекта. | IEffect | ||
hideFocusRing : Boolean
Определяет, должен ли эффект скрыть кольцо фокуса при запуске. | IEffect | ||
isPlaying : Boolean [только для чтения]
Флаг только для чтения, принимающий значение true, если какой-либо экземпляр эффекта воспроизводится в настоящее время, и false в противном случае. | IEffect | ||
perElementOffset : Number
Дополнительная задержка (в миллисекундах) для целевых объектов эффекта, обрабатываемых после первого целевого объекта эффекта. | IEffect | ||
playheadTime : Number
Текущая позиция эффекта. | IEffect | ||
relevantProperties : Array
Массив имен свойств, используемых при выполнении фильтрации. | IEffect | ||
relevantStyles : Array
Массив имен стилей, используемых при выполнении фильтрации. | IEffect | ||
target : Object
Объект, к которому применяется данный эффект. | IEffect | ||
targets : Array
Массив объектов, являющихся целевыми объектами эффекта. | IEffect | ||
triggerEvent : Event
Объект Event, переданный в Effect с помощью EffectManager при запуске эффекта, или null, если эффект воспроизводится без EffectManager. | IEffect |
Метод | Определено | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | IEventDispatcher | ||
Обеспечивает сбор текущих значений соответствующих свойств целевых объектов эффекта и сохраняет их как конечные значения. | IEffect | ||
Обеспечивает сбор текущих значений соответствующих свойств дополнительного набора целевых объектов. Flex использует эту функцию при воспроизведении эффекта изменения данных.
| IEffect | ||
Обеспечивает сбор текущих значений соответствующих свойств для целевых объектов эффекта. | IEffect | ||
Создает отдельный экземпляр эффекта и инициализирует его. | IEffect | ||
Принимает массив целевых объектов и вызывает метод createInstance() для каждой цели. | IEffect | ||
Удаляет прослушиватели событий из экземпляра и удаляет экземпляр из списка экземпляров. | IEffect | ||
Посылает событие в поток событий. | IEventDispatcher | ||
Прерывает эффект, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. | IEffect | ||
Возвращает массив строк, где каждая строка представляет собой имя свойства, которое было изменено данным эффектом. | IEffect | ||
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | IEventDispatcher | ||
Приостанавливает эффект до вызова метода resume(). | IEffect | ||
Начинает воспроизведение эффекта | IEffect | ||
Удаляет прослушиватель из объекта EventDispatcher. | IEventDispatcher | ||
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause(). | IEffect | ||
Если эффект воспроизводится в настоящее время, воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта. | IEffect | ||
Останавливает эффект, оставляя целевые объекты эффекта в текущем состоянии. | IEffect | ||
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | IEventDispatcher |
className | свойство |
className:String
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Имя класса эффекта, например Fade
.
Это короткое или неполное имя класса, в которое не входит имя пакета. Если требуется полное имя, следует воспользоваться методом getQualifiedClassName()
из пакета flash.utils.
Реализация
public function get className():String
customFilter | свойство |
customFilter:mx.effects:EffectTargetFilter
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает пользовательский объект фильтра типа EffectTargetFilter, используемый эффектом для определения целевых объектов, для которых должен воспроизводиться эффект.
Фильтрация целевых объектов выполняется только в том случае, если перед воспроизведением эффекта вызывается метод captureStartValues()
. Если эффект является частью перехода, Flex автоматически вызывает метод captureStartValues()
.
Для простой фильтрации следует использовать свойство filter
. Если свойство customFilter
имеет значение, отличное от null, то свойство filter
игнорируется.
Значением по умолчанию является null.
Реализация
public function get customFilter():mx.effects:EffectTargetFilter
public function set customFilter(value:mx.effects:EffectTargetFilter):void
Связанные элементы API
duration | свойство |
duration:Number
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Продолжительность эффекта в миллисекундах.
В эффекте Parallel или Sequence свойство duration
устанавливает продолжительность каждого эффекта. Например, если для эффекта Sequence свойство duration
имеет значение 3000, каждый эффект в эффекте Sequence воспроизводится в течение 3000 мс.
Для повторяющегося эффекта свойство duration
указывает продолжительность одного экземпляра эффекта. Следовательно, если свойство duration
эффекта имеет значение 2000, а свойство repeatCount
имеет значение 3, в общей сложности эффект воспроизводится в течение 6000 мс (6 секунд).
Значением по умолчанию является 500.
Реализация
public function get duration():Number
public function set duration(value:Number):void
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
filter | свойство |
filter:String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает алгоритм фильтрации целевых объектов для эффекта. Значение null
означает отсутствие фильтрации.
Фильтрация целевых объектов выполняется только в том случае, если перед воспроизведением эффекта вызывается метод captureStartValues()
. Если эффект является частью перехода или частью эффекта данных для элемента управления на основе списка, Flex автоматически вызывает метод captureStartValues()
.
Это свойство используется для простой фильтрации. Для более сложной фильтрации следует воспользоваться свойством customFilter
. Если свойство customFilter
имеет значение, отличное от null, это свойство игнорируется.
Для свойства filter
можно использовать следующие значения:
- Значение
add
воспроизводит эффект для любых целевых объектов, добавленных в качестве нижестоящих элементов к контейнеру. - Значение
addItem
воспроизводит эффект в средстве визуализации элемента для любых элементов списка, добавленных к элементу управления List или TileList. - Значение
hide
воспроизводит эффект для любых целей, свойство visible которых изменило значение сtrue
наfalse
. - Значение
move
воспроизводит эффект для любых целевых объектов, у которых изменилось свойствоx
илиy
. - Значение
remove
воспроизводит эффект для любых целевых объектов, удаленных как нижестоящие элементы контейнера. - Значение
removeItem
воспроизводит эффект в средстве визуализации элемента для любых элементов списка, удаленных из элемента управления List или TileList. - Значение
replacedItem
воспроизводит эффект в средстве визуализации элемента для любых элементов списка, замененных в элементе управления List или TileList новым элементом. - Значение
replacementItem
воспроизводит эффект в средстве визуализации элемента для любых элементов списка, добавленных к элементу управления List или TileList, и заменивших существующие элементы. - Значение
resize
воспроизводит эффект для любых целей, у которых изменилось свойствоwidth
илиheight
. - Значение
show
воспроизводит эффект для любых целевых объектов, значение свойства visible у которых изменилось сfalse
наtrue
. - Пустое значение
""
означает отсутствие фильтрации.
Значением по умолчанию является null.
Реализация
public function get filter():String
public function set filter(value:String):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
isPlaying | свойство |
isPlaying:Boolean
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Флаг только для чтения, принимающий значение true, если какой-либо экземпляр эффекта воспроизводится в настоящее время, и false в противном случае.
Реализация
public function get isPlaying():Boolean
perElementOffset | свойство |
perElementOffset:Number
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Дополнительная задержка (в миллисекундах) для целевых объектов эффекта, обрабатываемых после первого целевого объекта эффекта. Это значение добавляется к значению свойства startDelay
.
Реализация
public function get perElementOffset():Number
public function set perElementOffset(value:Number):void
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
relevantProperties | свойство |
relevantProperties:Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Массив имен свойств, используемых при выполнении фильтрации. Это свойство используется внутренне и не должно устанавливаться пользователями эффекта.
Значением по умолчанию является массив, возвращенный методом getAffectedProperties()
.
Реализация
public function get relevantProperties():Array
public function set relevantProperties(value:Array):void
relevantStyles | свойство |
relevantStyles:Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Массив имен стилей, используемых при выполнении фильтрации. Это свойство используется внутренне и не должно устанавливаться пользователями эффекта.
Значением по умолчанию является массив, возвращенный методом getAffectedProperties()
.
Реализация
public function get relevantStyles():Array
public function set relevantStyles(value:Array):void
target | свойство |
target:Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Объект, к которому применяется данный эффект. Если эффект запускается триггером эффекта, свойство target
автоматически становится объектом, запускающим эффект.
Реализация
public function get target():Object
public function set target(value:Object):void
targets | свойство |
targets:Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Массив объектов, являющихся целевыми объектами эффекта. При воспроизведении эффекта выполняет эффект параллельно для каждого целевого объекта. Установка свойства target
заменяет все объекты данного массива. После установки свойства targets
свойство target
возвращает первый элемент массива.
Реализация
public function get targets():Array
public function set targets(value:Array):void
triggerEvent | свойство |
triggerEvent:Event
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Объект Event, переданный в Effect с помощью EffectManager при запуске эффекта, или null
, если эффект воспроизводится без EffectManager.
Реализация
public function get triggerEvent():Event
public function set triggerEvent(value:Event):void
captureEndValues | () | метод |
public function captureEndValues():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Обеспечивает сбор текущих значений соответствующих свойств целевых объектов эффекта и сохраняет их как конечные значения.
Если эффект является частью эффекта изменения данных, Flex автоматически вызывает метод captureEndValues()
.
captureMoreStartValues | () | метод |
public function captureMoreStartValues(targets:Array):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Обеспечивает сбор текущих значений соответствующих свойств дополнительного набора целевых объектов
Flex использует эту функцию при воспроизведении эффекта изменения данных.
Параметры
targets:Array — Массив целевых объектов, для которых собираются значения
|
captureStartValues | () | метод |
public function captureStartValues():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Обеспечивает сбор текущих значений соответствующих свойств для целевых объектов эффекта. Если эффект является частью перехода, Flex автоматически вызывает метод captureStartValues()
.
Эта функция используется при необходимости вычисления эффектом начального и конечного значений эффекта. Для использования этой функции необходимо выполнить следующие действия:
- Вызовите метод
captureStartValues()
. Эффект осуществляет сбор начальных значений эффекта. - Внесите изменения в целевые объекты эффекта, например добавьте/удалите нижестоящие элементы, измените свойства, местоположение или размеры.
- Вызовите метод
play()
. Эффект осуществляет сбор конечных значений. Эта функция заполняет свойствоEffectInstance.propertyChanges
для каждого экземпляра эффекта, созданного данным эффектом. Для извлечения начальных и конечных значений эффекта разработчики эффектов могут использовать свойствоpropertyChanges
.
createInstance | () | метод |
public function createInstance(target:Object = null):IEffectInstance
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Создает отдельный экземпляр эффекта и инициализирует его. Этот метод используется вместо метода play()
для управления свойствами экземпляра эффекта перед воспроизведением экземпляра эффекта.
Экземпляр эффекта создается с типом, указанным в свойстве instanceClass
. Затем он инициализируется с использованием метода initInstance()
. Если экземпляр был создан с помощью EffectManager (при запуске эффекта посредством триггера эффекта), эффект далее инициализируется посредством вызова метода EffectInstance.initEffect()
.
Вызов метода createInstance()
не приводит к воспроизведению эффекта. Для возвращаемого экземпляра эффекта необходимо вызвать метод startEffect()
.
Эта функция вызывается автоматически методом Effect.play()
.
Параметры
target:Object (default = null ) — Объект, анимируемый с данным эффектом.
|
IEffectInstance — Объект экземпляра эффекта для эффекта.
|
createInstances | () | метод |
public function createInstances(targets:Array = null):Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Принимает массив целевых объектов и вызывает метод createInstance()
для каждой цели.
Параметры
targets:Array (default = null ) — Массив объектов, анимируемых с данным эффектом.
|
Array — Массив объектов экземпляров эффекта для эффекта, по одному объекту на каждый целевой объект.
|
deleteInstance | () | метод |
public function deleteInstance(instance:IEffectInstance):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Удаляет прослушиватели событий из экземпляра и удаляет экземпляр из списка экземпляров.
Параметры
instance:IEffectInstance — Экземпляр эффекта.
|
end | () | метод |
public function end(effectInstance:IEffectInstance = null):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Прерывает эффект, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. Вызов этого метода запускает выполнение метода EffectInstance.end()
.
Когда этот метод вызывается как часть завершения эффекта, экземпляр эффекта отправляет событие effectEnd
.
Если экземпляр эффекта передается в качестве аргумента, то прерывается только этот экземпляр. Если аргумент не передается, прерываются все экземпляры эффекта, порожденные эффектом к настоящему времени.
Параметры
effectInstance:IEffectInstance (default = null ) — Прерываемый EffectInstance.
|
Связанные элементы API
getAffectedProperties | () | метод |
public function getAffectedProperties():Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Возвращает массив строк, где каждая строка представляет собой имя свойства, которое было изменено данным эффектом. Например, эффект Move возвращает массив, содержащий x
и y
.
Каждый подкласс Effect должен реализовывать этот метод. Данный метод используется EffectManager для предотвращения одновременной анимации какими-либо двумя эффектами одного и того же свойства одного объекта.
ВозвращаетArray — Массив строк, указывающий имена свойств, измененных данным эффектом.
|
pause | () | метод |
public function pause():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Приостанавливает эффект до вызова метода resume()
.
play | () | метод |
public function play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начинает воспроизведение эффекта Как правило, метод end()
вызывается перед вызовом метода play()
, что позволяет убедиться в завершении всех предыдущих экземпляров эффекта перед запуском нового экземпляра.
Этот метод необходимо реализовать во всех подклассах.
Параметры
targets:Array (default = null ) — Массив целевых объектов, для которых воспроизводится данный эффект. Если этот параметр указан, то свойство targets эффекта не используется.
| |
playReversedFromEnd:Boolean (default = false ) — Если значение равно true , эффект воспроизводится в обратном порядке.
|
Array — Массив объектов EffectInstance для эффекта, по одному объекту на каждый целевой объект.
|
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 |
Если эффект воспроизводится в настоящее время, воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта.
stop | () | метод |
public function stop():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Останавливает эффект, оставляя целевые объекты эффекта в текущем состоянии. В отличие от вызова метода pause()
метод resume()
невозможно вызвать после вызова метода stop()
. Однако для перезапуска эффекта можно вызвать метод play()
.
Когда этот метод вызывается как часть завершения эффекта, экземпляр эффекта отправляет событие effectEnd
.
Что касается эффектов маски, то после завершения эффекта маска не удаляется автоматически. Выполнение других эффектов маски для тех же самых целевых объектов без предварительного удаления маски может привести к непредвиденным результатам.
Tue Jun 12 2018, 11:34 AM Z