Effect

Пакет	mx.effects
Класс	public class Effect
Наследование	Effect EventDispatcher Object
Реализует	IEffect
Подклассы	AddAction, AddChildAction, AddItemAction, Animate, CallAction, CompositeEffect, MaskEffect, RemoveAction, RemoveChildAction, RemoveItemAction, SetAction, SetPropertyAction, SetStyleAction, SoundEffect, TweenEffect, UnconstrainItemAction

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Класс Effect – это абстрактный базовый класс, определяющий базовые функциональные возможности всех эффектов Flex. Класс Effect определяет базовый заводской класс для всех эффектов. Класс EffectInstance определяет базовый класс для всех подклассов экземпляров эффектов.

Экземпляр самого класса Effect в приложении не создается. Вместо этого создается экземпляр одного из подклассов, например Fade или WipeLeft.

Синтаксис MXML expanded

Скрыть синтаксис MXML

The Effect class defines the following properties, which all of its subclasses inherit:

  <mx:tagname
    Properties
    customFilter=""
    duration="500"
    filter=""
    hideFocusRing="false"
    perElementOffset="0"
    repeatCount="1"
    repeatDelay="0"
    startDelay="0"
    suspendBackgroundProcessing="false|true"
    target="effect target"
    targets="array of effect targets"
     
    Events
    effectEnd="No default"
    efectStart="No default"
  />

Посмотреть примеры

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

mx.effects.EffectInstance

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

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

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

	Свойство		Определено
		className : String [только для чтения] Имя класса эффекта, например Fade.	Effect
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		customFilter : mx.effects:EffectTargetFilter Указывает пользовательский объект фильтра типа EffectTargetFilter, используемый эффектом для определения целевых объектов, для которых должен воспроизводиться эффект.	Effect
		duration : Number Продолжительность эффекта в миллисекундах.	Effect
		effectTargetHost : mx.effects:IEffectTargetHost Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных.	Effect
		filter : String Указывает алгоритм фильтрации целевых объектов для эффекта.	Effect
		hideFocusRing : Boolean Определяет, должен ли эффект скрыть кольцо фокуса при запуске.	Effect
		instanceClass : Class Объект типа Class, указывающий класс класса экземпляра эффекта для данного класса эффекта.	Effect
		isPlaying : Boolean [только для чтения] Флаг только для чтения, принимающий значение true, если какой-либо экземпляр эффекта воспроизводится в настоящее время, и false в противном случае.	Effect
		perElementOffset : Number Дополнительная задержка (в миллисекундах) для целевых объектов эффекта, обрабатываемых после первого целевого объекта эффекта.	Effect
		playheadTime : Number Текущая позиция эффекта.	Effect
		relevantProperties : Array Массив имен свойств, используемых при выполнении фильтрации.	Effect
		relevantStyles : Array Массив имен стилей, используемых при выполнении фильтрации.	Effect
		repeatCount : int = 1 Число повторов эффекта.	Effect
		repeatDelay : int = 0 Время ожидания (в миллисекундах) перед повторением эффекта.	Effect
		startDelay : int = 0 Время ожидания (в миллисекундах) перед запуском эффекта.	Effect
		suspendBackgroundProcessing : Boolean = false Если значение равно true, блокирует всю фоновую обработку во время воспроизведения эффекта.	Effect
		target : Object Объект, к которому применяется данный эффект.	Effect
		targets : Array Массив объектов, являющихся целевыми объектами эффекта.	Effect
		triggerEvent : Event Объект Event, переданный в Effect с помощью EffectManager при запуске эффекта, или null, если эффект воспроизводится без EffectManager.	Effect

Защищенные свойства

	Свойство		Определено
		applyTransitionEndProperties : Boolean Этот флаг указывает, должен ли эффект, воспроизводящийся при переходе, автоматически применить значения свойств, соответствующие конечному состоянию, или сохранить значения, установленные самим эффектом.	Effect
		endValuesCaptured : Boolean = false Флаг, содержащий значение true, если конечные значения эффекта уже определены, или значение false, если они должны быть получены из текущих свойств целевых объектов эффекта при воспроизведении эффекта.	Effect

