PDA

View Full Version : ColumnSelectionModel (work in progress)



chbfiv
25 Nov 2009, 7:09 AM
Currently the general functionally it also working with one problem, after about 6-7 clicks on cells within the grid the getCellIndex from the super classes View is returning the column offset by 1, causing a select on a column to select the next column. I didn't really change much (using RowSelectionModel) to get this working and I'm not sure why the underlying div/class seletion model is returning results fine for a little while, then offset results soon after.

I only really needed the core functions of a ColumnSelectionModel for my project, but I left the functions that should be included from the RowSelectionModel commented w/ the ColumnSelectionModel. Instead of returning a record when a column is selected I return the columnIndex and the column itself. I hope this is useful to someone and I'll keep looking into that offset problem.

Three files
YourIncludedCssFile.css
ColumnSelectionModel.js
AdvancedGridView.js

To use them in your grid,


//...
selModel: new Ext.grid.ColumnSelectionModel({
listeners: {
columnselect : function(selModel, colIndex, column) {
myOtherGrid.selModel.selectColumn(colIndex, false, false, true);
}
}
}),
view: new Ext.grid.AdvancedGridView(),
//...
YourIncludedCssFile.css

.x-grid3-column-selected {
background-color: #DFE8F6;
background-image: none;
border-color: #A3BAE9;
border-left: 1px dotted;
border-right: 1px dotted;
border-bottom: 0px;
border-top: 0px;
padding-right: 0px !important;
padding-left: 0px !important;
}ColumnSelectionModel.js


