mx.effects.DefaultListEffect (Flex 3.2)

包	mx.effects
类	public class DefaultListEffect
继承	DefaultListEffect Parallel CompositeEffect Effect EventDispatcher Object

DefaultListEffect 类可定义当数据提供程序中的数据发生更改时应用于 List 控件的项目渲染器的默认效果。如果 List 控件中删除了某个项目，则此效果将首先淡出该项目，然后将该项目的大小折叠为 0。如果 List 控件中添加了某个项目，此效果将首先展开该项目的槽，然后淡入此新项目。

您可以使用 itemsChangeEffect 样式属性将此效果应用到 List 控件。itemsChangeEffect 样式属性的默认值为 undefined，这意味着它不会使用任何效果。

因为 DefaultListEffect 效果在播放时会增大和收缩项目渲染器，所以您必须将 List.variableRowHeight 属性设置为 true，以便 List 控件动态更改其行高。

MXML 语法

隐藏 MXML 语法

The <mx:DefaultListEffect> tag inherits all the members of its parent and adds the following members:

   <DefaultListEffect
     Properties
     color="0xFFFFFF"
     fadeInDuration="300"
     fadeOutDuration="300"
     growDuration="300"
     removedElementOffset="100"
     shrinkDuration="300"
   />

另请参见

公共属性

	属性		定义方
		className : String [只读 (read-only)] 效果类的名称，如“Fade”。	Effect
		color : Number 表示淡入或淡出已添加项目和已删除项目时所用颜色的十六进制值。	DefaultListEffect
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		fadeInDuration : Number 对已添加和已删除项目的渲染器应用淡入效果的时间（以毫秒为单位）。	DefaultListEffect
		fadeOutDuration : Number 对已添加和已删除项目的渲染器应用淡出效果的时间（以毫秒为单位）。	DefaultListEffect
		growDuration : Number 应用于已添加和已删除项目的渲染器的时间（以毫秒为单位）。	DefaultListEffect
		hideFocusRing : Boolean 确定在开始播放效果时，效果是否应隐藏对焦环。	Effect
		instanceClass : Class 一个 Class 类型的对象，用于指定此效果类的效果实例类。	Effect
		isPlaying : Boolean [只读 (read-only)] 一个只读标志，如果当前正在播放效果的任一实例，则为 true；否则，则为 false。	Effect
		prototype : Object [静态] 对类或函数对象的原型对象的引用。	Object
		relevantProperties : Array 一个属性名称 Array，执行过滤时将使用这些名称。	Effect
		relevantStyles : Array 一个样式名称 Array，执行过滤时将使用这些名称。	Effect
		removedElementOffset : Number 同时删除的多个项目的渲染器所应用效果之间的偏移量（以毫秒为单位）。	DefaultListEffect
		shrinkDuration : Number 应用于已添加和已删除项目的渲染器的时间（以毫秒为单位）。	DefaultListEffect
		startDelay : int = 0 开始播放效果前需要等待的时间（以毫秒为单位）。	Effect
		suspendBackgroundProcessing : Boolean = false 如果为 true，则在播放效果时阻止所有背景处理。	Effect
		triggerEvent : Event 如果触发了某个效果，则此项目是由 EffectManager 传递给此 Effect 的 Event 对象；如果 EffectManager 当前没有播放此效果，则为 null。	Effect

	属性	定义方
		endValuesCaptured : Boolean = false 一个标志，如果已确定效果的结束值，则该标志中包含 true；如果需要在效果运行时从效果目标的当前属性捕获这些值，则其中包含 false。	Effect

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		定义方
		addChild(childEffect:IEffect):void 将新的子效果添加到此复合效果。	CompositeEffect
		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 返回一个字符串 Array，其中每个 String 都是被此效果更改的属性名称。	Effect
		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
		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
		filterInstance(propChanges:Array, target:Object):Boolean 确定筛选效果实例所用的逻辑。	Effect
		getValueFromTarget(target:Object, property:String):* 由 captureStartValues() 方法调用，用来从目标获得某个属性的值。	Effect
		initInstance(instance:IEffectInstance):void 将效果的属性复制到效果实例。	Effect