Общедоступные методы

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

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

	Метод		Определено
		Effect(target:Object = null) Конструктор.	Effect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.	EventDispatcher
		captureEndValues():void Обеспечивает сбор текущих значений соответствующих свойств целевых объектов эффекта и сохраняет их как конечные значения.	Effect
		captureMoreStartValues(targets:Array):void Обеспечивает сбор текущих значений соответствующих свойств дополнительного набора целевых объектов. Flex использует эту функцию при воспроизведении эффекта изменения данных.	Effect
		captureStartValues():void Обеспечивает сбор текущих значений соответствующих свойств для целевых объектов эффекта.	Effect
		createInstance(target:Object = null):IEffectInstance Создает отдельный экземпляр эффекта и инициализирует его.	Effect
		createInstances(targets:Array = null):Array Принимает массив целевых объектов и вызывает метод createInstance() для каждой цели.	Effect
		deleteInstance(instance:IEffectInstance):void Удаляет прослушиватели событий из экземпляра и удаляет экземпляр из списка экземпляров.	Effect
		dispatchEvent(event:Event):Boolean Посылает событие в поток событий.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Прерывает эффект, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта.	Effect
		getAffectedProperties():Array Возвращает массив строк, где каждая строка представляет собой имя свойства, которое было изменено данным эффектом.	Effect
		hasEventListener(type:String):Boolean Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события.	EventDispatcher
		hasOwnProperty(name:String):Boolean Показывает, определено ли заданное свойство для объекта.	Object
		isPrototypeOf(theClass:Object):Boolean Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.	Object
		pause():void Приостанавливает эффект до вызова метода resume().	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Начинает воспроизведение эффекта	Effect
		propertyIsEnumerable(name:String):Boolean Показывает наличие заданного свойства и его перечисляемость.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Удаляет прослушиватель из объекта EventDispatcher.	EventDispatcher
		resume():void Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause().	Effect
		reverse():void Если эффект воспроизводится в настоящее время, воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Задает доступность динамического свойства для операций цикла.	Object
		stop():void Останавливает эффект, оставляя целевые объекты эффекта в текущем состоянии.	Effect
		toLocaleString():String Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.	Object
		toString():String Возвращает строковое представление заданного объекта.	Object
		valueOf():Object Возвращает элементарное значение заданного объекта.	Object
		willTrigger(type:String):Boolean Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником.	EventDispatcher

Защищенные методы

	Метод		Определено
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Используется внутренне инфраструктурой Effect.	Effect
		effectEndHandler(event:EffectEvent):void Вызывается по завершении воспроизведения экземпляра эффекта.	Effect
		effectStartHandler(event:EffectEvent):void Этот метод вызывается в момент начала воспроизведения эффекта.	Effect
		effectStopHandler(event:EffectEvent):void Вызывается при остановке воспроизведения экземпляра эффекта посредством вызова метода stop().	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Определяет логику фильтрации экземпляра эффекта.	Effect
		getValueFromTarget(target:Object, property:String):* Вызывается методом captureStartValues() для получения значения свойства целевого объекта.	Effect
		initInstance(instance:IEffectInstance):void Свойства копий эффекта для экземпляра эффекта.	Effect

События

Дополнительные сведения о событиях

Скрыть унаследованные события

Показать унаследованные события

	Сводка	Определено
activate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным.	EventDispatcher
deactivate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным.	EventDispatcher
effectEnd	Отправляется в момент завершения воспроизведения экземпляра эффекта, по завершении воспроизведения экземпляра или при прерывании воспроизведения эффекта посредством вызова метода end().	Effect
effectStart	Отправляется в момент начала воспроизведения эффекта.	Effect
effectStop	Отправляется в момент прекращения воспроизведения эффекта, что происходит только в том случае, если воспроизведение эффекта было прервано посредством вызова метода stop().	Effect

Сведения о свойстве

applyTransitionEndProperties

свойство

