# CellSelectionModel.js

    /**
     * @class Ext.grid.CellSelectionModel
     * @extends Ext.grid.AbstractSelectionModel
     * This class provides the basic implementation for single cell selection in a grid. The object stored
     * as the selection and returned by {@link getSelectedCell} contains the following properties:
     * <div class="mdetail-params"><ul>
     * <li><b>record</b> : Ext.data.record<p class="sub-desc">The {@link Ext.data.Record Record}
     * which provides the data for the row containing the selection</p></li>
     * <li><b>cell</b> : Ext.data.record<p class="sub-desc">An object containing the
     * following properties:
     * <div class="mdetail-params"><ul>
     * <li><b>rowIndex</b> : Number<p class="sub-desc">The index of the selected row</p></li>
     * <li><b>cellIndex</b> : Number<p class="sub-desc">The index of the selected cell<br>
     * <b>Note that due to possible column reordering, the cellIndex should not be used as an index into
     * the Record's data. Instead, the <i>name</i> of the selected field should be determined
     * in order to retrieve the data value from the record by name:</b><pre><code>
        var fieldName = grid.getColumnModel().getDataIndex(cellIndex);
        var data = record.get(fieldName);
    </code></pre></p></li>
     * </ul></div></p></li>
     * </ul></div>
     * @constructor
     * @param {Object} config The object containing the configuration of this model.
     */
    Ext.grid.CellSelectionModel = function(config){
        Ext.apply(this, config);

        this.selection = null;

        this.addEvents(
            /**
    	     * @event beforecellselect
    	     * Fires before a cell is selected.
    	     * @param {SelectionModel} this
    	     * @param {Number} rowIndex The selected row index
    	     * @param {Number} colIndex The selected cell index
    	     */
    	    "beforecellselect",
            /**
    	     * @event cellselect
    	     * Fires when a cell is selected.
    	     * @param {SelectionModel} this
    	     * @param {Number} rowIndex The selected row index
    	     * @param {Number} colIndex The selected cell index
    	     */
    	    "cellselect",
            /**
    	     * @event selectionchange
    	     * Fires when the active selection changes.
    	     * @param {SelectionModel} this
    	     * @param {Object} selection null for no selection or an object (o) with two properties
    	        <ul>
    	        <li>o.record: the record object for the row the selection is in</li>
    	        <li>o.cell: An array of [rowIndex, columnIndex]</li>
    	        </ul>
    	     */
    	    "selectionchange"
        );

        Ext.grid.CellSelectionModel.superclass.constructor.call(this);
    };

    Ext.extend(Ext.grid.CellSelectionModel, Ext.grid.AbstractSelectionModel,  {

        /** @ignore */
        initEvents : function(){
            this.grid.on("cellmousedown", this.handleMouseDown, this);
            this.grid.getGridEl().on(Ext.isIE || (Ext.isWebKit && !Ext.isSafari2) ? "keydown" : "keypress", this.handleKeyDown, this);
            var view = this.grid.view;
            view.on("refresh", this.onViewChange, this);
            view.on("rowupdated", this.onRowUpdated, this);
            view.on("beforerowremoved", this.clearSelections, this);
            view.on("beforerowsinserted", this.clearSelections, this);
            if(this.grid.isEditor){
                this.grid.on("beforeedit", this.beforeEdit,  this);
            }
        },

    	//private
        beforeEdit : function(e){
            this.select(e.row, e.column, false, true, e.record);
        },

    	//private
        onRowUpdated : function(v, index, r){
            if(this.selection && this.selection.record == r){
                v.onCellSelect(index, this.selection.cell[1]);
            }
        },

    	//private
        onViewChange : function(){
            this.clearSelections(true);
        },

    	/**
    	 * Returns the currently selected cell's row and column indexes as an array (e.g., [0, 0]).
    	 * @return {Array} An array containing the row and column indexes of the selected cell, or null if none selected.
    	 */
        getSelectedCell : function(){
            return this.selection ? this.selection.cell : null;
        },

        /**
         * Clears all selections.
         * @param {Boolean} true to prevent the gridview from being notified about the change.
         */
        clearSelections : function(preventNotify){
            var s = this.selection;
            if(s){
                if(preventNotify !== true){
                    this.grid.view.onCellDeselect(s.cell[0], s.cell[1]);
                }
                this.selection = null;
                this.fireEvent("selectionchange", this, null);
            }
        },

        /**
         * Returns true if there is a selection.
         * @return {Boolean}
         */
        hasSelection : function(){
            return this.selection ? true : false;
        },

        /** @ignore */
        handleMouseDown : function(g, row, cell, e){
            if(e.button !== 0 || this.isLocked()){
                return;
            };
            this.select(row, cell);
        },

        /**
         * Selects a cell.
         * @param {Number} rowIndex
         * @param {Number} collIndex
         */
        select : function(rowIndex, colIndex, preventViewNotify, preventFocus, /*internal*/ r){
            if(this.fireEvent("beforecellselect", this, rowIndex, colIndex) !== false){
                this.clearSelections();
                r = r || this.grid.store.getAt(rowIndex);
                this.selection = {
                    record : r,
                    cell : [rowIndex, colIndex]
                };
                if(!preventViewNotify){
                    var v = this.grid.getView();
                    v.onCellSelect(rowIndex, colIndex);
                    if(preventFocus !== true){
                        v.focusCell(rowIndex, colIndex);
                    }
                }
                this.fireEvent("cellselect", this, rowIndex, colIndex);
                this.fireEvent("selectionchange", this, this.selection);
            }
        },

    	//private
        isSelectable : function(rowIndex, colIndex, cm){
            return !cm.isHidden(colIndex);
        },

        /** @ignore */
        handleKeyDown : function(e){
            if(!e.isNavKeyPress()){
                return;
            }
            var g = this.grid, s = this.selection;
            if(!s){
                e.stopEvent();
                var cell = g.walkCells(0, 0, 1, this.isSelectable,  this);
                if(cell){
                    this.select(cell[0], cell[1]);
                }
                return;
            }
            var sm = this;
            var walk = function(row, col, step){
                return g.walkCells(row, col, step, sm.isSelectable,  sm);
            };
            var k = e.getKey(), r = s.cell[0], c = s.cell[1];
            var newCell;

            switch(k){
                 case e.TAB:
                     if(e.shiftKey){
                         newCell = walk(r, c-1, -1);
                     }else{
                         newCell = walk(r, c+1, 1);
                     }
                 break;
                 case e.DOWN:
                     newCell = walk(r+1, c, 1);
                 break;
                 case e.UP:
                     newCell = walk(r-1, c, -1);
                 break;
                 case e.RIGHT:
                     newCell = walk(r, c+1, 1);
                 break;
                 case e.LEFT:
                     newCell = walk(r, c-1, -1);
                 break;
                 case e.ENTER:
                     if(g.isEditor && !g.editing){
                        g.startEditing(r, c);
                        e.stopEvent();
                        return;
                    }
                 break;
            };
            if(newCell){
                this.select(newCell[0], newCell[1]);
                e.stopEvent();
            }
        },

        acceptsNav : function(row, col, cm){
            return !cm.isHidden(col) && cm.isCellEditable(col, row);
        },

        onEditorKey : function(field, e){
            var k = e.getKey(), newCell, g = this.grid, ed = g.activeEditor;
            if(k == e.TAB){
                if(e.shiftKey){
                    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);
                }
                e.stopEvent();
            }else if(k == e.ENTER){
                ed.completeEdit();
                e.stopEvent();
            }else if(k == e.ESC){
            	e.stopEvent();
                ed.cancelEdit();
            }
            if(newCell){
                g.startEditing(newCell[0], newCell[1]);
            }
        }
    });

Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.