For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

Sencha Documentation

Mixins

This class manages animation for a specific target. The animation allows animation of various properties on the target, such as size, position, color and others.

Starting Conditions

The starting conditions for the animation are provided by the from configuration. Any/all of the properties in the from configuration can be specified. If a particular property is not defined, the starting value for that property will be read directly from the target.

End Conditions

The ending conditions for the animation are provided by the to configuration. These mark the final values once the animations has finished. The values in the from can mirror those in the to configuration to provide a starting point.

Other Options

  • duration: Specifies the time period of the animation.
  • easing: Specifies the easing of the animation.
  • iterations: Allows the animation to repeat a number of times.
  • alternate: Used in conjunction with iterations, reverses the direction every second iteration.

Example Code

var myComponent = Ext.create('Ext.Component', {
    renderTo: document.body,
    width: 200,
    height: 200,
    style: 'border: 1px solid red;'
});

new Ext.fx.Anim({
    target: myComponent,
    duration: 1000,
    from: {
        width: 400 //starting width 400
    },
    to: {
        width: 300, //end width 300
        height: 300 // end width 300
    }
});
Defined By

Config Options

Other Configs

 

Used in conjunction with iterations to reverse the animation each time an iteration completes. Defaults to false.

Used in conjunction with iterations to reverse the animation each time an iteration completes. Defaults to false.

 

Time to delay before starting the animation. Defaults to 0.

Time to delay before starting the animation. Defaults to 0.

 
Time in milliseconds for a single animation to last. Defaults to 250. If the iterations property is specified, then e...

Time in milliseconds for a single animation to last. Defaults to 250. If the iterations property is specified, then each animate will take the same duration for each iteration.

 
Currently only for Component Animation: Only set a component's outer element size bypassing layouts. Set to true to ...

Currently only for Component Animation: Only set a component's outer element size bypassing layouts. Set to true to do full layouts for every frame of the animation. Defaults to false.

 
This describes how the intermediate values used during a transition will be calculated. It allows for a transition to...

This describes how the intermediate values used during a transition will be calculated. It allows for a transition to change speed over its duration.

     -backIn
     -backOut
     -bounceIn
     -bounceOut
     -ease
     -easeIn
     -easeOut
     -easeInOut
     -elasticIn
     -elasticOut
     -cubic-bezier(x1, y1, x2, y2)

Note that cubic-bezier will create a custom easing curve following the CSS3 transition-timing-function specification http://www.w3.org/TR/css3-transitions/.transition-timing-function_tag. The four values specify points P1 and P2 of the curve as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid.

 
An object containing property/value pairs for the beginning of the animation. If not specified, the current state of...

An object containing property/value pairs for the beginning of the animation. If not specified, the current state of the Ext.fx.target will be used. For example:

from : {
    opacity: 0,       // Transparent
    color: '#ffffff', // White
    left: 0
}
 

Number of times to execute the animation. Defaults to 1.

Number of times to execute the animation. Defaults to 1.

 
Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to' is con...

Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to' is considered '100%'.Every keyframe declaration must have a keyframe rule for 0% and 100%, possibly defined using "from" or "to". A keyframe declaration without these keyframe selectors is invalid and will not be available for animation. The keyframe declaration for a keyframe rule consists of properties and values. Properties that are unable to be animated are ignored in these rules, with the exception of 'easing' which can be changed at each keyframe. For example:

keyframes : {
    '0%': {
        left: 100
    },
    '40%': {
        left: 150
    },
    '60%': {
        left: 75
    },
    '100%': {
        left: 100
    }
}
 
 
(optional) A config object containing one or more event handlers to be added to this object during initialization. T...

(optional)

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.


DOM events from ExtJs Components


While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this

is usually only done when extra value can be added. For example the DataView's click event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

 

Run the animation from the end to the beginning Defaults to false.

Run the animation from the end to the beginning Defaults to false.

 
The Ext.fx.target.Target to apply the animation to. This should only be specified when creating an Ext.fx.Anim direc...

The Ext.fx.target.Target to apply the animation to. This should only be specified when creating an Ext.fx.Anim directly. The target does not need to be a Ext.fx.target.Target instance, it can be the underlying object. For example, you can pass a Component, Element or Sprite as the target and the Anim will create the appropriate Ext.fx.target.Target object automatically.

 
An object containing property/value pairs for the end of the animation. For example: to : { opacity: 1, ...

An object containing property/value pairs for the end of the animation. For example:

 to : {
     opacity: 1,       // Opaque
     color: '#00ff00', // Green
     left: 500
 }
 
Defined By

Properties

 

Current iteration the animation is running.

Current iteration the animation is running.

 
Flag to determine if the animation is paused. Only set this to true if you need to keep the Anim instance around to b...

Flag to determine if the animation is paused. Only set this to true if you need to keep the Anim instance around to be unpaused later; otherwise call end.

 

Flag to determine if the animation has started

Flag to determine if the animation has started

 

Starting time of the animation.

Starting time of the animation.

Defined By

Methods

 
addEvents( Object/String o, String ) : void

Adds the specified events to the list of events which this Observable may fire.

Adds the specified events to the list of events which this Observable may fire.

Parameters

  • o : Object/String

    Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

  • : String

    [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

    this.addEvents('storeloaded', 'storecleared');
    

Returns

  • void   
 
addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Appends an event handler to this object.

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are event names. See

  • handler : Function

    The method the event invokes.

  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options : Object

    (optional) An object containing handler configuration. properties. This may contain any of the following properties:

    • scope : Object
      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
    • element : String
      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

      new Ext.panel.Panel({
          title: 'The title',
          listeners: {
              click: this.handlePanelClick,
              element: 'body'
          }
      });
      

      When added in this way, the options available are the options applicable to Ext.core.Element.addListener


    Combining Options
    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
    });

    Attaching multiple handlers in 1 call
    The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

    myGridPanel.on({
        cellClick: this.onCellClick,
        mouseover: this.onMouseOver,
        mouseout: this.onMouseOut,
        scope: this // Important. Ensure "this" is correct during handler execution
    });
    
    .

