ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.effects 

DefaultTileListEffect  - AS3 Flex
Packagemx.effects
Classpublic class DefaultTileListEffect
InheritanceDefaultTileListEffect Inheritance Parallel Inheritance CompositeEffect Inheritance Effect Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DefaultTileListEffect class defines the default effect applied to the item renderers of a TileList control when the data in the data provider changes. When an item in the TileList control is removed, this effect first fades out the item, then moves the remaining items to their new position. When you add an item to the TileList control, this effect moves the existing items to their new position, then fades in the new item.

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

You typically set the TileList.offscreenExtraRowsOrColumns property when applying a data effect. Typically, you set TileList.offscreenExtraRowsOrColumns to a small even number, such as 2, for a TileList control.

MXML SyntaxexpandedHide MXML Syntax

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

  <DefaultTileListEffect
    Properties
    color="0xFFFFFF"
    fadeInDuration="350"
    fadeOutDuration="350"
    moveDuration="300"
  />

Default MXML Propertychildren

View the examples

Learn more

About effects
Using MX effects
Handling MX effect events
About transitions

Related API Elements

mx.controls.TileList

Public Properties
 PropertyDefined By
 InheritedclassName : 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.
DefaultTileListEffect
 InheritedcompositeDuration : Number
[override] [read-only] Returns the duration of this effect as defined by the duration of all child effects.
Parallel
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  fadeInDuration : Number
The duration in milliseconds used to fade in renderers for added and removed items.
DefaultTileListEffect
  fadeOutDuration : Number
The duration in milliseconds used to fade out renderers for removed and replaced items.
DefaultTileListEffect
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
Effect
 InheritedinstanceClass : Class
An object of type Class that specifies the effect instance class class for this effect class.
Effect
 InheritedisPlaying : 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
  moveDuration : Number
The duration in milliseconds applied to renderers for items moved in the control as part of the effect.
DefaultTileListEffect
 InheritedplayheadTime : Number
Current time position of the effect.
Effect
 InheritedrelevantProperties : Array
An Array of property names to use when performing filtering.
Effect
 InheritedrelevantStyles : Array
An Array of style names to use when performing filtering.
Effect
 InheritedstartDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect.
Effect
 InheritedsuspendBackgroundProcessing : Boolean = false
If true, blocks all background processing while the effect is playing.
Effect
 InheritedtriggerEvent : 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
Protected Properties
 PropertyDefined By
 InheritedapplyTransitionEndProperties : Boolean
This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.
Effect
 InheritedendValuesCaptured : 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
 MethodDefined By
  
DefaultTileListEffect()
Constructor.
DefaultTileListEffect
 Inherited
addChild(childEffect:IEffect):void
Adds a new child effect to this composite effect.
CompositeEffect
 Inherited
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
 Inherited
captureEndValues():void
Captures the current values of the relevant properties on the effect's targets and saves them as end values.
Effect
 Inherited
captureMoreStartValues(targets:Array):void
Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run.
Effect
 Inherited
captureStartValues():void
Captures the current values of the relevant properties on the effect's targets.
Effect
 Inherited
createInstance(target:Object = null):IEffectInstance
Creates a single effect instance and initializes it.
Effect
 Inherited
createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the createInstance() method on each target.
Effect
 Inherited
deleteInstance(instance:IEffectInstance):void
Removes event listeners from an instance and removes it from the list of instances.
Effect
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.
Effect
 Inherited
getAffectedProperties():Array
Returns an Array of Strings, where each String is the name of a property changed by this effect.
Effect
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
pause():void
Pauses the effect until you call the resume() method.
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect.
Effect
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
Effect
 Inherited
reverse():void
Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.
Effect
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stop():void
Stops the effect, leaving the effect targets in their current state.
Effect
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
Protected Methods
 MethodDefined By
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
Used internally by the Effect infrastructure.
Effect
 Inherited
effectEndHandler(event:EffectEvent):void
Called when an effect instance has finished playing.
Effect
 Inherited
effectStartHandler(event:EffectEvent):void
This method is called when the effect instance starts playing.
Effect
 Inherited
effectStopHandler(event:EffectEvent):void
Called when an effect instance has stopped by a call to the stop() method.
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Determines the logic for filtering out an effect instance.
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
Called by the captureStartValues() method to get the value of a property from the target.
Effect
 Inherited
initInstance(instance:IEffectInstance):void
Copies properties of the effect to the effect instance.
Effect
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 Inherited
effectEnd
Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.Effect
 Inherited
effectStart
Dispatched when the effect starts playing.Effect
 Inherited
effectStop
Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.Effect
Property Detail

color

property
color:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

The default value is 350.



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

fadeOutDuration

property 
fadeOutDuration:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The duration in milliseconds used to fade out renderers for removed and replaced items.

The default value is 350.



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

moveDuration

property 
moveDuration:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The duration in milliseconds applied to renderers for items moved in the control as part of the effect.

The default value is 300.



Implementation
    public function get moveDuration():Number
    public function set moveDuration(value:Number):void
Constructor Detail

DefaultTileListEffect

()Constructor
public function DefaultTileListEffect()

Constructor.

Examples How to use this example
DefaultTileListEffectExample.mxml
<?xml version="1.0"?>
<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:Script>
        <![CDATA[
            import mx.effects.DefaultTileListEffect;
            import mx.effects.easing.Elastic;
            import mx.collections.ArrayCollection;
            import mx.effects.Move;

            [Bindable]
            private var myDP:ArrayCollection = new ArrayCollection(
                ['A','B','C','D','E','F','G','H','I','J','K','L','M','N','O','P']);

            private function deleteItems():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 < tlist0.selectedItems.length; i++)
                    toRemove.push(tlist0.selectedItems[i]);
                for (i = 0; i < toRemove.length; i++)
                    myDP.removeItemAt(myDP.getItemIndex(toRemove[i]));
            }

            private var zcount:int = 0;
            private function addItems():void {
                myDP.addItemAt("Z"+zcount++,Math.min(2,myDP.length));
            }
        ]]>
    </fx:Script>

    <!-- Define an instance of the DefaultTileListEffect effect,
         and set its moveDuration and color properties. -->

    <fx:Declarations>
        <mx:DefaultTileListEffect id="myDTLE"
            moveDuration="100"
            color="0x0000ff"/>
    </fx:Declarations>

    <s:Panel title="Halo DefaultTileListEffect Example" width="75%" height="75%">
        <s:VGroup left="20" right="20" top="20" bottom="20">

            <mx:TileList id="tlist0"
                height="100%" width="100%"
                columnCount="4" rowCount="4"
                fontSize="18" fontWeight="bold"
                direction="horizontal"
                dataProvider="{myDP}"
                allowMultipleSelection="true"
                offscreenExtraRowsOrColumns="2"
                itemsChangeEffect="{myDTLE}" />

            <s:Button
                label="Delete selected item(s)"
                click="deleteItems();"/>
            <s:Button
                label="Add item"
                click="addItems();"/>
         </s:VGroup>
    </s:Panel>
</s:Application>



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy