view release on metacpan or  search on metacpan

share/docs/source/RowSelectionModel.html  view on Meta::CPAN

        }
        return false;
    },

<span id='Ext-grid-RowSelectionModel-method-hasNext'>    /**
</span>     * Returns true if there is a next record to select
     * @return {Boolean}
     */
    hasNext : function(){
        return this.last !== false &amp;&amp; (this.last+1) &lt; this.grid.store.getCount();
    },

<span id='Ext-grid-RowSelectionModel-method-hasPrevious'>    /**
</span>     * Returns true if there is a previous record to select
     * @return {Boolean}
     */
    hasPrevious : function(){
        return !!this.last;
    },


<span id='Ext-grid-RowSelectionModel-method-getSelections'>    /**
</span>     * Returns the selected records
     * @return {Array} Array of selected records
     */
    getSelections : function(){
        return [].concat(this.selections.items);
    },

<span id='Ext-grid-RowSelectionModel-method-getSelected'>    /**
</span>     * Returns the first selected record.
     * @return {Record}
     */
    getSelected : function(){
        return this.selections.itemAt(0);
    },

<span id='Ext-grid-RowSelectionModel-method-each'>    /**
</span>     * Calls the passed function with each selection. If the function returns
     * &lt;tt&gt;false&lt;/tt&gt;, iteration is stopped and this function returns
     * &lt;tt&gt;false&lt;/tt&gt;. Otherwise it returns &lt;tt&gt;true&lt;/tt&gt;.
     * @param {Function} fn The function to call upon each iteration. It is passed the selected {@link Ext.data.Record Record}.
     * @param {Object} scope (optional) The scope (&lt;code&gt;this&lt;/code&gt; reference) in which the function is executed. Defaults to this RowSelectionModel.
     * @return {Boolean} true if all selections were iterated
     */
    each : function(fn, scope){
        var s = this.getSelections(),
            i = 0,
            len = s.length;
            
        for(; i &lt; len; i++){
            if(fn.call(scope || this, s[i], i) === false){
                return false;
            }
        }
        return true;
    },

<span id='Ext-grid-RowSelectionModel-method-clearSelections'>    /**
</span>     * Clears all selections if the selection model
     * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.
     * @param {Boolean} fast (optional) &lt;tt&gt;true&lt;/tt&gt; to bypass the
     * conditional checks and events described in {@link #deselectRow}.
     */
    clearSelections : function(fast){
        if(this.isLocked()){
            return;
        }
        if(fast !== true){
            var ds = this.grid.store,
                s = this.selections;
            s.each(function(r){
                this.deselectRow(ds.indexOfId(r.id));
            }, this);
            s.clear();
        }else{
            this.selections.clear();
        }
        this.last = false;
    },


<span id='Ext-grid-RowSelectionModel-method-selectAll'>    /**
</span>     * Selects all rows if the selection model
     * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}. 
     */
    selectAll : function(){
        if(this.isLocked()){
            return;
        }
        this.selections.clear();
        for(var i = 0, len = this.grid.store.getCount(); i &lt; len; i++){
            this.selectRow(i, true);
        }
    },

<span id='Ext-grid-RowSelectionModel-method-hasSelection'>    /**
</span>     * Returns &lt;tt&gt;true&lt;/tt&gt; if there is a selection.
     * @return {Boolean}
     */
    hasSelection : function(){
        return this.selections.length &gt; 0;
    },

<span id='Ext-grid-RowSelectionModel-method-isSelected'>    /**
</span>     * Returns &lt;tt&gt;true&lt;/tt&gt; if the specified row is selected.
     * @param {Number/Record} index The record or index of the record to check
     * @return {Boolean}
     */
    isSelected : function(index){
        var r = Ext.isNumber(index) ? this.grid.store.getAt(index) : index;
        return (r &amp;&amp; this.selections.key(r.id) ? true : false);
    },

<span id='Ext-grid-RowSelectionModel-method-isIdSelected'>    /**
</span>     * Returns &lt;tt&gt;true&lt;/tt&gt; if the specified record id is selected.
     * @param {String} id The id of record to check
     * @return {Boolean}
     */
    isIdSelected : function(id){
        return (this.selections.key(id) ? true : false);
    },

<span id='Ext-grid-RowSelectionModel-method-handleMouseDown'>    // private
</span>    handleMouseDown : function(g, rowIndex, e){
        if(e.button !== 0 || this.isLocked()){
            return;
        }
        var view = this.grid.getView();
        if(e.shiftKey &amp;&amp; !this.singleSelect &amp;&amp; this.last !== false){
            var last = this.last;
            this.selectRange(last, rowIndex, e.ctrlKey);
            this.last = last; // reset the last
            view.focusRow(rowIndex);
        }else{
            var isSelected = this.isSelected(rowIndex);
            if(e.ctrlKey &amp;&amp; isSelected){
                this.deselectRow(rowIndex);
            }else if(!isSelected || this.getCount() &gt; 1){
                this.selectRow(rowIndex, e.ctrlKey || e.shiftKey);
                view.focusRow(rowIndex);
            }
        }
    },

<span id='Ext-grid-RowSelectionModel-method-selectRows'>    /**
</span>     * Selects multiple rows.
     * @param {Array} rows Array of the indexes of the row to select
     * @param {Boolean} keepExisting (optional) &lt;tt&gt;true&lt;/tt&gt; to keep
     * existing selections (defaults to &lt;tt&gt;false&lt;/tt&gt;)
     */
    selectRows : function(rows, keepExisting){
        if(!keepExisting){
            this.clearSelections();
        }
        for(var i = 0, len = rows.length; i &lt; len; i++){
            this.selectRow(rows[i], true);
        }
    },

