mx.effects

# RemoveItemAction - AS3 Flex

Package | mx.effects
Class | public class RemoveItemAction
Inheritance | RemoveItemAction Effect EventDispatcher Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The RemoveItemAction class defines an action effect that determines when the item renderer disappears from the control for the item renderer of an item being removed from a list-based control, such as List or TileList, or for an item that is replaced by a new item added to the control. You can use this class as part of defining custom data effect for the list-based classes.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:RemoveItemAction>` tag inherits all of the tag attributes of its superclass, and adds no new tag attributes:

      <mx:RemoveItemAction
      />

View the examples

Learn more

About effects
Using MX effects
Handling MX effect events
About transitions

Related API Elements

mx.effects.effectClasses.RemoveItemActionInstance

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
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | customFilter : mx.effects:EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect. | Effect
|  | effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect. | Effect
|  | filter : String Specifies an algorithm for filtering targets for an effect. | Effect
|  | 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
|  | perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect. | Effect
|  | playheadTime : Number Current time position of the effect. | Effect
|  | 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
|  | repeatCount : int = 1 Number of times to repeat the effect. | Effect
|  | repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect. | 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
|  | target : Object The object to which this effect is applied. | Effect
|  | targets : Array An Array of objects that are targets for the effect. | 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
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | applyTransitionEndProperties : 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
|  | 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
--- | --- | ---
|  | RemoveItemAction(target:Object = null) Constructor. | RemoveItemAction
|  | 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 Flex uses this function 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 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

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| 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
|  | effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method. | 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

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | 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 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
|  | effectStart | Dispatched when the effect starts playing. | Effect
|  | effectStop | Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method. | Effect

Constructor Detail

### RemoveItemAction

()
Constructor

`public function RemoveItemAction(target:Object = null)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `target:Object` (default = `null`)`` — The Object to animate with this effect.

Examples How to use this example
AddItemActionEffectExample.mxml
Copy

    <?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.easing.Elastic;
                import mx.collections.ArrayCollection;

                [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 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 < 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 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));
                }
            ]]>
        </fx:Script>

        <!-- Define a custom data effect as a Halo Sequence effect. -->
        <fx:Declarations>
            <mx:Sequence id="itemsChangeEffect1">
                <mx:Blur
                    blurYTo="12" blurXTo="12"
                    duration="300"
                    perElementOffset="150"
                    filter="removeItem"/>
                <mx:Parallel>
                    <mx:Move
                        duration="750"
                        easingFunction="{Elastic.easeOut}"
                        perElementOffset="20"/>
                    <mx:RemoveItemAction
                        startDelay="400"
                        filter="removeItem"/>
                    <mx:AddItemAction
                        startDelay="400"
                        filter="addItem"/>
                    <mx:Blur
                        startDelay="410"
                        blurXFrom="18" blurYFrom="18" blurXTo="0" blurYTo="0"
                        duration="300"
                        filter="addItem"/>
                </mx:Parallel>
            </mx:Sequence>
        </fx:Declarations>

        <s:Panel title="AddItemEffect/RemoveItemEffect Example" width="75%" height="75%" >
            <s:VGroup left="20" right="20" top="20" bottom="20">
            <!-- This TileList uses a custom data change effect -->
            <mx:TileList id="tlist0"
                height="100%" width="100%"
                fontSize="18" fontStyle="italic"
                columnCount="4" rowCount="4"
                direction="horizontal"
                dataProvider="{myDP}"
                allowMultipleSelection="true"
                offscreenExtraRowsOrColumns="4"
                itemsChangeEffect="{itemsChangeEffect1}"/>

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00