Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
AnimateColorInstance

Package | spark.effects.supportClasses
Class | public class AnimateColorInstance
Inheritance | AnimateColorInstance AnimateInstance EffectInstance flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The AnimateColorInstance class is the instance class of the AnimateColor effect, which animates a change in color by interpolating the from/to values per color channel. Flex creates an instance of this class when it plays a AnimateFilter effect; you do not create one yourself.

See also

spark.effects.AnimateColor

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 "FadeInstance". | EffectInstance
|  | colorFrom : uint The starting color value. | AnimateColorInstance
|  | colorPropertyName : String The name of the color property on the target object affected by this animation. | AnimateColorInstance
|  | colorTo : uint The ending color value. | AnimateColorInstance
|  | disableLayout : Boolean If true, the effect disables layout on its targets' parent containers, setting the containers autoLayout property to false, and also disables any layout constraints on the target objects. | AnimateInstance
|  | duration : Number The duration of the effect, in milliseconds. | EffectInstance
|  | easer : IEaser The easing behavior for this effect. | AnimateInstance
|  | effect : IEffect The IEffect object that created this IEffectInstance object. | EffectInstance
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | EffectInstance
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | EffectInstance
|  | interpolator : IInterpolator The interpolator used by this effect to calculate values between the start and end values of a property. | AnimateInstance
|  | motionPaths : Vector.<MotionPath> A Vector of MotionPath objects, each of which holds the name of a property being animated and the values that the property takes during the animation. | AnimateInstance
|  | playheadTime : Number [override] Current time position of the effect. | AnimateInstance
|  | propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets. | EffectInstance
|  | repeatBehavior : String The behavior of a repeating effect, which means an effect with repeatCount equal to either 0 or > 1. | AnimateInstance
|  | repeatCount : int Number of times to repeat the effect. | EffectInstance
|  | repeatDelay : int Amount of time, in milliseconds, to wait before repeating the effect. | EffectInstance
|  | startDelay : int Amount of time, in milliseconds, to wait before starting the effect. | EffectInstance
|  | suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing. | EffectInstance
|  | target : Object The UIComponent object to which this effect is applied. | EffectInstance
|  | triggerEvent : Event The event, if any, which triggered the playing of the effect. | EffectInstance

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | autoRemoveTarget : Boolean = false If true, the effect retains its target during a transition and removes it when finished. | AnimateInstance
|  | playCount : int = 0 Number of times that the instance has been played. | EffectInstance

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AnimateColorInstance(target:Object) Constructor. | AnimateColorInstance
|  | end():void Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect. | EffectInstance
|  | finishEffect():void Called by the end() method when the effect finishes playing. | EffectInstance
|  | finishRepeat():void Called after each iteration of a repeated effect finishes playing. | EffectInstance
|  | initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager. | EffectInstance
|  | pause():void Pauses the effect until you call the resume() method. | EffectInstance
|  | play():void Plays the effect instance on the target. | EffectInstance
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | EffectInstance
|  | reverse():void Plays the effect in reverse, starting from the current position of the effect. | EffectInstance
|  | startEffect():void Plays the effect instance on the target after the startDelay period has elapsed. | EffectInstance
|  | stop():void Stops the effect, leaving the target in its current state. | EffectInstance

Property Detail

colorFrom | property

`public var colorFrom:uint`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The starting color value.

colorPropertyName | property |

`public var colorPropertyName:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The name of the color property on the target object affected by this animation. A color property is a property that takes 32-bit color value.

colorTo | property |

`public var colorTo:uint`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The ending color value.

Constructor Detail

AnimateColorInstance | () | Constructor

`public function AnimateColorInstance(target:Object)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `target:Object` — The Object to animate with this effect.

Wed Nov 15 2017, 09:50 AM +01:00