<span id='Ext-grid-RowSelectionModel-method-selectRange'>    /**
</span>     * Selects a range of rows if the selection model
     * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.
     * All rows in between startRow and endRow are also selected.
     * @param {Number} startRow The index of the first row in the range
     * @param {Number} endRow The index of the last row in the range
     * @param {Boolean} keepExisting (optional) True to retain existing selections
     */
    selectRange : function(startRow, endRow, keepExisting){
        var i;
        if(this.isLocked()){
            return;
        }
        if(!keepExisting){
            this.clearSelections();
        }
        if(startRow &lt;= endRow){
            for(i = startRow; i &lt;= endRow; i++){
                this.selectRow(i, true);
            }
        }else{
            for(i = startRow; i &gt;= endRow; i--){
                this.selectRow(i, true);
            }
        }
    },

<span id='Ext-grid-RowSelectionModel-method-deselectRange'>    /**
</span>     * Deselects a range of rows if the selection model
     * {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.  
     * All rows in between startRow and endRow are also deselected.
     * @param {Number} startRow The index of the first row in the range
     * @param {Number} endRow The index of the last row in the range
     */
    deselectRange : function(startRow, endRow, preventViewNotify){
        if(this.isLocked()){
            return;
        }
        for(var i = startRow; i &lt;= endRow; i++){
            this.deselectRow(i, preventViewNotify);
        }
    },

<span id='Ext-grid-RowSelectionModel-method-selectRow'>    /**
</span>     * Selects a row.  Before selecting a row, checks if the selection model
     * {@link Ext.grid.AbstractSelectionModel#isLocked is locked} and fires the
     * {@link #beforerowselect} event.  If these checks are satisfied the row
     * will be selected and followed up by  firing the {@link #rowselect} and
     * {@link #selectionchange} events.
     * @param {Number} row The index of the row to select
     * @param {Boolean} keepExisting (optional) &lt;tt&gt;true&lt;/tt&gt; to keep existing selections
     * @param {Boolean} preventViewNotify (optional) Specify &lt;tt&gt;true&lt;/tt&gt; to
     * prevent notifying the view (disables updating the selected appearance)
     */
    selectRow : function(index, keepExisting, preventViewNotify){
        if(this.isLocked() || (index &lt; 0 || index &gt;= this.grid.store.getCount()) || (keepExisting &amp;&amp; this.isSelected(index))){
            return;
        }
        var r = this.grid.store.getAt(index);
        if(r &amp;&amp; this.fireEvent('beforerowselect', this, index, keepExisting, r) !== false){
            if(!keepExisting || this.singleSelect){
                this.clearSelections();
            }
            this.selections.add(r);
            this.last = this.lastActive = index;
            if(!preventViewNotify){
                this.grid.getView().onRowSelect(index);
            }
            if(!this.silent){
                this.fireEvent('rowselect', this, index, r);
                this.fireEvent('selectionchange', this);
            }
        }
    },

<span id='Ext-grid-RowSelectionModel-method-deselectRow'>    /**
</span>     * Deselects a row.  Before deselecting a row, checks if the selection model
     * {@link Ext.grid.AbstractSelectionModel#isLocked is locked}.
     * If this check is satisfied the row will be deselected and followed up by
     * firing the {@link #rowdeselect} and {@link #selectionchange} events.
     * @param {Number} row The index of the row to deselect
     * @param {Boolean} preventViewNotify (optional) Specify &lt;tt&gt;true&lt;/tt&gt; to
     * prevent notifying the view (disables updating the selected appearance)
     */
    deselectRow : function(index, preventViewNotify){
        if(this.isLocked()){
            return;
        }
        if(this.last == index){
            this.last = false;
        }
        if(this.lastActive == index){
            this.lastActive = false;
        }
        var r = this.grid.store.getAt(index);
        if(r){
            this.selections.remove(r);
            if(!preventViewNotify){
                this.grid.getView().onRowDeselect(index);
            }
            this.fireEvent('rowdeselect', this, index, r);
            this.fireEvent('selectionchange', this);
        }
    },

<span id='Ext-grid-RowSelectionModel-method-acceptsNav'>    // private
</span>    acceptsNav : function(row, col, cm){
        return !cm.isHidden(col) &amp;&amp; cm.isCellEditable(col, row);
    },

<span id='Ext-grid-RowSelectionModel-method-onEditorKey'>    // private
</span>    onEditorKey : function(field, e){
        var k = e.getKey(), 
            newCell, 
            g = this.grid, 
            last = g.lastEdit,
            ed = g.activeEditor,
            shift = e.shiftKey,
            ae, last, r, c;
            
        if(k == e.TAB){
            e.stopEvent();
            ed.completeEdit();
            if(shift){
                newCell = g.walkCells(ed.row, ed.col-1, -1, this.acceptsNav, this);
            }else{
                newCell = g.walkCells(ed.row, ed.col+1, 1, this.acceptsNav, this);
            }
        }else if(k == e.ENTER){
            if(this.moveEditorOnEnter !== false){
                if(shift){
                    newCell = g.walkCells(last.row - 1, last.col, -1, this.acceptsNav, this);
                }else{
                    newCell = g.walkCells(last.row + 1, last.col, 1, this.acceptsNav, this);
                }
            }
        }
        if(newCell){