X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..refs/heads/master:/docs/api/Ext.util.Animate.html diff --git a/docs/api/Ext.util.Animate.html b/docs/api/Ext.util.Animate.html deleted file mode 100644 index 23cc2e5b..00000000 --- a/docs/api/Ext.util.Animate.html +++ /dev/null @@ -1,361 +0,0 @@ -Ext.util.Animate | Ext JS 4.0 Documentation -
For up to date documentation and features, visit -http://docs.sencha.com/ext-js/4-0

Sencha Documentation

- - - - - -

This animation class is a mixin.

- -

Ext.util.Animate provides an API for the creation of animated transitions of properties and styles.
-This class is used as a mixin and currently applied to Ext.core.Element, Ext.CompositeElement, -Ext.draw.Sprite, Ext.draw.CompositeSprite, and Ext.Component. Note that Components -have a limited subset of what attributes can be animated such as top, left, x, y, height, width, and -opacity (color, paddings, and margins can not be animated).

- -

Animation Basics

- -

All animations require three things - easing, duration, and to (the final end value for each property) -you wish to animate. Easing and duration are defaulted values specified below. -Easing describes how the intermediate values used during a transition will be calculated. -Easing allows for a transition to change speed over its duration. -You may use the defaults for easing and duration, but you must always set a -to property which is the end value for all animations.

- -

Popular element 'to' configurations are:

- -
    -
  • opacity
  • -
  • x
  • -
  • y
  • -
  • color
  • -
  • height
  • -
  • width
  • -
- - -

Popular sprite 'to' configurations are:

- -
    -
  • translation
  • -
  • path
  • -
  • scale
  • -
  • stroke
  • -
  • rotation
  • -
- - -

The default duration for animations is 250 (which is a 1/4 of a second). Duration is denoted in -milliseconds. Therefore 1 second is 1000, 1 minute would be 60000, and so on. The default easing curve -used for all animations is 'ease'. Popular easing functions are included and can be found in Easing.

- -

For example, a simple animation to fade out an element with a default easing and duration:

- -
var p1 = Ext.get('myElementId');
-
-p1.animate({
-    to: {
-        opacity: 0
-    }
-});
-
- -

To make this animation fade out in a tenth of a second:

- -
var p1 = Ext.get('myElementId');
-
-p1.animate({
-   duration: 100,
-    to: {
-        opacity: 0
-    }
-});
-
- -

Animation Queues

- -

By default all animations are added to a queue which allows for animation via a chain-style API. -For example, the following code will queue 4 animations which occur sequentially (one right after the other):

- -
p1.animate({
-    to: {
-        x: 500
-    }
-}).animate({
-    to: {
-        y: 150
-    }
-}).animate({
-    to: {
-        backgroundColor: '#f00'  //red
-    }
-}).animate({
-    to: {
-        opacity: 0
-    }
-});
-
- -

You can change this behavior by calling the syncFx method and all -subsequent animations for the specified target will be run concurrently (at the same time).

- -
p1.syncFx();  //this will make all animations run at the same time
-
-p1.animate({
-    to: {
-        x: 500
-    }
-}).animate({
-    to: {
-        y: 150
-    }
-}).animate({
-    to: {
-        backgroundColor: '#f00'  //red
-    }
-}).animate({
-    to: {
-        opacity: 0
-    }
-});
-
- -

This works the same as:

- -
p1.animate({
-    to: {
-        x: 500,
-        y: 150,
-        backgroundColor: '#f00'  //red
-        opacity: 0
-    }
-});
-
- -

The stopAnimation method can be used to stop any -currently running animations and clear any queued animations.

- -

Animation Keyframes

- -

You can also set up complex animations with keyframe which follows the -CSS3 Animation configuration pattern. Note rotation, translation, and scaling can only be done for sprites. -The previous example can be written with the following syntax:

- -
p1.animate({
-    duration: 1000,  //one second total
-    keyframes: {
-        25: {     //from 0 to 250ms (25%)
-            x: 0
-        },
-        50: {   //from 250ms to 500ms (50%)
-            y: 0
-        },
-        75: {  //from 500ms to 750ms (75%)
-            backgroundColor: '#f00'  //red
-        },
-        100: {  //from 750ms to 1sec
-            opacity: 0
-        }
-    }
-});
-
- -

Animation Events

- -

Each animation you create has events for beforeanimation, -afteranimate, and lastframe.
-Keyframed animations adds an additional keyframe event which -fires for each keyframe in your animation.

- -

All animations support the listeners configuration to attact functions to these events.

- -
startAnimate: function() {
-    var p1 = Ext.get('myElementId');
-    p1.animate({
-       duration: 100,
-        to: {
-            opacity: 0
-        },
-        listeners: {
-            beforeanimate:  function() {
-                // Execute my custom method before the animation
-                this.myBeforeAnimateFn();
-            },
-            afteranimate: function() {
-                // Execute my custom method after the animation
-                this.myAfterAnimateFn();
-            },
-            scope: this
-    });
-},
-myBeforeAnimateFn: function() {
-  // My custom logic
-},
-myAfterAnimateFn: function() {
-  // My custom logic
-}
-
- -

Due to the fact that animations run asynchronously, you can determine if an animation is currently -running on any target by using the getActiveAnimation -method. This method will return false if there are no active animations or return the currently -running Ext.fx.Anim instance.

- -

In this example, we're going to wait for the current animation to finish, then stop any other -queued animations before we fade our element's opacity to 0:

- -
var curAnim = p1.getActiveAnimation();
-if (curAnim) {
-    curAnim.on('afteranimate', function() {
-        p1.stopAnimation();
-        p1.animate({
-            to: {
-                opacity: 0
-            }
-        });
-    });
-}
-
-
Defined By

Properties

 
@deprecated 4.0 Replaced by getActiveAnimation -Returns thq current animation if this object has any effects actively ...

@deprecated 4.0 Replaced by getActiveAnimation -Returns thq current animation if this object has any effects actively running or queued, else returns false.

-
 
Stops any running effects and clears this object's internal effects queue if it contains -any additional effects that ...

Stops any running effects and clears this object's internal effects queue if it contains -any additional effects that haven't started yet.

-
Defined By

Methods

 
animate( -Object config) - : Object
Perform custom animation on this object. -This method is applicable to both the the Component class and the Element cl...

Perform custom animation on this object.

-

This method is applicable to both the the Component class and the Element class. -It performs animated transitions of certain properties of this object over a specified timeline.

-

The sole parameter is an object which specifies start property values, end property values, and properties which -describe the timeline. Of the properties listed below, only to is mandatory.

-

Properties include

    -
  • from
    An object which specifies start values for the properties being animated. -If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon -ths object being animated. See the sections below on Element and Component animation.
  • -
  • to
    An object which specifies end values for the properties being animated.
  • -
  • duration
    The duration in milliseconds for which the animation will run.
  • -
  • easing
    A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:
      -
    • ease
    • -
    • easeIn
    • -
    • easeOut
    • -
    • easeInOut
    • -
    • backIn
    • -
    • backOut
    • -
    • elasticIn
    • -
    • elasticOut
    • -
    • bounceIn
    • -
    • bounceOut
    • -
  • -
  • keyframes
    This is an object which describes the state of animated properties at certain points along the timeline. -it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.
  • -
  • listeners
    This is a standard listeners configuration object which may be used -to inject behaviour at either the beforeanimate event or the afteranimate event.
  • -

-

Animating an Element

-When animating an Element, the following properties may be specified in from, to, and keyframe objects:
    -
  • x
    The page X position in pixels.
  • -
  • y
    The page Y position in pixels
  • -
  • left
    The element's CSS left value. Units must be supplied.
  • -
  • top
    The element's CSS top value. Units must be supplied.
  • -
  • width
    The element's CSS width value. Units must be supplied.
  • -
  • height
    The element's CSS height value. Units must be supplied.
  • -
  • scrollLeft
    The element's scrollLeft value.
  • -
  • scrollTop
    The element's scrollLeft value.
  • -
  • opacity
    The element's opacity value. This must be a value between 0 and 1.
  • -
-

Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state -will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to -directly animate certain properties of Components.

-

Animating a Component

-When animating an Element, the following properties may be specified in from, to, and keyframe objects:
    -
  • x
    The Component's page X position in pixels.
  • -
  • y
    The Component's page Y position in pixels
  • -
  • left
    The Component's left value in pixels.
  • -
  • top
    The Component's top value in pixels.
  • -
  • width
    The Component's width value in pixels.
  • -
  • width
    The Component's width value in pixels.
  • -
  • dynamic
    Specify as true to update the Component's layout (if it is a Container) at every frame -of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.
  • -
-

For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:

-
myWindow = Ext.create('Ext.window.Window', {
-    title: 'Test Component animation',
-    width: 500,
-    height: 300,
-    layout: {
-        type: 'hbox',
-        align: 'stretch'
-    },
-    items: [{
-        title: 'Left: 33%',
-        margins: '5 0 5 5',
-        flex: 1
-    }, {
-        title: 'Left: 66%',
-        margins: '5 5 5 5',
-        flex: 2
-    }]
-});
-myWindow.show();
-myWindow.header.el.on('click', function() {
-    myWindow.animate({
-        to: {
-            width: (myWindow.getWidth() == 500) ? 700 : 500,
-            height: (myWindow.getHeight() == 300) ? 400 : 300,
-        }
-    });
-});
-
-

For performance reasons, by default, the internal layout is only updated when the Window reaches its final "to" size. If dynamic updating of the Window's child -Components is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

- -

Parameters

  • config : Object

    An object containing properties which describe the animation's start and end states, and the timeline of the animation.

    -

Returns

  • Object   

    this

    -
 

Returns thq current animation if this object has any effects actively running or queued, else returns false.

-

Returns thq current animation if this object has any effects actively running or queued, else returns false.

-

Returns

  • Mixed   

    anim if element has active effects, else false

    -
 
Ensures that all effects queued after sequenceFx is called on this object are -run in sequence. This is the opposite ...

Ensures that all effects queued after sequenceFx is called on this object are -run in sequence. This is the opposite of syncFx.

-

Returns

  • Ext.core.Element   

    The Element

    -
 
@deprecated 4.0 Replaced by stopAnimation -Stops any running effects and clears this object's internal effects queue i...

@deprecated 4.0 Replaced by stopAnimation -Stops any running effects and clears this object's internal effects queue if it contains -any additional effects that haven't started yet.

-

Returns

  • Ext.core.Element   

    The Element

    -
 
Ensures that all effects queued after syncFx is called on this object are -run concurrently. This is the opposite of ...

Ensures that all effects queued after syncFx is called on this object are -run concurrently. This is the opposite of sequenceFx.

-

Returns

  • Ext.core.Element   

    The Element

    -
\ No newline at end of file