protected var applyTransitionEndProperties:Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Этот флаг указывает, должен ли эффект, воспроизводящийся при переходе, автоматически применить значения свойств, соответствующие конечному состоянию, или сохранить значения, установленные самим эффектом.

Значением по умолчанию является true.

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 игнорируется.

Реализация
public function get customFilter():mx.effects:EffectTargetFilter
public function set customFilter(value:mx.effects:EffectTargetFilter):void

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 секунд).

Реализация
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

endValuesCaptured

свойство

protected var endValuesCaptured:Boolean = false

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Флаг, содержащий значение true, если конечные значения эффекта уже определены, или значение false, если они должны быть получены из текущих свойств целевых объектов эффекта при воспроизведении эффекта. Это свойство требуется для эффектов данных, так как при установке эффектов данных, таких как DefaultListEffect и DefaultTileListEffect, используется более сложная последовательность действий, чем при установке обычных эффектов.

Значением по умолчанию является false.

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.
Пустое значение "" означает отсутствие фильтрации.

Реализация
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

instanceClass

свойство

public var instanceClass:Class

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Объект типа Class, указывающий класс класса экземпляра эффекта для данного класса эффекта.

Для всех подклассов класса Effect это свойство должно быть установлено в соответствующем конструкторе.

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

repeatCount

свойство

public var repeatCount:int = 1

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Число повторов эффекта. Возможные значения – это любые целые числа, которые больше или равны 0. Значение 1 соответствует однократному воспроизведению эффекта. Значение 0 соответствует бесконечному воспроизведению эффекта, пока оно не будет остановлено посредством вызова метода end().

Значением по умолчанию является 1.

repeatDelay

свойство

public var repeatDelay:int = 0

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Время ожидания (в миллисекундах) перед повторением эффекта. Возможные значения – это любые целые числа, которые больше или равны 0.

Значением по умолчанию является 0.

startDelay

свойство

public var startDelay:int = 0

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Время ожидания (в миллисекундах) перед запуском эффекта. Возможные значения – любые положительные целые числа или 0. Если эффект повторяется с использованием свойства repeatCount, startDelay применяется только при первом воспроизведении эффекта.

Значением по умолчанию является 0.

suspendBackgroundProcessing

свойство

public var suspendBackgroundProcessing:Boolean = false

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Если значение равно true, блокирует всю фоновую обработку во время воспроизведения эффекта. Фоновая обработка состоит из измерений, макетирования и обработки ответов, поступивших от сервера. Значение по умолчанию false.

Рекомендуется устанавливать для этого свойства значение true в большинстве случаев, так как оно способствует повышению производительности приложения. Однако для этого свойства необходимо установить значение false в следующих случаях:

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

Значением по умолчанию является false.

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

Сведения о конструкторе

()

Конструктор

public function Effect(target:Object = null)

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Конструктор.

Запуск эффекта, как правило, состоит из трех шагов:

Создайте экземпляр объекта эффекта с оператором new.
Установите свойства для объекта эффекта, например duration.
Вызовите метод play() или присвойте эффект триггеру.

Параметры

target:Object (default = null) — Объект, анимируемый с использованием данного эффекта.

Сведения о методе

applyValueToTarget

()

метод

protected function applyValueToTarget(target:Object, property:String, value:*, props:Object):void

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Используется внутренне инфраструктурой Effect. В случае вызова метода captureStartValues() Flex вызывает метод play(), использующий данную функцию для возврата целевых объектов в начальное состояние. Поведение по умолчанию должно состоять в принятии значения, полученного с использованием метода getValueFromTarget(), и его непосредственном присвоении свойству целевого объекта. Например:

      
      target[property] = value;

Этот метод следует переопределять только в том случае, если полученное значение необходимо применить другим способом. Следует отметить, что для установки свойств стиля целевого объекта применяется другой механизм. Для указания свойства стиля, которое требуется получить и применить, используется свойство relevantStyles.

