Ext.data.JsonP.Ext_selection_TreeModel({"alternateClassNames":[],"aliases":{"selection":["treemodel"]},"enum":null,"parentMixins":["Ext.util.Bindable"],"tagname":"class","subclasses":[],"extends":"Ext.selection.RowModel","uses":[],"html":"

Hierarchy

Inherited mixins

Files

Adds custom behavior for left/right keyboard navigation for use with a tree.\nDepends on the view having an expand and collapse method which accepts a\nrecord. This selection model is created by default for Ext.tree.Panel.

\n
Defined By

Config options

Allow users to deselect a record in a DataView, List or Grid. ...

Allow users to deselect a record in a DataView, List or Grid.\nOnly applicable when the mode is 'SINGLE'.

\n
Turns on/off keyboard navigation within the grid. ...

Turns on/off keyboard navigation within the grid.

\n

Defaults to: true

True to ignore selections that are made when using the right mouse button if there are\nrecords that are already selec...

True to ignore selections that are made when using the right mouse button if there are\nrecords that are already selected. If no records are selected, selection will continue\nas normal

\n

Defaults to: false

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\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly 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\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

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

Mode of selection. Valid values are:

\n\n
    \n
  • \"SINGLE\" - Only allows selecting one item at a time. Use allowDeselect to allow\ndeselecting that item. Also see toggleOnClick. This is the default.
  • \n
  • \"SIMPLE\" - Allows simple selection of multiple items one-by-one. Each click in grid will either\nselect or deselect an item.
  • \n
  • \"MULTI\" - Allows complex selection of multiple items using Ctrl and Shift keys.
  • \n
\n\n
true to toggle the selection state of an item when clicked. ...

true to toggle the selection state of an item when clicked.\nOnly applicable when the mode is 'SINGLE'.\nOnly applicable when the allowDeselect is 'true'.

\n

Defaults to: true

Properties

Defined By

Instance Properties

...
\n

Defaults to: 'Ext.Base'

...
\n

Defaults to: {}

Number of pixels to scroll to the left/right when pressing\nleft/right keys. ...

Number of pixels to scroll to the left/right when pressing\nleft/right keys.

\n

Defaults to: 5

Initial suspended call count. ...

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

\n

Defaults to: 0

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\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

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

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

Defaults to: []

...
\n

Defaults to: {}

...
\n

Defaults to: true

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.

\n

Defaults to: true

A MixedCollection that maintains all of the currently selected records. ...

A MixedCollection that maintains all of the currently selected records.

\n
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,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n
Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n
Defined By

Static Properties

...
\n

Defaults to: []

Methods

Defined By

Instance Methods

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.

\n

Parameters

  • eventNames : Object/String...

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

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

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

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

Appends an event handler to this object. For example:

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

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

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

One can also specify options for each event handler separately:

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

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

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

Parameters

  • eventName : String/Object

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

    \n\n
  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.

    \n\n
  • scope : Object (optional)

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

    \n\n
  • options : Object (optional)

    An object containing handler configuration.

    \n\n\n\n\n

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

    \n\n\n\n\n

    This object may contain any of the following properties:

    \n\n
    • scope : Object

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

      \n\n
    • delay : Number

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

      \n\n
    • single : Boolean

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

      \n\n
    • buffer : Number

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

      \n\n
    • target : Ext.util.Observable

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

      \n\n
    • element : String

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

      \n\n\n\n\n

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

      \n\n\n\n\n
        new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
      \n\n
    • 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.

      \n\n

      Defaults to: false

    • priority : Number (optional)

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

      \n\n\n\n\n

      Combining Options

      \n\n\n\n\n

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

      \n\n\n\n\n

      A delayed, one-time listener.

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

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

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

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

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n

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\ndestr...

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

\n

Parameters

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

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
  • options : Object (optional)

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

    \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

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

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

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
...
\n

Parameters

Private\nCalled after a new record has been navigated to by a keystroke. ...

Private\nCalled after a new record has been navigated to by a keystroke.\nEvent is passed so that shift and ctrl can be handled.

\n

Parameters

Checks whether a selection should proceed based on the ignoreRightMouseSelection\noption. ...

Checks whether a selection should proceed based on the ignoreRightMouseSelection\noption.

\n

Parameters

Returns

  • Boolean

    False if the selection should not proceed

    \n
...
\n

Parameters

Ext.selection.TreeModel
view source
( [store] )
binds the store to the selModel. ...

binds the store to the selModel.

\n\n

Binds a store to this instance.

\n

Parameters

  • store : Ext.data.AbstractStore/String (optional)

    The store to bind or ID of the store.\nWhen no store given (or when null or undefined passed), unbinds the existing store.

    \n\n

Overrides: Ext.selection.Model.bindStore

Binds listeners for this component to the store. ...

Binds listeners for this component to the store. By default it will add\nanything bound by the getStoreListeners method, however it can be overridden\nin a subclass to provide any more complicated handling.

\n

Parameters

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

Call the original method that was previously overridden with override

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

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\n
\n

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result of calling the overridden method

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

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

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

This can be used with an override as follows:

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

This also works with static methods.

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

Lastly, it also works with overridden static methods.

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

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

\n

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result of calling the parent method

    \n
This method is used by an override to call the superclass method but bypass any\noverridden method. ...

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

\n\n

Consider:

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

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

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

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

\n

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result of calling the superclass method

    \n
...
\n

Parameters

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

Removes all listeners for this object including the managed listeners

\n
Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

\n
A fast reset of the selections without firing events, updating the ui, etc. ...

A fast reset of the selections without firing events, updating the ui, etc.\nFor private usage only.

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

Continue to fire event.

\n

Parameters

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.

\n

Parameters

  • newName : String

    The name under which to refire the passed parameters.

    \n
  • beginEnd : Array (optional)

    The caller can specify on which indices to slice.

    \n

Returns

( records, [suppressEvent] )
Deselects a record instance by record instance or index. ...

Deselects a record instance by record instance or index.

\n

Parameters

  • records : Ext.data.Model[]/Number

    An array of records or an index

    \n
  • suppressEvent : Boolean (optional)

    True to not fire a deselect event

    \n

    Defaults to: false

Deselects all records in the view. ...

Deselects all records in the view.

\n

Parameters

  • suppressEvent : Boolean (optional)

    True to suppress any deselect events

    \n
Called by subclasses to deselect records upon detection of deletion from the store ...

Called by subclasses to deselect records upon detection of deletion from the store

\n

Parameters

( toSelect, selected, suppressEvent )private
...
\n

Parameters

Deselects a range of rows if the selection model is not locked. ...

Deselects a range of rows if the selection model is not locked.

\n

Parameters

cleanup. ...

cleanup.

\n

Overrides: Ext.Base.destroy

( records, suppressEvent )private
records can be an index, a record or an array of records ...

records can be an index, a record or an array of records

\n

Parameters

( records, keepExisting, suppressEvent )private
...
\n

Parameters

( records, keepExisting, suppressEvent )private
...
\n

Parameters

( record, suppressEvent )private
...
\n

Parameters

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

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

\n\n

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

\n\n

Example:

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

Parameters

  • eventNames : String/String[]

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

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

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

\n\n

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

\n

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object...

    Variable number of parameters are passed to handlers.

    \n

Returns

  • Boolean

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

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

Fires the specified event with the passed parameter list.

\n\n

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

\n

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object[]

    An array of parameters which are passed to handlers.

    \n

Returns

  • Boolean

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

    \n
Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

\n

Returns

...
\n

Parameters

Returns the count of selected records. ...

Returns the count of selected records.

\n

Returns

  • Number

    The number of selected records

    \n
Returns position of the first selected cell in the selection in the format {row: row, column: column} ...

Returns position of the first selected cell in the selection in the format {row: row, column: column}

\n
Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

\n

Parameters

  • name : String (optional)

    Name of the config option to return.

    \n

Returns

  • Object/Mixed

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

    \n
...
\n

Returns

Returns the number of rows currently visible on the screen or\nfalse if there were no rows. ...

Returns the number of rows currently visible on the screen or\nfalse if there were no rows. This assumes that all rows are\nof the same height and the first view is accurate.

\n
Returns an array of the currently selected records. ...

Returns an array of the currently selected records.

\n

Returns

...
\n

Parameters

Returns the current selectionMode. ...

Returns the current selectionMode.

\n

Returns

  • String

    The selectionMode: 'SINGLE', 'MULTI' or 'SIMPLE'.

    \n
Gets the current store instance. ...

Gets the current store instance.

\n

Returns

Gets the listeners to bind to a new store. ...

Gets the listeners to bind to a new store.

\n

Parameters

  • store : Ext.data.Store

    The Store which is being bound to for which a listeners object should be returned.

    \n

Returns

  • Object

    The listeners to be bound to the store in object literal form. The scope\nmay be omitted, it is assumed to be the current instance.

    \n

Overrides: Ext.util.Bindable.getStoreListeners

...
\n

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\nindicates whether the event needs firing or not.

\n

Parameters

  • eventName : String

    The name of the event to check for

    \n

Returns

  • Boolean

    true if the event is being listened for or bubbles, else false

    \n
Returns true if there are any a selected records. ...

Returns true if there are any a selected records.

\n

Returns

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

Initialize configuration for this class. a typical example:

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

Parameters

Returns

...
\n

Parameters

Determines if this record is currently focused. ...

Determines if this record is currently focused.

\n

Parameters

Returns true if the selections are locked. ...

Returns true if the selections are locked.

\n

Returns

Returns true if the specified row is selected. ...

Returns true if the specified row is selected.

\n

Parameters

Returns

...
\n

Parameters

Returns true if the specified row is selected. ...

Returns true if the specified row is selected.

\n

Parameters

Returns

fire selection change as long as true is not passed\ninto maybeFireSelectionChange ...

fire selection change as long as true is not passed\ninto maybeFireSelectionChange

\n

Parameters

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

Shorthand for addManagedListener.

\n\n

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

\n

Parameters

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

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
  • options : Object (optional)

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

    \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

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

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

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

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

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n

Parameters

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

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
Ext.selection.TreeModel
view source
( e, t )private
...
\n

Parameters

Ext.selection.TreeModel
view source
( e, t )private
...
\n

Parameters

...
\n

Parameters

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

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

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

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

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

One can also specify options for each event handler separately:

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

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

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

Parameters

  • eventName : String/Object

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

    \n\n
  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.

    \n\n
  • scope : Object (optional)

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

    \n\n
  • options : Object (optional)

    An object containing handler configuration.

    \n\n\n\n\n

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

    \n\n\n\n\n

    This object may contain any of the following properties:

    \n\n
    • scope : Object

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

      \n\n
    • delay : Number

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

      \n\n
    • single : Boolean

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

      \n\n
    • buffer : Number

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

      \n\n
    • target : Ext.util.Observable

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

      \n\n
    • element : String

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

      \n\n\n\n\n

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

      \n\n\n\n\n
        new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
      \n\n
    • 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.

      \n\n

      Defaults to: false

    • priority : Number (optional)

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

      \n\n\n\n\n

      Combining Options

      \n\n\n\n\n

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

      \n\n\n\n\n

      A delayed, one-time listener.

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

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

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

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

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
( store, initial )protected
Template method, it is called when a new store is bound\nto the current instance. ...

Template method, it is called when a new store is bound\nto the current instance.

\n

Parameters

( names, callback, scope )private
...
\n

Parameters

...
\n

Parameters

Navigate one record down. ...

Navigate one record down. This could be a selection or\ncould be simply focusing a record for discontiguous\nselection. Provides bounds checking.

\n

Parameters

go to last visible record in grid. ...

go to last visible record in grid.

\n

Parameters

Ext.selection.TreeModel
view source
( e, t )private
...
\n

Parameters

Overrides: Ext.selection.RowModel.onKeyEnter

go to first visible record in grid. ...

go to first visible record in grid.

\n

Parameters

Ext.selection.TreeModel
view source
( e, t )private
...
\n

Parameters

Overrides: Ext.selection.RowModel.onKeyLeft

Go one page down from the lastFocused record in the grid. ...

Go one page down from the lastFocused record in the grid.

\n

Parameters

Go one page up from the lastFocused record in the grid. ...

Go one page up from the lastFocused record in the grid.

\n

Parameters

Ext.selection.TreeModel
view source
( e, t )private
...
\n

Parameters

Overrides: Ext.selection.RowModel.onKeyRight

Ext.selection.TreeModel
view source
( e, t )private
...
\n

Parameters

Overrides: Ext.selection.RowModel.onKeySpace

Navigate one record up. ...

Navigate one record up. This could be a selection or\ncould be simply focusing a record for discontiguous\nselection. Provides bounds checking.

\n

Parameters

( oldFocused, newFocused, supressFocus )private
Provide indication of what row was last focused via\nthe gridview. ...

Provide indication of what row was last focused via\nthe gridview.

\n

Parameters

Overrides: Ext.selection.Model.onLastFocusChanged

( store, model, oldId, newId, oldInternalId )private
...
\n

Parameters

Ext.selection.TreeModel
view source
( parent, node, isMove )private
...
\n

Parameters

( view, record, item, index, e )private
...
\n

Parameters

( view, record, item, index, e )private
Select the record with the event included so that\nwe can take into account ctrlKey, shiftKey, etc ...

Select the record with the event included so that\nwe can take into account ctrlKey, shiftKey, etc

\n

Parameters

( record, isSelected, suppressEvent, commitFn )private
Allow the GridView to update the UI by\nadding/removing a CSS class from the row. ...

Allow the GridView to update the UI by\nadding/removing a CSS class from the row.

\n

Parameters

Overrides: Ext.selection.Model.onSelectChange

when a record is added to a store ...

when a record is added to a store

\n
when a store is cleared remove all selections\n(if there were any) ...

when a store is cleared remove all selections\n(if there were any)

\n
( store, records, indexes, isMove )private
prune records from the SelectionModel if\nthey were selected at the time they were\nremoved. ...

prune records from the SelectionModel if\nthey were selected at the time they were\nremoved.

\n

Parameters

if records are updated ...

if records are updated

\n
Template method, it is called when an existing store is unbound\nfrom the current instance. ...

Template method, it is called when an existing store is unbound\nfrom the current instance.

\n

Parameters

...
\n

Parameters

Overrides: Ext.selection.Model.onUpdate

( type, view, cell, rowIndex, cellIndex, e, record )private
If the mousedown event is vetoed, we still want to treat it as though we've had\na mousedown because we don't want to ...

If the mousedown event is vetoed, we still want to treat it as though we've had\na mousedown because we don't want to proceed on click. For example, the click on\nan action column vetoes the mousedown event so the click isn't processed.

\n

Parameters

Prepares a given class for observable instances. ...

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

\n

Parameters

  • T : Function

    The class constructor to prepare.

    \n
( view, record, item, index, e )private
...
\n

Parameters

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.

\n\n

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

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

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

\n

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

    \n
  • events : String[]

    Array of event names to relay.

    \n
  • prefix : String (optional)

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

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

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

    \n

Returns

  • Object

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

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

    Can be undone by calling

    \n\n
    Ext.destroy(this.storeRelayers);\n
    \n\n

    or

    \n\n
    this.store.relayers.destroy();\n
    \n
Removes an event handler. ...

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.

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

Removes listeners that were added by the mon method.

\n

Parameters

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

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
Remove a single managed listener item ...

Remove a single managed listener item

\n

Parameters

  • isClear : Boolean

    True if this is being called during a clear

    \n
  • managedListener : Object

    The managed listener item\nSee removeManagedListener for other args

    \n

Overrides: Ext.AbstractComponent.removeManagedListenerItem

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

Resumes firing of the named event(s).

\n\n

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

\n\n

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

\n

Parameters

  • eventName : String...

    Multiple event names to resume.

    \n
Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

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

\n
...
\n

Parameters

( records, [keepExisting], [suppressEvent] )
Selects a record instance by record instance or index. ...

Selects a record instance by record instance or index.

\n

Parameters

  • records : Ext.data.Model[]/Number

    An array of records or an index

    \n
  • keepExisting : Boolean (optional)

    True to retain existing selections

    \n

    Defaults to: false

  • suppressEvent : Boolean (optional)

    True to not fire a select event

    \n

    Defaults to: false

Selects all records in the view. ...

Selects all records in the view.

\n

Parameters

  • suppressEvent : Boolean

    True to suppress any select events

    \n
...
\n

Parameters

( [keepExisting], [suppressEvent] ) : Boolean
Selects the record immediately following the currently selected record. ...

Selects the record immediately following the currently selected record.

\n

Parameters

  • keepExisting : Boolean (optional)

    True to retain existing selections

    \n
  • suppressEvent : Boolean (optional)

    Set to false to not fire a select event

    \n

Returns

  • Boolean

    true if there is a next record, else false

    \n
( [keepExisting], [suppressEvent] ) : Boolean
Selects the record that precedes the currently selected record. ...

Selects the record that precedes the currently selected record.

\n

Parameters

  • keepExisting : Boolean (optional)

    True to retain existing selections

    \n
  • suppressEvent : Boolean (optional)

    Set to false to not fire a select event

    \n

Returns

  • Boolean

    true if there is a previous record, else false

    \n
( startRow, endRow, [keepExisting] )
Selects a range of rows if the selection model is not locked. ...

Selects a range of rows if the selection model is not locked.\nAll rows in between startRow and endRow are also selected.

\n

Parameters

Provides differentiation of logic between MULTI, SIMPLE and SINGLE\nselection modes. ...

Provides differentiation of logic between MULTI, SIMPLE and SINGLE\nselection modes. Requires that an event be passed so that we can know\nif user held ctrl or shift.

\n

Parameters

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

Parameters

Returns

Sets a record as the last focused record. ...

Sets a record as the last focused record. This does NOT mean\nthat the record has been selected.

\n

Parameters

Locks the current selection and disables any changes from happening to the selection. ...

Locks the current selection and disables any changes from happening to the selection.

\n

Parameters

  • locked : Boolean

    True to lock, false to unlock.

    \n
Sets the current selectionMode. ...

Sets the current selectionMode.

\n

Parameters

  • selMode : String

    'SINGLE', 'MULTI' or 'SIMPLE'.

    \n
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,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

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

Returns

We need this special check because we could have a model\nwithout an idProperty. ...

We need this special check because we could have a model\nwithout an idProperty. getById() is fast, so we use that\nif possible, otherwise we need to check the internalId

\n

Parameters

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

Suspends firing of the named event(s).

\n\n

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

\n\n

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

\n

Parameters

  • eventName : String...

    Multiple event names to suspend.

    \n
Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

\n

Parameters

  • queueSuspended : Boolean

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

    \n
Ext.selection.TreeModel
view source
( e )private
...
\n

Parameters

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

Shorthand for removeListener.

\n\n

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.

    \n\n
Unbinds listeners from this component to the store. ...

Unbinds listeners from this component to the store. By default it will remove\nanything bound by the bindStoreListeners method, however it can be overridden\nin a subclass to provide any more complicated handling.

\n

Parameters

Defined By

Static Methods

( config )privatestatic
...
\n

Parameters

( members )chainableprivatestatic
...
\n

Parameters

( name, member )chainableprivatestatic
...
\n

Parameters

( members )chainablestatic
Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

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

Parameters

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

Add / override static properties of this class.

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

Parameters

Returns

( xtype )chainableprivatestatic
...
\n

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.

\n\n
Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : Array/String

    The names of the members to borrow

    \n

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

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

All parameters are passed to the constructor of the class.

\n

Returns

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

Create aliases for existing prototype methods. Example:

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

Parameters

( config )privatestatic
...
\n

Parameters

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

Get the current class' name in string format.

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

Returns

( )deprecatedstatic
Adds members to class. ...

Adds members to class.

\n
\n

This method has been deprecated since 4.1

\n

Use addMembers instead.

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

Used internally by the mixins pre-processor

\n

Parameters

( fn, scope )chainableprivatestatic
...
\n

Parameters

( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

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

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

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

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

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

\n
\n

This method has been deprecated since 4.1.0

\n

Use Ext.define instead

\n\n
\n

Parameters

  • members : Object

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

    \n

Returns

Defined By

Events

Fired before a record is deselected. ...

Fired before a record is deselected. If any listener returns false, the\ndeselection is cancelled.

\n

Parameters

( this, record, index, eOpts )
Fired before a record is selected. ...

Fired before a record is selected. If any listener returns false, the\nselection is cancelled.

\n

Parameters

( this, record, index, eOpts )
Fired after a record is deselected ...

Fired after a record is deselected

\n

Parameters

( this, oldFocused, newFocused, eOpts )
Fired when a row is focused ...

Fired when a row is focused

\n

Parameters

( this, record, index, eOpts )
Fired after a record is selected ...

Fired after a record is selected

\n

Parameters

Fired after a selection change has occurred ...

Fired after a selection change has occurred

\n

Parameters

","superclasses":["Ext.Base","Ext.util.Observable","Ext.selection.Model","Ext.selection.RowModel"],"meta":{},"code_type":"ext_define","requires":[],"html_meta":{},"statics":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"$onExtended","id":"static-property-S-onExtended"}],"cfg":[],"css_var":[],"method":[{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"addConfig","id":"static-method-addConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addInheritableStatics","id":"static-method-addInheritableStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addMember","id":"static-method-addMember"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addMembers","id":"static-method-addMembers"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addXtype","id":"static-method-addXtype"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"borrow","id":"static-method-borrow"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"create","id":"static-method-create"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"extend","id":"static-method-extend"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"getName","id":"static-method-getName"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"deprecated":{"text":"Use {@link #addMembers} instead.","version":"4.1"}},"name":"implement","id":"static-method-implement"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"mixin","id":"static-method-mixin"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"onExtended","id":"static-method-onExtended"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"markdown":true,"deprecated":{"text":"Use {@link Ext#define Ext.define} instead","version":"4.1.0"}},"name":"override","id":"static-method-override"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"triggerExtended","id":"static-method-triggerExtended"}],"event":[],"css_mixin":[]},"files":[{"href":"TreeModel3.html#Ext-selection-TreeModel","filename":"TreeModel.js"}],"linenr":1,"members":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"$className","id":"property-S-className"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"configMap","id":"property-configMap"},{"tagname":"property","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"deltaScroll","id":"property-deltaScroll"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"private":true},"name":"eventsSuspended","id":"property-eventsSuspended"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"readonly":true},"name":"hasListeners","id":"property-hasListeners"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigList","id":"property-initConfigList"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigMap","id":"property-initConfigMap"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"isInstance","id":"property-isInstance"},{"tagname":"property","owner":"Ext.util.Observable","meta":{},"name":"isObservable","id":"property-isObservable"},{"tagname":"property","owner":"Ext.selection.Model","meta":{"readonly":true},"name":"selected","id":"property-selected"},{"tagname":"property","owner":"Ext.Base","meta":{"protected":true},"name":"self","id":"property-self"},{"tagname":"property","owner":"Ext.selection.Model","meta":{"private":true},"name":"suspendChange","id":"property-suspendChange"}],"cfg":[{"tagname":"cfg","owner":"Ext.selection.Model","meta":{},"name":"allowDeselect","id":"cfg-allowDeselect"},{"tagname":"cfg","owner":"Ext.selection.RowModel","meta":{},"name":"enableKeyNav","id":"cfg-enableKeyNav"},{"tagname":"cfg","owner":"Ext.selection.RowModel","meta":{},"name":"ignoreRightMouseSelection","id":"cfg-ignoreRightMouseSelection"},{"tagname":"cfg","owner":"Ext.util.Observable","meta":{},"name":"listeners","id":"cfg-listeners"},{"tagname":"cfg","owner":"Ext.selection.Model","meta":{},"name":"mode","id":"cfg-mode"},{"tagname":"cfg","owner":"Ext.selection.Model","meta":{},"name":"toggleOnClick","id":"cfg-toggleOnClick"}],"css_var":[],"method":[{"tagname":"method","owner":"Ext.selection.RowModel","meta":{},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addEvents","id":"method-addEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addListener","id":"method-addListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addManagedListener","id":"method-addManagedListener"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"afterBufferedScrollTo","id":"method-afterBufferedScrollTo"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"afterKeyNavigate","id":"method-afterKeyNavigate"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"allowRightMouseSelection","id":"method-allowRightMouseSelection"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"abstract":true,"private":true},"name":"beforeViewRender","id":"method-beforeViewRender"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"bindComponent","id":"method-bindComponent"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{},"name":"bindStore","id":"method-bindStore"},{"tagname":"method","owner":"Ext.util.Bindable","meta":{"protected":true},"name":"bindStoreListeners","id":"method-bindStoreListeners"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true,"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."}},"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callParent","id":"method-callParent"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callSuper","id":"method-callSuper"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"captureArgs","id":"method-captureArgs"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearListeners","id":"method-clearListeners"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearManagedListeners","id":"method-clearManagedListeners"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"clearSelections","id":"method-clearSelections"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"configClass","id":"method-configClass"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"continueFireEvent","id":"method-continueFireEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"createRelayer","id":"method-createRelayer"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"deselect","id":"method-deselect"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"deselectAll","id":"method-deselectAll"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"deselectDeletedRecords","id":"method-deselectDeletedRecords"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"deselectDuringSelect","id":"method-deselectDuringSelect"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"deselectRange","id":"method-deselectRange"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"destroy","id":"method-destroy"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"doDeselect","id":"method-doDeselect"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"doMultiSelect","id":"method-doMultiSelect"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"doSelect","id":"method-doSelect"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"doSingleSelect","id":"method-doSingleSelect"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"enableBubble","id":"method-enableBubble"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEventArgs","id":"method-fireEventArgs"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"getBubbleParent","id":"method-getBubbleParent"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"getConfig","id":"method-getConfig"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"getCount","id":"method-getCount"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{},"name":"getCurrentPosition","id":"method-getCurrentPosition"},{"tagname":"method","owner":"Ext.Base","meta":{},"name":"getInitialConfig","id":"method-getInitialConfig"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"getLastFocused","id":"method-getLastFocused"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"getLastSelected","id":"method-getLastSelected"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"getRowsVisible","id":"method-getRowsVisible"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"getSelection","id":"method-getSelection"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"getSelectionId","id":"method-getSelectionId"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"getSelectionMode","id":"method-getSelectionMode"},{"tagname":"method","owner":"Ext.util.Bindable","meta":{},"name":"getStore","id":"method-getStore"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"protected":true},"name":"getStoreListeners","id":"method-getStoreListeners"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"hasConfig","id":"method-hasConfig"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"hasListener","id":"method-hasListener"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"hasSelection","id":"method-hasSelection"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"protected":true},"name":"initConfig","id":"method-initConfig"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"initKeyNav","id":"method-initKeyNav"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"isFocused","id":"method-isFocused"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"isLocked","id":"method-isLocked"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"isRangeSelected","id":"method-isRangeSelected"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"isRowSelected","id":"method-isRowSelected"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"isSelected","id":"method-isSelected"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"maybeFireSelectionChange","id":"method-maybeFireSelectionChange"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mon","id":"method-mon"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mun","id":"method-mun"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"navCollapse","id":"method-navCollapse"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"navExpand","id":"method-navExpand"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"normalizeRowRange","id":"method-normalizeRowRange"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"on","id":"method-on"},{"tagname":"method","owner":"Ext.util.Bindable","meta":{"protected":true},"name":"onBindStore","id":"method-onBindStore"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"onConfigUpdate","id":"method-onConfigUpdate"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"abstract":true,"private":true},"name":"onEditorKey","id":"method-onEditorKey"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onEditorTab","id":"method-onEditorTab"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onKeyDown","id":"method-onKeyDown"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onKeyEnd","id":"method-onKeyEnd"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"onKeyEnter","id":"method-onKeyEnter"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onKeyHome","id":"method-onKeyHome"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"onKeyLeft","id":"method-onKeyLeft"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onKeyPageDown","id":"method-onKeyPageDown"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onKeyPageUp","id":"method-onKeyPageUp"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"onKeyRight","id":"method-onKeyRight"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"onKeySpace","id":"method-onKeySpace"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onKeyUp","id":"method-onKeyUp"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onLastFocusChanged","id":"method-onLastFocusChanged"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"onModelIdChanged","id":"method-onModelIdChanged"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"onNodeRemove","id":"method-onNodeRemove"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onRowClick","id":"method-onRowClick"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onRowMouseDown","id":"method-onRowMouseDown"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onSelectChange","id":"method-onSelectChange"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"onStoreAdd","id":"method-onStoreAdd"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"onStoreClear","id":"method-onStoreClear"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"abstract":true,"private":true},"name":"onStoreLoad","id":"method-onStoreLoad"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"onStoreRefresh","id":"method-onStoreRefresh"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"onStoreRemove","id":"method-onStoreRemove"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"onStoreUpdate","id":"method-onStoreUpdate"},{"tagname":"method","owner":"Ext.util.Bindable","meta":{"protected":true},"name":"onUnbindStore","id":"method-onUnbindStore"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onUpdate","id":"method-onUpdate"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"onVetoUIEvent","id":"method-onVetoUIEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"prepareClass","id":"method-prepareClass"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"processSelection","id":"method-processSelection"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"pruneIf","id":"method-pruneIf"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"refresh","id":"method-refresh"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeListener","id":"method-removeListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeManagedListener","id":"method-removeManagedListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"removeManagedListenerItem","id":"method-removeManagedListenerItem"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"resumeChanges","id":"method-resumeChanges"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvent","id":"method-resumeEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"scrollByDeltaX","id":"method-scrollByDeltaX"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"select","id":"method-select"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"selectAll","id":"method-selectAll"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{"private":true},"name":"selectByPosition","id":"method-selectByPosition"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{},"name":"selectNext","id":"method-selectNext"},{"tagname":"method","owner":"Ext.selection.RowModel","meta":{},"name":"selectPrevious","id":"method-selectPrevious"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"selectRange","id":"method-selectRange"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"selectWithEvent","id":"method-selectWithEvent"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"private":true},"name":"setConfig","id":"method-setConfig"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"setLastFocused","id":"method-setLastFocused"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"setLocked","id":"method-setLocked"},{"tagname":"method","owner":"Ext.selection.Model","meta":{},"name":"setSelectionMode","id":"method-setSelectionMode"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"statics","id":"method-statics"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"storeHasSelected","id":"method-storeHasSelected"},{"tagname":"method","owner":"Ext.selection.Model","meta":{"private":true},"name":"suspendChanges","id":"method-suspendChanges"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvent","id":"method-suspendEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","owner":"Ext.selection.TreeModel","meta":{"private":true},"name":"toggleCheck","id":"method-toggleCheck"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"un","id":"method-un"},{"tagname":"method","owner":"Ext.util.Bindable","meta":{"protected":true},"name":"unbindStoreListeners","id":"method-unbindStoreListeners"}],"event":[{"tagname":"event","owner":"Ext.selection.RowModel","meta":{},"name":"beforedeselect","id":"event-beforedeselect"},{"tagname":"event","owner":"Ext.selection.RowModel","meta":{},"name":"beforeselect","id":"event-beforeselect"},{"tagname":"event","owner":"Ext.selection.RowModel","meta":{},"name":"deselect","id":"event-deselect"},{"tagname":"event","owner":"Ext.selection.Model","meta":{},"name":"focuschange","id":"event-focuschange"},{"tagname":"event","owner":"Ext.selection.RowModel","meta":{},"name":"select","id":"event-select"},{"tagname":"event","owner":"Ext.selection.Model","meta":{},"name":"selectionchange","id":"event-selectionchange"}],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.selection.TreeModel","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.selection.TreeModel","mixins":[],"mixedInto":[]});