Touch 2.0.2 Sencha Docs

Ext.device.Connection

Hierarchy

Ext.Base
Ext.device.Connection

Mixins

Requires

Files

This class is used to check if the current device is currently online or not. It has three different implementations:

  • Sencha Packager
  • PhoneGap
  • Simulator

Both the Sencha Packager and PhoneGap implementations will use the native functionality to determine if the current device is online. The Simulator version will simply use navigator.onLine.

When this singleton (Ext.device.Connection) is instantiated, it will automatically decide which version to use based on the current platform.

Examples

Determining if the current device is online:

alert(Ext.device.Connection.isOnline());

Checking the type of connection the device has:

alert('Your connection type is: ' + Ext.device.Connection.getType());

The available connection types are:

Available since: 2.0.0

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.

Available since: 2.0.0

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 listeners config when you are defining a class using Ext.define. Instead, only specify listeners when you are instantiating your class with Ext.create.

Available since: 1.1.0

...

Defaults to: false

Available since: 2.0.0

Properties

Defined By

Instance properties

Text label for a connection type. ...

Text label for a connection type.

Defaults to: 'Cell 2G connection'

Available since: 2.0.0

Text label for a connection type. ...

Text label for a connection type.

Defaults to: 'Cell 3G connection'

Available since: 2.0.0

Text label for a connection type. ...

Text label for a connection type.

Defaults to: 'Cell 4G connection'

Available since: 2.0.0

Text label for a connection type. ...

Text label for a connection type.

Defaults to: 'Ethernet connection'

Available since: 2.0.0

Text label for a connection type. ...

Text label for a connection type.

Defaults to: 'No network connection'

Available since: 2.0.0

Text label for a connection type. ...

Text label for a connection type.

Defaults to: 'Unknown connection'

Available since: 2.0.0

Text label for a connection type. ...

Text label for a connection type.

Defaults to: 'WiFi connection'

Available since: 2.0.0

...

Defaults to: 'ext-'

Available since: 2.0.0

...

Defaults to: '-'

Available since: 2.0.0

...

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

Available since: 2.0.0

...

Defaults to: false

Available since: 2.0.0

...

Defaults to: true

Available since: 2.0.0

...

Defaults to: true

Available since: 1.1.0

...

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

Available since: 2.0.0

...

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

Available since: 2.0.0

...

Defaults to: 'identifiable'

Available since: 2.0.0

...

Defaults to: '#'

Available since: 2.0.0

...

Defaults to: 'observable'

Available since: 2.0.0

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); / dependentOL 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'

Available since: 2.0.0

...

Defaults to: /^([\w\-]+)$/

Available since: 2.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance methods

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

Appends an after-event handler.

Same as addListener with order set to 'after'.

Available since: 2.0.0