摘要	定义方
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
effectEnd	当效果完成播放时（既可以是效果实际完成播放时，也可以是通过调用 end() 方法中断效果时）调度。	Effect
effectStart	当效果开始播放时调度。	Effect

属性详细信息

color

属性

color:Number [读写]

表示淡入或淡出已添加项目和已删除项目时所用颜色的十六进制值。

默认值为 0xFFFFFF.

实现
public function get color():Number
public function set color(value:Number):void

fadeInDuration

属性

fadeInDuration:Number [读写]

对已添加和已删除项目的渲染器应用淡入效果的时间（以毫秒为单位）。

默认值为 300.

实现
public function get fadeInDuration():Number
public function set fadeInDuration(value:Number):void

fadeOutDuration

属性

fadeOutDuration:Number [读写]

对已添加和已删除项目的渲染器应用淡出效果的时间（以毫秒为单位）。

默认值为 300.

实现
public function get fadeOutDuration():Number
public function set fadeOutDuration(value:Number):void

growDuration

属性

growDuration:Number [读写]

应用于已添加和已删除项目的渲染器的时间（以毫秒为单位）。

默认值为 300.

实现
public function get growDuration():Number
public function set growDuration(value:Number):void

removedElementOffset

属性

removedElementOffset:Number [读写]

同时删除的多个项目的渲染器所应用效果之间的偏移量（以毫秒为单位）。如果为 0，则所有渲染器都将同时淡化和收缩。

默认值为 100.

实现
public function get removedElementOffset():Number
public function set removedElementOffset(value:Number):void

shrinkDuration

属性

shrinkDuration:Number [读写]

应用于已添加和已删除项目的渲染器的时间（以毫秒为单位）。

默认值为 300.

实现
public function get shrinkDuration():Number
public function set shrinkDuration(value:Number):void

示例如何使用示例

DefaultListEffectExample.mxml

<?xml version="1.0"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        <![CDATA[
            import mx.effects.DefaultListEffect;
            import mx.collections.ArrayCollection;
            
            [Bindable]
            private var myDP:ArrayCollection = new ArrayCollection(
                ['A','B','C','D','E','F','G','H']);
            
            private function deleteItem():void {
                // As each item is removed, the index of the other items changes.
                // So first get the items to delete, then determine their indices
                // as you remove them.
                var toRemove:Array = [];
                for (var i:int = 0; i < list0.selectedItems.length; i++)
                    toRemove.push(list0.selectedItems[i]);
                for (i = 0; i < toRemove.length; i++)
                    myDP.removeItemAt(myDP.getItemIndex(toRemove[i]));
            }

            private var zcount:int = 0;
            private function addItem():void {
                // Always add the new item after the third item,
                // or after the last item if the length is less than 3.
                myDP.addItemAt("Z"+zcount++,Math.min(3,myDP.length));
            }            
        ]]>
    </mx:Script>

    <!-- Define an instance of the DefaultListEffect effect, 
         and set its fadeOutDuration and color properties. -->
    <mx:DefaultListEffect id="myDLE" 
        fadeOutDuration="1000" 
        color="0x0000ff"/>

    <mx:Panel title="DefaultListEffect Example" width="75%" height="75%" 
        paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:List id="list0" 
            width="150"
            dataProvider="{myDP}" 
            variableRowHeight="true" 
            fontSize="18" 
            allowMultipleSelection="true" 
            itemsChangeEffect="{myDLE}"/>
    
        <mx:Button 
            label="Delete item" 
            click="deleteItem();"/>
        <mx:Button 
            label="Add item" 
            click="addItem();"/>

    </mx:Panel> 
</mx:Application>

Adobe® Flex™ 3.2 语言参考		全部包 \| 全部类 \| 语言元素 \| 索引 \| 附录 \| 约定 \| 框架无框架
DefaultListEffect	属性 \| 方法 \| 事件 \| 样式 \| 效果 \| 常量 \| 示例