Returns

  • void   
 
addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function

    Optional. If the ename parameter was an event name, this is the handler function.

  • scope : Object

    Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

  • opt : Object

    Optional. If the ename parameter was an event name, this is the addListener options.

Returns

  • void   
 
capture( Observable o, Function fn, [Object scope]) : void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

  • o : Observable

    The Observable to capture events from.

  • fn : Function

    The function to call when an event is fired.

  • scope : Object

    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

  • void   
 

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

Returns

  • void   
 

Removes all managed listeners for this object.

Removes all managed listeners for this object.

Returns

  • void   
 
enableBubble( String/Array events) : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present....

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.override(Ext.form.field.Base, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
    this.enableBubble('change');
}),

//  We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
    if (!this.formPanel) {
        this.formPanel = this.findParentByType('form');
    }
    return this.formPanel;
}
});

var myForm = new Ext.formPanel({
title: 'User Details',
items: [{
    ...
}],
listeners: {
    change: function() {
        // Title goes red if form has been modified.
        myForm.header.setStyle('color', 'red');
    }
}
});

Parameters

  • events : String/Array

    The event name to bubble, or an Array of event names.

Returns

  • void   
 
fireEvent( String eventName, Object... args) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

Parameters

  • eventName : String

    The name of the event to fire.

  • args : Object...

    Variable number of parameters are passed to handlers.

Returns

  • Boolean   

    returns false if any of the handlers return false otherwise it returns true.

 
hasListener( String eventName) : Boolean

Checks to see if this object has any listeners for a specified event

Checks to see if this object has any listeners for a specified event

Parameters

  • eventName : String

    The name of the event to check for

Returns

  • Boolean   

    True if the event is being listened for, else false

 
observe( Function c, Object listeners) : void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
    console.log('Ajax request made to ' + options.url);
});

Parameters

  • c : Function

    The class constructor to make observable.

  • listeners : Object

    An object containing a series of listeners to add. See addListener.

Returns

  • void   
 
on( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object (shorthand for addListener.)

Appends an event handler to this object (shorthand for addListener.)

Parameters

  • eventName : String

    The type of event to listen for

  • handler : Function

    The method the event invokes

  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options : Object

    (optional) An object containing handler configuration.

Returns

  • void   
 
relayEvents( Object origin, Array events, Object prefix) : void

Relays selected events from the specified Observable as if the events were fired by this.

Relays selected events from the specified Observable as if the events were fired by this.

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

  • events : Array

    Array of event names to relay.

  • prefix : Object

Returns

  • void   
 

Removes all added captures from the Observable.

Removes all added captures from the Observable.

Parameters

  • o : Observable

    The Observable to release

Returns

  • void   
 
removeListener( String eventName, Function handler, [Object scope]) : void

Removes an event handler.

Removes an event handler.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope : Object

    (optional) The scope originally specified for the handler.

Returns

  • void   
 
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : void

Removes listeners that were added by the mon method.

Removes listeners that were added by the mon method.

Parameters

  • item : Observable|Element

    The item from which to remove a listener/listeners.

  • ename : Object|String

    The event name, or an object containing event name properties.

  • fn : Function

    Optional. If the ename parameter was an event name, this is the handler function.

  • scope : Object

    Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Returns

  • void   
 
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Returns

  • void   
 
suspendEvents( Boolean queueSuspended) : void

Suspend the firing of all events. (see resumeEvents)

Suspend the firing of all events. (see resumeEvents)

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

Returns

  • void   
 
un( String eventName, Function handler, [Object scope]) : void

Removes an event handler (shorthand for removeListener.)

Removes an event handler (shorthand for removeListener.)

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope : Object

    (optional) The scope originally specified for the handler.

Returns

  • void   
Defined By

Events

 
afteranimate( Ext.fx.Anim this, Date startTime)

Fires when the animation is complete.

Fires when the animation is complete.

Parameters

  • this : Ext.fx.Anim
  • startTime : Date
 

Fires before the animation starts. A handler can return false to cancel the animation.

Fires before the animation starts. A handler can return false to cancel the animation.

Parameters

  • this : Ext.fx.Anim
 
lastframe( Ext.fx.Anim this, Date startTime)

Fires when the animation's last frame has been set.

Fires when the animation's last frame has been set.

Parameters

  • this : Ext.fx.Anim
  • startTime : Date