Parameters

  • eventName : String

    The name of the event to listen for.

  • fn : Function

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

    Available since: 2.0.0

    Parameters

    • eventName : String

      The name of the event to listen for.

    • fn : Function

      The method the event invokes.

    • scope : Object (optional)

      The scope for fn.

    • options : Object (optional)

      An object containing handler configuration.

    Fires

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

      Available since: 2.0.0

      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.

        Available since: 1.1.0

        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.on('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.on({
            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.on({
            tap  : { fn: this.onTap, scope: this, single: true },
            swipe: { fn: button.onSwipe, scope: button }
        });
        

        See the Events Guide for more.

        Available since: 1.1.0

        Parameters

        • eventName : String

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

        • fn : Function

          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

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

          • delay : Number

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

          • single : Boolean

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

          • order : String

            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

            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

            Allows you to add a listener onto a element of this component using the elements reference.

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

            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

            Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

            // 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.on({
                // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                delegate: 'button',
            
                tap: function() {
                    alert('Button tapped!');
                }
            });
            
        • 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.

          Available since: 1.1.0

          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.

          ...

          Available since: 2.0.0

          Parameters

          Fires

            ...

            Available since: 2.0.0

            Parameters

            Fires

              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!");
              
                      var instance = this.callOverridden();
              
                      alert("Meeeeoooowwww");
              
                      return instance;
                  }
              });
              
              var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                        // alerts "I'm a cat!"
                                        // alerts "Meeeeoooowwww"
              

              Available since: 2.0.0

              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
              

              Available since: 2.0.0

              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

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

              Available since: 2.0.0

              Parameters

              Removes all listeners for this object. ...

              Removes all listeners for this object.

              Available since: 1.1.0

              Fires

                ...

                Available since: 1.1.0

                Parameters

                Fires

                  ...

                  Available since: 2.0.0

                  Parameters

                  Fires

                    Creates an event handling function which refires the event from this object as the passed event name. ...

                    Creates an event handling function which refires the event from this object as the passed event name.

                    Available since: 2.0.0

                    Parameters

                    Returns

                    Fires

                      ...

                      Available since: 2.0.0

                      Fires

                      • destroy

                      Overrides: Ext.Base.destroy

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

                      Available since: 2.0.0

                      Parameters

                      Fires

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

                        Available since: 2.0.0

                        Parameters

                        Fires

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

                          Available since: 2.0.0

                          Parameters

                          Fires

                            ( me, value, oldValue, options )private
                            ...

                            Available since: 2.0.0

                            Parameters

                            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.

                            Available since: 1.1.0

                            Parameters

                            • events : String/String[]

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

                            Fires

                              ( eventName, args, fn, scope )
                              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.

                              Available since: 2.0.0

                              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

                              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.

                                Available since: 1.1.0

                                Parameters

                                • eventName : String

                                  The name of the event to fire.

                                • args : Object...

                                  Variable number of parameters are passed to handlers.

                                Returns

                                • Boolean

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

                                Fires

                                  Returns the value of bubbleEvents. ...

                                  Returns the value of bubbleEvents.

                                  Available since: 2.0.0

                                  Returns

                                  ...

                                  Available since: 2.0.0

                                  ...

                                  Available since: 2.0.0

                                  Parameters

                                  ...

                                  Available since: 2.0.0

                                  ...

                                  Available since: 2.0.0

                                  Fires

                                    Retrieves the id of this component. ...

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

                                    Available since: 2.0.0

                                    Returns

                                    Fires

                                      Returns the initial configuration passed to constructor. ...

                                      Returns the initial configuration passed to constructor.

                                      Available since: 2.0.0

                                      Parameters

                                      • name : String (optional)

                                        When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

                                      Returns

                                      Returns the value of listeners. ...

                                      Returns the value of listeners.

                                      Available since: 2.0.0

                                      Returns

                                      ...

                                      Available since: 2.0.0

                                      Parameters

                                      ...

                                      Available since: 2.0.0

                                      Fires

                                        Returns the value of online. ...

                                        Returns the value of online.

                                        Available since: 2.0.0

                                        Returns

                                        ...

                                        Available since: 2.0.0

                                        ...

                                        Available since: 2.0.0

                                        Returns the current connection type. ...

                                        Returns the current connection type.

                                        Available since: 2.0.0

                                        Returns

                                        ...

                                        Available since: 2.0.0

                                        ...

                                        Available since: 2.0.0

                                        ...

                                        Available since: 2.0.0

                                        Parameters

                                        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

                                        Available since: 1.1.0

                                        Parameters

                                        • eventName : String

                                          The name of the event to check for

                                        Returns

                                        • Boolean

                                          True if the event is being listened for, else false

                                        Fires

                                          ( instanceConfig ) : Objectchainableprotected
                                          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'
                                          

                                          Available since: 2.0.0

                                          Parameters

                                          Returns

                                          • Object

                                            mixins The mixin prototypes as key - value pairs

                                          Fires

                                            ...

                                            Available since: 2.0.0

                                            Fires

                                              True if the device is currently online ...

                                              True if the device is currently online

                                              Available since: 2.0.0

                                              Returns

                                              Fires

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

                                                Alias for addManagedListener.

                                                Available since: 2.0.0

                                                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.

                                                Available since: 2.0.0

                                                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.

                                                Available since: 1.1.0

                                                Parameters

                                                • eventName : String

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

                                                • fn : Function

                                                  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

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

                                                  • delay : Number

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

                                                  • single : Boolean

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

                                                  • order : String

                                                    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

                                                    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

                                                    Allows you to add a listener onto a element of this component using the elements reference.

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

                                                    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

                                                    Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

                                                    // 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.on({
                                                        // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                                                        delegate: 'button',
                                                    
                                                        tap: function() {
                                                            alert('Button tapped!');
                                                        }
                                                    });
                                                    
                                                • 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.

                                                Available since: 2.0.0

                                                Parameters

                                                • eventName : String

                                                  The name of the event to listen for.

                                                • fn : Function

                                                  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.

                                                Available since: 2.0.0

                                                Parameters

                                                • eventName : String

                                                  The name of the event to listen for.

                                                • fn : Function

                                                  The method the event invokes.

                                                • scope : Object (optional)

                                                  The scope for fn.

                                                • options : Object (optional)

                                                  An object containing handler configuration.

                                                ...

                                                Available since: 2.0.0

                                                Parameters

                                                Fires

                                                  Overrides: Ext.mixin.Mixin.onClassExtended

                                                  ( names, callback, scope )private
                                                  ...

                                                  Available since: 2.0.0

                                                  Parameters

                                                  ...

                                                  Available since: 2.0.0

                                                  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.

                                                    Available since: 1.1.0

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

                                                      Available since: 2.0.0

                                                      Parameters

                                                      • eventName : String

                                                        The name of the event the handler was associated with.

                                                      • fn : Function

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

                                                        Available since: 2.0.0

                                                        Parameters

                                                        • eventName : String

                                                          The name of the event the handler was associated with.

                                                        • fn : Function

                                                          The handler to remove.

                                                        • scope : Object (optional)

                                                          The scope originally specified for fn.

                                                        • options : Object (optional)

                                                          Extra options object.

                                                        Fires

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

                                                          Available since: 2.0.0

                                                          Parameters

                                                          Fires

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

                                                            Removes an event handler.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • eventName : String

                                                              The type of event the handler was associated with.

                                                            • fn : Function

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

                                                            • scope : Object (optional)

                                                              The scope originally specified for the handler. 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.

                                                              Available since: 1.1.0

                                                              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.

                                                              Resumes firing events (see suspendEvents). ...

                                                              Resumes firing events (see suspendEvents).

                                                              If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

                                                              Available since: 1.1.0

                                                              Sets the value of bubbleEvents. ...

                                                              Sets the value of bubbleEvents.

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              Returns

                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              Sets the value of listeners. ...

                                                              Sets the value of listeners.

                                                              Available since: 2.0.0

                                                              Parameters

                                                              Sets the value of online. ...

                                                              Sets the value of online.

                                                              Available since: 2.0.0

                                                              Parameters

                                                              Sets the value of type. ...

                                                              Sets the value of type.

                                                              Available since: 2.0.0

                                                              Parameters

                                                              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
                                                              

                                                              Available since: 2.0.0

                                                              Returns

                                                              Suspends the firing of all events. ...

                                                              Suspends the firing of all events. (see resumeEvents)

                                                              Available since: 1.1.0

                                                              Parameters

                                                              • queueSuspended : Boolean

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

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

                                                              Alias for removeListener.

                                                              Available since: 1.1.0

                                                              Parameters

                                                              • eventName : String

                                                                The type of event the handler was associated with.

                                                              • fn : Function

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

                                                              • scope : Object (optional)

                                                                The scope originally specified for the handler. 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.

                                                              Available since: 2.0.0

                                                              Parameters

                                                              • eventName : String

                                                                The name of the event the handler was associated with.

                                                              • fn : Function

                                                                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.

                                                              Available since: 2.0.0

                                                              Parameters

                                                              • eventName : String

                                                                The name of the event the handler was associated with.

                                                              • fn : Function

                                                                The handler to remove.

                                                              • scope : Object (optional)

                                                                The scope originally specified for fn.

                                                              • options : Object (optional)

                                                                Extra options object.

                                                              Defined By

                                                              Static methods

                                                              ( config, fullMerge )privatestatic
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( members )chainableprivatestatic
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( name, member )chainableprivatestatic
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( members )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.implement({
                                                                   meow: function() {
                                                                      alert('Meowww...');
                                                                   }
                                                               });
                                                              
                                                               var kitty = new My.awesome.Cat;
                                                               kitty.meow();
                                                              

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( 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() { ... };
                                                              });
                                                              

                                                              Available since: 2.0.0

                                                              Parameters

                                                              Returns

                                                              ( xtype )chainableprivatestatic
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( fromClass, members ) : Ext.Basechainableprivatestatic
                                                              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 '$$$$$$$'
                                                              

                                                              Available since: 2.0.0

                                                              Parameters

                                                              • fromClass : Ext.Base

                                                                The class to borrow members from

                                                              • members : Array/String

                                                                The names of the members to borrow

                                                              Returns

                                                              ( args )privatestatic
                                                              ...

                                                              Available since: 2.0.0

                                                              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.

                                                              Available since: 2.0.0

                                                              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()
                                                              

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( parent )privatestatic
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              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'
                                                              

                                                              Available since: 2.0.0

                                                              Returns

                                                              ...

                                                              Available since: 2.0.0

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

                                                              Used internally by the mixins pre-processor

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( fn, scope )chainableprivatestatic
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              ( members ) : Ext.Basechainabledeprecatedstatic
                                                              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!");
                                                              
                                                                      var instance = this.callParent(arguments);
                                                              
                                                                      alert("Meeeeoooowwww");
                                                              
                                                                      return instance;
                                                                  }
                                                              });
                                                              
                                                              var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                        // alerts "I'm a cat!"
                                                                                        // alerts "Meeeeoooowwww"
                                                              

                                                              As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

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

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

                                                              Available since: 2.0.0

                                                              This method has been deprecated since 4.1.0

                                                              Please use Ext.define instead

                                                              Parameters

                                                              • members : Object

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

                                                              Returns

                                                              ...

                                                              Available since: 2.0.0

                                                              Defined By

                                                              Events

                                                              Ext.device.Connection
                                                              view source
                                                              ( online, type, eOpts )
                                                              Fires when the connection status changes. ...

                                                              Fires when the connection status changes.

                                                              Available since: 2.0.0

                                                              Parameters