mx.effects.DefaultListEffect (Flex 3.4)

Package	mx.effects
Class	public class DefaultListEffect
Inheritance	DefaultListEffect Parallel CompositeEffect Effect EventDispatcher Object

The DefaultListEffect class defines the default effect applied to the item renderers of a List control when the data in the data provider changes. When an item in the List control is removed, this effect first fades out the item, then collapses the size of the item to 0. When you add an item to the List control, this effect expands the slot for the item, then fades in the new item.

You use the itemsChangeEffect style property to apply this effect to a List control. The default value of the itemsChangeEffect style property is undefined, meaning it does not use any effect.

Because the DefaultListEffect effect grows and shrinks item renderers as it plays, you must set the List.variableRowHeight property to true to enable the List control to dynalically change its row height.

MXML Syntax expanded

Hide MXML Syntax

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"
   />

View the examples

See also

mx.controls.List

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		className : String [read-only] The name of the effect class, such as "Fade".	Effect
		color : Number Hex value that represents the color used when fading the added and removed item.	DefaultListEffect
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		fadeInDuration : Number The duration in milliseconds for fading in renderers for added and removed items.	DefaultListEffect
		fadeOutDuration : Number The duration in milliseconds used for fading out renderers for added and removed items.	DefaultListEffect
		growDuration : Number The duration in milliseconds of applied to renderers for added and removed items.	DefaultListEffect
		hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect.	Effect
		instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class.	Effect
		isPlaying : Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.	Effect
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		relevantProperties : Array An Array of property names to use when performing filtering.	Effect
		relevantStyles : Array An Array of style names to use when performing filtering.	Effect
		removedElementOffset : Number The offset in milliseconds between the effects applied to the renderers representing multiple items deleted at the same time.	DefaultListEffect
		shrinkDuration : Number The duration in milliseconds applied to renderers for added and removed items.	DefaultListEffect
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	Effect
		suspendBackgroundProcessing : Boolean = false If true, blocks all background processing while the effect is playing.	Effect
		triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager.	Effect

	Property	Defined By
		endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.	Effect

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addChild(childEffect:IEffect):void Adds a new child effect to this composite effect.	CompositeEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets This function is used by Flex when a data change effect is run.	Effect
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property that is changed by this effect.	Effect
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the pause() method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	Method	Defined By
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect

Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
effectEnd	Dispatched when the effect finishes playing, either when the effect finishes playing or when the effect has been interrupted by a call to the end() method.	Effect
effectStart	Dispatched when the effect starts playing.	Effect

Property Detail

color

property

color:Number

Hex value that represents the color used when fading the added and removed item.

The default value is 0xFFFFFF.

Implementation
public function get color():Number
public function set color(value:Number):void

fadeInDuration

property

fadeInDuration:Number

The duration in milliseconds for fading in renderers for added and removed items.

The default value is 300.

Implementation
public function get fadeInDuration():Number
public function set fadeInDuration(value:Number):void

fadeOutDuration

property

fadeOutDuration:Number

The duration in milliseconds used for fading out renderers for added and removed items.

The default value is 300.

Implementation
public function get fadeOutDuration():Number
public function set fadeOutDuration(value:Number):void

growDuration

property

growDuration:Number

The duration in milliseconds of applied to renderers for added and removed items.

The default value is 300.

Implementation
public function get growDuration():Number
public function set growDuration(value:Number):void

removedElementOffset

property

removedElementOffset:Number

The offset in milliseconds between the effects applied to the renderers representing multiple items deleted at the same time. If 0, all renderers will fade and shrink simultaneously.

The default value is 100.

Implementation
public function get removedElementOffset():Number
public function set removedElementOffset(value:Number):void

shrinkDuration

property

shrinkDuration:Number

The duration in milliseconds applied to renderers for added and removed items.

The default value is 300.

Implementation
public function get shrinkDuration():Number
public function set shrinkDuration(value:Number):void

Examples How to use this example

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.4 Language Reference Language Reference only	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
DefaultListEffect	Properties \| Methods \| Events \| Examples