WipeRight

包	mx.effects
类	public class WipeRight
继承	WipeRight MaskEffect Effect EventDispatcher Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

从 Flex 4.0 开始，Adobe 建议您使用 spark.effects.Wipe 类来替代此类。

Flex 3 中的方向特定 Wipe 效果已替换为采用通用方向的更通用的 Wipe 效果。要从新的 Wipe 效果实现相似的行为，请相应地设置 direction 参数。

WipeRight 类定义向右划出效果。组件的 before 或 after 状态必须不可见。

此效果经常与 showEffect 和 hideEffect 触发器配合使用。通过将组件的 visible 属性从 false 更改为 true 使组件可见时，showEffect 触发器便会出现。通过将组件的 visible 属性从 true 更改为 false 使组件不可见时，hideEffect 触发器便会出现。

此效果继承 MaskEffect.show 属性。如果将此值设置为 true，组件将出现。如果将此值设置为 false，组件将消失。默认值为 true。

如果为 showEffect 或 hideEffect 触发器指定此效果，Flex 会将 show 属性设置为 true（如果组件不可见）或 false（如果组件可见）。

MXML 语法

隐藏 MXML 语法

The <mx:WipeRight> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:WipeRight
    id="ID"
  />

查看示例

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		className : String [只读] 效果类的名称，如“Fade”。	Effect
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		createMaskFunction : Function 效果创建遮罩时调用的函数。	MaskEffect
		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
		moveEasingFunction : Function 要用于移动遮罩的缓动函数。	MaskEffect
		perElementOffset : Number 在效果的第一个目标之后，其他效果目标的附加延迟（以毫秒为单位）。	Effect
		playheadTime : Number 效果的当前时间位置。	Effect
		relevantProperties : Array 一个属性名称 Array，执行过滤时将使用这些名称。	Effect
		relevantStyles : Array 一个样式名称 Array，执行过滤时将使用这些名称。	Effect
		repeatCount : int = 1 效果的重复次数。	Effect
		repeatDelay : int = 0 重复播放效果前需要等待的时间（以毫秒为单位）。	Effect
		scaleEasingFunction : Function 要用于缩放遮罩的缓动函数。	MaskEffect
		scaleXFrom : Number 遮罩最初的 scaleX。	MaskEffect
		scaleXTo : Number 遮罩最终的 scaleX。	MaskEffect
		scaleYFrom : Number 遮罩最初的 scaleY。	MaskEffect
		scaleYTo : Number 遮罩最终的 scaleY。	MaskEffect
		showTarget : Boolean 指定目标组件是可见 (true) 还是不可见 (false)。	MaskEffect
		startDelay : int = 0 开始播放效果前需要等待的时间（以毫秒为单位）。	Effect
		suspendBackgroundProcessing : Boolean = false 如果为 true，则在播放效果时阻止所有背景处理。	Effect
		target : Object 要应用此效果的对象。	Effect
		targets : Array 一个对象 Array，这些对象都是效果的目标。	Effect
		triggerEvent : Event 如果触发了某个效果，则此项目是由 EffectManager 传递给此 Effect 的 Event 对象；如果 EffectManager 当前没有播放此效果，则为 null。	Effect
		xFrom : Number 遮罩初始位置的 x 坐标。	MaskEffect
		xTo : Number 遮罩目标位置的 x 坐标。	MaskEffect
		yFrom : Number 遮罩初始位置的 y 坐标。	MaskEffect
		yTo : Number 遮罩目标位置的 y 坐标。	MaskEffect

受保护的属性

隐藏继承的受保护属性

显示继承的受保护属性

	属性		由以下参数定义
		applyTransitionEndProperties : Boolean 此标志控制该效果（进行转换时）是否将根据结束状态自动应用属性值，这与将值保留为效果本身所设置的值相反。	Effect
		endValuesCaptured : Boolean = false 一个标志，如果已确定效果的结束值，则该标志中包含 true；如果需要在效果运行时从效果目标的当前属性捕获这些值，则其中包含 false。	Effect

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		WipeRight(target:Object = null) 构造函数。	WipeRight
		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 获取一个目标对象 Array，并对每个目标调用 createInstance() 方法。	Effect
		deleteInstance(instance:IEffectInstance):void 删除实例中的事件侦听器，然后从实例列表中删除该实例。	Effect
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		end(effectInstance:IEffectInstance = null):void 中断当前正在播放的效果，立即跳转到该效果的末尾。	Effect
		getAffectedProperties():Array [覆盖] 返回被此效果修改的组件属性。	MaskEffect
		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
		tweenEventHandler(event:mx.events:TweenEvent):void 当 TweenEffect 调度 TweenEvent 时调用此方法。	MaskEffect

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
effectEnd	在其中一个效果实例完成播放时（既可以是实例实际完成播放时，也可以是通过调用 end() 方法中断效果时）调度。	Effect
effectStart	当效果开始播放时调度。	Effect
effectStop	在已停止效果时调度，仅当该效果已被 stop() 方法调用中断时才会发生。	Effect
tweenEnd	在结束效果时调度。	MaskEffect
tweenStart	在开始播放效果时调度此事件，相当于首次调用 onMoveTweenUpdate() 和 onScaleTweenUpdate() 方法。	MaskEffect
tweenUpdate	每当效果更新目标时调度。	MaskEffect

构造函数详细信息

()

构造函数

public function WipeRight(target:Object = null)

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

构造函数。

参数

target:Object (default = null) — 要使用此效果为其设置动画的 Object。

示例如何使用本示例

WipeRightExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the WipeRight effect. -->
<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:Declarations>
        <mx:WipeRight id="wipeOut" duration="1000"/>
        <mx:WipeRight id="wipeIn" duration="1000"/>
    </fx:Declarations>

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

            <s:Label width="100%" color="blue"
                text="Use the WipeRight effect to show or hide the text and image."/>

            <mx:Label text="Nokia 9930"
                fontSize="14"
                visible="{cb1.selected}"
                hideEffect="{wipeOut}" showEffect="{wipeIn}"/>

            <mx:Image source="@Embed(source='assets/Nokia_6630.png')"
                visible="{cb1.selected}"
                hideEffect="{wipeOut}" showEffect="{wipeIn}"/>

            <s:CheckBox id="cb1" label="visible" selected="true"/>
        </s:VGroup>

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

法律声明 | 在线隐私策略

WipeRight - AS3 Flex

类 x

WipeRight