Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
mx.effects 

IEffectInstance  - AS3 Flex

Пакетmx.effects
Интерфейсpublic interface IEffectInstance
Средство реализации EffectInstance

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Интерфейс IEffectInstance представляет экземпляр эффекта, воспроизводящийся для целевого объекта. Каждый целевой объект имеет отдельный связанный с нею экземпляр эффекта. Время жизни экземпляра эффекта является непродолжительным. Экземпляр создается при воспроизведении эффекта для целевого объекта и удаляется по завершении воспроизведения эффекта. Если для целевого объекта одновременно воспроизводится несколько эффектов (например, эффект Parallel), то для каждого эффекта создается отдельный экземпляр эффекта.

Разработчики эффектов должны создать класс экземпляров для пользовательских эффектов.

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



Общедоступные свойства
 СвойствоОпределено
  className : String
[только для чтения] Имя класса эффекта, например FadeInstance.
IEffectInstance
  duration : Number
Продолжительность эффекта, в миллисекундах.
IEffectInstance
  effect : IEffect
Объект IEffect, создавший данный объект IEffectInstance.
IEffectInstance
  effectTargetHost : mx.effects:IEffectTargetHost
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных.
IEffectInstance
  hideFocusRing : Boolean
Определяет, должен ли эффект скрыть кольцо фокуса при запуске.
IEffectInstance
  playheadTime : Number
Текущая позиция эффекта.
IEffectInstance
  propertyChanges : PropertyChanges
Указывает объект PropertyChanges, содержащий начальные и конечные значения для набора свойств, относящихся к целевым объектам эффекта.
IEffectInstance
  repeatCount : int
Число повторов эффекта.
IEffectInstance
  repeatDelay : int
Время ожидания (в миллисекундах) перед повторением эффекта.
IEffectInstance
  startDelay : int
Время ожидания (в миллисекундах) перед запуском эффекта.
IEffectInstance
  suspendBackgroundProcessing : Boolean
Если значение равно true, блокирует всю фоновую обработку во время воспроизведения эффекта.
IEffectInstance
  target : Object
Объект UIComponent, к которому применяется данный эффект.
IEffectInstance
  triggerEvent : Event
Событие (при наличии), запускающее воспроизведение эффекта.
IEffectInstance
Общедоступные методы
 МетодОпределено
  
Прерывает экземпляр эффекта, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта.
IEffectInstance
  
Вызывается методом end() по завершении воспроизведения эффекта.
IEffectInstance
  
Вызывается после завершения воспроизведения повторяющегося эффекта при каждой итерации.
IEffectInstance
  
Этот метод вызывается в случае запуска эффекта посредством EffectManager.
IEffectInstance
  
Приостанавливает эффект до вызова метода resume().
IEffectInstance
  
Воспроизводит экземпляр эффекта для целевого объекта.
IEffectInstance
  
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause().
IEffectInstance
  
Воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта.
IEffectInstance
  
Воспроизводит экземпляр эффекта для целевого объекта после истечения периода startDelay.
IEffectInstance
  
Останавливает эффект, оставляя целевой объект в текущем состоянии.
IEffectInstance
Сведения о свойстве

className

свойство
className:String  [только для чтения]

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

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



Реализация
    public function get className():String

duration

свойство 
duration:Number

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

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



Реализация
    public function get duration():Number
    public function set duration(value:Number):void

effect

свойство 
effect:IEffect

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Объект IEffect, создавший данный объект IEffectInstance.



Реализация
    public function get effect():IEffect
    public function set effect(value:IEffect):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

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

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

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

repeatCount

свойство 
repeatCount:int

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

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



Реализация
    public function get repeatCount():int
    public function set repeatCount(value:int):void

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

repeatDelay

свойство 
repeatDelay:int

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Время ожидания (в миллисекундах) перед повторением эффекта.

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



Реализация
    public function get repeatDelay():int
    public function set repeatDelay(value:int):void

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

startDelay

свойство 
startDelay:int

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

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



Реализация
    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, блокирует всю фоновую обработку во время воспроизведения эффекта. Фоновая обработка состоит из измерений, макетирования и обработки ответов, поступивших от сервера.

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



Реализация
    public function get suspendBackgroundProcessing():Boolean
    public function set suspendBackgroundProcessing(value:Boolean):void

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

target

свойство 
target:Object

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Объект UIComponent, к которому применяется данный эффект.



Реализация
    public function get target():Object
    public function set target(value:Object):void

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

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
Сведения о методе

end

()метод
public function end():void

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

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

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

Этот метод можно дополнительно переопределить в подклассе EffectInstance. В качестве части переопределения в конце переопределения после логики необходим вызов метода super.end().

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

finishEffect

()метод 
public function finishEffect():void

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Вызывается методом end() по завершении воспроизведения эффекта. Эта функция отправляет событие endEffect для целевого объекта эффекта

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

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

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.





[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.