Ext.grid.ColumnSelectionModel = function(config){
Ext.apply(this, config);
this.selections = new Ext.util.MixedCollection(false, function(o){
return o.id;
});

//this.last = false;
//this.lastActive = false;

this.addEvents(

"selectionchange",
"beforecolumnselect",
"columnselect",
"columndeselect"
);

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

Ext.extend(Ext.grid.ColumnSelectionModel, Ext.grid.AbstractSelectionModel, {
singleSelect : false,

// private
initEvents : function(){

this.grid.on("cellclick", function(grid, rowIndex, columnIndex, e) {
if(e.button === 0 && !e.shiftKey && !e.ctrlKey) {
this.selectColumn(columnIndex, false);
//grid.view.focusCell(rowIndex, columnIndex);
}
}, this);
/*
if(!this.grid.enableDragDrop && !this.grid.enableDrag){
this.grid.on("rowmousedown", this.handleMouseDown, this);
}else{ // allow click to work like normal
this.grid.on("rowclick", function(grid, rowIndex, e) {
if(e.button === 0 && !e.shiftKey && !e.ctrlKey) {
this.selectRow(rowIndex, false);
grid.view.focusRow(rowIndex);
}
}, this);
}



this.rowNav = new Ext.KeyNav(this.grid.getGridEl(), {
"up" : function(e){
if(!e.shiftKey || this.singleSelect){
this.selectPrevious(false);
}else if(this.last !== false && this.lastActive !== false){
var last = this.last;
this.selectRange(this.last, this.lastActive-1);
this.grid.getView().focusRow(this.lastActive);
if(last !== false){
this.last = last;
}
}else{
this.selectFirstRow();
}
},
"down" : function(e){
if(!e.shiftKey || this.singleSelect){
this.selectNext(false);
}else if(this.last !== false && this.lastActive !== false){
var last = this.last;
this.selectRange(this.last, this.lastActive+1);
this.grid.getView().focusRow(this.lastActive);
if(last !== false){
this.last = last;
}
}else{
this.selectFirstRow();
}
},
scope: this
});
*/
var view = this.grid.view;
view.on("refresh", this.onRefresh, this);
// view.on("rowupdated", this.onRowUpdated, this);
// view.on("rowremoved", this.onRemove, this);
},

// private
onRefresh : function(){
// this.selectFirstColumn();

var ds = this.grid.getColumnModel().config, index;
var s = this.getSelections();
this.clearSelections(true);
for(var i = 0, len = s.length; i < len; i++){
var r = s[i];
if((index = ds.indexOfId(r.id)) != -1){
this.selectColumn(index, true);
}
}
if(s.length != this.selections.getCount()){
this.fireEvent("selectionchange", this);
}
/*
var ds = this.grid.getColumnModel().config, index;
var s = this.getSelections();
this.clearSelections(true);
for(var i = 0, len = s.length; i < len; i++){
var r = s[i];
if((index = ds.indexOfId(r.id)) != -1){
this.selectRow(index, true);
}
}
if(s.length != this.selections.getCount()){
this.fireEvent("selectionchange", this);
}
*/
},

/*
// private
onRemove : function(v, index, r){
if(this.selections.remove(r) !== false){
this.fireEvent('selectionchange', this);
}
},

// private
onRowUpdated : function(v, index, r){
if(this.isSelected(r)){
v.onRowSelect(index);
}
},
*/

/**
* Select records.
* @param {Array} records The records to select
* @param {Boolean} keepExisting (optional) <tt>true</tt> to keep existing selections
*/
/*selectRecords : function(records, keepExisting){
if(!keepExisting){
this.clearSelections();
}
var ds = this.grid.store;
for(var i = 0, len = records.length; i < len; i++){
this.selectRow(ds.indexOf(records[i]), true);
}
},*/

/**
* Gets the number of selected rows.
* @return {Number}
*/
getCount : function(){
return this.selections.length;
},

/**
* Selects the first row in the grid.
*/

selectFirstColumn : function(){
this.selectColumn(0);
},

/**
* Select the last row.
* @param {Boolean} keepExisting (optional) <tt>true</tt> to keep existing selections
*/
/*
selectLastRow : function(keepExisting){
this.selectRow(this.grid.store.getCount() - 1, keepExisting);
},*/

/**
* Selects the row immediately following the last selected row.
* @param {Boolean} keepExisting (optional) <tt>true</tt> to keep existing selections
* @return {Boolean} <tt>true</tt> if there is a next row, else <tt>false</tt>
*/
selectNext : function(keepExisting){
/*if(this.hasNext()){
this.selectRow(this.last+1, keepExisting);
this.grid.getView().focusRow(this.last);
return true;
}
return false;*/
},

/**
* Selects the row that precedes the last selected row.
* @param {Boolean} keepExisting (optional) <tt>true</tt> to keep existing selections
* @return {Boolean} <tt>true</tt> if there is a previous row, else <tt>false</tt>
*/
selectPrevious : function(keepExisting){
/*
if(this.hasPrevious()){
this.selectRow(this.last-1, keepExisting);
this.grid.getView().focusRow(this.last);
return true;
}
return false;
*/
},

/**
* Returns true if there is a next record to select
* @return {Boolean}
*/
hasNext : function(){
//return this.last !== false && (this.last+1) < this.grid.store.getCount();
},

/**
* Returns true if there is a previous record to select
* @return {Boolean}
*/
hasPrevious : function(){
//return !!this.last;
},


/**
* Returns the selected records
* @return {Array} Array of selected records
*/
getSelections : function(){
return [].concat(this.selections.items);
},

/**
* Returns the first selected record.
* @return {Record}
*/
getSelected : function(){
return this.selections.itemAt(0);
},

/**
* Calls the passed function with each selection. If the function returns
* <tt>false</tt>, iteration is stopped and this function returns
* <tt>false</tt>. Otherwise it returns <tt>true</tt>.
* @param {Function} fn
* @param {Object} scope (optional)
* @return {Boolean} true if all selections were iterated
*/
each : function(fn, scope){
var s = this.getSelections();
for(var i = 0, len = s.length; i < len; i++){
if(fn.call(scope || this, s[i], i) === false){
return false;
}
}
return true;
},

/**
* Clears all selections if the selection model
* {@link Ext.grid.AbstractSelectionModel#isLocked is not locked}.
* @param {Boolean} fast (optional) <tt>true</tt> to bypass the
* conditional checks and events described in {@link #deselectRow}.
*/
clearSelections : function(fast){

if(this.isLocked()){
return;
}
if(fast !== true){
var s = this.selections;
s.each(function(c){
this.deselectColumn(c.id);
}, this);
s.clear();
}else{
this.selections.clear();
}


},


/**
* 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 < len; i++){
this.selectRow(i, true);
}
*/
},

/**
* Returns <tt>true</tt> if there is a selection.
* @return {Boolean}
*/
hasSelection : function(){
return this.selections.length > 0;
},

/**
* Returns <tt>true</tt> 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 columns = this.grid.getColumnModel().config;
var c = columns[index];
c.id = index;
return (c && this.selections.key(c) ? true : false);
},

/**
* Returns <tt>true</tt> 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);
},

// private
handleMouseDown : function(g, rowIndex, e){
/*
if(e.button !== 0 || this.isLocked()){
return;
}
var view = this.grid.getView();
if(e.shiftKey && !this.singleSelect && 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 && isSelected){
this.deselectRow(rowIndex);
}else if(!isSelected || this.getCount() > 1){
this.selectRow(rowIndex, e.ctrlKey || e.shiftKey);
view.focusRow(rowIndex);
}
}
*/
},

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

/**
* 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 <= endRow){
for(i = startRow; i <= endRow; i++){
this.selectRow(i, true);
}
}else{
for(i = startRow; i >= endRow; i--){
this.selectRow(i, true);
}
}
*/
},

/**
* 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 <= endRow; i++){
this.deselectRow(i, preventViewNotify);
}
*/
},