Параметры

	`target:Object` — Целевой объект эффекта.

	`property:String` — Целевое свойство.

	`value:*` — Значение свойства.

	`props:Object` — Массив объектов, в котором каждый элемент массива содержит объекты `start` и `end` для свойств, контролируемых эффектом.

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 — Экземпляр эффекта.

effectEndHandler

()

метод

protected function effectEndHandler(event:EffectEvent):void

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Вызывается по завершении воспроизведения экземпляра эффекта. В случае переопределения данного метода следует убедиться, что вызывается вышестоящий метод.

Параметры

event:EffectEvent — Объект события типа EffectEvent.

effectStartHandler

()

метод

protected function effectStartHandler(event:EffectEvent):void

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Этот метод вызывается в момент начала воспроизведения эффекта. В случае переопределения данного метода следует убедиться, что вызывается вышестоящий метод.

Параметры

event:EffectEvent — Объект события типа EffectEvent.

effectStopHandler

()

метод

protected function effectStopHandler(event:EffectEvent):void

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Вызывается при остановке воспроизведения экземпляра эффекта посредством вызова метода stop(). В случае переопределения данного метода следует убедиться, что вызывается вышестоящий метод.

Параметры

event:EffectEvent — Объект события типа EffectEvent.

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.

filterInstance

()

метод

protected function filterInstance(propChanges:Array, target:Object):Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Определяет логику фильтрации экземпляра эффекта. Данный метод переопределяется классом CompositeEffect.

Параметры

	`propChanges:Array` — Свойства, изменяемые эффектом.

	`target:Object` — Целевой объект эффекта.

Возвращает

Boolean — Возвращает значение true в случае необходимости воспроизведения экземпляра эффекта.

getAffectedProperties

()

метод

public function getAffectedProperties():Array

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Возвращает массив строк, где каждая строка представляет собой имя свойства, которое было изменено данным эффектом. Например, эффект Move возвращает массив, содержащий x и y.

Каждый подкласс Effect должен реализовывать этот метод. Данный метод используется EffectManager для предотвращения одновременной анимации какими-либо двумя эффектами одного и того же свойства одного объекта.

Возвращает

Array — Массив строк, указывающий имена свойств, измененных данным эффектом.

getValueFromTarget

()

метод

protected function getValueFromTarget(target:Object, property:String):*

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Вызывается методом captureStartValues() для получения значения свойства целевого объекта. Данная функция должна вызваться только внутренне посредством инфраструктуры эффектов. Поведением по умолчанию является возврат target[property]. Разработчики эффектов могут переопределить эту функцию, если необходим другой вариант поведения.

Параметры

	`target:Object` — Целевой объект эффекта.

	`property:String` — Целевое свойство.

Возвращает

* — Значение свойства target.

initInstance

()

метод

protected function initInstance(instance:IEffectInstance):void

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Свойства копий эффекта для экземпляра эффекта.

Flex выполняет вызов этого метода из методаEffect.createInstance(); вам не требуется выполнять вызов самостоятельно.

При создании пользовательского эффекта вы перезаписываете этот метод для копирования свойств из класса Effect в класс экземпляров эффектов. При изменении вызовите super.initInstance().

Параметры

instance:IEffectInstance — Экземпляр эффекта для инициализации.

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.

Что касается эффектов маски, то после завершения эффекта маска не удаляется автоматически. Выполнение других эффектов маски для тех же самых целевых объектов без предварительного удаления маски может привести к непредвиденным результатам.

Сведения о событии

effectEnd

Событие

Тип объекта события: mx.events.EffectEvent
свойство EffectEvent.type = mx.events.EffectEvent.EFFECT_END

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Отправляется в момент завершения воспроизведения экземпляра эффекта, по завершении воспроизведения экземпляра или при прерывании воспроизведения эффекта посредством вызова метода end().

Константа EffectEvent.EFFECT_END определяет значение свойства type объекта события для события effectEnd.

Свойства объекта события имеют следующие значения:

Свойство	Значение
`bubbles`	false
`cancelable`	false
`currentTarget`	Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется `myButton.addEventListener()` для регистрации прослушивателя события, значением `currentTarget` является myButton.
`effectInstance`	Объект экземпляра эффекта для события.
`target`	Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство `currentTarget` всегда используется для получения доступа к объекту, прослушивающему событие.

