Ext JS 4.2.1 Sencha Docs

Ext.util.ComponentDragger

Hierarchy

Ext.Base
Ext.dd.DragTracker
Ext.util.ComponentDragger

Inherited mixins

Files

A subclass of Ext.dd.DragTracker which handles dragging any Component.

This is configured with a Component to be made draggable, and a config object for the Ext.dd.DragTracker class.

A delegate may be provided which may be either the element to use as the mousedown target or a Ext.DomQuery selector to activate multiple mousedown targets.

When the Component begins to be dragged, its beginDrag method will be called if implemented.

When the drag ends, its endDrag method will be called if implemented.

Available since: 4.0.0

Defined By

Config options

Specify true to defer trigger start by 1000 ms. ...

Specify true to defer trigger start by 1000 ms. Specify a Number for the number of milliseconds to defer trigger start.

Defaults to: false

Available since: 3.4.0

Ext.util.ComponentDragger
view source
: Boolean

Specify as true to constrain the Component to within the bounds of the constrainTo region.

Specify as true to constrain the Component to within the bounds of the constrainTo region.

Available since: 4.0.0

Ext.util.ComponentDragger
view source
: Boolean

Specify as true to constrain the drag handles within the constrainTo region.

Specify as true to constrain the drag handles within the constrainTo region.

Available since: 4.0.0

A Region (Or an element from which a Region measurement will be read) which is used to constrain the result of the ge...

A Region (Or an element from which a Region measurement will be read) which is used to constrain the result of the getOffset call.

This may be set any time during the DragTracker's lifecycle to set a dynamic constraining region.

Available since: 4.0.0

Ext.util.ComponentDragger
view source
: String/Ext.Element
A DomQuery selector which identifies child elements within the Component's encapsulating Element which are the drag h...

A DomQuery selector which identifies child elements within the Component's encapsulating Element which are the drag handles. This limits dragging to only begin when the matching elements are mousedowned.

This may also be a specific child element within the Component's encapsulating element to use as the drag handle.

Available since: 4.0.0

Overrides: Ext.dd.DragTracker.delegate

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.

DOM events from Ext JS Components

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

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

Available since: 1.1.0

A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used, when a d...

A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used, when a delegate element) is mouseovered.

If the delegate option is used, these events fire only when a delegate element is entered of left.

Available since: 4.0.0

Specify false to enable default actions on onMouseDown events. ...

Specify false to enable default actions on onMouseDown events.

Defaults to: true

Available since: 4.0.0

Specify true to stop the mousedown event from bubbling to outer listeners from the target element (or its delegates). ...

Specify true to stop the mousedown event from bubbling to outer listeners from the target element (or its delegates).

Defaults to: false

Available since: 4.0.0

Number of pixels the drag target must be moved before dragging is considered to have started. ...

Number of pixels the drag target must be moved before dragging is considered to have started.

Defaults to: 5

Available since: 3.4.0

Set to true to fire mouseover and mouseout events when the mouse enters or leaves the target element. ...

Set to true to fire mouseover and mouseout events when the mouse enters or leaves the target element.

This is implicitly set when an overCls is specified.

If the delegate option is used, these events fire only when a delegate element is entered of left.

Defaults to: false

Available since: 4.0.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

Indicates whether the user is currently dragging this tracker. ...

Indicates whether the user is currently dragging this tracker.

Defaults to: false

Available since: 4.0.0

...

Defaults to: {}

Available since: 4.1.1

Available since: 3.4.0

The element being dragged. ...

The element being dragged.

Only valid during drag operations.

If the delegate option is used, this will be the delegate element which was mousedowned.

Available since: 4.0.0

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

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 (via observe) 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);
 }

Available since: 4.1.0

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

...

Defaults to: true

Available since: 4.1.1

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Available since: 4.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); // 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'

Available since: 4.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

Ext.util.ComponentDragger
view source
new( comp, [config] ) : Ext.util.ComponentDragger
Creates new ComponentDragger. ...

Creates new ComponentDragger.

Available since: 4.0.0

Parameters

  • comp : Object

    The Component to provide dragging for.

  • config : Object (optional)

    Config object

