1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
/*
Copyright (c) 2004-2011, The Dojo Foundation All Rights Reserved.
Available via Academic Free License >= 2.1 OR the modified BSD license.
see: http://dojotoolkit.org/license for details
*/
dojo._xdResourceLoaded(function(dojo, dijit, dojox){
return {depends: [["provide", "dojox.grid.enhanced.plugins.CellMerge"],
["require", "dojox.grid.enhanced._Plugin"]],
defineResource: function(dojo, dijit, dojox){if(!dojo._hasResource["dojox.grid.enhanced.plugins.CellMerge"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code.
dojo._hasResource["dojox.grid.enhanced.plugins.CellMerge"] = true;
dojo.provide("dojox.grid.enhanced.plugins.CellMerge");
dojo.require("dojox.grid.enhanced._Plugin");
dojo.declare("dojox.grid.enhanced.plugins.CellMerge", dojox.grid.enhanced._Plugin, {
// summary:
// This plugin provides functions to merge(un-merge) adjacent cells within one row.
// Acceptable plugin paramters:
// 1. mergedCells: Array
// An array of objects with structure:
// {
// row: function(Integer)|Integer
// If it's a function, it's a predicate to decide which rows are to be merged.
// It takes an integer (the row index), and should return true or false;
// start: Integer
// The column index of the left most cell that shall be merged.
// end: Integer
// The column index of the right most cell that shall be merged.
// major: Integer
// The column index of the cell whose content should be used as the content of the merged cell.
// It must be larger than or equal to the startColumnIndex, and less than or equal to the endColumnIndex.
// If it is omitted, the content of the leading edge (left-most for ltr, right most for rtl) cell will be used.
// }
// name: String
// Plugin name
name: "cellMerge",
constructor: function(grid, args){
this.grid = grid;
this._records = [];
this._merged = {};
if(args && dojo.isObject(args)){
this._setupConfig(args.mergedCells);
}
this._initEvents();
this._mixinGrid();
},
//----------------Public----------------------------
mergeCells: function(rowTester, startColumnIndex, endColumnIndex, majorColumnIndex){
// summary:
// Merge cells from *startColumnIndex* to *endColumnIndex* at rows that make *rowTester* return true,
// using the content of the cell at *majorColumnIndex*
// tags:
// public
// rowTester: function(Integer)|Integer
// If it's a function, it's a predicate to decide which rows are to be merged.
// It takes an integer (the row index), and should return true or false;
// startColumnIndex: Integer
// The column index of the left most cell that shall be merged.
// endColumnIndex: Integer
// The column index of the right most cell that shall be merged.
// majorColumnIndex: Integer?
// The column index of the cell whose content should be used as the content of the merged cell.
// It must be larger than or equal to the startColumnIndex, and less than or equal to the endColumnIndex.
// If it is omitted, the content of the leading edge (left-most for ltr, right most for rtl) cell will be used.
// return: Object | null
// A handler for the merged cells created by a call of this function.
// This handler can be used later to unmerge cells using the function unmergeCells
// If the merge is not valid, returns null;
var item = this._createRecord({
"row": rowTester,
"start": startColumnIndex,
"end": endColumnIndex,
"major": majorColumnIndex
});
if(item){
this._updateRows(item);
}
return item;
},
unmergeCells: function(mergeHandler){
// summary:
// Unmerge the cells that are merged by the *mergeHandler*, which represents a call to the function mergeCells.
// tags:
// public
// mergeHandler: object
// A handler for the merged cells created by a call of function mergeCells.
var idx;
if(mergeHandler && (idx = dojo.indexOf(this._records, mergeHandler)) >= 0){
this._records.splice(idx, 1);
this._updateRows(mergeHandler);
}
},
getMergedCells: function(){
// summary:
// Get all records of currently merged cells.
// tags:
// public
// return: Array
// An array of records for merged-cells.
// The record has the following structure:
// {
// "row": 1, //the row index
// "start": 2, //the start column index
// "end": 4, //the end column index
// "major": 3, //the major column index
// "handle": someHandle, //The handler that covers this merge cell record.
// }
var res = [];
for(var i in this._merged){
res = res.concat(this._merged[i]);
}
return res;
},
getMergedCellsByRow: function(rowIndex){
// summary:
// Get the records of currently merged cells at the given row.
// tags:
// public
// return: Array
// An array of records for merged-cells. See docs of getMergedCells.
return this._merged[rowIndex] || [];
},
//----------------Private--------------------------
_setupConfig: function(config){
dojo.forEach(config, this._createRecord, this);
},
_initEvents: function(){
dojo.forEach(this.grid.views.views, function(view){
this.connect(view, "onAfterRow", dojo.hitch(this, "_onAfterRow", view.index));
}, this);
},
_mixinGrid: function(){
var g = this.grid;
g.mergeCells = dojo.hitch(this, "mergeCells");
g.unmergeCells = dojo.hitch(this, "unmergeCells");
g.getMergedCells = dojo.hitch(this, "getMergedCells");
g.getMergedCellsByRow = dojo.hitch(this, "getMergedCellsByRow");
},
_getWidth: function(colIndex){
var node = this.grid.layout.cells[colIndex].getHeaderNode();
return dojo.position(node).w;
},
_onAfterRow: function(viewIdx, rowIndex, subrows){
try{
if(rowIndex < 0){
return;
}
var result = [], i, j, len = this._records.length,
cells = this.grid.layout.cells;
//Apply merge-cell requests one by one.
for(i = 0; i < len; ++i){
var item = this._records[i];
var storeItem = this.grid._by_idx[rowIndex];
if(item.view == viewIdx && item.row(rowIndex, storeItem && storeItem.item, this.grid.store)){
var res = {
record: item,
hiddenCells: [],
totalWidth: 0,
majorNode: cells[item.major].getNode(rowIndex),
majorHeaderNode: cells[item.major].getHeaderNode()
};
//Calculated the width of merged cell.
for(j = item.start; j <= item.end; ++j){
var w = this._getWidth(j, rowIndex);
res.totalWidth += w;
if(j != item.major){
res.hiddenCells.push(cells[j].getNode(rowIndex));
}
}
//If width is valid, remember it. There may be multiple merges within one row.
if(subrows.length != 1 || res.totalWidth > 0){
//Remove conflicted merges.
for(j = result.length - 1; j >= 0; --j){
var r = result[j].record;
if((r.start >= item.start && r.start <= item.end) ||
(r.end >= item.start && r.end <= item.end)){
result.splice(j, 1);
}
}
result.push(res);
}
}
}
this._merged[rowIndex] = [];
dojo.forEach(result, function(res){
dojo.forEach(res.hiddenCells, function(node){
dojo.style(node, "display", "none");
});
var pbm = dojo.marginBox(res.majorHeaderNode).w - dojo.contentBox(res.majorHeaderNode).w;
var tw = res.totalWidth;
//Tricky for WebKit.
if(!dojo.isWebKit){
tw -= pbm;
}
dojo.style(res.majorNode, "width", tw + "px");
//In case we're dealing with multiple subrows.
dojo.attr(res.majorNode, "colspan", res.hiddenCells.length + 1);
this._merged[rowIndex].push({
"row": rowIndex,
"start": res.record.start,
"end": res.record.end,
"major": res.record.major,
"handle": res.record
});
}, this);
}catch(e){
console.warn("CellMerge._onAfterRow() error: ", rowIndex, e);
}
},
_createRecord: function(item){
if(this._isValid(item)){
item = {
"row": item.row,
"start": item.start,
"end": item.end,
"major": item.major
};
var cells = this.grid.layout.cells;
item.view = cells[item.start].view.index;
item.major = typeof item.major == "number" && !isNaN(item.major) ? item.major : item.start;
if(typeof item.row == "number"){
var r = item.row;
item.row = function(rowIndex){
return rowIndex === r;
};
}else if(typeof item.row == "string"){
var id = item.row;
item.row = function(rowIndex, storeItem, store){
try{
if(store && storeItem && store.getFeatures()['dojo.data.api.Identity']){
return store.getIdentity(storeItem) == id;
}
}catch(e){
console.error(e);
}
return false;
};
}
if(dojo.isFunction(item.row)){
this._records.push(item);
return item;
}
}
return null;
},
_isValid: function(item){
var cells = this.grid.layout.cells,
colCount = cells.length;
return (dojo.isObject(item) && ("row" in item) && ("start" in item) && ("end" in item) &&
item.start >= 0 && item.start < colCount &&
item.end > item.start && item.end < colCount &&
cells[item.start].view.index == cells[item.end].view.index &&
cells[item.start].subrow == cells[item.end].subrow &&
!(typeof item.major == "number" && (item.major < item.start || item.major > item.end)));
},
_updateRows: function(item){
var min = null;
for(var i = 0, count = this.grid.rowCount; i < count; ++i){
var storeItem = this.grid._by_idx[i];
if(storeItem && item.row(i, storeItem && storeItem.item, this.grid.store)){
this.grid.views.updateRow(i);
if(min === null){ min = i; }
}
}
if(min >= 0){
this.grid.scroller.rowHeightChanged(min);
}
}
});
dojox.grid.EnhancedGrid.registerPlugin(dojox.grid.enhanced.plugins.CellMerge/*name:'cellMerge'*/);
}
}};});
|