effectStart

Событие

Тип объекта события: mx.events.EffectEvent
свойство EffectEvent.type = mx.events.EffectEvent.EFFECT_START

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Отправляется в момент начала воспроизведения эффекта.

Константа EffectEvent.EFFECT_START определяет значение свойства type объекта события для события effectStart.

Свойства объекта события имеют следующие значения:

Свойство	Значение
`bubbles`	false
`cancelable`	false
`currentTarget`	Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется `myButton.addEventListener()` для регистрации прослушивателя события, значением `currentTarget` является myButton.
`effectInstance`	Объект экземпляра эффекта для события.
`target`	Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство `currentTarget` всегда используется для получения доступа к объекту, прослушивающему событие.

effectStop

Событие

Тип объекта события: mx.events.EffectEvent
свойство EffectEvent.type = mx.events.EffectEvent.EFFECT_STOP

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Отправляется в момент прекращения воспроизведения эффекта, что происходит только в том случае, если воспроизведение эффекта было прервано посредством вызова метода stop(). Также отправляется событие EFFECT_END, сигнализирующее об окончании воспроизведения эффекта. Это дополнительное событие отправляется первым в качестве указателя для прослушивателей на то, что эффект не достиг своего конечного состояния.

Константа EffectEvent.EFFECT_STOP определяет значение свойства type объекта события для события effectStop.

Свойства объекта события имеют следующие значения:

Свойство	Значение
`bubbles`	false
`cancelable`	false
`currentTarget`	Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется `myButton.addEventListener()` для регистрации прослушивателя события, значением `currentTarget` является myButton.
`effectInstance`	Объект экземпляра эффекта для события.
`target`	Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство `currentTarget` всегда используется для получения доступа к объекту, прослушивающему событие.

Примеры Использование этого примера

SimpleEffectExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the Effect class. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx:Script>
        <![CDATA[

            import mx.controls.Alert;

            // Event handler for the effectEnd event.
            private function endEffectHandler():void {
                Alert.show("Effect Ended!");
            }

            // Event handler for the reset button.
            private function resetHandler():void {
                expand.end();
                img.width=30;
                img.height=60;
                button1.enabled=true;
            }
        ]]>
    </fx:Script>

    <fx:Declarations>
        <mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"
             duration="10000" effectEnd="endEffectHandler();"/>
    </fx:Declarations>

    <s:Panel title="Resize Effect Example" width="100%" height="100%" >
        <s:VGroup left="20" right="20" top="20" bottom="20">

            <s:Label width="100%" color="blue"
                text="Use the Button controls to control the Resize effect."/>

            <mx:Image id="img" width="30" height="60"
                source="@Embed(source='assets/Nokia_6630.png')"/>


            <s:Button id="button1" label="Start" click="expand.play(); button1.enabled=false;"/>
            <s:Button label="Pause" click="expand.pause();"/>
            <s:Button label="Resume" click="expand.resume();"/>
            <s:Button label="Reverse" click="expand.reverse();"/>
            <s:Button label="End" click="expand.end();"/>
            <s:Button label="Reset" click="resetHandler();"/>

        </s:VGroup>
    </s:Panel>
</s:Application>

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

Effect - AS3 Flex

Классы x

applyTransitionEndProperties

className

customFilter

duration

effectTargetHost

endValuesCaptured

filter

hideFocusRing

instanceClass

isPlaying

perElementOffset

playheadTime

relevantProperties

relevantStyles

repeatCount

repeatDelay

startDelay

suspendBackgroundProcessing

target

targets

triggerEvent

Effect

applyValueToTarget

captureEndValues

captureMoreStartValues

captureStartValues

createInstance

createInstances

deleteInstance

effectEndHandler

effectStartHandler

effectStopHandler

end

filterInstance

getAffectedProperties

getValueFromTarget

initInstance

pause

play

resume

reverse

stop

effectEnd

effectStart

effectStop