Packagemx.effects
Classpublic class AnimateProperty
InheritanceAnimateProperty Inheritance TweenEffect Inheritance Effect Inheritance EventDispatcher Inheritance Object

The AnimateProperty effect animates a property or style of a component. You specify the property name, start value, and end value of the property to animate. The effect sets the property to the start value, and then updates the property value over the duration of the effect until it reaches the end value.

For example, to change the width of a Button control, you can specify width as the property to animate, and starting and ending width values to the effect.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:AnimateProperty 
    id="ID"
   fromValue="0"
    isStyle="false|true"	 
    property="required"
    roundValue="false|true"
    toValue="0" 
  />

See also

mx.effects.effectClasses.AnimatePropertyInstance

Public Properties
 PropertyDefined By
 InheritedclassName : String
[read-only] The name of the effect class, such as "Fade".
Effect
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcustomFilter : 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
 Inheritedduration : Number
Duration of the effect in milliseconds.
Effect
 InheritedeasingFunction : Function = null
The easing function for the animation.
TweenEffect
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
Effect
 Inheritedfilter : String
Specifies an algorithm for filtering targets for an effect.
Effect
  fromValue : Number
The starting value of the property for the effect.
AnimateProperty
 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
  isStyle : Boolean = false
If true, the property attribute is a style and you set it by using the setStyle() method.
AnimateProperty
 InheritedperElementOffset : Number
Additional delay, in milliseconds, for effect targets after the first target of the effect.
Effect
  property : String
The name of the property on the target to animate.
AnimateProperty
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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
 InheritedrepeatCount : int = 1
Number of times to repeat the effect.
Effect
 InheritedrepeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect.
Effect
  roundValue : Boolean = false
If true, round off the interpolated tweened value to the nearest integer.
AnimateProperty
 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
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
Effect
 Inheritedtargets : Array
An Array of UIComponent objects that are targets for the effect.
Effect
  toValue : Number
The ending value for the effect.
AnimateProperty
 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
 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
  
AnimateProperty(target:Object = null)
Constructor.
AnimateProperty
 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 This function is used by Flex 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 that is 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:Object, props:*):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
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
 Inherited
tweenEventHandler(event:mx.events:TweenEvent):void
Called when the TweenEffect dispatches a TweenEvent.
TweenEffect
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 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
 Inherited
effectStart
Dispatched when the effect starts playing.Effect
 Inherited
tweenEnd
Dispatched when the tween effect ends.TweenEffect
 Inherited
tweenStart
Dispatched when the tween effect starts, which corresponds to the first call to the onTweenUpdate() method.TweenEffect
 Inherited
tweenUpdate
Dispatched every time the tween effect updates the target.TweenEffect
Property Detail
fromValueproperty
public var fromValue:Number

The starting value of the property for the effect. The default value is the target's current property value.

isStyleproperty 
public var isStyle:Boolean = false

If true, the property attribute is a style and you set it by using the setStyle() method.

The default value is false.

propertyproperty 
public var property:String

The name of the property on the target to animate. This attribute is required.

roundValueproperty 
public var roundValue:Boolean = false

If true, round off the interpolated tweened value to the nearest integer. This property is useful if the property you are animating is an int or uint.

The default value is false.

toValueproperty 
public var toValue:Number

The ending value for the effect. The default value is the target's current property value.

Constructor Detail
AnimateProperty()Constructor
public function AnimateProperty(target:Object = null)

Constructor.

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



© 2009 Adobe Systems Incorporated. All rights reserved.
Fri Aug 14 2009, 04:09 PM +05:30