Ext JS Sencha Docs

Ext.data.Batch

Hierarchy

Ext.Base
Ext.data.Batch

Mixins

Files

Provides a mechanism to run one or more operations in a given order. Fires the operationcomplete event after the completion of each Operation, and the complete event when all Operations have been successfully executed. Fires an exception event if any of the Operations encounter an exception.

Usually these are only used internally by Ext.data.proxy.Proxy classes.

Defined By

Config options

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

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

A config object containing one or more event handlers to be added to this object during initialization. ...

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.

See the Event guide for more

Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define(). Instead, only specify listeners when you are instantiating your class with Ext.create().

True to pause the execution of the batch if any operation encounters an exception (defaults to false). ...

True to pause the execution of the batch if any operation encounters an exception (defaults to false). If you set this to true you are responsible for implementing the appropriate handling logic and restarting or discarding the batch as needed. There are different ways you could do this, e.g. by handling the batch's exception event directly, or perhaps by overriding onBatchException at the store level. If you do pause and attempt to handle the exception you can call retry to process the same operation again.

Note that operations are atomic, so any operations that may have succeeded prior to an exception (and up until pausing the batch) will be finalized at the server level and will not be automatically reversible. Any transactional / rollback behavior that might be desired would have to be implemented at the application level. Pausing on exception will likely be most beneficial when used in coordination with such a scheme, where an exception might actually affect subsequent operations in the same batch and so should be handled before continuing with the next operation.

If you have not implemented transactional operation handling then this option should typically be left to the default of false (e.g. process as many operations as possible, and handle any exceptions asynchronously without holding up the rest of the batch).

Defaults to: false

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_")...

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to: false

Available since: 5.0.0

Overrides: Ext.Component.$configPrefixed, Ext.data.AbstractStore.$configPrefixed, Ext.layout.Layout.$configPrefixed, Ext.layout.container.boxOverflow.None.$configPrefixed

The value true instructs the initConfig method to only honor values for properties declared in the config block of a ...

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to: true

Available since: 5.0.0

Overrides: Ext.Component.$configStrict, Ext.data.AbstractStore.$configStrict, Ext.layout.Layout.$configStrict, Ext.layout.container.boxOverflow.None.$configStrict

Ext.data.Batch
view source
: Booleanprivate
True if this batch has been executed completely. ...

True if this batch has been executed completely.

Defaults to: false

Ext.data.Batch
view source
: Numberprivate

The index of the current operation being executed.

The index of the current operation being executed.

Ext.data.Batch
view source
: Booleanprivate
True if this batch has encountered an exception. ...

True if this batch has encountered an exception. This is cleared at the start of each operation.

Defaults to: false

Ordered array of operations that raised an exception during the most recent batch execution and did not successfully ...

Ordered array of operations that raised an exception during the most recent batch execution and did not successfully complete

Defaults to: []

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }
...

Defaults to: /\.|[^\w\-]/g

This property is set to true during the call to initConfig. ...

This property is set to true during the call to initConfig.

Defaults to: false

Available since: 5.0.0

This property is set to true if this instance is the first of its class. ...

This property is set to true if this instance is the first of its class.

Defaults to: false

Available since: 5.0.0

This value is true and is used to identify plain objects from instances of a defined class. ...

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to: true

...

Defaults to: /^(?:scope|order|delegate|single|delay|buffer|args|prepend|destroyable)$/

...

Defaults to: {id: 'observable', after: {destroy: 'destroy'}}

...

Defaults to: 'observable'

Ordered array of operations that will be executed by this batch ...

Ordered array of operations that will be executed by this batch

Defaults to: []

Ext.data.Batch
view source
: Booleanprivate
True if the batch is currently running. ...

True if the batch is currently running.

Defaults to: false

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'
Ext.data.Batch
view source
: Numberprivate
The total number of operations in this batch. ...

The total number of operations in this batch.

Defaults to: 0

Defined By

Static properties

...

Defaults to: []

Methods

Defined By

Instance methods

Ext.data.Batch
view source
new( [config] ) : Ext.data.Batch
Creates new Batch object. ...

Creates new Batch object.

Parameters

  • config : Object (optional)

    Config object

Returns

Overrides: Ext.mixin.Observable.constructor

Ext.data.Batch
view source
( operation ) : Ext.data.Batchchainable
Adds a new operation to this batch at the end of the operations array ...

Adds a new operation to this batch at the end of the operations array

Parameters

Returns

