Flex Effect
介绍
Effect类是一个抽象基类，定义所有Flex效果的基本功能。 Effect类定义了所有效果的基本工厂类。 EffectInstance类定义所有效果实例子类的基类。
类声明
以下是 mx.effects.Effect 类的声明:
public class Effect
extends EventDispatcher
implements IEffect公共属性
| S.N. | 属性和描述 |
|---|---|
| 1 | className:String [只读]效果类的名称，例如“Fade"。 |
| 2 | customFilter:mx.effects:EffectTargetFilter 指定EffectTargetFilter类型的自定义过滤器对象，由效果用于确定要在其上播放效果的目标。 |
| 3 | duration:Number 效果持续时间(以毫秒为单位)。 |
| 4 | effectTargetHost:mx.effects:IEffectTargetHost 一种属性，允许您访问基于列表的数据效果控制。 |
| 5 | filter:String 指定用于过滤效果的目标的算法。 |
| 6 | hideFocusRing:Boolean 确定效果是否应在启动效果时隐藏对焦环。 |
| 7 | instanceClass:Class 类型Class的对象，指定此效果类的效果实例类类。 |
| 8 | isPlaying:Boolean [只读]只读标志，如果效果的任何实例当前正在播放，则为true，如果没有则为false。 |
| 9 | perElementOffset:Number 在效果的第一个目标之后的效果目标的额外延迟(以毫秒为单位)。 |
| 10 | playheadTime:Number 效果的当前时间位置。 |
| 11 | relevantProperties:Array 执行过滤时要使用的属性名称数组。 |
| 12 | relevantStyles:Array 执行过滤时要使用的样式名称数组。 |
| 13 | repeatCount:int = 1 重复效果的次数。 |
| 14 | repeatDelay:int = 0 重复效果之前等待的时间(以毫秒为单位)。 |
| 15 | startDelay:int = 0 启动效果之前等待的时间(以毫秒为单位)。 |
| 16 | suspendBackgroundProcessing:Boolean = false 如果为true，则在效果播放时阻止所有背景处理。 |
| 17 | target:Object 应用此效果的对象。 |
| 18 | targets:Array 作为效果的目标的对象数组。 |
| 19 | triggerEvent:Event 事件对象在效果被触发时由EffectManager传递给此效果，如果效果未由EffectManager播放，则为null。 |
受保护的属性
| S.N. | 属性和描述 |
|---|---|
| 1 | applyTransitionEndProperties:Boolean 此标志控制效果在转换中运行时，是否根据结束状态自动应用属性值，而不是保留效果本身设置的值。 |
| 2 | endValuesCaptured:Boolean = false 如果效果的结束值已经确定，则包含true的标志，或者如果效果运行时应从效果目标的当前属性获取它们，则为false。 |
公共方法
| S.N. | 方法和描述 |
|---|---|
| 1 | Effect(target:Object = null) 构造函数。 |
| 2 | captureEndValues():void 捕获效果目标上相关属性的当前值，并将其保存为结束值。 |
| 3 | captureMoreStartValues(targets:Array):void 捕获额外一组目标的相关属性的当前值Flex在运行数据更改效果时使用此函数。 |
| 4 | captureStartValues():void 捕获效果目标上相关属性的当前值。 |
| 5 | createInstance(target:Object = null):IEffectInstance 创建单个效果实例并初始化它。 |
| 6 | createInstances(targets:Array = null):Array 获取目标对象数组，并在每个目标上调用createInstance()方法。 |
| 7 | deleteInstance(instance:IEffectInstance):void 从实例中删除事件侦听器，并将其从实例列表中删除。 |
| 8 | end(effectInstance:IEffectInstance = null):void 中断当前正在播放的效果，并立即跳转到效果的结尾。 |
| 9 | getAffectedProperties():Array 返回一个字符串数组，其中每个String是由此效果更改的属性的名称。 |
| 10 | pause():void 暂停效果，直到调用resume()方法。 |
| 11 | play(targets:Array = null，playReversedFromEnd:Boolean = false):Array 开始播放效果。 |
| 12 | resume():void 通过调用pause()方法暂停后，恢复效果。 |
| 13 | reverse():void 如果效果当前正在播放，则从效果的当前位置开始播放效果。 |
| 14 | stop():void 停止效果，将效果目标保留在其当前状态。 |
保护方法
| S.N. | 方法和描述 |
|---|---|
| 1 | applyValueToTarget(target:Object，property:String，value:*，props:Object):void 由Effect基础结构内部使用。 |
| 2 | effectEndHandler(event:EffectEvent):void 效果实例完成播放时调用。 |
| 3 | effectStartHandler(event:EffectEvent):void 当效果实例开始播放时调用此方法。 |
| 4 | effectStopHandler(event:EffectEvent):void 当效果实例通过调用stop()方法停止时调用。 |
| 5 | filterInstance(propChanges:Array，target:Object):Boolean 确定用于过滤效果实例的逻辑。 |
| 6 | getValueFromTarget(target:Object，property:String):* 由captureStartValues()方法调用以从目标获取属性的值。 |
| 7 | initInstance(instance:IEffectInstance):void 将效果的属性复制到效果实例。 |
事件
| S.N. | 事件和描述 |
|---|---|
| 1 | effectEnd 当其中一个效果的实例完成播放时调度，当实例完成播放时，或者当调用end()方法中断效果时，调度。 |
| 2 | effectStart 效果开始播放时分派。 |
| 3 | effectStop 当效果已停止时调度，该效果仅在效果通过调用stop()方法中断时发生。 |
继承的方法
此类继承以下类中的方法:
flash.events.EventDispatcher
Object