2010-06-25 21:58:30 +02:00
|
|
|
/* -*- Mode: js2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
2010-05-27 16:41:59 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Data table interface to be added to a DIV (this!)
|
|
|
|
*
|
|
|
|
* Available events:
|
|
|
|
* datatable:rendered -- fired once the view rendering is completed
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
var SOGoDataTableInterface = {
|
|
|
|
|
|
|
|
// Object variables initialized with "bind"
|
|
|
|
columnsCount: null,
|
|
|
|
rowModel: null,
|
|
|
|
rowHeight: 0,
|
|
|
|
body: null,
|
|
|
|
|
|
|
|
// Object variables
|
|
|
|
dataSource: null,
|
|
|
|
rowTop: null,
|
|
|
|
rowBottom: null,
|
|
|
|
renderedIndex: -1,
|
|
|
|
renderedCount: 0,
|
|
|
|
rowRenderCallback: null,
|
|
|
|
|
|
|
|
// Constants
|
|
|
|
overflow: 30, // must be lower than the overflow of the data source class
|
|
|
|
renderDelay: 0.2, // delay (in seconds) before which the table is rendered upon scrolling
|
|
|
|
|
|
|
|
bind: function() {
|
|
|
|
this.observe("scroll" , this.render.bind(this));
|
|
|
|
|
|
|
|
this.body = this.down("tbody");
|
|
|
|
this.rowModel = this.body.down("tr");
|
|
|
|
|
2010-08-26 16:14:10 +02:00
|
|
|
/**
|
|
|
|
* Overrided methods from HTMLElement.js
|
|
|
|
* Handle selection based on rows ID.
|
|
|
|
*/
|
|
|
|
this.body.selectRange = function(startIndex, endIndex) {
|
|
|
|
var element = $(this);
|
|
|
|
var s;
|
|
|
|
var e;
|
|
|
|
var rows;
|
|
|
|
var div = this.up('div');
|
|
|
|
var uid = lastClickedRowId.substr(4);
|
|
|
|
|
|
|
|
startIndex = div.dataSource.indexOf(uid);
|
|
|
|
uid = div.down('tr', endIndex).id.substr(4);
|
|
|
|
endIndex = div.dataSource.indexOf(uid);
|
|
|
|
|
|
|
|
if (startIndex > endIndex) {
|
|
|
|
s = endIndex;
|
|
|
|
e = startIndex;
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
s = startIndex;
|
|
|
|
e = endIndex;
|
|
|
|
}
|
|
|
|
|
|
|
|
while (s <= e) {
|
|
|
|
uid = "row_" + div.dataSource.uids[s];
|
|
|
|
if (this.selectedIds.indexOf(uid) < 0)
|
|
|
|
this.selectedIds.push(uid);
|
|
|
|
s++;
|
|
|
|
}
|
|
|
|
this.refreshSelectionByIds();
|
|
|
|
};
|
|
|
|
|
|
|
|
this.body.selectAll = function() {
|
|
|
|
var div = this.up('div');
|
|
|
|
this.selectedIds = new Array();
|
|
|
|
for (var i = 0; i < div.dataSource.uids.length; i++)
|
|
|
|
this.selectedIds.push("row_" + div.dataSource.uids[i]);
|
|
|
|
this.refreshSelectionByIds();
|
|
|
|
},
|
|
|
|
|
2010-05-27 16:41:59 +02:00
|
|
|
// Since we use the fixed table layout, the first row must have the
|
|
|
|
// proper CSS classes that will define the columns width.
|
2010-08-26 16:14:10 +02:00
|
|
|
this.rowTop = new Element('tr', {'id': 'rowTop'});
|
2010-05-27 16:41:59 +02:00
|
|
|
this.body.insertBefore(this.rowTop, this.rowModel); // IE requires the element to be inside the DOM before appending new children
|
|
|
|
var cells = this.rowModel.select('TD');
|
|
|
|
for (var i = 0; i < cells.length; i++) {
|
|
|
|
var cell = cells[i];
|
|
|
|
var td = new Element('td', {'class': cell.className});
|
|
|
|
this.rowTop.appendChild(td);
|
|
|
|
}
|
|
|
|
|
|
|
|
this.rowBottom = new Element('tr', {'id': 'rowBottom'}).update(new Element('td'));
|
|
|
|
this.body.insertBefore(this.rowBottom, this.rowModel);
|
|
|
|
|
|
|
|
this.columnsCount = this.rowModel.select("td").length;
|
|
|
|
this.rowHeight = this.rowModel.getHeight();
|
2010-05-28 22:06:24 +02:00
|
|
|
// log ("DataTable.bind() row height = " + this.rowHeight + "px");
|
2010-05-27 16:41:59 +02:00
|
|
|
},
|
|
|
|
|
|
|
|
setRowRenderCallback: function(callbackFunction) {
|
|
|
|
// Each time a row is created or updated with new data, this callback
|
|
|
|
// function will be called.
|
|
|
|
this.rowRenderCallback = callbackFunction;
|
|
|
|
},
|
|
|
|
|
2010-06-25 21:58:30 +02:00
|
|
|
setSource: function(ds) {
|
|
|
|
this.dataSource = ds;
|
2010-08-26 16:14:10 +02:00
|
|
|
this.currentRenderID = "";
|
2010-06-25 21:58:30 +02:00
|
|
|
this._emptyTable();
|
|
|
|
this.scrollTop = 0;
|
|
|
|
},
|
|
|
|
|
|
|
|
initSource: function(dataSourceClass, url, params) {
|
2010-05-27 16:41:59 +02:00
|
|
|
// log ("DataTable.setSource() " + url);
|
|
|
|
if (this.dataSource) this.dataSource.destroy();
|
|
|
|
this._emptyTable();
|
|
|
|
this.dataSource = new window[dataSourceClass](this, url);
|
2010-05-28 21:18:52 +02:00
|
|
|
this.scrollTop = 0;
|
2010-05-27 16:41:59 +02:00
|
|
|
this.load(params);
|
|
|
|
},
|
|
|
|
|
|
|
|
load: function(urlParams) {
|
|
|
|
if (!this.dataSource) return;
|
|
|
|
// log ("DataTable.load() with parameters [" + urlParams.keys().join(' ') + "]");
|
|
|
|
if (Object.isHash(urlParams) && urlParams.keys().length > 0) this.dataSource.load(urlParams);
|
|
|
|
else this.dataSource.load(new Hash());
|
|
|
|
},
|
|
|
|
|
|
|
|
visibleRowCount: function() {
|
|
|
|
var divHeight = this.getHeight();
|
|
|
|
var visibleRowCount = Math.ceil(divHeight/this.rowHeight);
|
|
|
|
|
|
|
|
return visibleRowCount;
|
|
|
|
},
|
|
|
|
|
|
|
|
firstVisibleRowIndex: function() {
|
|
|
|
var firstRowIndex = Math.floor(this.scrollTop/this.rowHeight);
|
|
|
|
|
|
|
|
return firstRowIndex;
|
|
|
|
},
|
|
|
|
|
2010-11-03 21:53:13 +01:00
|
|
|
refresh: function() {
|
|
|
|
this.render(true);
|
|
|
|
},
|
|
|
|
|
|
|
|
render: function(refresh) {
|
|
|
|
// Setting "refresh" to true will force the call to getData which
|
|
|
|
// recomputes the top and bottom padding with respect to the total
|
|
|
|
// number of rows.
|
2010-05-27 16:41:59 +02:00
|
|
|
var index = this.firstVisibleRowIndex();
|
|
|
|
var count = this.visibleRowCount();
|
|
|
|
// Overflow the query to the maximum defined in the class variable overflow
|
|
|
|
var start = index - (this.overflow/2);
|
|
|
|
if (start < 0) start = 0;
|
|
|
|
var end = index + count + this.overflow - (index - start);
|
2010-11-03 21:53:13 +01:00
|
|
|
// log ("DataTable.render() from " + index + " to " + (index + count) + " boosted from " + start + " to " + end);
|
2010-05-27 16:41:59 +02:00
|
|
|
|
|
|
|
// Don't overflow above the maximum number of entries from the data source
|
2010-06-25 21:58:30 +02:00
|
|
|
//if (this.dataSource.uids && this.dataSource.uids.length < end) end = this.dataSource.uids.length;
|
2010-05-27 16:41:59 +02:00
|
|
|
|
|
|
|
index = start;
|
|
|
|
count = end - start;
|
|
|
|
|
|
|
|
this.currentRenderID = index + "-" + count;
|
2010-11-05 22:32:00 +01:00
|
|
|
|
2010-05-27 16:41:59 +02:00
|
|
|
// Query the data source only if at least one row is not loaded
|
2010-11-03 21:53:13 +01:00
|
|
|
if (refresh === true ||
|
|
|
|
this.renderedIndex < 0 ||
|
2010-05-27 16:41:59 +02:00
|
|
|
this.renderedIndex > index ||
|
|
|
|
this.renderedCount < count ||
|
|
|
|
(index + count) > (this.renderedIndex + this.renderedCount)) {
|
|
|
|
this.dataSource.getData(this.currentRenderID,
|
|
|
|
index,
|
|
|
|
count,
|
2010-11-05 22:32:00 +01:00
|
|
|
(refresh === true)?this._refresh.bind(this):this._render.bind(this),
|
2010-05-27 16:41:59 +02:00
|
|
|
this.renderDelay);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
2010-11-05 22:32:00 +01:00
|
|
|
_refresh: function(renderID, start, max, data) {
|
|
|
|
this._render(renderID, start, max, data, true);
|
|
|
|
},
|
|
|
|
|
|
|
|
_render: function(renderID, start, max, data, refresh) {
|
2010-05-27 16:41:59 +02:00
|
|
|
if (this.currentRenderID != renderID) {
|
|
|
|
// log ("DataTable._render() ignore render for " + renderID + " (current is " + this.currentRenderID + ")");
|
|
|
|
return;
|
|
|
|
}
|
2010-11-03 21:53:13 +01:00
|
|
|
// log("DataTable._render() for " + data.length + " uids (from " + start + ", max " + max + ")");
|
2010-05-27 16:41:59 +02:00
|
|
|
|
|
|
|
var h, i, j;
|
|
|
|
var rows = this.body.select("tr");
|
|
|
|
var scroll;
|
|
|
|
|
|
|
|
scroll = this.scrollTop;
|
|
|
|
|
|
|
|
h = start * this.rowHeight;
|
|
|
|
if (Prototype.Browser.IE)
|
|
|
|
this.rowTop.setStyle({ 'height': h + 'px', 'line-height': h + 'px' });
|
|
|
|
this.rowTop.firstChild.setStyle({ 'height': h + 'px', 'line-height': h + 'px' });
|
|
|
|
|
|
|
|
h = (max - start - data.length) * this.rowHeight;
|
|
|
|
if (Prototype.Browser.IE)
|
|
|
|
this.rowBottom.setStyle({ 'height': h + 'px', 'line-height': h + 'px' });
|
|
|
|
this.rowBottom.firstChild.setStyle({ 'height': h + 'px', 'line-height': h + 'px' });
|
|
|
|
|
|
|
|
if (this.renderedIndex < 0) {
|
|
|
|
this.renderedIndex = 0;
|
|
|
|
this.renderedCount = 0;
|
|
|
|
}
|
|
|
|
|
2010-11-05 22:32:00 +01:00
|
|
|
if (refresh === true ||
|
|
|
|
start > (this.renderedIndex + this.renderedCount) ||
|
2010-05-27 16:41:59 +02:00
|
|
|
start + data.length < this.renderedIndex) {
|
|
|
|
// No reusable row in the viewport;
|
|
|
|
// refresh the complete view port
|
|
|
|
for (i = 0, j = start;
|
|
|
|
i < this.renderedCount && i < data.length;
|
|
|
|
i++, j++) {
|
|
|
|
// Render all existing rows with new data
|
|
|
|
var row = rows[i+1]; // must skip the first row (this.rowTop)
|
|
|
|
this.rowRenderCallback(row, data[i], false);
|
|
|
|
}
|
|
|
|
|
|
|
|
for (i = this.renderedCount;
|
|
|
|
i < data.length;
|
|
|
|
i++, j++) {
|
|
|
|
// Add new rows, if necessary
|
|
|
|
var row = this.rowModel.cloneNode(true);
|
|
|
|
this.rowRenderCallback(row, data[i], true);
|
|
|
|
row.show();
|
|
|
|
this.body.insertBefore(row, this.rowBottom);
|
|
|
|
}
|
|
|
|
|
|
|
|
for (i = this.renderedCount;
|
|
|
|
i > data.length;
|
|
|
|
i--) {
|
|
|
|
// Delete extra rows, if necessary
|
|
|
|
this.body.removeChild(rows[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else if (start >= this.renderedIndex) {
|
|
|
|
// Scrolling down
|
|
|
|
|
|
|
|
// Delete top rows
|
|
|
|
for (i = start; i > this.renderedIndex; i--) {
|
|
|
|
this.body.removeChild(rows[i - this.renderedIndex]);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add bottom rows
|
|
|
|
for (j = this.renderedIndex + this.renderedCount - start, i = this.renderedIndex + this.renderedCount;
|
|
|
|
j < data.length;
|
|
|
|
j++, i++) {
|
|
|
|
var row = this.rowModel.cloneNode(true);
|
|
|
|
this.rowRenderCallback(row, data[j], true);
|
|
|
|
row.show();
|
|
|
|
this.body.insertBefore(row, this.rowBottom);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
// Scrolling up
|
|
|
|
|
|
|
|
// Delete bottom rows
|
|
|
|
for (i = this.renderedIndex + this.renderedCount, j = this.renderedCount;
|
|
|
|
i > (start + data.length);
|
|
|
|
i--, j--) {
|
|
|
|
this.body.removeChild(rows[j]);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Add top rows
|
|
|
|
for (i = 0, j = start;
|
|
|
|
j < this.renderedIndex;
|
|
|
|
i++, j++) {
|
|
|
|
var row = this.rowModel.cloneNode(true);
|
|
|
|
this.rowRenderCallback(row, data[i], true);
|
|
|
|
row.show();
|
|
|
|
this.body.insertBefore(row, rows[1]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-06-25 21:58:30 +02:00
|
|
|
// Update references to selected rows
|
2010-05-27 16:41:59 +02:00
|
|
|
this.body.refreshSelectionByIds();
|
2010-06-25 23:30:38 +02:00
|
|
|
// log ("DataTable._render() top gap/bottom gap/total rows = " + this.rowTop.getStyle('height') + "/" + this.rowBottom.getStyle('height') + "/" + this.body.select("tr").length + " (height = " + this.down("table").getHeight() + "px)");
|
2010-05-27 16:41:59 +02:00
|
|
|
|
|
|
|
// Save current rendered view index and count
|
|
|
|
this.renderedIndex = start;
|
|
|
|
this.renderedCount = data.length;
|
|
|
|
|
|
|
|
// Restore scroll position (necessary in certain cases)
|
|
|
|
this.scrollTop = scroll;
|
|
|
|
|
|
|
|
Event.fire(this, "datatable:rendered", max);
|
|
|
|
},
|
|
|
|
|
2010-06-25 21:58:30 +02:00
|
|
|
invalidate: function(uid, withoutRefresh) {
|
|
|
|
// Refetch the data for uid. Only refresh the data table if
|
|
|
|
// necessary.
|
|
|
|
var index = this.dataSource.invalidate(uid);
|
|
|
|
this.currentRenderID = index + "-" + 1;
|
|
|
|
this.dataSource.getData(this.currentRenderID,
|
|
|
|
index,
|
|
|
|
1,
|
|
|
|
(withoutRefresh?false:this._invalidate.bind(this)),
|
|
|
|
0);
|
|
|
|
},
|
|
|
|
|
|
|
|
_invalidate: function(renderID, start, max, data) {
|
|
|
|
if (renderID == this.currentRenderID) {
|
|
|
|
var rows = this.body.select("TR#" + data[0]['rowID']);
|
|
|
|
if (rows.length > 0)
|
|
|
|
this.rowRenderCallback(rows[0], data[0], false);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
2010-05-27 16:41:59 +02:00
|
|
|
remove: function(uid) {
|
|
|
|
var rows = this.body.select("TR#row_" + uid);
|
|
|
|
if (rows.length == 1) {
|
|
|
|
var row = rows.first();
|
2010-11-03 21:53:13 +01:00
|
|
|
row.deselect();
|
2010-05-27 16:41:59 +02:00
|
|
|
row.parentNode.removeChild(row);
|
|
|
|
}
|
2010-11-03 21:53:13 +01:00
|
|
|
var index = this.dataSource.remove(uid);
|
|
|
|
// log ("DataTable.remove(" + uid + ") at index " + index);
|
2010-11-05 22:32:00 +01:00
|
|
|
if (index >= 0) {
|
|
|
|
if (this.renderedIndex > index)
|
|
|
|
this.renderedIndex--;
|
|
|
|
else if ((this.renderedIndex + this.renderedCount) > index)
|
|
|
|
this.renderedCount--;
|
|
|
|
}
|
2010-11-03 21:53:13 +01:00
|
|
|
return index;
|
2010-05-27 16:41:59 +02:00
|
|
|
},
|
|
|
|
|
|
|
|
_emptyTable: function() {
|
|
|
|
var rows = this.body.select("tr");
|
|
|
|
var currentCount = rows.length;
|
|
|
|
|
|
|
|
for (var i = currentCount - 1; i >= 0; i--) {
|
|
|
|
if (rows[i] != this.rowModel &&
|
|
|
|
rows[i] != this.rowTop &&
|
|
|
|
rows[i] != this.rowBottom)
|
|
|
|
this.body.removeChild(rows[i]);
|
|
|
|
}
|
|
|
|
|
|
|
|
this.renderedIndex = -1;
|
|
|
|
this.renderedCount = 0;
|
|
|
|
this.rowTop.firstChild.setStyle({ 'height': '0px', 'line-height': '0px' });
|
|
|
|
this.rowBottom.firstChild.setStyle({ 'height': '0px', 'line-height': '0px' });
|
|
|
|
}
|
|
|
|
};
|