| 包 | mx.effects.effectClasses |
| 类 | public class MaskEffectInstance |
| 继承 | MaskEffectInstance  EffectInstance EventDispatcher Object |
| 子类 | IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance |
属于 TweenEffect 类的子类的所有效果类均支持下列事件：
tweenEnd：当补间效果结束时调度。
tweenUpdate：当 TweenEffect 类每次计算新值时调度。
向这两个事件的事件侦听器传递的对象是 TweenEvent 类型的。TweenEvent 类用于定义 value 属性，该属性中包含由效果计算的补间值。对于 Mask 效果，TweenEvent.value 属性中包含一个具有四个项的 Array，其中有：
x 属性的值。
y 属性的值。
scaleX 属性的值。
scaleY 属性的值。
另请参见
| 属性 | 定义方 | ||
|---|---|---|---|
 | className : String [只读 (read-only)] 效果类的名称，如“FadeInstance”。 | EffectInstance | |
| constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| createMaskFunction : Function 效果创建蒙版时调用的函数。 | MaskEffectInstance | ||
| duration : Number 效果的持续时间（以毫秒为单位）。 | EffectInstance | |
| effect : IEffect 创建此 IEffectInstance 对象的 IEffect 对象。 | EffectInstance | |
| effectTargetHost : IEffectTargetHost 一个属性，您可以通过设置此属性访问数据效果基于列表的目标控件。 | EffectInstance | |
| hideFocusRing : Boolean 确定在开始播放效果时，效果是否应隐藏对焦环。 | EffectInstance | |
| moveEasingFunction : Function 要用于移动遮罩的缓动函数。 | MaskEffectInstance | ||
| playheadTime : Number [只读 (read-only)] 播放效果时所处的当前位置。 | EffectInstance | |
| propertyChanges : PropertyChanges 指定包含一组属性的初始值和结束值的 PropertyChanges 对象，这些属性与效果的目标相关。 | EffectInstance | |
| prototype : Object [静态]
对类或函数对象的原型对象的引用。 | Object | |
| repeatCount : int 效果的重复次数。 | EffectInstance | |
| repeatDelay : int 重复播放效果前需要等待的时间（以毫秒为单位）。 | EffectInstance | |
| scaleEasingFunction : Function 要用于缩放遮罩的缓动函数。 | MaskEffectInstance | ||
| scaleXFrom : Number 遮罩最初的 scaleX。 | MaskEffectInstance | ||
| scaleXTo : Number 遮罩最终的 scaleX。 | MaskEffectInstance | ||
| scaleYFrom : Number 遮罩最初的 scaleY。 | MaskEffectInstance | ||
| scaleYTo : Number 遮罩最终的 scaleY。 | MaskEffectInstance | ||
| showTarget : Boolean 指定如果为 false，则目标组件可见；如果为 true，则不可见。 | MaskEffectInstance | ||
| startDelay : int 开始播放效果前需要等待的时间（以毫秒为单位）。 | EffectInstance | |
| suspendBackgroundProcessing : Boolean 如果为 true，则在播放效果时阻止所有背景处理。 | EffectInstance | |
| target : Object 要应用此效果的 UIComponent 对象。 | EffectInstance | |
| targetArea : Rectangle 目标上应用遮罩的区域。 | MaskEffectInstance | ||
| triggerEvent : Event 触发播放效果的事件（如果有）。 | EffectInstance | |
| xFrom : Number 遮罩初始位置的 x 坐标。 | MaskEffectInstance | ||
| xTo : Number 遮罩目标位置的 x 坐标。 | MaskEffectInstance | ||
| yFrom : Number 遮罩初始位置的 y 坐标。 | MaskEffectInstance | ||
| yTo : Number 遮罩目标位置的 y 坐标。 | MaskEffectInstance | ||
| 属性 | 定义方 | ||
|---|---|---|---|
| effectMask : Shape 包含效果遮罩，可以是由 defaultCreateMask() 方法创建的默认遮罩，也可以是由传递给 createMaskFunction 属性的函数指定的遮罩。 | MaskEffectInstance | ||
| targetVisualBounds : Rectangle 效果目标的实际大小（包含所有投影）。 | MaskEffectInstance | ||
| 方法 | 定义方 | ||
|---|---|---|---|
MaskEffectInstance(target:Object) 构造函数。 | MaskEffectInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。 | EventDispatcher | |
| 将事件调度到事件流中。 | EventDispatcher | |
| 中断当前播放的效果实例，立即跳转到效果的结束位置。 | EffectInstance | |
| 在完成效果播放时由 end() 方法调用。 | EffectInstance | |
| 每次完成重复效果的迭代播放后调用。 | EffectInstance | |
| 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | |
|
指示对象是否已经定义了指定的属性。 | Object | |
| 如果由 EffectManager 触发效果，则会调用此方法。 | EffectInstance | |
|
指示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
暂停效果，直到调用 resume() 方法。 | MaskEffectInstance | ||
| 在目标上播放效果实例。 | EffectInstance | |
|
指示指定的属性是否存在、是否可枚举。 | Object | |
| 从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | |
在效果由 pause() 方法暂停后继续播放效果。 | MaskEffectInstance | ||
从效果的当前位置开始反向播放效果。 | MaskEffectInstance | ||
|
设置循环操作动态属性的可用性。 | Object | |
| 经过 startDelay 所占用的这段时间后，在目标上播放效果实例。 | EffectInstance | |
| 停止播放效果，使目标保持当前状态。 | EffectInstance | |
|
返回指定对象的字符串表示形式。 | Object | |
|
返回指定对象的原始值。 | Object | |
| 检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。 | EventDispatcher | |
| 方法 | 定义方 | ||
|---|---|---|---|
为效果创建默认遮罩。 | MaskEffectInstance | ||
初始化效果的 move 和 scale 属性。 | MaskEffectInstance | ||
当应最后一次使用效果更新遮罩的 x 和 y 位置时，要调用的回调方法。 | MaskEffectInstance | ||
当应使用效果更新遮罩的 x 和 y 位置时，要调用的回调方法。 | MaskEffectInstance | ||
当应最后一次使用效果更新遮罩的 scaleX 和 scaleY 属性时，要调用的回调方法。 | MaskEffectInstance | ||
当应使用效果更新遮罩的 scaleX 和 scaleY 属性时，要调用的回调方法。 | MaskEffectInstance | ||
| createMaskFunction | 属性 |
隐藏继承的公共属性
显示继承的公共属性createMaskFunction:Function [读写] 效果创建蒙版时调用的函数。默认值是一个函数，返回与效果目标大小相同的 Rectangle。
您可以使用此属性来指定自己的回调函数，用于绘制遮罩。此函数必须具有以下特征：
public function createLargeMask(targ:Object, bounds:Rectangle):Shape {
var myMask:Shape = new Shape();
// Create mask.
return myMask;
}
您需要将此属性设置为该函数的名称，如以下的 WipeLeft 效果示例所示：
<mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/>
public function get createMaskFunction():Function public function set createMaskFunction(value:Function):void| effectMask | 属性 |
protected var effectMask:Shape
包含效果遮罩，可以是由 defaultCreateMask() 方法创建的默认遮罩，也可以是由传递给 createMaskFunction 属性的函数指定的遮罩。
| moveEasingFunction | 属性 |
public var moveEasingFunction:Function要用于移动遮罩的缓动函数。
| scaleEasingFunction | 属性 |
public var scaleEasingFunction:Function要用于缩放遮罩的缓动函数。
| scaleXFrom | 属性 |
public var scaleXFrom:Number遮罩最初的 scaleX。
| scaleXTo | 属性 |
public var scaleXTo:Number遮罩最终的 scaleX。
| scaleYFrom | 属性 |
public var scaleYFrom:Number遮罩最初的 scaleY。
| scaleYTo | 属性 |
public var scaleYTo:Number遮罩最终的 scaleY。
| showTarget | 属性 |
showTarget:Boolean [读写]
指定如果为 false，则目标组件可见；如果为 true，则不可见。
默认值为 true.
public function get showTarget():Boolean public function set showTarget(value:Boolean):void| targetArea | 属性 |
public var targetArea:Rectangle
目标上应用遮罩的区域。其尺寸随目标自身而改变。默认情况下，此区域是整个目标，并以如下方式创建：new Rectangle(0, 0, target.width, target.height);
| targetVisualBounds | 属性 |
protected var targetVisualBounds:Rectangle效果目标的实际大小（包含所有投影）。Flex 会自动计算此属性的值；您不必设置它。
| xFrom | 属性 |
public var xFrom:Number遮罩初始位置的 x 坐标。
| xTo | 属性 |
public var xTo:Number遮罩目标位置的 x 坐标。
| yFrom | 属性 |
public var yFrom:Number遮罩初始位置的 y 坐标。
| yTo | 属性 |
public var yTo:Number遮罩目标位置的 y 坐标。
| MaskEffectInstance | () | 构造函数 |
| defaultCreateMask | () | 方法 |
protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape为效果创建默认遮罩。
参数
targ:Object — 效果目标。 | |
bounds:Rectangle — 包含投影的目标的实际可视范围 |
Shape — 用于定义遮罩的 Shape 对象。 |
| initMaskEffect | () | 方法 |
protected function initMaskEffect():void
初始化效果的 move 和 scale 属性。所有子类都应覆盖此函数。Flex 会在从创建遮罩到创建补间这段时间内调用它。
| onMoveTweenEnd | () | 方法 |
protected function onMoveTweenEnd(value:Object):void当应最后一次使用效果更新遮罩的 x 和 y 位置时，要调用的回调方法。您无需直接调用此方法，此方法可实现 superclass 的方法。
参数
value:Object —
包含遮罩位置的 x 和 y 最终值，其中 value[0] 包含遮罩的 x 位置，而 value[1] 包含遮罩的 y 位置。
|
| onMoveTweenUpdate | () | 方法 |
protected function onMoveTweenUpdate(value:Object):void当应使用效果更新遮罩的 x 和 y 位置时，要调用的回调方法。您无需直接调用此方法，此方法可实现 superclass 的方法。
参数
value:Object —
包含遮罩位置的 x 和 y 插补值，其中 value[0] 包含遮罩的新的 x 位置，而 value[1] 包含遮罩的新的 y 位置。
|
| onScaleTweenEnd | () | 方法 |
protected function onScaleTweenEnd(value:Object):void
当应最后一次使用效果更新遮罩的 scaleX 和 scaleY 属性时，要调用的回调方法。您无需直接调用此方法，此方法可实现 superclass 的方法。
参数
value:Object —
包含遮罩的 scaleX 和 scaleY 最终值，其中 value[0] 包含遮罩的 scaleX 值，而 value[1] 包含遮罩的 scaleY 值。
|
| onScaleTweenUpdate | () | 方法 |
protected function onScaleTweenUpdate(value:Object):void
当应使用效果更新遮罩的 scaleX 和 scaleY 属性时，要调用的回调方法。您无需直接调用此方法，此方法可实现 superclass 的方法。
参数
value:Object —
包含遮罩的 scaleX 和 scaleY 插补值，其中 value[0] 包含遮罩的新的 scaleX 值，而 value[1] 包含遮罩的新的 scaleY 值。
|
| pause | () | 方法 |
override public function pause():void
暂停效果，直到调用 resume() 方法。
| resume | () | 方法 |
override public function resume():void
在效果由 pause() 方法暂停后继续播放效果。
| reverse | () | 方法 |
override public function reverse():void从效果的当前位置开始反向播放效果。