Animation is an abstract base class used as a starting point for all the other animations.
provides the basic mechanics for the animation (playing, pausing, stopping, timing, etc.)
and leaves the actual animation to be done in the abstract methods getAnimatedValue
and setValue.

Tag:

Animation

Class:

AjaxControlToolkit.Animation.Animation

Base:

Sys.Component

Constructor:

new AjaxControlToolkit.Animation.Animation(target, duration, fps);

Play:

AjaxControlToolkit.Animation.Animation.play(target, duration, fps);

Properties:

Number duration;

Length of time to play the animation (in seconds). The default value is 1.

Number fps;

Number of frames per second shown when animating. The default values is 25.

Boolean isActive; // Read Only

true if animation is active, false if not.

Boolean isInitialized; // Read Only

Inherited from Sys.Component

Boolean isPlaying; // Read Only

true if animation is playing, false if not.

Boolean isUpdating; // Read Only

Inherited from Sys.Component

Number percentComplete; // Read Only

Percentage of the animation already played.

Object target;

Target element that the animation should operate on. (Note: Do not set this property in
a generic xml animation description. It will be set automatically using either the TargetControlID
or the AnimationTarget properties.)

Methods:

dispose();

Dispose the animation

getAnimatedValue();

Determine the state of the animation after the given percentage of its duration has elapsed

getDescriptor();

Inherited from Sys.Component

interpolate(start, end, percentage);

Given two Numbers start and
end, the interpolate function
will produce another Number the specified
percentage between the two values.

onEnd();

Perform any cleanup after playing the animation.

onStart();

Perform any initialization before playing the animation.

onStep(percentage);

Progress the animation through each frame

pause();

Pause the animation

play();

Play the animation

setOwner(owner);

Inherited from Sys.Component

setValue(value);

Set the current state of the animation

stop();

Stop playing the animation

Parent Animation

The ParentAnimation serves as a base class for all animations that contain children (such as
ParallelAnimation,
SequenceAnimation, etc.). It does not
actually play the animations, so any classes that inherit from it must do so.

The ParallelAnimation plays several animations simultaneously. It inherits from
ParentAnimation, but makes itself the owner of all its child animations as this allows
it to use a single timer and synchronization mechanisms of the parent animation (in other words, the duration
properties of any child animations are ignored in favor of the parent's duration). It is very useful in
creating sophisticated effects through combinations of simpler animations.Note: The ParallelAnimation cannot have any child animations that derive
from SequenceAnimation.

The SequenceAnimation runs several child animations one after the other. It can also repeat the sequence
of animations for a specified number of iterations (which defaults to a single iteration, but will repeat
forever if you specify zero or less iterations). It is important to note that the SequenceAnimation ignores
its duration and fps properties, and will let each of its child animations
use any values they please.Note: The SequenceAnimation cannot be a child animation of ParallelAnimation,
SelectionAnimation, or any animation deriving from these two.

Implementation of an abstract function from Sys.UI.Animation that throws
an exception (because it should never be called).

stop();

Stop the currently playing sequence of child animations.

Selection Animation

The SelectionAnimation will run a single animation chosen from of its child animations.
This is a base class with no functional implementation, so consider using ConditionAnimation or
CaseAnimation.Note: The SelectionAnimation cannot have any child animations that derive
from SequenceAnimation.

The ConditionAnimation is used as a control structure to play a specific child animation depending
on the result of executing the conditionScript. If the conditionScript
evaluated to true, the first child animation is played. If it evaluates to false, the second child animation is played (although nothing
is played if the second animation is not present).Note: The ConditionAnimation cannot have any child animations that derive from SequenceAnimation.

The CaseAnimation is used as a control structure to play a specific child animation depending
on the result of executing the selectScript, which should evaluate to the index of the child
animation to play (this is similar to the switch statement in C#, etc.). If the provided index
is outside the bounds of the child animations (or if nothing was returned) then we will not play anything.Note: The CaseAnimation cannot have any child animations that derive from SequenceAnimation.

The FadeAnimation is used to fade an element in or out of view, depending on the provided
AjaxControlToolkit.Animation.FadeEffect. The minimum and maximum opacity values can be specified to precisely control the fade.
Also, due to known issues with Internet Explorer, the forceLayoutInIE
property is used to enforce certain conditions (specifically that it has a set size and background color). You may also consider using
FadeInAnimation and FadeOutAnimation if you know the specific direction you are fading.

Determines whether we fade in or out. Possible values are FadeIn and
FadeOut. The default falue is FadeIn.

Boolean forceLayoutInIE;

Flag indicating whether or not we should force a layout to be created for Internet Explorer by giving it a width
and setting its background color (the latter is required in case the user has ClearType enabled). The default values is true.
This property is obviously ignored when working in other browsers.

The PulseAnimation fades an element in and our repeatedly to create a pulsating effect. The
iterations determine how many pulses there will be. The duration property
defines the length of each fade in or fade out, not the length of the animation as a whole.

The PropertyAnimation is a useful base animation that will assign the value from
getAnimatedValue to a specified property. You can provide the name of a property
alongside an optional propertyKey (which indicates the value property[propertyKey],
like style['backgroundColor']).

Optional key of the property to be set (which indicates the value
property[propertyKey], like style['backgroundColor']).
Note that for the style property, the key must be in a JavaScript friendly format
(i.e. backgroundColor instead of background-color).

The MoveAnimation is used to move the target element.
If the relative flag is set to true, then it treats the horizontal
and vertical properties as offsets to move the element. If the relative
flag is false, then it will treat the horizontal and vertical properties
as coordinates on the page where the target element should be moved. It is important to note that the
target must be positioned (i.e. absolutely)
so that settings its top/left properties will change its location.

The ScaleAnimation scales the size of the target element by the given
scaleFactor (i.e. a scaleFactor of .5 will shrink it in half and a
scaleFactor of 2.0 will double it). If scaleFont is true, the size of
the font will also scale with the element. If center is true, then the element's center will not move as it
is scaled. It is important to note that the target must be positioned
(i.e. absolutely) so that settings its top/left
properties will change its location in order for center to have an effect.

Action is a base class for all "non-animating" animations. While regular animations
perform an operation in a sequence of small steps spread over an interval, the actions perform a single operation
instantaneously. By default, all actions have a duration of zero.