mx.effects.Move (Flex™ 2 Language Reference)

Package	mx.effects
Class	public class Move
Inheritance	Move TweenEffect Effect EventDispatcher Object

The Move effect changes the position of a component over a specified time interval. You can specify the initial position with the xFrom and yFrom values, the destination position with xTo and yTo, or the number of pixels to move the component with xBy and yBy.

If you specify any two of the values (initial position, destination, or amount to move), Flex calculates the third. If you specify all three, Flex ignores the xBy and yBy values. If you specify only the xTo and yTo values or the xBy and yBy values, Flex sets xFrom and yFrom to be the object's current position.

If you specify a Move effect for a moveEffect trigger, and if you do not set the six From, To, and By properties, Flex sets them to create a smooth transition between the object's old position and its new position.

If the object's position was originally determined by its parent container (for example, the object is inside an HBox container), the object's position may be reset to its original position next time that the container's layout code runs. To avoid snapping back to the original position, place the object inside a Canvas container, or set the parent container's autoLayout property to false.

MXML Syntax expanded

Hide MXML Syntax

The <mx:Move> tag inherits all of the tag attributes of its of its superclass, and adds the following tag attributes:

  <mx:Move
    id="ID"
    xFrom="val" 
    yFrom="val"
    xTo="val"
    yTo="val"
    xBy="val"
    yBy="val"
   />

View the examples.

See also

mx.effects.effectClasses.MoveInstance

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		className : String 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 : EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.	Effect
		duration : Number Duration of the effect in milliseconds.	Effect
		easingFunction : Function = null The easing function for the animation.	TweenEffect
		filter : String Specifies an algorithm for filtering targets for an effect.	Effect
		instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class.	Effect
		isPlaying : Boolean 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
		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 UIComponent object to which this effect is applied.	Effect
		targets : Array An Array of UIComponent objects that are targets for the effect.	Effect
		xBy : Number Number of pixels to move the components along the x axis.	Move
		xFrom : Number Initial position's x coordinate.	Move
		xTo : Number Destination position's x coordinate.	Move
		yBy : Number Number of pixels to move the components along the y axis.	Move
		yFrom : Number Initial position's y coordinate.	Move
		yTo : Number Destination position's y coordinate.	Move

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		Move(target:Object = null) Constructor.	Move
		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
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):EffectInstance 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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end(effectInstance:EffectInstance = 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
		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
		filterInstance(propChanges:Array, targ: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:EffectInstance):void Copies properties of the effect to the effect instance.	Effect
		tweenEventHandler(event:TweenEvent):void Called when the TweenEffect dispatches a TweenEvent.	TweenEffect

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
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
tweenEnd	Dispatched when the tween effect ends.	TweenEffect
tweenStart	Dispatched when the tween effect starts, which corresponds to the first call to the `onTweenUpdate()` method.	TweenEffect
tweenUpdate	Dispatched every time the tween effect updates the target.	TweenEffect

Property detail

xBy

property

public var xBy:Number

Number of pixels to move the components along the x axis. Values can be negative.

xFrom

property

public var xFrom:Number

Initial position's x coordinate.

xTo

property

public var xTo:Number

Destination position's x coordinate.

yBy

property

public var yBy:Number

Number of pixels to move the components along the y axis. Values can be negative.

yFrom

property

public var yFrom:Number

Initial position's y coordinate.

yTo

property

public var yTo:Number

Destination position's y coordinate.

Constructor detail

Move

()

constructor

public function Move(target:Object = null)

Constructor.

Parameters

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

Examples

MoveEffectExample

<?xml version="1.0"?>
<!-- Simple example to demonstrate the Move effect. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        <![CDATA[

            private function moveImage():void {
                myMove.end();
                myMove.xTo=mouseX-60; 
                myMove.play();
            }
      ]]>
    </mx:Script>

    <mx:Move id="myMove" target="{img}"/>

    <mx:Panel title="Move Effect Example" width="95%" height="95%" 
        paddingTop="5" paddingLeft="10" paddingRight="10" paddingBottom="5">

       <mx:Text width="100%" color="blue" 
           text="Click anywhere on the canvas to move the phone horizontally to that position"/>

        <mx:Canvas id="canvas" width="100%" height="100%" mouseDown="moveImage();">

            <mx:Image id="img" source="@Embed(source='assets/Nokia_6630.png')"/>

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

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class Move	Properties \| Methods \| Events \| Examples