Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Combine tree edit #191

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Combine tree edit #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4f57bc1
Use column's grid member if this is not column object (relevant when …
yassam May 24, 2012
5dfe2fd
options param isn't defined when tree wrapped in editor
yassam May 24, 2012
aab2be3
If a tree is wrapped in an editor, the expand tree event is now succe…
yassam May 24, 2012
7773f77
When editing done indented tree elements are drawn correctly.
yassam May 25, 2012
ca6aabe
Prevent space key during edit from expanding tree node
yassam May 25, 2012
995eff3
Added optional column property 'onEdit' which is called by editor if …
yassam May 28, 2012
323c03a
Merge branch 'upstream-master' into combine-tree-edit
yassam May 28, 2012
802b32a
'Always on' editors now check column.canEdit()
yassam May 29, 2012
28a1ccd
Merge branch 'upstream-master' into combine-tree-edit
yassam May 31, 2012
c34e277
Merge branch 'upstream-master' into combine-tree-edit
yassam Jun 3, 2012
b5c659a
Merge branch 'upstream-master' into combine-tree-edit
yassam Jun 5, 2012
590f72a
If the editor wraps a tree and the editor is active pressing the space
yassam Jun 5, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions List.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,17 @@ function(arrayUtil, kernel, declare, listen, aspect, has, miscUtil, TouchScroll,
renderHeader: function(){
// no-op in a plain list
},
_rowIdForObject: function(object) {
// summary:
// Returns the row dom id for the row that represents passed object
// description:
// Useful to code which needs row ID before row has finished
// being created (see editor for example).
//
// A side-effect of calling this function is that this._autoId
// will be incremented if this List doesn't use a store
return this.id + "-row-" + ((this.store && this.store.getIdentity) ? this.store.getIdentity(object) : this._autoId++);
},
insertRow: function(object, parent, beforeNode, i, options){
// summary:
// Renders a single row in the grid
Expand Down
76 changes: 50 additions & 26 deletions editor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ define([
"dojo/has",
"./Grid",
"put-selector/put",
"dojo/_base/sniff"
], function(kernel, lang, Deferred, on, aspect, has, Grid, put){
"dojo/query",
"dojo/_base/sniff",
], function(kernel, lang, Deferred, on, aspect, has, Grid, put, query){

var activeCell, activeValue; // tracks cell currently being edited, and its value

Expand Down Expand Up @@ -191,8 +192,10 @@ function createSharedEditor(column, originalRenderCell){
parentNode.removeChild(node);

// pass new value to original renderCell implementation for this cell
Grid.appendIfNode(parentNode, originalRenderCell(
column.grid.row(parentNode).data, activeValue, parentNode));
Grid.appendIfNode(parentNode, originalRenderCell.call(column,
column.grid.row(parentNode).data, activeValue, parentNode,
cmp._optionsForCell));
delete cmp._optionsForCell;

// reset state now that editor is deactivated
activeCell = activeValue = null;
Expand Down Expand Up @@ -246,6 +249,10 @@ function showEditor(cmp, column, cell, value){
// (Clear flag on a timeout to wait for delayed onChange to fire first)
cmp._dgridIgnoreChange = true;
cmp.set("value", value);
if (column.onEdit) {
var obj = grid.cell(cell).row.data;
column.onEdit(obj, cmp);
}
setTimeout(function(){ cmp._dgridIgnoreChange = false; }, 0);
}
// track previous value for short-circuiting or in case we need to revert
Expand All @@ -254,12 +261,14 @@ function showEditor(cmp, column, cell, value){
if(activeCell){ activeValue = value; }
}

function edit(cell) {
function edit(cell, options) {
// summary:
// Method to be mixed into grid instances, which will show/focus the
// editor for a given grid cell. Also used by renderCell.
// cell: Object
// Cell (or something resolvable by grid.cell) to activate editor on.
// options: Object (optional)
// options used to render original cell
// returns:
// If the cell is editable, returns a promise resolving to the editor
// input/widget when the cell editor is focused.
Expand All @@ -280,7 +289,11 @@ function edit(cell) {
dirty = this.dirty && this.dirty[row.id];
value = (dirty && field in dirty) ? dirty[field] :
column.get ? column.get(row.data) : row.data[field];


// Smuggle in options so that onblur() above (which is within createSharedEditor())
// can use the correct options when calling originalRenderCell(). This is needed
// if editor wraps a tree plugin.
cmp._optionsForCell = options;
showEditor(column.editorInstance, column, cellElement, value);

// focus / blur-handler-resume logic is surrounded in a setTimeout
Expand Down Expand Up @@ -334,6 +347,10 @@ return function(column, editor, editOn){
column.renderCell = editOn ? function(object, value, cell, options){
var grid = column.grid;

if (!(grid.store && grid.store.getIdentity)) {
throw new Error("Editor currently only works for store-backed grids");
}

// On first run, create one shared widget/input which will be swapped into
// the active cell.
if(!column.editorInstance){
Expand All @@ -351,31 +368,38 @@ return function(column, editor, editOn){
column.editorInstance.destroyRecursive();
});
}

// TODO: Consider using event delegation
// (Would require using dgrid's focus events for activating on focus,
// which we already advocate in README for optimal use)

// in IE<8, cell is the child of the td due to the extra padding node
on(cell.tagName == "TD" ? cell : cell.parentNode, editOn,
function(){ grid.edit(this); });

// initially render content in non-edit mode
return originalRenderCell(object, value, cell, options);

// initially render content in non-edit mode
var nonEditNode = originalRenderCell.call(this, object, value, cell, options);

// Use grid.on to target exact element for event handling
var rowSel = ".dgrid-row#" + grid._rowIdForObject(object);
var colSelector = ".dgrid-content " + rowSel + " .dgrid-column-" + column.id;
// Does the editor wrap a tree? If so, get the content node
var treeExpandoClass = ".dgrid-expando-text";
var nl = query(treeExpandoClass, cell);
if (nl.length > 0) {
// TODO: This doesn't work with event dgrid-cellfocusin so event
// click needs to be used when you wrap a tree within an editor
colSelector += " " + treeExpandoClass;
}
var eventType = colSelector + ":" + editOn;
grid.on(eventType, function(evt) {
grid.edit(this, options);
});
return nonEditNode;
} : function(object, value, cell, options){
// always-on: create editor immediately upon rendering each cell
var grid = column.grid,
cmp = createEditor(column);

var grid = column.grid;
if(!grid.edit){
grid.edit = edit; // add edit method on first render
}

showEditor(cmp, column, cell, value);

// Maintain reference for later use.
cell[isWidget ? "widget" : "input"] = cmp;
if (!column.canEdit || column.canEdit(object, value)) {
var cmp = createEditor(column);
showEditor(cmp, column, cell, value);
// Maintain reference for later use.
cell[isWidget ? "widget" : "input"] = cmp;
}
if(isWidget){
if(!cleanupAdded){
cleanupAdded = true;
Expand Down
4 changes: 3 additions & 1 deletion tree.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ return function(column){
target = target.element || target; // if a row object was passed in, get the element first
target = target.className.indexOf("dgrid-expando-icon") > -1 ? target :
querySelector(".dgrid-expando-icon", target)[0];
if(target.mayHaveChildren){
// Check if target is defined. If editor is wrapped in editor pressing space key whilst
// editing will trigger this event and target will be undefined
if(target && target.mayHaveChildren){
// on click we toggle expanding and collapsing
var expanded = target.expanded = expand === undefined ? !target.expanded : expand;
// update the expando display
Expand Down