Fires

    ( eventName, fn, [scope], [options] )
    Appends an after-event handler. ...

    Appends an after-event handler.

    Same as addListener with order set to 'after'.

    Parameters

    • eventName : String/String[]/Object

      The name of the event to listen for.

    • fn : Function/String

      The method the event invokes.

    • scope : Object (optional)

      The scope for fn.

    • options : Object (optional)

      An object containing handler configuration.

    Fires

      ( eventName, fn, [scope], [options] )
      Appends a before-event handler. ...

      Appends a before-event handler. Returning false from the handler will stop the event.

      Same as addListener with order set to 'before'.

      Parameters

      • eventName : String/String[]/Object

        The name of the event to listen for.

      • fn : Function/String

        The method the event invokes.

      • scope : Object (optional)

        The scope for fn.

      • options : Object (optional)

        An object containing handler configuration.

      Fires

        ( deprecations )private
        This method applies a versioned, deprecation declaration to this class. ...

        This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

        Parameters

        ( selector, name, fn, scope, options, order )private
        ...

        Parameters

        Fires

          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.

          This method has been deprecated since 2.0

          It's no longer needed to add events before firing.

          Parameters

          • eventNames : 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.

          ( eventName, fn, [scope], [options], [order] )
          Appends an event handler to this object. ...

          Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

          Combining Options

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

          A delayed, one-time listener:

          container.addListener('tap', this.handleTap, 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:

          container.addListener({
              tap  : this.onTap,
              swipe: this.onSwipe,
          
              scope: this // Important. Ensure "this" is correct during handler execution
          });
          

          One can also specify options for each event handler separately:

          container.addListener({
              tap  : { fn: this.onTap, scope: this, single: true },
              swipe: { fn: button.onSwipe, scope: button }
          });
          

          See the Events Guide for more.

          Parameters

          • eventName : String/String[]/Object

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

          • fn : Function/String

            The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

          • 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.

            This object may contain any of the following properties:

            • scope : Object (optional)

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

            • delay : Number (optional)

              The number of milliseconds to delay the invocation of the handler after the event fires.

            • single : Boolean (optional)

              true to add a handler to handle just the next firing of the event, and then remove itself.

            • order : String (optional)

              The order of when the listener should be added into the listener queue.

              If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

              Available options are before, current and after.

              Defaults to: current

            • buffer : Number (optional)

              Causes the handler to be 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.

            • element : String (optional)

              If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.

              Ext.create('Ext.Component', {
                  listeners: {
                      element: 'element',
                      tap: function() {
                          alert('element tap!');
                      }
                  }
              });
              

              In Sencha Touch, All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

            • delegate : String (optional)

              For Elements, a simple DOM selector to filter the target or look for a descendant of the target.

              Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.

              // Create a container with a two children; a button and a toolbar
              var container = Ext.create('Ext.Container', {
                  items: [
                      {
                          xtype: 'toolbar',
                          docked: 'top',
                          title: 'My Toolbar'
                      },
                      {
                         xtype: 'button',
                         text: 'My Button'
                      }
                  ]
              });
              
              container.addListener({
                  // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                  delegate: 'button',
              
                  tap: function() {
                      alert('Button tapped!');
                  }
              });
              
            • capture : Boolean

              true to initiate capture which will fire the listeners on the target Element before any descendant Elements. Normal events start with the target element and propagate upward to ancestor elements, whereas captured events propagate from the top of the DOM downward to descendant elements. This option achieves the same result as the useCapture parameter in the standard JavaScript addEventListener method.

          • order : String (optional)

            The order of when the listener should be added into the listener queue. Possible values are before, current and after.

            Defaults to: 'current'

          Fires

            ( object, eventName, [fn], [scope], [options] )deprecated
            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.

            This method has been deprecated since 2.0

            All listeners are now automatically managed where necessary. Simply use addListener.

            Parameters

            • object : Ext.mixin.Observable/HTMLElement

              The item to which to add a listener/listeners.

            • eventName : Object/String

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

            • fn : Function (optional)

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

            • scope : Object (optional)

              If the eventName parameter was an event name, this is the scope in which the handler function is executed.

            • options : Object (optional)

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

            ...

            Parameters

            ...

            Parameters

            Fires

              ...

              Parameters

              Fires

                ( args ) : Objectdeprecatedprotected
                Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

                Call the original method that was previously overridden with override

                Ext.define('My.Cat', {
                    constructor: function() {
                        alert("I'm a cat!");
                    }
                });
                
                My.Cat.override({
                    constructor: function() {
                        alert("I'm going to be a cat!");
                
                        this.callOverridden();
                
                        alert("Meeeeoooowwww");
                    }
                });
                
                var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                          // alerts "I'm a cat!"
                                          // alerts "Meeeeoooowwww"
                

                This method has been deprecated

                Use callParent instead.

                Parameters

                • args : Array/Arguments

                  The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

                Returns

                • Object

                  Returns the result of calling the overridden method

                Call the "parent" method of the current method. ...

                Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

                 Ext.define('My.Base', {
                     constructor: function (x) {
                         this.x = x;
                     },
                
                     statics: {
                         method: function (x) {
                             return x;
                         }
                     }
                 });
                
                 Ext.define('My.Derived', {
                     extend: 'My.Base',
                
                     constructor: function () {
                         this.callParent([21]);
                     }
                 });
                
                 var obj = new My.Derived();
                
                 alert(obj.x);  // alerts 21
                

                This can be used with an override as follows:

                 Ext.define('My.DerivedOverride', {
                     override: 'My.Derived',
                
                     constructor: function (x) {
                         this.callParent([x*2]); // calls original My.Derived constructor
                     }
                 });
                
                 var obj = new My.Derived();
                
                 alert(obj.x);  // now alerts 42
                

                This also works with static methods.

                 Ext.define('My.Derived2', {
                     extend: 'My.Base',
                
                     statics: {
                         method: function (x) {
                             return this.callParent([x*2]); // calls My.Base.method
                         }
                     }
                 });
                
                 alert(My.Base.method(10));     // alerts 10
                 alert(My.Derived2.method(10)); // alerts 20
                

                Lastly, it also works with overridden static methods.

                 Ext.define('My.Derived2Override', {
                     override: 'My.Derived2',
                
                     statics: {
                         method: function (x) {
                             return this.callParent([x*2]); // calls My.Derived2.method
                         }
                     }
                 });
                
                 alert(My.Derived2.method(10); // now alerts 40
                

                To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

                Parameters

                • args : Array/Arguments

                  The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

                Returns

                • Object

                  Returns the result of calling the parent method

                This method is used by an override to call the superclass method but bypass any overridden method. ...

                This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

                Consider:

                 Ext.define('Ext.some.Class', {
                     method: function () {
                         console.log('Good');
                     }
                 });
                
                 Ext.define('Ext.some.DerivedClass', {
                     extend: 'Ext.some.Class',
                
                     method: function () {
                         console.log('Bad');
                
                         // ... logic but with a bug ...
                
                         this.callParent();
                     }
                 });
                

                To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an override:

                 Ext.define('App.patches.DerivedClass', {
                     override: 'Ext.some.DerivedClass',
                
                     method: function () {
                         console.log('Fixed');
                
                         // ... logic but with bug fixed ...
                
                         this.callSuper();
                     }
                 });
                

                The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

                Parameters

                • args : Array/Arguments

                  The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

                Returns

                • Object

                  Returns the result of calling the superclass method

                ( actionFn, eventName, fn, scope, options, order )private
                ...

                Parameters

                Removes all listeners for this object. ...

                Removes all listeners for this object.

                Fires

                  ...

                  Parameters

                  Fires

                    ...

                    Parameters

                    Fires

                      Creates an event handling function which re-fires the event from this object as the passed event name. ...

                      Creates an event handling function which re-fires the event from this object as the passed event name.

                      Parameters

                      Returns

                      Fires

                        This method is called to cleanup an object and its resources. ...

                        This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.

                        Fires

                        • destroy

                        Overrides: Ext.Base.destroy, Ext.mixin.Observable.destroy

                        ( name, fn, scope, options, order ) : Booleanprivate
                        ...

                        Parameters

                        Returns

                        Fires

                          ( eventName, args, action, connectedController )private
                          ...

                          Parameters

                          Fires

                            ( name, fn, scope, options, order )private
                            ...

                            Parameters

                            Fires

                              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.

                              Parameters

                              • events : String/String[]

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

                              Fires

                                ( eventName, args, fn, scope ) : Object
                                Fires the specified event with the passed parameters and execute a function (action) at the end if there are no liste...

                                Fires the specified event with the passed parameters and execute a function (action) at the end if there are no listeners that return false.

                                Parameters

                                • eventName : String

                                  The name of the event to fire.

                                • args : Array

                                  Arguments to pass to handers.

                                • fn : Function

                                  Action.

                                • scope : Object

                                  Scope of fn.

                                Returns

                                Fires

                                  Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

                                  Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

                                  The first argument is the name of the event. Every other argument passed will be available when you listen for the event.

                                  Example

                                  Firstly, we set up a listener for our new event.

                                  this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
                                      console.log(arg1); // true
                                      console.log(arg2); // 2
                                      console.log(arg3); // { test: 'foo' }
                                      console.log(arg4); // 14
                                      console.log(options); // the options added when adding the listener
                                      console.log(e); // the event object with information about the event
                                  });
                                  

                                  And then we can fire off the event.

                                  this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);
                                  

                                  An event may be set to bubble up an Observable parent hierarchy 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.

                                  Fires

                                    Fires the specified event with the passed parameter list. ...

                                    Fires the specified event with the passed parameter list.

                                    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[]

                                      An array of parameters which are passed to handlers.

                                    Returns

                                    • Boolean

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

                                    Fires

                                      Returns the value of bubbleEvents. ...

                                      Returns the value of bubbleEvents.

                                      Returns

                                      Returns a specified config property value. ...

                                      Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

                                      Parameters

                                      • name : String (optional)

                                        The name of the config property to get.

                                      • peek : Boolean (optional)

                                        true to peek at the raw value without calling the getter.

                                        Defaults to: false

                                      Returns

                                      • Object

                                        The config property value.

                                      Gets the currently running operation. ...

                                      Gets the currently running operation. Will return null if the batch has not started or is completed.

                                      Returns

                                      Gets any operations that have returned without success in this batch. ...

                                      Gets any operations that have returned without success in this batch.

                                      Returns

                                      Retrieves the id of this component. ...

                                      Retrieves the id of this component. Will autogenerate an id if one has not already been set.

                                      Returns

                                      Fires

                                        Returns the initial configuration passed to constructor when instantiating this class. ...

                                        Returns the initial configuration passed to constructor when instantiating this class.

                                        Parameters

                                        • name : String (optional)

                                          Name of the config option to return.

                                        Returns

                                        • Object/Mixed

                                          The full config object or a single config value when name parameter specified.

                                        Returns the value of listeners. ...

                                        Returns the value of listeners.

                                        Returns

                                        ...

                                        Parameters

                                        Gets the operations for this batch. ...

                                        Gets the operations for this batch.

                                        Returns

                                        Returns the value of pauseOnException. ...

                                        Returns the value of pauseOnException.

                                        Returns

                                        Ext.data.Batch
                                        view source
                                        ( ) : Number
                                        Gets the total number of operations in this batch. ...

                                        Gets the total number of operations in this batch.

                                        Returns

                                        ...

                                        Parameters

                                        Ext.data.Batch
                                        view source
                                        ( ) : Boolean
                                        Checks if this batch has any exceptions. ...

                                        Checks if this batch has any exceptions.

                                        Returns

                                        • Boolean

                                          true if this batch has any exceptions.

                                        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

                                        Fires

                                          ( config ) : Ext.Basechainableprotected
                                          Initialize configuration for this class. ...

                                          Initialize configuration for this class. a typical example:

                                          Ext.define('My.awesome.Class', {
                                              // The default config
                                              config: {
                                                  name: 'Awesome',
                                                  isAwesome: true
                                              },
                                          
                                              constructor: function(config) {
                                                  this.initConfig(config);
                                              }
                                          });
                                          
                                          var awesome = new My.awesome.Class({
                                              name: 'Super Awesome'
                                          });
                                          
                                          alert(awesome.getName()); // 'Super Awesome'
                                          

                                          Parameters

                                          Returns

                                          Fires

                                            Ext.data.Batch
                                            view source
                                            ( ) : Boolean
                                            Checks if this batch is complete. ...

                                            Checks if this batch is complete.

                                            Returns

                                            • Boolean

                                              true if this batch is complete.

                                            Ext.data.Batch
                                            view source
                                            ( ) : Boolean
                                            Checks if this batch is running. ...

                                            Checks if this batch is running.

                                            Returns

                                            • Boolean

                                              true if this batch is running.

                                            Checks if all events, or a specific event, is suspended. ...

                                            Checks if all events, or a specific event, is suspended.

                                            Parameters

                                            • eventName : String (optional)

                                              The name of the specific event to check

                                            Returns

                                            • Boolean

                                              true if events are suspended

                                            ( object, eventName, [fn], [scope], [options] )deprecated
                                            Alias for addManagedListener. ...

                                            Alias for addManagedListener.

                                            This method has been deprecated since 2.0.0

                                            This is now done automatically

                                            Parameters

                                            • object : Ext.mixin.Observable/HTMLElement

                                              The item to which to add a listener/listeners.

                                            • eventName : Object/String

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

                                            • fn : Function (optional)

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

                                            • scope : Object (optional)

                                              If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                            • options : Object (optional)

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

                                            ( object, eventName, [fn], [scope] )deprecated
                                            Alias for removeManagedListener. ...

                                            Alias for removeManagedListener.

                                            This method has been deprecated since 2.0.0

                                            This is now done automatically

                                            Parameters

                                            • object : Ext.mixin.Observable/HTMLElement

                                              The item to which to add a listener/listeners.

                                            • eventName : Object/String

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

                                            • fn : Function (optional)

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

                                            • scope : Object (optional)

                                              If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                            ( eventName, fn, [scope], [options], [order] )
                                            Alias for addListener. ...

                                            Alias for addListener.

                                            Parameters

                                            • eventName : String/String[]/Object

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

                                            • fn : Function/String

                                              The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

                                            • 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.

                                              This object may contain any of the following properties:

                                              • scope : Object (optional)

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

                                              • delay : Number (optional)

                                                The number of milliseconds to delay the invocation of the handler after the event fires.

                                              • single : Boolean (optional)

                                                true to add a handler to handle just the next firing of the event, and then remove itself.

                                              • order : String (optional)

                                                The order of when the listener should be added into the listener queue.

                                                If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

                                                Available options are before, current and after.

                                                Defaults to: current

                                              • buffer : Number (optional)

                                                Causes the handler to be 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.

                                              • element : String (optional)

                                                If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.

                                                Ext.create('Ext.Component', {
                                                    listeners: {
                                                        element: 'element',
                                                        tap: function() {
                                                            alert('element tap!');
                                                        }
                                                    }
                                                });
                                                

                                                In Sencha Touch, All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

                                              • delegate : String (optional)

                                                For Elements, a simple DOM selector to filter the target or look for a descendant of the target.

                                                Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.

                                                // Create a container with a two children; a button and a toolbar
                                                var container = Ext.create('Ext.Container', {
                                                    items: [
                                                        {
                                                            xtype: 'toolbar',
                                                            docked: 'top',
                                                            title: 'My Toolbar'
                                                        },
                                                        {
                                                           xtype: 'button',
                                                           text: 'My Button'
                                                        }
                                                    ]
                                                });
                                                
                                                container.addListener({
                                                    // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                                                    delegate: 'button',
                                                
                                                    tap: function() {
                                                        alert('Button tapped!');
                                                    }
                                                });
                                                
                                              • capture : Boolean

                                                true to initiate capture which will fire the listeners on the target Element before any descendant Elements. Normal events start with the target element and propagate upward to ancestor elements, whereas captured events propagate from the top of the DOM downward to descendant elements. This option achieves the same result as the useCapture parameter in the standard JavaScript addEventListener method.

                                            • order : String (optional)

                                              The order of when the listener should be added into the listener queue. Possible values are before, current and after.

                                              Defaults to: 'current'

                                            ( eventName, fn, [scope], [options] )
                                            Alias for addAfterListener. ...

                                            Alias for addAfterListener.

                                            Parameters

                                            • eventName : String/String[]/Object

                                              The name of the event to listen for.

                                            • fn : Function/String

                                              The method the event invokes.

                                            • scope : Object (optional)

                                              The scope for fn.

                                            • options : Object (optional)

                                              An object containing handler configuration.

                                            ( eventName, fn, [scope], [options] )
                                            Alias for addBeforeListener. ...

                                            Alias for addBeforeListener.

                                            Parameters

                                            • eventName : String/String[]/Object

                                              The name of the event to listen for.

                                            • fn : Function/String

                                              The method the event invokes.

                                            • scope : Object (optional)

                                              The scope for fn.

                                            • options : Object (optional)

                                              An object containing handler configuration.

                                            Ext.data.Batch
                                            view source
                                            ( operation )private
                                            ...

                                            Parameters

                                            Fires

                                            Ext.data.Batch
                                            view source
                                            ( ) : Ext.data.Batchchainable
                                            Pauses execution of the batch, but does not cancel the current operation ...

                                            Pauses execution of the batch, but does not cancel the current operation

                                            Returns

                                            ( args, fn, scope, options, order )private
                                            ...

                                            Parameters

                                            Fires

                                              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

                                              • object : Object

                                                The Observable whose events this object is to relay.

                                              • events : String/Array/Object

                                                Array of event names to relay.

                                              Returns

                                              Fires

                                                ( eventName, fn, [scope], [options] )
                                                Removes a before-event handler. ...

                                                Removes a before-event handler.

                                                Same as removeListener with order set to 'after'.

                                                Parameters

                                                • eventName : String/String[]/Object

                                                  The name of the event the handler was associated with.

                                                • fn : Function/String

                                                  The handler to remove.

                                                • scope : Object (optional)

                                                  The scope originally specified for fn.

                                                • options : Object (optional)

                                                  Extra options object.

                                                Fires

                                                  ( eventName, fn, [scope], [options] )
                                                  Removes a before-event handler. ...

                                                  Removes a before-event handler.

                                                  Same as removeListener with order set to 'before'.

                                                  Parameters

                                                  • eventName : String/String[]/Object

                                                    The name of the event the handler was associated with.

                                                  • fn : Function/String

                                                    The handler to remove.

                                                  • scope : Object (optional)

                                                    The scope originally specified for fn.

                                                  • options : Object (optional)

                                                    Extra options object.

                                                  Fires

                                                    ( selector, name, fn, scope, options, order )private
                                                    ...

                                                    Parameters

                                                    Fires

                                                      ( eventName, fn, [scope], [options], [order] )
                                                      Removes an event handler. ...

                                                      Removes an event handler.

                                                      Parameters

                                                      • eventName : String/String[]/Object

                                                        The type of event the handler was associated with.

                                                      • fn : Function/String

                                                        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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                      • options : Object (optional)

                                                        Extra options object. See addListener for details.

                                                      • order : String (optional)

                                                        The order of the listener to remove. Possible values are before, current and after.

                                                        Defaults to: 'current'

                                                      Fires

                                                        ( object, eventName, [fn], [scope] )deprecated
                                                        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.

                                                        This method has been deprecated since 2.0

                                                        All listeners are now automatically managed where necessary. Simply use removeListener.

                                                        Parameters

                                                        • object : Ext.mixin.Observable/HTMLElement

                                                          The item to which to add a listener/listeners.

                                                        • eventName : Object/String

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

                                                        • fn : Function (optional)

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

                                                        • scope : Object (optional)

                                                          If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                        This method determines the scope (the this pointer) of named listeners that have not be given a specific scope. ...

                                                        This method determines the scope (the this pointer) of named listeners that have not be given a specific scope. For example:

                                                         component.on({
                                                             click: 'onClick'
                                                         });
                                                        

                                                        The default implementation of this method returns this object. Components and other observable objects that have natural hierarchies can override this method to pick the desired scope using other means.

                                                        Available since: 5.0.0

                                                        Parameters

                                                        • defaultScope : Object (optional)

                                                          The default scope to return if none is found.

                                                          Defaults to: this

                                                        Returns

                                                        • Object

                                                          The object on which non-scoped, named listeners should be fired.

                                                        Resumes firing of the named event(s). ...

                                                        Resumes firing of the named event(s).

                                                        After calling this method to resume events, the events will fire when requested to fire.

                                                        Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

                                                        Parameters

                                                        • eventName : String...

                                                          Multiple event names to resume.

                                                        Fires

                                                          Resumes firing events (see suspendEvents). ...

                                                          Resumes firing events (see suspendEvents).

                                                          Parameters

                                                          • discardQueuedEvents : Boolean

                                                            Pass as true to discard any queued events.

                                                          Ext.data.Batch
                                                          view source
                                                          ( ) : Ext.data.Batchchainable
                                                          Kicks off execution of the batch, continuing from the current operation. ...

                                                          Kicks off execution of the batch, continuing from the current operation. This is intended for restarting a paused batch after an exception, and the operation that raised the exception will now be retried. The batch will then continue with its normal processing until all operations are complete or another exception is encountered.

                                                          Note that if the batch is already running any call to retry will be ignored.

                                                          Returns

                                                          Fires

                                                          Ext.data.Batch
                                                          view source
                                                          ( ) : Ext.data.Batchchainableprivate
                                                          Runs the next operation, relative to this.current. ...

                                                          Runs the next operation, relative to this.current.

                                                          Returns

                                                          Fires

                                                          Ext.data.Batch
                                                          view source
                                                          ( index ) : Ext.data.Batchchainableprivate
                                                          Executes an operation by its numeric index in the operations array ...

                                                          Executes an operation by its numeric index in the operations array

                                                          Parameters

                                                          • index : Number

                                                            The operation index to run

                                                          Returns

                                                          Fires

                                                          Sets the value of bubbleEvents. ...

                                                          Sets the value of bubbleEvents.

                                                          Parameters

                                                          ( name, [value] ) : Ext.Basechainable
                                                          Sets a single/multiple configuration options. ...

                                                          Sets a single/multiple configuration options.

                                                          Parameters

                                                          • name : String/Object

                                                            The name of the property to set, or a set of key value pairs to set.

                                                          • value : Object (optional)

                                                            The value to set for the name parameter.

                                                          Returns

                                                          Fires

                                                            ...

                                                            Parameters

                                                            Sets the value of listeners. ...

                                                            Sets the value of listeners.

                                                            Parameters

                                                            Ext.data.Batch
                                                            view source
                                                            ( pauseOnException )
                                                            Sets the value of pauseOnException. ...

                                                            Sets the value of pauseOnException.

                                                            Parameters

                                                            Ext.data.Batch
                                                            view source
                                                            ( )
                                                            Sorts the operations based on their type and the foreign key dependencies of the entities. ...

                                                            Sorts the operations based on their type and the foreign key dependencies of the entities. Consider a simple Parent and Child case where the Child has a "parentId" field. If this batch contains two create operations, one of a Parent and one for its Child, the server must receive and process the create of the Parent before the Child can be created.

                                                            In the case of destroy operations this order is reversed. The Child entity must be destroyed before the Parent to avoid any foreign key constraints (a Child with an invalid parentId field).

                                                            Further, create operations must all occur before update operations to ensure that all entities exist that might be now referenced by the updates. The created entities can safely reference already existing entities.

                                                            Finally, destroy operations are sorted after update operations to allow those updates to remove references to the soon-to-be-deleted entities.

                                                            Ext.data.Batch
                                                            view source
                                                            ( operation1, operation2 )private
                                                            ...

                                                            Parameters

                                                            Ext.data.Batch
                                                            view source
                                                            ( index ) : Ext.data.Batchchainable
                                                            Kicks off execution of the batch, continuing from the next operation if the previous operation encountered an excepti...

                                                            Kicks off execution of the batch, continuing from the next operation if the previous operation encountered an exception, or if execution was paused. Use this method to start the batch for the first time or to restart a paused batch by skipping the current unsuccessful operation.

                                                            To retry processing the current operation before continuing to the rest of the batch (e.g. because you explicitly handled the operation's exception), call retry instead.

                                                            Note that if the batch is already running any call to start will be ignored.

                                                            Parameters

                                                            Returns

                                                            Fires

                                                            Get the reference to the class from which this object was instantiated. ...

                                                            Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                            Ext.define('My.Cat', {
                                                                statics: {
                                                                    totalCreated: 0,
                                                                    speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                },
                                                            
                                                                constructor: function() {
                                                                    var statics = this.statics();
                                                            
                                                                    alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                    // equivalent to: My.Cat.speciesName
                                                            
                                                                    alert(this.self.speciesName);   // dependent on 'this'
                                                            
                                                                    statics.totalCreated++;
                                                                },
                                                            
                                                                clone: function() {
                                                                    var cloned = new this.self();   // dependent on 'this'
                                                            
                                                                    cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                            
                                                                    return cloned;
                                                                }
                                                            });
                                                            
                                                            
                                                            Ext.define('My.SnowLeopard', {
                                                                extend: 'My.Cat',
                                                            
                                                                statics: {
                                                                    speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                },
                                                            
                                                                constructor: function() {
                                                                    this.callParent();
                                                                }
                                                            });
                                                            
                                                            var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                            
                                                            var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                            
                                                            var clone = snowLeopard.clone();
                                                            alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                            alert(clone.groupName);                 // alerts 'Cat'
                                                            
                                                            alert(My.Cat.totalCreated);             // alerts 3
                                                            

                                                            Returns

                                                            Suspends firing of the named event(s). ...

                                                            Suspends firing of the named event(s).

                                                            After calling this method to suspend events, the events will no longer fire when requested to fire.

                                                            Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

                                                            Parameters

                                                            • eventName : String...

                                                              Multiple event names to suspend.

                                                            Suspends the firing of all events. ...

                                                            Suspends the firing of all events. (see resumeEvents)

                                                            Parameters

                                                            • queueSuspended : Boolean

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

                                                            ( toggle, eventName, fn, scope, options, order )private
                                                            ...

                                                            Parameters

                                                            Fires

                                                              ( eventName, fn, [scope], [options], [order] )
                                                              Alias for removeListener. ...

                                                              Alias for removeListener.

                                                              Parameters

                                                              • eventName : String/String[]/Object

                                                                The type of event the handler was associated with.

                                                              • fn : Function/String

                                                                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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                              • options : Object (optional)

                                                                Extra options object. See addListener for details.

                                                              • order : String (optional)

                                                                The order of the listener to remove. Possible values are before, current and after.

                                                                Defaults to: 'current'

                                                              ( eventName, fn, [scope], [options] )
                                                              Alias for removeAfterListener. ...

                                                              Alias for removeAfterListener.

                                                              Parameters

                                                              • eventName : String/String[]/Object

                                                                The name of the event the handler was associated with.

                                                              • fn : Function/String

                                                                The handler to remove.

                                                              • scope : Object (optional)

                                                                The scope originally specified for fn.

                                                              • options : Object (optional)

                                                                Extra options object.

                                                              ( eventName, fn, [scope], [options] )
                                                              Alias for removeBeforeListener. ...

                                                              Alias for removeBeforeListener.

                                                              Parameters

                                                              • eventName : String/String[]/Object

                                                                The name of the event the handler was associated with.

                                                              • fn : Function/String

                                                                The handler to remove.

                                                              • scope : Object (optional)

                                                                The scope originally specified for fn.

                                                              • options : Object (optional)

                                                                Extra options object.

                                                              Defined By

                                                              Static methods

                                                              ( config, [mixinClass] )privatestatic
                                                              Adds new config properties to this class. ...

                                                              Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

                                                              Parameters

                                                              • config : Object
                                                              • mixinClass : Class (optional)

                                                                The mixin class if the configs are from a mixin.

                                                              ( members )chainableprivatestatic
                                                              ...

                                                              Parameters

                                                              ( name, member )chainableprivatestatic
                                                              ...

                                                              Parameters

                                                              ( members, [isStatic], [privacy] )chainablestatic
                                                              Add methods / properties to the prototype of this class. ...

                                                              Add methods / properties to the prototype of this class.

                                                              Ext.define('My.awesome.Cat', {
                                                                  constructor: function() {
                                                                      ...
                                                                  }
                                                              });
                                                              
                                                               My.awesome.Cat.addMembers({
                                                                   meow: function() {
                                                                      alert('Meowww...');
                                                                   }
                                                               });
                                                              
                                                               var kitty = new My.awesome.Cat();
                                                               kitty.meow();
                                                              

                                                              Parameters

                                                              • members : Object

                                                                The members to add to this class.

                                                              • isStatic : Boolean (optional)

                                                                Pass true if the members are static.

                                                                Defaults to: false

                                                              • privacy : Boolean (optional)

                                                                Pass true if the members are private. This only has meaning in debug mode and only for methods.

                                                                Defaults to: false

                                                              ( members ) : Ext.Basechainablestatic
                                                              Add / override static properties of this class. ...

                                                              Add / override static properties of this class.

                                                              Ext.define('My.cool.Class', {
                                                                  ...
                                                              });
                                                              
                                                              My.cool.Class.addStatics({
                                                                  someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                                                                  method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
                                                                  method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
                                                              });
                                                              

                                                              Parameters

                                                              Returns

                                                              ( fromClass, members ) : Ext.Baseprivatestatic
                                                              Borrow another class' members to the prototype of this class. ...

                                                              Borrow another class' members to the prototype of this class.

                                                              Ext.define('Bank', {
                                                                  money: '$$$',
                                                                  printMoney: function() {
                                                                      alert('$$$$$$$');
                                                                  }
                                                              });
                                                              
                                                              Ext.define('Thief', {
                                                                  ...
                                                              });
                                                              
                                                              Thief.borrow(Bank, ['money', 'printMoney']);
                                                              
                                                              var steve = new Thief();
                                                              
                                                              alert(steve.money); // alerts '$$$'
                                                              steve.printMoney(); // alerts '$$$$$$$'
                                                              

                                                              Parameters

                                                              • fromClass : Ext.Base

                                                                The class to borrow members from

                                                              • members : Array/String

                                                                The names of the members to borrow

                                                              Returns

                                                              ( args )protectedstatic
                                                              ...

                                                              Parameters

                                                              ( args )protectedstatic
                                                              ...

                                                              Parameters

                                                              Create a new instance of this Class. ...

                                                              Create a new instance of this Class.

                                                              Ext.define('My.cool.Class', {
                                                                  ...
                                                              });
                                                              
                                                              My.cool.Class.create({
                                                                  someConfig: true
                                                              });
                                                              

                                                              All parameters are passed to the constructor of the class.

                                                              Returns

                                                              ( alias, origin )static
                                                              Create aliases for existing prototype methods. ...

                                                              Create aliases for existing prototype methods. Example:

                                                              Ext.define('My.cool.Class', {
                                                                  method1: function() { ... },
                                                                  method2: function() { ... }
                                                              });
                                                              
                                                              var test = new My.cool.Class();
                                                              
                                                              My.cool.Class.createAlias({
                                                                  method3: 'method1',
                                                                  method4: 'method2'
                                                              });
                                                              
                                                              test.method3(); // test.method1()
                                                              
                                                              My.cool.Class.createAlias('method5', 'method3');
                                                              
                                                              test.method5(); // test.method3() -> test.method1()
                                                              

                                                              Parameters

                                                              ( config )privatestatic
                                                              ...

                                                              Parameters

                                                              Returns the Ext.Configurator for this class. ...

                                                              Returns the Ext.Configurator for this class.

                                                              Returns

                                                              Get the current class' name in string format. ...

                                                              Get the current class' name in string format.

                                                              Ext.define('My.cool.Class', {
                                                                  constructor: function() {
                                                                      alert(this.self.getName()); // alerts 'My.cool.Class'
                                                                  }
                                                              });
                                                              
                                                              My.cool.Class.getName(); // 'My.cool.Class'
                                                              

                                                              Returns

                                                              ( name, mixinClass )privatestatic
                                                              Used internally by the mixins pre-processor ...

                                                              Used internally by the mixins pre-processor

                                                              Parameters

                                                              ( fn, scope )chainableprivatestatic
                                                              ...

                                                              Parameters

                                                              Override members of this class. ...

                                                              Override members of this class. Overridden methods can be invoked via callParent.

                                                              Ext.define('My.Cat', {
                                                                  constructor: function() {
                                                                      alert("I'm a cat!");
                                                                  }
                                                              });
                                                              
                                                              My.Cat.override({
                                                                  constructor: function() {
                                                                      alert("I'm going to be a cat!");
                                                              
                                                                      this.callParent(arguments);
                                                              
                                                                      alert("Meeeeoooowwww");
                                                                  }
                                                              });
                                                              
                                                              var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                        // alerts "I'm a cat!"
                                                                                        // alerts "Meeeeoooowwww"
                                                              

                                                              Direct use of this method should be rare. Use Ext.define instead:

                                                              Ext.define('My.CatOverride', {
                                                                  override: 'My.Cat',
                                                                  constructor: function() {
                                                                      alert("I'm going to be a cat!");
                                                              
                                                                      this.callParent(arguments);
                                                              
                                                                      alert("Meeeeoooowwww");
                                                                  }
                                                              });
                                                              

                                                              The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

                                                              Parameters

                                                              • members : Object

                                                                The properties to add to this class. This should be specified as an object literal containing one or more properties.

                                                              Returns

                                                              Defined By

                                                              Events

                                                              Ext.data.Batch
                                                              view source
                                                              ( batch, operation, eOpts )
                                                              Fired when all operations of this batch have been completed ...

                                                              Fired when all operations of this batch have been completed

                                                              Parameters

                                                              Ext.data.Batch
                                                              view source
                                                              ( batch, operation, eOpts )
                                                              Fired when a operation encountered an exception ...

                                                              Fired when a operation encountered an exception

                                                              Parameters

                                                              Ext.data.Batch
                                                              view source
                                                              ( batch, operation, eOpts )
                                                              Fired when each operation of the batch completes ...

                                                              Fired when each operation of the batch completes

                                                              Parameters