Package | mx.effects |
Class | public class AnimateProperty |
Inheritance | AnimateProperty TweenEffect Effect flash.events.EventDispatcher |
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.
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
Property | Defined by | ||
---|---|---|---|
className : String
The name of the effect class, such as
"Fade" . | Effect | ||
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 | ||
effectTargetHost : 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 | ||
fromValue : Number
The starting value of the property for the effect.
| AnimateProperty | ||
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
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 | ||
perElementOffset : 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 | ||
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 | ||
roundValue : Boolean = false
If
true , round off the interpolated tweened value
to the nearest integer. | AnimateProperty | ||
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 | ||
toValue : Number
The ending value for the effect.
| AnimateProperty | ||
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 |
Method | Defined by | ||
---|---|---|---|
AnimateProperty(target:Object = null)
Constructor.
| AnimateProperty | ||
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
This function is used by Flex 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 | ||
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 that is changed by this effect.
| Effect | ||
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 | ||
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 | ||
stop():void
Stops the effect, leaving the effect targets in their current state.
| Effect |
fromValue | property |
public var fromValue:Number
The starting value of the property for the effect. The default value is the target's current property value.
isStyle | property |
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
.
property | property |
public var property:String
The name of the property on the target to animate. This attribute is required.
roundValue | property |
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
.
toValue | property |
public var toValue:Number
The ending value for the effect. The default value is the target's current property value.
AnimateProperty | () | constructor |
public function AnimateProperty(target:Object = null)
Constructor.
Parameterstarget:Object (default = null ) — The Object to animate with this effect.
|