/**
* 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) <tt>true</tt> to keep existing selections
* @param {Boolean} preventViewNotify (optional) Specify <tt>true</tt> to
* prevent notifying the view (disables updating the selected appearance)
*/
/*selectRow : function(index, keepExisting, preventViewNotify){

if(this.isLocked() || (index < 0 || index >= this.grid.store.getCount()) || (keepExisting && this.isSelected(index))){
return;
}
var r = this.grid.store.getAt(index);
if(r && 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);
}
this.fireEvent("rowselect", this, index, r);
this.fireEvent("selectionchange", this);
}

},*/
//TODO: isSelected, clearSelections
selectColumn: function(index, keepExisting, preventViewNotify, supressEvent){
supressEvent = supressEvent || false;
var columns = this.grid.getColumnModel().config;
if(this.isLocked() ||
(index < 0 || index >= columns.length) ||
(keepExisting && this.isSelected(index))){
return;
}
var c = columns[index];
if(c && this.fireEvent("beforecolumnselect", this, index, keepExisting, r) !== false) {
c.id = index;

if(!keepExisting || this.singleSelect){
this.clearSelections();
}

if(!c.getEditor()) {
this.clearSelections();
return;
}

if(!preventViewNotify) {

var records = this.grid.store.data;
for(var i = 0; i < records.length; i++) {
// if(i == 0) {
// this.grid.getView().onColumnSelect(i, index, '-top');
// }
// else if(i == records.length - 1) {
// this.grid.getView().onColumnSelect(i, index, '-bottom');
// }
// else {
// this.grid.getView().onColumnSelect(i, index);
// }
this.grid.getView().onColumnSelect(i, index);
}

// this.grid.store.each(function(r) {
// var rowId = this.grid.store.indexOf(r);
// this.grid.getView().onColumnSelect(rowId, index);
// }, this);
}

this.selections.add(c);

if(!supressEvent) {
this.fireEvent("columnselect", this, index, c);
this.fireEvent("selectionchange", this);
}
}

},

/**
* 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 <tt>true</tt> 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);
}

},*/
deselectColumn : function(index, preventViewNotify){

if(this.isLocked()){
return;
}

var c = this.grid.getColumnModel().config[index];
if(c){
c.id = index;
this.selections.remove(c);
if(!preventViewNotify){

var records = this.grid.store.data;
for(var i = 0; i < records.length; i++) {
// if(i == 0) {
// this.grid.getView().onColumnDeselect(i, index, '-top');
// }
// else if(i == records.length - 1) {
// this.grid.getView().onColumnDeselect(i, index, '-bottom');
// }
// else {
// this.grid.getView().onColumnDeselect(i, index);
// }
this.grid.getView().onColumnDeselect(i, index);
}

// this.grid.store.each(function(r) {
// var rowId = this.grid.store.indexOf(r);
// this.grid.getView().onColumnDeselect(rowId, index, "-top");
// }, this);
}
this.fireEvent("columndeselect", this, index, c);
this.fireEvent("selectionchange", this);
}

},

// private
restoreLast : function(){
/*
if(this._last){
this.last = this._last;
}*/

},

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

// private
onEditorKey : function(field, e){
/*
var k = e.getKey(), newCell, g = this.grid, ed = g.activeEditor;
var shift = e.shiftKey;
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){
e.stopEvent();
ed.completeEdit();
if(this.moveEditorOnEnter !== false){
if(shift){
newCell = g.walkCells(ed.row - 1, ed.col, -1, this.acceptsNav, this);
}else{
newCell = g.walkCells(ed.row + 1, ed.col, 1, this.acceptsNav, this);
}
}
}else if(k == e.ESC){
ed.cancelEdit();
}
if(newCell){
g.startEditing(newCell[0], newCell[1]);
}
*/
},

destroy: function(){
/*
if(this.rowNav){
this.rowNav.disable();
this.rowNav = null;
}*/
Ext.grid.ColumnSelectionModel.superclass.destroy.call(this);
}
});AdvancedGridView.js


Ext.grid.AdvancedGridView = function(config) {
Ext.apply(this, config);
this.addEvents(
'beforecolumnremoved',
'beforecolumnsinserted',
'columnremoved',
'columnsinserted',
'columnupdated'
);
Ext.grid.AdvancedGridView.superclass.constructor.call(this);
};

Ext.extend(Ext.grid.AdvancedGridView, Ext.grid.GridView, {

selectedColumnClass : 'x-grid3-column-selected',

// private
onColumnSelect : function(row, column, appendCls){
appendCls = appendCls || '';
this.addColumnClass(row, column, this.selectedColumnClass + appendCls);
},

// private
onColumnDeselect : function(row, column, appendCls){
appendCls = appendCls || '';
this.removeColumnClass(row, column, this.selectedColumnClass + appendCls);
},

// private
addColumnClass : function(row, column, cls){
var c = this.getCell(row, column);
if(c){
this.fly(c).addClass(cls);
}
},

// private
removeColumnClass : function(row, column, cls){
var c = this.getCell(row, column);
if(c){
this.fly(c).removeClass(cls);
}
}

});