Packagespark.effects
Classpublic class AnimateColor
InheritanceAnimateColor Inheritance Animate Inheritance Effect Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The AnimateColor effect animates a change in a color property over time, interpolating between given from/to color values on a per-channel basis. use this effect, rather than the Animate or other effect, when animating color properties.

MXML SyntaxexpandedHide MXML Syntax

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

  <s:AnimateColor
    Properties
    id="ID"
    colorFrom="no default"
    colorPropertyName="color"
    colorTo="no default"
  />

Default MXML PropertymotionPaths

View the examples

See also

spark.effects.supportClasses.AnimateColorInstance

Public Properties
 PropertyDefined By
 InheritedclassName : String
[read-only] The name of the effect class, such as "Fade".
Effect
  colorFrom : uint = 0xFFFFFFFF
The starting color value.
AnimateColor
  colorPropertyName : String = color
The name of the color property on the target object affected by this animation.
AnimateColor
  colorTo : uint = 0xFFFFFFFF
The ending color value.
AnimateColor
 InheritedcustomFilter : EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.
Effect
 InheriteddisableLayout : 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.
Animate
 Inheritedduration : Number
Duration of the effect in milliseconds.
Effect
 Inheritedeaser : IEaser
The easing behavior for this effect.
Animate
 InheritedeffectTargetHost : 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
 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
 Inheritedinterpolator : IInterpolator
The interpolator used by this effect to calculate values between the start and end values of a property.
Animate
 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
 InheritedmotionPaths : 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.
Animate
 InheritedperElementOffset : Number
Additional delay, in milliseconds, for effect targets after the first target of the effect.
Effect
 InheritedplayheadTime : Number
Current time position of the effect.
Effect
 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
 InheritedrepeatBehavior : String
The behavior of a repeating effect, which means an effect with repeatCount equal to either 0 or > 1.
Animate
 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
 InheritedstartDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect.
Effect
 Inheritedtarget : Object
The object to which this effect is applied.
Effect
 Inheritedtargets : Array
An Array of objects that are targets for the effect.
Effect
 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
 InheritedapplyTransitionEndProperties : 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
 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
  
AnimateColor(target:Object = null)
Constructor.
AnimateColor
 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 Flex uses this function 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
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 changed by this effect.
Effect
 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
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
stop():void
Stops the effect, leaving the effect targets in their current state.
Effect
Protected Methods
 MethodDefined By
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):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
effectStopHandler(event:EffectEvent):void
Called when an effect instance has stopped by a call to the stop() method.
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
Events
 Event Summary Defined By
 Inherited
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
 Inherited
effectRepeat
Dispatched when the effect begins a new repetition, for any effect that is repeated more than once.Animate
 Inherited
effectStart
Dispatched when the effect starts playing.Effect
 Inherited
effectStop
Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.Effect
 Inherited
effectUpdate
Dispatched every time the effect updates the target.Animate
Property Detail
colorFromproperty
public var colorFrom:uint = 0xFFFFFFFF

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The starting color value.

The default value is 0xFFFFFF.

colorPropertyNameproperty 
public var colorPropertyName:String = color

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.

The default value is "color".

colorToproperty 
public var colorTo:uint = 0xFFFFFFFF

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The ending color value.

The default value is 0xFFFFFF.

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

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Parameters
target:Object (default = null) — The Object to animate with this effect.
Examples
AnimateColorEffectExample.mxml
<?xml version="1.0"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- Simple example to demonstrate the s:AnimateColor class. -->
<s:Application
    xmlns:fx="http://ns.adobe.com/mxml/2009"
    xmlns:mx="library://ns.adobe.com/flex/mx"
    xmlns:s="library://ns.adobe.com/flex/spark">

    <fx:Declarations>
        <s:AnimateColor id="colorEffect" targets="{[examplePanel, targetLabel, detailText]}"
            colorFrom="0x0000FF" colorTo="0xFF0000" repeatCount="2" repeatBehavior="reverse"
            effectStart="playButton.enabled=false" effectEnd="playButton.enabled=true;"/>
        <s:AnimateColor id="colorEffectBackground" colorPropertyName="borderColor"
            target="{examplePanel}" colorFrom="0xBBBBBB" colorTo="0xFF4444" repeatCount="2"
            repeatBehavior="reverse" effectStart="playButton.enabled=false"
            effectEnd="playButton.enabled=true;"/>
    </fx:Declarations>

    <s:Panel id="examplePanel"
        title="AnimateColor Effect Example"
        width="75%" height="75%">

        <s:HGroup top="5">
            <!-- Our target to affect-->
            <s:VGroup id="targetBox" width="50%"  horizontalAlign="center">
                <s:Label id="targetLabel" text="Some Image" fontSize="14"/>
                <s:BitmapImage id="targetImg" source="@Embed(source='assets/back2.png')"/>
            </s:VGroup>
            <s:VGroup id="detailsBox" width="50%" left="0">
                <s:Label id="detailText" width="99%" color="blue"
                    text="The:AnimateColor effect changes the color of a target using the following parameters: colorFrom, colorTo. Click 'Animate Color' to watch the effect."/>
            </s:VGroup>
        </s:HGroup>

        <s:Rect left="0" right="0" bottom="0" height="30">
            <s:fill>
                <s:LinearGradient rotation="90">
                    <s:GradientEntry color="0xE2E2E2" />
                    <s:GradientEntry color="0xD9D9D9" />
                </s:LinearGradient>
            </s:fill>
        </s:Rect>
        <s:Button id="playButton"
            left="5" bottom="5"
            label="Animate Color"
            click="colorEffect.play();colorEffectBackground.play();"/>
    </s:Panel>
</s:Application>



The Apache Software Foundation

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