IEffect  - AS3 Flex

Имя класса эффекта, например Fade.

Это короткое или неполное имя класса, в которое не входит имя пакета. Если требуется полное имя, следует воспользоваться методом getQualifiedClassName() из пакета flash.utils.

Указывает пользовательский объект фильтра типа EffectTargetFilter, используемый эффектом для определения целевых объектов, для которых должен воспроизводиться эффект.

Фильтрация целевых объектов выполняется только в том случае, если перед воспроизведением эффекта вызывается метод captureStartValues(). Если эффект является частью перехода, Flex автоматически вызывает метод captureStartValues().

Для простой фильтрации следует использовать свойство filter. Если свойство customFilter имеет значение, отличное от null, то свойство filter игнорируется.

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

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

Продолжительность эффекта в миллисекундах.

В эффекте Parallel или Sequence свойство duration устанавливает продолжительность каждого эффекта. Например, если для эффекта Sequence свойство duration имеет значение 3000, каждый эффект в эффекте Sequence воспроизводится в течение 3000 мс.

Для повторяющегося эффекта свойство duration указывает продолжительность одного экземпляра эффекта. Следовательно, если свойство duration эффекта имеет значение 2000, а свойство repeatCount имеет значение 3, в общей сложности эффект воспроизводится в течение 6000 мс (6 секунд).

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

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

Указывает алгоритм фильтрации целевых объектов для эффекта. Значение 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.

Определяет, должен ли эффект скрыть кольцо фокуса при запуске. За сокрытие кольца фокуса несет ответственность целевой объект эффекта. Подклассы класса UIComponent скрывают кольцо фокуса автоматически. Если целевой объект эффекта не является подклассом класса UIComponent, к нему необходимо добавить функциональные возможности скрытия кольца фокуса.

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

Для подклассов Effect значением по умолчанию является значение false. Для подклассов MaskEffect значением по умолчанию является значение true.

Флаг только для чтения, принимающий значение true, если какой-либо экземпляр эффекта воспроизводится в настоящее время, и false в противном случае.

Дополнительная задержка (в миллисекундах) для целевых объектов эффекта, обрабатываемых после первого целевого объекта эффекта. Это значение добавляется к значению свойства startDelay.

Текущая позиция эффекта. Значение этого свойства находится в диапазоне от 0 до значения общей продолжительности, включающей значения параметров эффекта startDelay, repeatCount и repeatDelay.

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

Значением по умолчанию является массив, возвращенный методом getAffectedProperties().

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

Значением по умолчанию является массив, возвращенный методом getAffectedProperties().

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

Массив объектов, являющихся целевыми объектами эффекта. При воспроизведении эффекта выполняет эффект параллельно для каждого целевого объекта. Установка свойства target заменяет все объекты данного массива. После установки свойства targets свойство target возвращает первый элемент массива.

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

Обеспечивает сбор текущих значений соответствующих свойств целевых объектов эффекта и сохраняет их как конечные значения.

Если эффект является частью эффекта изменения данных, Flex автоматически вызывает метод captureEndValues().

Обеспечивает сбор текущих значений соответствующих свойств дополнительного набора целевых объектов

Flex использует эту функцию при воспроизведении эффекта изменения данных.

Параметры

Обеспечивает сбор текущих значений соответствующих свойств для целевых объектов эффекта. Если эффект является частью перехода, Flex автоматически вызывает метод captureStartValues().

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

1. Вызовите метод captureStartValues(). Эффект осуществляет сбор начальных значений эффекта.
2. Внесите изменения в целевые объекты эффекта, например добавьте/удалите нижестоящие элементы, измените свойства, местоположение или размеры.
3. Вызовите метод play(). Эффект осуществляет сбор конечных значений. Эта функция заполняет свойство EffectInstance.propertyChanges для каждого экземпляра эффекта, созданного данным эффектом. Для извлечения начальных и конечных значений эффекта разработчики эффектов могут использовать свойство propertyChanges.

Создает отдельный экземпляр эффекта и инициализирует его. Этот метод используется вместо метода play() для управления свойствами экземпляра эффекта перед воспроизведением экземпляра эффекта.

Экземпляр эффекта создается с типом, указанным в свойстве instanceClass. Затем он инициализируется с использованием метода initInstance(). Если экземпляр был создан с помощью EffectManager (при запуске эффекта посредством триггера эффекта), эффект далее инициализируется посредством вызова метода EffectInstance.initEffect().

Вызов метода createInstance() не приводит к воспроизведению эффекта. Для возвращаемого экземпляра эффекта необходимо вызвать метод startEffect().

Эта функция вызывается автоматически методом Effect.play().

Параметры

Принимает массив целевых объектов и вызывает метод createInstance() для каждой цели.

Параметры

Удаляет прослушиватели событий из экземпляра и удаляет экземпляр из списка экземпляров.

Параметры

Прерывает эффект, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. Вызов этого метода запускает выполнение метода EffectInstance.end().

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

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

Параметры

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

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

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

Приостанавливает эффект до вызова метода resume().

Начинает воспроизведение эффекта Как правило, метод end() вызывается перед вызовом метода play(), что позволяет убедиться в завершении всех предыдущих экземпляров эффекта перед запуском нового экземпляра.

Этот метод необходимо реализовать во всех подклассах.

Параметры

Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause().

Если эффект воспроизводится в настоящее время, воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта.

Останавливает эффект, оставляя целевые объекты эффекта в текущем состоянии. В отличие от вызова метода pause() метод resume() невозможно вызвать после вызова метода stop(). Однако для перезапуска эффекта можно вызвать метод play().

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

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