Returns

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

    Parameters

    • eventNames : Object/String...

      Either an object with event names as properties with a value of true. For example:

      this.addEvents({
          storeloaded: true,
          storecleared: true
      });
      

      Or any number of event names as separate parameters. For example:

      this.addEvents('storeloaded', 'storecleared');
      
    ( eventName, [fn], [scope], [options] ) : Object
    Appends an event handler to this object. ...

    Appends an event handler to this object. For example:

    myGridPanel.on("mouseover", this.onMouseOver, this);
    

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

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

    One can also specify options for each event handler separately:

    myGridPanel.on({
        cellClick: {fn: this.onCellClick, scope: this, single: true},
        mouseover: {fn: panel.onMouseOver, scope: panel}
    });
    

    Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

    myGridPanel.on({
        cellClick: {fn: 'onCellClick', scope: this, single: true},
        mouseover: {fn: 'onMouseOver', scope: panel}
    });
    

    Available since: 1.1.0

    Parameters

    • eventName : String/Object

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

    • fn : Function (optional)

      The method the event invokes, or if scope is specified, the name* of the method within the specified scope. 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.

      Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

      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.

      • buffer : Number

        Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

      • target : Ext.util.Observable

        Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

      • element : String

        This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

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

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

        When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

        Defaults to: false

      • priority : Number (optional)

        An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

        Combining Options

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

        A delayed, one-time listener.

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

    Returns

    • Object

      Only when the destroyable option is specified.

      A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

      this.btnListeners =  = myButton.on({
          destroyable: true
          mouseover:   function() { console.log('mouseover'); },
          mouseout:    function() { console.log('mouseout'); },
          click:       function() { console.log('click'); }
      });
      

      And when those listeners need to be removed:

      Ext.destroy(this.btnListeners);
      

      or

      this.btnListeners.destroy();
      

    Fires

      Overrides: Ext.AbstractComponent.addListener

      ( item, ename, [fn], [scope], [options] ) : Object
      Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

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

      Available since: 4.0.0

      Parameters

      • item : Ext.util.Observable/Ext.Element

        The item to which to add a listener/listeners.

      • ename : Object/String

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

      • fn : Function (optional)

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

      • scope : Object (optional)

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

      • options : Object (optional)

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

      Returns

      • Object

        Only when the destroyable option is specified.

        A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

        this.btnListeners =  = myButton.mon({
            destroyable: true
            mouseover:   function() { console.log('mouseover'); },
            mouseout:    function() { console.log('mouseout'); },
            click:       function() { console.log('click'); }
        });
        

        And when those listeners need to be removed:

        Ext.destroy(this.btnListeners);
        

        or

        this.btnListeners.destroy();
        

      Fires

        Ext.util.ComponentDragger
        view source
        ( )private
        ...

        Available since: 4.0.0

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

        Available since: 4.0.0

        This method has been deprecated

        as of 4.1. 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.

        Available since: 4.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

        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', {
             method: function () {
                 console.log('Bad');
        
                 // ... logic but with a bug ...
        
                 this.callParent();
             }
         });
        

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

         Ext.define('App.paches.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".

        Available since: 4.1.3

        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

        ...

        Available since: Ext JS 4.2.1

        Parameters

        Removes all listeners for this object including the managed listeners ...

        Removes all listeners for this object including the managed listeners

        Available since: 4.0.0

        Fires

          Removes all managed listeners for this object. ...

          Removes all managed listeners for this object.

          Available since: 4.0.0

          Fires

            ...

            Available since: 3.4.0

            ...

            Available since: 4.1.1

            ( eventName, args, bubbles )private
            Continue to fire event. ...

            Continue to fire event.

            Available since: 4.0.7

            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: 4.0.0

              Parameters

              • newName : String

                The name under which to refire the passed parameters.

              • beginEnd : Array (optional)

                The caller can specify on which indices to slice.

              Returns

              ...

              Available since: 3.4.0

              Fires

              Overrides: Ext.Base.destroy

              ...

              Available since: 4.0.0

              ...

              Available since: 4.0.0

              Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

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

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

              Example:

              Ext.define('Ext.overrides.form.field.Base', {
                  override: 'Ext.form.field.Base',
              
                  //  Add functionality to Field's initComponent to enable the change event to bubble
                  initComponent: function () {
                      this.callParent();
                      this.enableBubble('change');
                  }
              });
              
              var myForm = Ext.create('Ext.form.Panel', {
                  title: 'User Details',
                  items: [{
                      ...
                  }],
                  listeners: {
                      change: function() {
                          // Title goes red if form has been modified.
                          myForm.header.setStyle('color', 'red');
                      }
                  }
              });
              

              Available since: 3.4.0

              Parameters

              • eventNames : String/String[]

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

              Stop the drag operation, and remove active mouse listeners. ...

              Stop the drag operation, and remove active mouse listeners.

              Available since: 4.0.0

              Parameters

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

              An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) 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

                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.

                Available since: 4.2.0

                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

                  Gets the bubbling parent for an Observable ...

                  Gets the bubbling parent for an Observable

                  Available since: 4.0.7

                  Returns

                  Fires

                    ...

                    Available since: 4.1.0

                    Parameters

                    Return the Region into which the drag operation is constrained. ...

                    Return the Region into which the drag operation is constrained. Either the XY pointer itself can be constrained, or the dragTarget element The private property _constrainRegion is cached until onMouseUp

                    Available since: 4.0.0

                    Fires

                      ...

                      Available since: 3.4.0

                      Returns

                      Returns the drag target. ...

                      Returns the drag target. This is usually the DragTracker's encapsulating element.

                      If the delegate option is being used, this may be a child element which matches the delegate selector.

                      Available since: 3.4.0

                      Returns

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

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

                      Available since: 4.1.0

                      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 X, Y offset of the current mouse position from the mousedown point. ...

                      Returns the X, Y offset of the current mouse position from the mousedown point.

                      This method may optionally constrain the real offset values, and returns a point coerced in one of two modes:

                      • point The current mouse position is coerced into the constrainRegion and the resulting position is returned.
                      • dragTarget The new Region of the dragTarget is calculated based upon the current mouse position, and then coerced into the constrainRegion. The returned mouse position is then adjusted by the same delta as was used to coerce the region.\

                      Available since: 3.4.0

                      Parameters

                      • constrainMode : String (optional)

                        If omitted the true mouse position is returned. May be passed as point or dragTarget. See above.

                      Returns

                      • Number[]

                        The X, Y offset from the mousedown point, optionally constrained.

                      Fires

                        ...

                        Available since: 3.4.0

                        Parameters

                        ...

                        Available since: 4.1.0

                        Parameters

                        Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

                        Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

                        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 or bubbles, else false

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

                        Available since: 4.0.0

                        Parameters

                        Returns

                        Initializes the DragTracker on a given element. ...

                        Initializes the DragTracker on a given element.

                        Available since: 3.4.0

                        Parameters

                        Fires

                          ( item, ename, [fn], [scope], [options] ) : Object
                          Shorthand for addManagedListener. ...

                          Shorthand for addManagedListener.

                          Available since: 4.0.2

                          Parameters

                          • item : Ext.util.Observable/Ext.Element

                            The item to which to add a listener/listeners.

                          • ename : Object/String

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

                          • fn : Function (optional)

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

                          • scope : Object (optional)

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

                          • options : Object (optional)

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

                          Returns

                          • Object

                            Only when the destroyable option is specified.

                            A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                            this.btnListeners =  = myButton.mon({
                                destroyable: true
                                mouseover:   function() { console.log('mouseover'); },
                                mouseout:    function() { console.log('mouseout'); },
                                click:       function() { console.log('click'); }
                            });
                            

                            And when those listeners need to be removed:

                            Ext.destroy(this.btnListeners);
                            

                            or

                            this.btnListeners.destroy();
                            
                          ( item, ename, [fn], [scope] )
                          Shorthand for removeManagedListener. ...

                          Shorthand for removeManagedListener.

                          Available since: 4.0.2

                          Parameters

                          • item : Ext.util.Observable/Ext.Element

                            The item from which to remove a listener/listeners.

                          • ename : Object/String

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

                          • fn : Function (optional)

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

                          • scope : Object (optional)

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

                          ( eventName, [fn], [scope], [options] ) : Object
                          Shorthand for addListener. ...

                          Shorthand for addListener.

                          Available since: 1.1.0

                          Parameters

                          • eventName : String/Object

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

                          • fn : Function (optional)

                            The method the event invokes, or if scope is specified, the name* of the method within the specified scope. 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.

                            Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

                            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.

                            • buffer : Number

                              Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

                            • target : Ext.util.Observable

                              Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

                            • element : String

                              This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

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

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

                              When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

                              Defaults to: false

                            • priority : Number (optional)

                              An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

                              Combining Options

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

                              A delayed, one-time listener.

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

                          Returns

                          • Object

                            Only when the destroyable option is specified.

                            A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                            this.btnListeners =  = myButton.on({
                                destroyable: true
                                mouseover:   function() { console.log('mouseover'); },
                                mouseout:    function() { console.log('mouseout'); },
                                click:       function() { console.log('click'); }
                            });
                            

                            And when those listeners need to be removed:

                            Ext.destroy(this.btnListeners);
                            

                            or

                            this.btnListeners.destroy();
                            
                          Template method which should be overridden by each DragTracker instance. ...

                          Template method which should be overridden by each DragTracker instance. Called when the user first clicks and holds the mouse button down. Return false to disallow the drag

                          Available since: 3.4.0

                          This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                          Parameters

                          ( names, callback, scope )private
                          ...

                          Available since: 4.1.0

                          Parameters

                          Ext.util.ComponentDragger
                          view source
                          ( e )template
                          Move either the ghost Component or the target Component to its new position on drag ...

                          Move either the ghost Component or the target Component to its new position on drag

                          Available since: 4.0.0

                          This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                          Parameters

                          Fires

                            Overrides: Ext.dd.DragTracker.onDrag

                            Ext.util.ComponentDragger
                            view source
                            ( e )template
                            Template method which should be overridden by each DragTracker instance. ...

                            Template method which should be overridden by each DragTracker instance. Called when a drag operation has been completed (e.g. the user clicked and held the mouse down, dragged the element and then released the mouse button)

                            Available since: 4.0.0

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            Overrides: Ext.dd.DragTracker.onEnd

                            ...

                            Available since: 3.4.0

                            Parameters

                            Fires

                            ...

                            Available since: 3.4.0

                            Parameters

                            Fires

                            When the pointer exits a tracking element, fire a mouseout. ...

                            When the pointer exits a tracking element, fire a mouseout. This is mouseleave functionality, but we cannot use mouseleave because we are using "delegate" to filter mouse targets

                            Available since: 4.0.0

                            Parameters

                            Fires

                            When the pointer enters a tracking element, fire a mouseover if the mouse entered from outside. ...

                            When the pointer enters a tracking element, fire a mouseover if the mouse entered from outside. This is mouseenter functionality, but we cannot use mouseenter because we are using "delegate" to filter mouse targets

                            Available since: 4.0.0

                            Parameters

                            Fires

                            ...

                            Available since: 3.4.0

                            Parameters

                            Fires

                            Ext.util.ComponentDragger
                            view source
                            ( e )template
                            Template method which should be overridden by each DragTracker instance. ...

                            Template method which should be overridden by each DragTracker instance. Called when a drag operation starts (e.g. the user has moved the tracked element beyond the specified tolerance)

                            Available since: 4.0.0

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            Fires

                              Overrides: Ext.dd.DragTracker.onStart

                              Prepares a given class for observable instances. ...

                              Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

                              Available since: 4.1.2

                              Parameters

                              • T : Function

                                The class constructor to prepare.

                              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.

                              For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

                              this.relayEvents(this.getStore(), ['load']);
                              

                              The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

                              Available since: 2.3.0

                              Parameters

                              • origin : Object

                                The Observable whose events this object is to relay.

                              • events : String[]

                                Array of event names to relay.

                              • prefix : String (optional)

                                A common prefix to prepend to the event names. For example:

                                this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                

                                Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

                              Returns

                              • Object

                                A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

                                this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                

                                Can be undone by calling

                                Ext.destroy(this.storeRelayers);
                                

                                or this.store.relayers.destroy();

                              Fires

                                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.

                                Fires

                                  Removes listeners that were added by the mon method. ...

                                  Removes listeners that were added by the mon method.

                                  Available since: 4.0.0

                                  Parameters

                                  • item : Ext.util.Observable/Ext.Element

                                    The item from which to remove a listener/listeners.

                                  • ename : Object/String

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

                                  • fn : Function (optional)

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

                                  • scope : Object (optional)

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

                                  Fires

                                    Remove a single managed listener item ...

                                    Remove a single managed listener item

                                    Available since: 4.0.1

                                    Parameters

                                    • isClear : Boolean

                                      True if this is being called during a clear

                                    • managedListener : Object

                                      The managed listener item See removeManagedListener for other args

                                    Overrides: Ext.AbstractComponent.removeManagedListenerItem

                                    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.

                                    Available since: 4.2.0

                                    Parameters

                                    • eventName : String...

                                      Multiple event names to resume.

                                    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: 2.3.0

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

                                    Available since: 4.0.0

                                    Parameters

                                    Returns

                                    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: 4.0.0

                                    Returns

                                    ...

                                    Available since: 3.4.0

                                    Parameters

                                    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.

                                    Available since: 4.2.0

                                    Parameters

                                    • eventName : String...

                                      Multiple event names to suspend.

                                    Suspends the firing of all events. ...

                                    Suspends the firing of all events. (see resumeEvents)

                                    Available since: 2.3.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.

                                    ...

                                    Available since: 3.4.0

                                    Parameters

                                    Fires

                                    ( eventName, fn, [scope] )
                                    Shorthand for removeListener. ...

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

                                    Defined By

                                    Static methods

                                    ( config )privatestatic
                                    ...

                                    Available since: 4.1.1

                                    Parameters

                                    ( members )chainableprivatestatic
                                    ...

                                    Available since: 4.1.1

                                    Parameters

                                    ( name, member )chainableprivatestatic
                                    ...

                                    Available since: 4.1.1

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

                                    Available since: 4.1.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: 4.0.2

                                    Parameters

                                    Returns

                                    ( xtype )chainableprivatestatic
                                    ...

                                    Available since: 4.1.1

                                    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: 4.0.2

                                    Parameters

                                    • fromClass : Ext.Base

                                      The class to borrow members from

                                    • members : Array/String

                                      The names of the members to borrow

                                    Returns

                                    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: 4.0.2

                                    Returns

                                    Overrides: Ext.layout.Layout.create

                                    ( 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: 4.0.2

                                    Parameters

                                    ( config )privatestatic
                                    ...

                                    Available since: 4.1.1

                                    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: 4.0.4

                                    Returns

                                    ( )deprecatedstatic
                                    Adds members to class. ...

                                    Adds members to class.

                                    Available since: 4.0.2

                                    This method has been deprecated since 4.1

                                    Use addMembers instead.

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

                                    Used internally by the mixins pre-processor

                                    Available since: 4.1.1

                                    Parameters

                                    ( fn, scope )chainableprivatestatic
                                    ...

                                    Available since: 4.1.1

                                    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!");
                                    
                                            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"
                                    

                                    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!");
                                    
                                            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).

                                    Available since: 4.0.2

                                    This method has been deprecated since 4.1.0

                                    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: 4.1.1

                                    Defined By

                                    Events

                                    ...

                                    Available since: 4.0.1

                                    Parameters

                                    ...

                                    Available since: 3.4.0

                                    Parameters

                                    ...

                                    Available since: 3.4.0

                                    Parameters

                                    ...

                                    Available since: 3.4.0

                                    Parameters

                                    Fires when the mouse button is pressed down, but before a drag operation begins. ...

                                    Fires when the mouse button is pressed down, but before a drag operation begins. The drag operation begins after either the mouse has been moved by tolerance pixels, or after the autoStart timer fires.

                                    Return false to veto the drag operation.

                                    Available since: 3.4.0

                                    Parameters

                                    Fired when the mouse is moved. ...

                                    Fired when the mouse is moved. Returning false cancels the drag operation.

                                    Available since: 3.4.0

                                    Parameters

                                    Fires when the mouse exits the DragTracker's target element (or if delegate is used, when the mouse exits a delegate ...

                                    Fires when the mouse exits the DragTracker's target element (or if delegate is used, when the mouse exits a delegate element).

                                    Only available when trackOver is true

                                    Available since: 4.0.0

                                    Parameters

                                    ( this, e, target, eOpts )
                                    Fires when the mouse enters the DragTracker's target element (or if delegate is used, when the mouse enters a delegat...

                                    Fires when the mouse enters the DragTracker's target element (or if delegate is used, when the mouse enters a delegate element).

                                    Only available when trackOver is true

                                    Available since: 4.0.0

                                    Parameters

                                    ...

                                    Available since: 3.4.0

                                    Parameters