/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_grid_RowSelectionModel({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":["Ext.grid.CheckboxSelectionModel"],"extends":"Ext.grid.AbstractSelectionModel","uses":[],"html":"
Hierarchy
Ext.util.ObservableExt.grid.AbstractSelectionModelExt.grid.RowSelectionModelSubclasses
Files
The default SelectionModel used by Ext.grid.GridPanel.\nIt supports multiple selections and keyboard selection/navigation. The objects stored\nas selections and returned by getSelected, and getSelections are\nthe Records which provide the data for the selected rows.
\n(optional)
A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.
\n\nDOM events from ExtJs Components
\n\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n
is usually only done when extra value can be added. For example the DataView's\nclick
event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:
// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n constructor: function(config) {\n this.listeners = config.listeners ? config.listeners : config;\n },\n\n // Component passes itself into plugin's init method\n init: function(c) {\n var p, l = this.listeners;\n for (p in l) {\n if (Ext.isFunction(l[p])) {\n l[p] = this.createHandler(l[p], c);\n } else {\n l[p].fn = this.createHandler(l[p].fn, c);\n }\n }\n\n // Add the listeners to the Element immediately following the render call\n c.render = c.render.createSequence(function() {\n var e = c.getEl();\n if (e) {\n e.on(l);\n }\n });\n },\n\n createHandler: function(fn, c) {\n return function(e) {\n fn.call(this, e, c);\n };\n }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n // Collapse combo when its element is clicked on\n plugins: [ new Ext.DomObserver({\n click: function(evt, comp) {\n comp.collapse();\n }\n })],\n store: myStore,\n typeAhead: true,\n mode: 'local',\n triggerAction: 'all'\n});\n
\n\n\n\nfalse to turn off moving the editor to the next row down when the enter key is pressed\nor the next row up when shift + enter keys are pressed.
\ntrue to allow selection of only one row at a time (defaults to false\nallowing multiple selections)
\nDefaults to: false
The GridPanel for which this SelectionModel is handling selection. Read-only.
\nAdds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
\nor the first event name string if multiple event names are being passed as separate parameters.
. Event name if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\n\nAppends an event handler to this object.
\nThe name of the event to listen for.
\nThe method the event invokes.
\nThe scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
An object containing handler configuration.\nproperties. This may contain any of the following properties:
this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
\n\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n
\n
myGridPanel.on({\n'click' : {\n fn: this.onClick,\n scope: this,\n delay: 100\n},\n'mouseover' : {\n fn: this.onMouseOver,\n scope: this\n},\n'mouseout' : {\n fn: this.onMouseOut,\n scope: this\n}\n});
\n\nOr a shorthand syntax:
\n
myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
\n\nClears all selections if the selection model\nis not locked.
\ntrue to bypass the\nconditional checks and events described in deselectRow.
\nDeselects a range of rows if the selection model\nis not locked.
\nAll rows in between startRow and endRow are also deselected.
Deselects a row. Before deselecting a row, checks if the selection model\nis locked.\nIf this check is satisfied the row will be deselected and followed up by\nfiring the rowdeselect and selectionchange events.
\nThe index of the row to deselect
\nSpecify true to\nprevent notifying the view (disables updating the selected appearance)
\nCalls the passed function with each selection. If the function returns\nfalse, iteration is stopped and this function returns\nfalse. Otherwise it returns true.
\nThe function to call upon each iteration. It is passed the selected Record.
\nThe scope (this
reference) in which the function is executed. Defaults to this RowSelectionModel.
true if all selections were iterated
\nEnables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.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\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.override(Ext.form.Field, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\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\nFires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nReturns the first selected record.
\nprivate
\nChecks to see if this object has any listeners for a specified event
\nThe name of the event to check for
\nTrue if the event is being listened for, else false
\nReturns true if there is a next record to select
\nReturns true if there is a previous record to select
\nReturns true if there is a selection.
\nReturns true if the specified record id is selected.
\nThe id of record to check
\nReturns true if the selections are locked.
\nReturns true if the specified row is selected.
\nThe record or index of the record to check
\nAppends an event handler to this object (shorthand for addListener.)
\nThe type of event to listen for
\nThe method the event invokes
\nThe scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
An object containing handler configuration.
\nprivate
\nprivate
\nRelays selected events from the specified Observable as if the events were fired by this.
\nThe Observable whose events this object is to relay.
\nArray of event names to relay.
\nRemoves an event handler.
\nThe type of event the handler was associated with.
\nThe handler to remove. This must be a reference to the function passed into the addListener call.
\nThe scope originally specified for the handler.
\nResume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.
\nSelects all rows if the selection model\nis not locked.
\nSelect the last row.
\ntrue to keep existing selections
\nSelects the row immediately following the last selected row.
\ntrue to keep existing selections
\ntrue if there is a next row, else false
\nSelects the row that precedes the last selected row.
\ntrue to keep existing selections
\ntrue if there is a previous row, else false
\nSelects a range of rows if the selection model\nis not locked.\nAll rows in between startRow and endRow are also selected.
\nSelect records.
\nThe records to select
\ntrue to keep existing selections
\nSelects a row. Before selecting a row, checks if the selection model\nis locked and fires the\nbeforerowselect event. If these checks are satisfied the row\nwill be selected and followed up by firing the rowselect and\nselectionchange events.
\nThe index of the row to select
\ntrue to keep existing selections
\nSpecify true to\nprevent notifying the view (disables updating the selected appearance)
\nSelects multiple rows.
\nArray of the indexes of the row to select
\ntrue to keep\nexisting selections (defaults to false)
\nset the lock states before and after a view refresh
\nset the lock states before and after a view refresh
\nSuspend the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\nRemoves an event handler (shorthand for removeListener.)
\nThe type of event the handler was associated with.
\nThe handler to remove. This must be a reference to the function passed into the addListener call.
\nThe scope originally specified for the handler.
\nFires before a row is selected, return false to cancel the selection.
\nThe index to be selected
\nFalse if other selections will be cleared
\nThe record to be selected
\nFires when a row is deselected. To prevent deselection\nlock the selections.
\nFires when a row is selected.
\nThe selected index
\nThe selected record
\nFires when the selection changes
\n