| Package | mx.effects |
| Class | public class DefaultTileListEffect |
| Inheritance | DefaultTileListEffect  Parallel CompositeEffect Effect EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Show MXML Syntax
Hide MXML SyntaxThe <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
Learn more
Related API Elements
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. | DefaultTileListEffect | ||
| compositeDuration : Number [override] [read-only]
Returns the duration of this effect as defined by the duration of
all child effects. | Parallel | |
| constructor : 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 | ||
| 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 | |
| moveDuration : Number
The duration in milliseconds
applied to renderers for items moved in the control
as part of the effect. | DefaultTileListEffect | ||
| playheadTime : Number
Current time position of the effect. | 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 | |
| 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 | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DefaultTileListEffect | ||
|
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 | |
|
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
|
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 | |
|
Captures the current values of the relevant properties
on the effect's targets. | Effect | |
|
Creates a single effect instance and initializes it. | Effect | |
|
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
|
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
|
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Pauses the effect until you call the resume() method. | Effect | |
|
Begins playing the effect. | Effect | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | |
|
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
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):voidfadeInDuration | 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):voidfadeOutDuration | 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):voidmoveDuration | 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):voidConstructor 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>
Mon Nov 28 2011, 06:48 AM -08:00