/**
* The DataTable widget provides a progressively enhanced DHTML control for
* displaying tabular data across A-grade browsers.
*
* @module datatable
* @requires yahoo, dom, event, datasource
* @optional dragdrop
* @title DataTable Widget
* @beta
*/
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/**
* DataTable class for the YUI DataTable widget.
*
* @namespace YAHOO.widget
* @class DataTable
* @uses YAHOO.util.EventProvider
* @constructor
* @param elContainer {HTMLElement} Container element for the TABLE.
* @param aColumnDefs {Object[]} Array of object literal Column definitions.
* @param oDataSource {YAHOO.util.DataSource} DataSource instance.
* @param oConfigs {object} (optional) Object literal of configuration values.
*/
YAHOO.widget.DataTable = function(elContainer,aColumnDefs,oDataSource,oConfigs) {
// Internal vars
this._nIndex = YAHOO.widget.DataTable._nCount;
this._sName = "instance" + this._nIndex;
this.id = "yui-dt"+this._nIndex;
// Initialize container element
this._initContainerEl(elContainer);
if(!this._elContainer) {
YAHOO.log("Could not instantiate DataTable due to an invalid container element", "error", this.toString());
return;
}
// Initialize configs
this._initConfigs(oConfigs);
// Initialize ColumnSet
this._initColumnSet(aColumnDefs);
if(!this._oColumnSet) {
YAHOO.log("Could not instantiate DataTable due to an invalid ColumnSet", "error", this.toString());
return;
}
// Initialize RecordSet
this._initRecordSet();
if(!this._oRecordSet) {
YAHOO.log("Could not instantiate DataTable due to an invalid RecordSet", "error", this.toString());
return;
}
// Initialize DataSource
this._initDataSource(oDataSource);
if(!this._oDataSource) {
YAHOO.log("Could not instantiate DataTable due to an invalid DataSource", "error", this.toString());
return;
}
// Progressive enhancement special case
if(this._oDataSource.dataType == YAHOO.util.DataSource.TYPE_HTMLTABLE) {
this._oDataSource.sendRequest(this.get("initialRequest"), this._onDataReturnEnhanceTable, this);
}
else {
// Initialize DOM elements
this._initTableEl();
if(!this._elTable || !this._elThead || !this._elTbody) {
YAHOO.log("Could not instantiate DataTable due to an invalid DOM elements", "error", this.toString());
return;
}
// Call Element's constructor after DOM elements are created
// but *before* table is populated with data
YAHOO.widget.DataTable.superclass.constructor.call(this, this._elContainer, this._oConfigs);
//HACK: Set the Paginator values here via updatePaginator
if(this._oConfigs && this._oConfigs.paginator) {
this.updatePaginator(this._oConfigs.paginator);
}
// Send out for data in an asynchronous request
this._oDataSource.sendRequest(this.get("initialRequest"), this.onDataReturnInitializeTable, this);
}
// Initialize inline Cell editing
this._initCellEditorEl();
// Initialize Column sort
this._initColumnSort();
// Initialize DOM event listeners
this._initDomEvents();
YAHOO.widget.DataTable._nCount++;
YAHOO.log("DataTable initialized", "info", this.toString());
};
if(YAHOO.util.Element) {
YAHOO.lang.extend(YAHOO.widget.DataTable, YAHOO.util.Element);
}
else {
YAHOO.log("Missing dependency: YAHOO.util.Element","error",this.toString());
}
/////////////////////////////////////////////////////////////////////////////
//
// Superclass methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Implementation of Element's abstract method. Sets up config values.
*
* @method initAttributes
* @param oConfigs {Object} (Optional) Object literal definition of configuration values.
* @private
*/
YAHOO.widget.DataTable.prototype.initAttributes = function(oConfigs) {
oConfigs = oConfigs || {};
YAHOO.widget.DataTable.superclass.initAttributes.call(this, oConfigs);
/**
* @attribute summary
* @description Value for the SUMMARY attribute.
* @type String
*/
this.setAttributeConfig("summary", {
value: null,
validator: YAHOO.lang.isString,
method: function(sSummary) {
this._elTable.summary = sSummary;
}
});
/**
* @attribute selectionMode
* @description Specifies row or cell selection mode. Accepts the following strings:
* <dl>
* <dt>"standard"</dt>
* <dd>Standard row selection with support for modifier keys to enable
* multiple selections.</dd>
*
* <dt>"single"</dt>
* <dd>Row selection with modifier keys disabled to not allow
* multiple selections.</dd>
*
* <dt>"singlecell"</dt>
* <dd>Cell selection with modifier keys disabled to not allow
* multiple selections.</dd>
*
* <dt>"cellblock"</dt>
* <dd>Cell selection with support for modifier keys to enable multiple
* selections in a block-fashion, like a spreadsheet.</dd>
*
* <dt>"cellrange"</dt>
* <dd>Cell selection with support for modifier keys to enable multiple
* selections in a range-fashion, like a calendar.</dd>
* </dl>
*
* @default "standard"
* @type String
*/
this.setAttributeConfig("selectionMode", {
value: "standard",
validator: YAHOO.lang.isString
});
/**
* @attribute initialRequest
* @description Defines the initial request that gets sent to the DataSource.
* @type String
*/
this.setAttributeConfig("initialRequest", {
value: "",
validator: YAHOO.lang.isString
});
/**
* @attribute sortedBy
* @description Object literal provides metadata for initial sort values if
* data will arrive pre-sorted:
* <dl>
* <dt>sortedBy.key</dt>
* <dd>{String} Key of sorted Column</dd>
* <dt>sortedBy.dir</dt>
* <dd>{String} Initial sort direction, either "asc" or "desc"</dd>
* </dl>
* @type Object
*/
this.setAttributeConfig("sortedBy", {
value: null,
// TODO: accepted array for nested sorts
validator: function(oNewSortedBy) {
return (oNewSortedBy && (oNewSortedBy.constructor == Object) && oNewSortedBy.key);
},
method: function(oNewSortedBy) {
// Remove ASC/DESC from TH
var oOldSortedBy = this.get("sortedBy");
if(oOldSortedBy && (oOldSortedBy.constructor == Object) && oOldSortedBy.key) {
var oldColumn = this._oColumnSet.getColumn(oOldSortedBy.key);
var oldThEl = this.getThEl(oldColumn);
YAHOO.util.Dom.removeClass(oldThEl, YAHOO.widget.DataTable.CLASS_ASC);
YAHOO.util.Dom.removeClass(oldThEl, YAHOO.widget.DataTable.CLASS_DESC);
}
// Set ASC/DESC on TH
var column = (oNewSortedBy.column) ? oNewSortedBy.column : this._oColumnSet.getColumn(oNewSortedBy.key);
if(column) {
var newClass = (oNewSortedBy.dir && (oNewSortedBy.dir != "asc")) ?
YAHOO.widget.DataTable.CLASS_DESC :
YAHOO.widget.DataTable.CLASS_ASC;
YAHOO.util.Dom.addClass(this.id + "-col" + column.getId(), newClass);
}
}
});
/**
* @attribute paginator
* @description Object literal of pagination values.
* @default <br>
* { containers:[], // UI container elements <br>
* rowsPerPage:500, // 500 rows <br>
* currentPage:1, // page one <br>
* pageLinks:0, // show all links <br>
* pageLinksStart:1, // first link is page 1 <br>
* dropdownOptions:null, // no dropdown <br>
* links: [], // links elements <br>
* dropdowns: [] } //dropdown elements
*
* @type Object
*/
this.setAttributeConfig("paginator", {
value: {
rowsPerPage:500, // 500 rows per page
currentPage:1, // show page one
startRecordIndex:0, // start with first Record
totalRecords:0, // how many Records total
totalPages:0, // how many pages total
rowsThisPage:0, // how many rows this page
pageLinks:0, // show all links
pageLinksStart:1, // first link is page 1
dropdownOptions: null, //no dropdown
containers:[], // Paginator container element references
dropdowns: [], //dropdown element references,
links: [] // links elements
},
validator: function(oNewPaginator) {
if(oNewPaginator && (oNewPaginator.constructor == Object)) {
// Check for incomplete set of values
if((oNewPaginator.rowsPerPage !== undefined) &&
(oNewPaginator.currentPage !== undefined) &&
(oNewPaginator.startRecordIndex !== undefined) &&
(oNewPaginator.totalRecords !== undefined) &&
(oNewPaginator.totalPages !== undefined) &&
(oNewPaginator.rowsThisPage !== undefined) &&
(oNewPaginator.pageLinks !== undefined) &&
(oNewPaginator.pageLinksStart !== undefined) &&
(oNewPaginator.dropdownOptions !== undefined) &&
(oNewPaginator.containers !== undefined) &&
(oNewPaginator.dropdowns !== undefined) &&
(oNewPaginator.links !== undefined)) {
// Validate each value
if(YAHOO.lang.isNumber(oNewPaginator.rowsPerPage) &&
YAHOO.lang.isNumber(oNewPaginator.currentPage) &&
YAHOO.lang.isNumber(oNewPaginator.startRecordIndex) &&
YAHOO.lang.isNumber(oNewPaginator.totalRecords) &&
YAHOO.lang.isNumber(oNewPaginator.totalPages) &&
YAHOO.lang.isNumber(oNewPaginator.rowsThisPage) &&
YAHOO.lang.isNumber(oNewPaginator.pageLinks) &&
YAHOO.lang.isNumber(oNewPaginator.pageLinksStart) &&
YAHOO.lang.isArray(oNewPaginator.dropdownOptions) &&
YAHOO.lang.isArray(oNewPaginator.containers) &&
YAHOO.lang.isArray(oNewPaginator.dropdowns) &&
YAHOO.lang.isArray(oNewPaginator.links)) {
return true;
}
}
}
return false;
}
});
/**
* @attribute paginated
* @description True if built-in client-side pagination is enabled
* @default false
* @type Boolean
*/
this.setAttributeConfig("paginated", {
value: false,
validator: YAHOO.lang.isBoolean,
method: function(oParam) {
var oPaginator = this.get("paginator");
var aContainerEls = oPaginator.containers;
var i;
// Paginator is enabled
if(oParam) {
// No containers found, create two from scratch
if(aContainerEls.length === 0) {
// One before TABLE
var pag0 = document.createElement("span");
pag0.id = this.id + "-paginator0";
YAHOO.util.Dom.addClass(pag0, YAHOO.widget.DataTable.CLASS_PAGINATOR);
pag0 = this._elContainer.insertBefore(pag0, this._elTable);
aContainerEls.push(pag0);
// One after TABLE
var pag1 = document.createElement("span");
pag1.id = this.id + "-paginator1";
YAHOO.util.Dom.addClass(pag1, YAHOO.widget.DataTable.CLASS_PAGINATOR);
pag1 = this._elContainer.insertBefore(pag1, this._elTable.nextSibling);
aContainerEls.push(pag1);
// Add containers directly to tracker
this._configs.paginator.value.containers = [pag0, pag1];
}
else {
// Show each container
for(i=0; i<aContainerEls.length; i++) {
aContainerEls[i].style.display = "";
}
}
// Links are enabled
if(oPaginator.pageLinks > -1) {
var aLinkEls = oPaginator.links;
// No links containers found, create from scratch
if(aLinkEls.length === 0) {
for(i=0; i<aContainerEls.length; i++) {
// Create one links container per Paginator container
var linkEl = document.createElement("span");
linkEl.id = "yui-dt-pagselect"+i;
linkEl = aContainerEls[i].appendChild(linkEl);
// Add event listener
//TODO: anon fnc
YAHOO.util.Event.addListener(linkEl,"click",this._onPaginatorLinkClick,this);
// Add directly to tracker
this._configs.paginator.value.links.push(linkEl);
}
}
}
// Show these options in the dropdown
var dropdownOptions = oPaginator.dropdownOptions || [];
for(i=0; i<aContainerEls.length; i++) {
// Create one SELECT element per Paginator container
var selectEl = document.createElement("select");
YAHOO.util.Dom.addClass(selectEl, YAHOO.widget.DataTable.CLASS_DROPDOWN);
selectEl = aContainerEls[i].appendChild(selectEl);
selectEl.id = "yui-dt-pagselect"+i;
// Add event listener
//TODO: anon fnc
YAHOO.util.Event.addListener(selectEl,"change",this._onPaginatorDropdownChange,this);
// Add DOM reference directly to tracker
this._configs.paginator.value.dropdowns.push(selectEl);
// Hide dropdown
if(!oPaginator.dropdownOptions) {
selectEl.style.display = "none";
}
}
//TODO: fire paginatorDisabledEvent & add to api doc
YAHOO.log("Paginator enabled", "info", this.toString());
}
// Pagination is disabled
else {
// Containers found
if(aContainerEls.length > 0) {
// Destroy or just hide?
// Hide each container
for(i=0; i<aContainerEls.length; i++) {
aContainerEls[i].style.display = "none";
}
/*TODO?
// Destroy each container
for(i=0; i<aContainerEls.length; i++) {
YAHOO.util.Event.purgeElement(aContainerEls[i], true);
aContainerEls.innerHTML = null;
//TODO: remove container?
// aContainerEls[i].parentNode.removeChild(aContainerEls[i]);
}
*/
}
//TODO: fire paginatorDisabledEvent & add to api doc
YAHOO.log("Paginator disabled", "info", this.toString());
}
}
});
/**
* @attribute caption
* @description Value for the CAPTION element.
* @type String
*/
this.setAttributeConfig("caption", {
value: null,
validator: YAHOO.lang.isString,
method: function(sCaption) {
// Create CAPTION element
if(!this._elCaption) {
if(!this._elTable.firstChild) {
this._elCaption = this._elTable.appendChild(document.createElement("caption"));
}
else {
this._elCaption = this._elTable.insertBefore(document.createElement("caption"), this._elTable.firstChild);
}
}
// Set CAPTION value
this._elCaption.innerHTML = sCaption;
}
});
/**
* @attribute scrollable
* @description True if primary TBODY should scroll while THEAD remains fixed.
* When enabling this feature, captions cannot be used, and the following
* features are not recommended: inline editing, resizeable columns.
* @default false
* @type Boolean
*/
this.setAttributeConfig("scrollable", {
value: false,
validator: function(oParam) {
//TODO: validate agnst resizeable
return (YAHOO.lang.isBoolean(oParam) &&
// Not compatible with caption
!YAHOO.lang.isString(this.get("caption")));
},
method: function(oParam) {
if(oParam) {
//TODO: conf height
YAHOO.util.Dom.addClass(this._elContainer,YAHOO.widget.DataTable.CLASS_SCROLLABLE);
YAHOO.util.Dom.addClass(this._elTbody,YAHOO.widget.DataTable.CLASS_SCROLLBODY);
}
else {
YAHOO.util.Dom.removeClass(this._elContainer,YAHOO.widget.DataTable.CLASS_SCROLLABLE);
YAHOO.util.Dom.removeClass(this._elTbody,YAHOO.widget.DataTable.CLASS_SCROLLBODY);
}
}
});
};
/////////////////////////////////////////////////////////////////////////////
//
// Public constants
//
/////////////////////////////////////////////////////////////////////////////
/**
* Class name assigned to TABLE element.
*
* @property DataTable.CLASS_TABLE
* @type String
* @static
* @final
* @default "yui-dt-table"
*/
YAHOO.widget.DataTable.CLASS_TABLE = "yui-dt-table";
/**
* Class name assigned to header container elements within each TH element.
*
* @property DataTable.CLASS_HEADER
* @type String
* @static
* @final
* @default "yui-dt-header"
*/
YAHOO.widget.DataTable.CLASS_HEADER = "yui-dt-header";
/**
* Class name assigned to the primary TBODY element.
*
* @property DataTable.CLASS_BODY
* @type String
* @static
* @final
* @default "yui-dt-body"
*/
YAHOO.widget.DataTable.CLASS_BODY = "yui-dt-body";
/**
* Class name assigned to the scrolling TBODY element of a fixed scrolling DataTable.
*
* @property DataTable.CLASS_SCROLLBODY
* @type String
* @static
* @final
* @default "yui-dt-scrollbody"
*/
YAHOO.widget.DataTable.CLASS_SCROLLBODY = "yui-dt-scrollbody";
/**
* Class name assigned to display label elements.
*
* @property DataTable.CLASS_LABEL
* @type String
* @static
* @final
* @default "yui-dt-label"
*/
YAHOO.widget.DataTable.CLASS_LABEL = "yui-dt-label";
/**
* Class name assigned to resizer handle elements.
*
* @property DataTable.CLASS_RESIZER
* @type String
* @static
* @final
* @default "yui-dt-resizer"
*/
YAHOO.widget.DataTable.CLASS_RESIZER = "yui-dt-resizer";
/**
* Class name assigned to Editor container elements.
*
* @property DataTable.CLASS_EDITOR
* @type String
* @static
* @final
* @default "yui-dt-editor"
*/
YAHOO.widget.DataTable.CLASS_EDITOR = "yui-dt-editor";
/**
* Class name assigned to paginator container elements.
*
* @property DataTable.CLASS_PAGINATOR
* @type String
* @static
* @final
* @default "yui-dt-paginator"
*/
YAHOO.widget.DataTable.CLASS_PAGINATOR = "yui-dt-paginator";
/**
* Class name assigned to page number indicators.
*
* @property DataTable.CLASS_PAGE
* @type String
* @static
* @final
* @default "yui-dt-page"
*/
YAHOO.widget.DataTable.CLASS_PAGE = "yui-dt-page";
/**
* Class name assigned to default indicators.
*
* @property DataTable.CLASS_DEFAULT
* @type String
* @static
* @final
* @default "yui-dt-default"
*/
YAHOO.widget.DataTable.CLASS_DEFAULT = "yui-dt-default";
/**
* Class name assigned to previous indicators.
*
* @property DataTable.CLASS_PREVIOUS
* @type String
* @static
* @final
* @default "yui-dt-previous"
*/
YAHOO.widget.DataTable.CLASS_PREVIOUS = "yui-dt-previous";
/**
* Class name assigned next indicators.
*
* @property DataTable.CLASS_NEXT
* @type String
* @static
* @final
* @default "yui-dt-next"
*/
YAHOO.widget.DataTable.CLASS_NEXT = "yui-dt-next";
/**
* Class name assigned to first elements.
*
* @property DataTable.CLASS_FIRST
* @type String
* @static
* @final
* @default "yui-dt-first"
*/
YAHOO.widget.DataTable.CLASS_FIRST = "yui-dt-first";
/**
* Class name assigned to last elements.
*
* @property DataTable.CLASS_LAST
* @type String
* @static
* @final
* @default "yui-dt-last"
*/
YAHOO.widget.DataTable.CLASS_LAST = "yui-dt-last";
/**
* Class name assigned to even elements.
*
* @property DataTable.CLASS_EVEN
* @type String
* @static
* @final
* @default "yui-dt-even"
*/
YAHOO.widget.DataTable.CLASS_EVEN = "yui-dt-even";
/**
* Class name assigned to odd elements.
*
* @property DataTable.CLASS_ODD
* @type String
* @static
* @final
* @default "yui-dt-odd"
*/
YAHOO.widget.DataTable.CLASS_ODD = "yui-dt-odd";
/**
* Class name assigned to selected elements.
*
* @property DataTable.CLASS_SELECTED
* @type String
* @static
* @final
* @default "yui-dt-selected"
*/
YAHOO.widget.DataTable.CLASS_SELECTED = "yui-dt-selected";
/**
* Class name assigned to highlighted elements.
*
* @property DataTable.CLASS_HIGHLIGHTED
* @type String
* @static
* @final
* @default "yui-dt-highlighted"
*/
YAHOO.widget.DataTable.CLASS_HIGHLIGHTED = "yui-dt-highlighted";
/**
* Class name assigned to disabled elements.
*
* @property DataTable.CLASS_DISABLED
* @type String
* @static
* @final
* @default "yui-dt-disabled"
*/
YAHOO.widget.DataTable.CLASS_DISABLED = "yui-dt-disabled";
/**
* Class name assigned to empty indicators.
*
* @property DataTable.CLASS_EMPTY
* @type String
* @static
* @final
* @default "yui-dt-empty"
*/
YAHOO.widget.DataTable.CLASS_EMPTY = "yui-dt-empty";
/**
* Class name assigned to loading indicatorx.
*
* @property DataTable.CLASS_LOADING
* @type String
* @static
* @final
* @default "yui-dt-loading"
*/
YAHOO.widget.DataTable.CLASS_LOADING = "yui-dt-loading";
/**
* Class name assigned to error indicators.
*
* @property DataTable.CLASS_ERROR
* @type String
* @static
* @final
* @default "yui-dt-error"
*/
YAHOO.widget.DataTable.CLASS_ERROR = "yui-dt-error";
/**
* Class name assigned to editable elements.
*
* @property DataTable.CLASS_EDITABLE
* @type String
* @static
* @final
* @default "yui-dt-editable"
*/
YAHOO.widget.DataTable.CLASS_EDITABLE = "yui-dt-editable";
/**
* Class name assigned to scrollable elements.
*
* @property DataTable.CLASS_SCROLLABLE
* @type String
* @static
* @final
* @default "yui-dt-scrollable"
*/
YAHOO.widget.DataTable.CLASS_SCROLLABLE = "yui-dt-scrollable";
/**
* Class name assigned to sortable elements.
*
* @property DataTable.CLASS_SORTABLE
* @type String
* @static
* @final
* @default "yui-dt-sortable"
*/
YAHOO.widget.DataTable.CLASS_SORTABLE = "yui-dt-sortable";
/**
* Class name assigned to ascending elements.
*
* @property DataTable.CLASS_ASC
* @type String
* @static
* @final
* @default "yui-dt-asc"
*/
YAHOO.widget.DataTable.CLASS_ASC = "yui-dt-asc";
/**
* Class name assigned to descending elements.
*
* @property DataTable.CLASS_DESC
* @type String
* @static
* @final
* @default "yui-dt-desc"
*/
YAHOO.widget.DataTable.CLASS_DESC = "yui-dt-desc";
/**
* Class name assigned to BUTTON elements and/or container elements.
*
* @property DataTable.CLASS_BUTTON
* @type String
* @static
* @final
* @default "yui-dt-button"
*/
YAHOO.widget.DataTable.CLASS_BUTTON = "yui-dt-button";
/**
* Class name assigned to INPUT TYPE=CHECKBOX elements and/or container elements.
*
* @property DataTable.CLASS_CHECKBOX
* @type String
* @static
* @final
* @default "yui-dt-checkbox"
*/
YAHOO.widget.DataTable.CLASS_CHECKBOX = "yui-dt-checkbox";
/**
* Class name assigned to SELECT elements and/or container elements.
*
* @property DataTable.CLASS_DROPDOWN
* @type String
* @static
* @final
* @default "yui-dt-dropdown"
*/
YAHOO.widget.DataTable.CLASS_DROPDOWN = "yui-dt-dropdown";
/**
* Class name assigned to INPUT TYPE=RADIO elements and/or container elements.
*
* @property DataTable.CLASS_RADIO
* @type String
* @static
* @final
* @default "yui-dt-radio"
*/
YAHOO.widget.DataTable.CLASS_RADIO = "yui-dt-radio";
/**
* Message to display if DataTable has no data.
*
* @property DataTable.MSG_EMPTY
* @type String
* @static
* @final
* @default "No records found."
*/
YAHOO.widget.DataTable.MSG_EMPTY = "No records found.";
/**
* Message to display while DataTable is loading data.
*
* @property DataTable.MSG_LOADING
* @type String
* @static
* @final
* @default "Loading data..."
*/
YAHOO.widget.DataTable.MSG_LOADING = "Loading data...";
/**
* Message to display while DataTable has data error.
*
* @property DataTable.MSG_ERROR
* @type String
* @static
* @final
* @default "Data error."
*/
YAHOO.widget.DataTable.MSG_ERROR = "Data error.";
/////////////////////////////////////////////////////////////////////////////
//
// Private member variables
//
/////////////////////////////////////////////////////////////////////////////
/**
* Internal class variable for indexing multiple DataTable instances.
*
* @property DataTable._nCount
* @type Number
* @private
* @static
*/
YAHOO.widget.DataTable._nCount = 0;
/**
* Index assigned to instance.
*
* @property _nIndex
* @type Number
* @private
*/
YAHOO.widget.DataTable.prototype._nIndex = null;
/**
* Counter for IDs assigned to TR elements.
*
* @property _nTrCount
* @type Number
* @private
*/
YAHOO.widget.DataTable.prototype._nTrCount = 0;
/**
* Unique name assigned to instance.
*
* @property _sName
* @type String
* @private
*/
YAHOO.widget.DataTable.prototype._sName = null;
/**
* DOM reference to the container element for the DataTable instance into which
* the TABLE element gets created.
*
* @property _elContainer
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elContainer = null;
/**
* DOM reference to the CAPTION element for the DataTable instance.
*
* @property _elCaption
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elCaption = null;
/**
* DOM reference to the TABLE element for the DataTable instance.
*
* @property _elTable
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elTable = null;
/**
* DOM reference to the THEAD element for the DataTable instance.
*
* @property _elThead
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elThead = null;
/**
* DOM reference to the primary TBODY element for the DataTable instance.
*
* @property _elTbody
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elTbody = null;
/**
* DOM reference to the secondary TBODY element used to display DataTable messages.
*
* @property _elMsgTbody
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elMsgTbody = null;
/**
* DOM reference to the secondary TBODY element's single TR element used to display DataTable messages.
*
* @property _elMsgTbodyRow
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elMsgTbodyRow = null;
/**
* DOM reference to the secondary TBODY element's single TD element used to display DataTable messages.
*
* @property _elMsgTbodyCell
* @type HTMLElement
* @private
*/
YAHOO.widget.DataTable.prototype._elMsgTbodyCell = null;
/**
* DataSource instance for the DataTable instance.
*
* @property _oDataSource
* @type YAHOO.util.DataSource
* @private
*/
YAHOO.widget.DataTable.prototype._oDataSource = null;
/**
* ColumnSet instance for the DataTable instance.
*
* @property _oColumnSet
* @type YAHOO.widget.ColumnSet
* @private
*/
YAHOO.widget.DataTable.prototype._oColumnSet = null;
/**
* RecordSet instance for the DataTable instance.
*
* @property _oRecordSet
* @type YAHOO.widget.RecordSet
* @private
*/
YAHOO.widget.DataTable.prototype._oRecordSet = null;
/**
* ID string of first label link element of the current DataTable page, if any.
* Used for focusing sortable Columns with TAB.
*
* @property _sFirstLabelLinkId
* @type String
* @private
*/
YAHOO.widget.DataTable.prototype._sFirstLabelLinkId = null;
/**
* ID string of first TR element of the current DataTable page.
*
* @property _sFirstTrId
* @type String
* @private
*/
YAHOO.widget.DataTable.prototype._sFirstTrId = null;
/**
* ID string of the last TR element of the current DataTable page.
*
* @property _sLastTrId
* @type String
* @private
*/
YAHOO.widget.DataTable.prototype._sLastTrId = null;
/////////////////////////////////////////////////////////////////////////////
//
// Private methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Sets focus on the given element.
*
* @method _focusEl
* @param el {HTMLElement} Element.
* @private
*/
YAHOO.widget.DataTable.prototype._focusEl = function(el) {
el = el || this._elTable;
// http://developer.mozilla.org/en/docs/index.php?title=Key-navigable_custom_DHTML_widgets
// The timeout is necessary in both IE and Firefox 1.5, to prevent scripts from doing
// strange unexpected things as the user clicks on buttons and other controls.
setTimeout(function() { el.focus(); },0);
};
// INIT FUNCTIONS
/**
* Initializes container element.
*
* @method _initContainerEl
* @param elContainer {HTMLElement | String} HTML DIV element by reference or ID.
* @private
*/
YAHOO.widget.DataTable.prototype._initContainerEl = function(elContainer) {
this._elContainer = null;
elContainer = YAHOO.util.Dom.get(elContainer);
if(elContainer && elContainer.tagName && (elContainer.tagName.toLowerCase() == "div")) {
this._elContainer = elContainer;
}
};
/**
* Initializes object literal of config values.
*
* @method _initConfigs
* @param oConfig {Object} Object literal of config values.
* @private
*/
YAHOO.widget.DataTable.prototype._initConfigs = function(oConfigs) {
if(oConfigs) {
if(oConfigs.constructor != Object) {
oConfigs = null;
YAHOO.log("Invalid configs", "warn", this.toString());
}
// Backward compatibility
else if(YAHOO.lang.isBoolean(oConfigs.paginator)) {
YAHOO.log("DataTable's paginator model has been revised" +
" -- please refer to the documentation for implementation" +
" details", "warn", this.toString());
}
this._oConfigs = oConfigs;
}
};
/**
* Initializes ColumnSet.
*
* @method _initColumnSet
* @param aColumnDefs {Object[]} Array of object literal Column definitions.
* @private
*/
YAHOO.widget.DataTable.prototype._initColumnSet = function(aColumnDefs) {
this._oColumnSet = null;
if(YAHOO.lang.isArray(aColumnDefs)) {
this._oColumnSet = new YAHOO.widget.ColumnSet(aColumnDefs);
}
// Backward compatibility
else if(aColumnDefs instanceof YAHOO.widget.ColumnSet) {
this._oColumnSet = aColumnDefs;
YAHOO.log("DataTable's constructor now requires an array" +
" of object literal Column definitions instead of a ColumnSet instance",
"warn", this.toString());
}
};
/**
* Initializes DataSource.
*
* @method _initDataSource
* @param oDataSource {YAHOO.util.DataSource} DataSource instance.
* @private
*/
YAHOO.widget.DataTable.prototype._initDataSource = function(oDataSource) {
this._oDataSource = null;
if(oDataSource && (oDataSource instanceof YAHOO.util.DataSource)) {
this._oDataSource = oDataSource;
}
// Backward compatibility
else {
var tmpTable = null;
var tmpContainer = this._elContainer;
var i;
// Peek in container child nodes to see if TABLE already exists
if(tmpContainer.hasChildNodes()) {
var tmpChildren = tmpContainer.childNodes;
for(i=0; i<tmpChildren.length; i++) {
if(tmpChildren[i].tagName && tmpChildren[i].tagName.toLowerCase() == "table") {
tmpTable = tmpChildren[i];
break;
}
}
if(tmpTable) {
var tmpFieldsArray = [];
for(i=0; i<this._oColumnSet.keys.length; i++) {
tmpFieldsArray.push({key:this._oColumnSet.keys[i].key});
}
this._oDataSource = new YAHOO.util.DataSource(tmpTable);
this._oDataSource.responseType = YAHOO.util.DataSource.TYPE_HTMLTABLE;
this._oDataSource.responseSchema = {fields: tmpFieldsArray};
YAHOO.log("Null DataSource for progressive enhancement from" +
" markup has been deprecated", "warn", this.toString());
}
}
}
};
/**
* Initializes RecordSet.
*
* @method _initRecordSet
* @private
*/
YAHOO.widget.DataTable.prototype._initRecordSet = function() {
if(this._oRecordSet) {
this._oRecordSet.reset();
}
else {
this._oRecordSet = new YAHOO.widget.RecordSet();
}
};
/**
* Creates HTML markup for TABLE, THEAD and TBODY elements.
*
* @method _initTableEl
* @private
*/
YAHOO.widget.DataTable.prototype._initTableEl = function() {
// Clear the container
YAHOO.util.Event.purgeElement(this._elContainer, true);
this._elContainer.innerHTML = "";
// Create TABLE
this._elTable = this._elContainer.appendChild(document.createElement("table"));
var elTable = this._elTable;
elTable.tabIndex = 0;
elTable.id = this.id + "-table";
YAHOO.util.Dom.addClass(elTable, YAHOO.widget.DataTable.CLASS_TABLE);
// Create THEAD
this._initTheadEl(elTable, this._oColumnSet);
// Create TBODY for messages
var elMsgTbody = document.createElement("tbody");
var elMsgRow = elMsgTbody.appendChild(document.createElement("tr"));
YAHOO.util.Dom.addClass(elMsgRow,YAHOO.widget.DataTable.CLASS_FIRST);
YAHOO.util.Dom.addClass(elMsgRow,YAHOO.widget.DataTable.CLASS_LAST);
this._elMsgRow = elMsgRow;
var elMsgCell = elMsgRow.appendChild(document.createElement("td"));
elMsgCell.colSpan = this._oColumnSet.keys.length;
YAHOO.util.Dom.addClass(elMsgCell,YAHOO.widget.DataTable.CLASS_FIRST);
YAHOO.util.Dom.addClass(elMsgCell,YAHOO.widget.DataTable.CLASS_LAST);
this._elMsgTd = elMsgCell;
this._elMsgTbody = elTable.appendChild(elMsgTbody);
this.showTableMessage(YAHOO.widget.DataTable.MSG_LOADING, YAHOO.widget.DataTable.CLASS_LOADING);
// Create TBODY for data
this._elTbody = elTable.appendChild(document.createElement("tbody"));
YAHOO.util.Dom.addClass(this._elTbody,YAHOO.widget.DataTable.CLASS_BODY);
};
/**
* Populates THEAD element with TH cells as defined by ColumnSet.
*
* @method _initTheadEl
* @private
*/
YAHOO.widget.DataTable.prototype._initTheadEl = function() {
var i,oColumn, colId;
var oColumnSet = this._oColumnSet;
this._sFirstLabelLinkId = null;
// Create THEAD
var elThead = document.createElement("thead");
// Iterate through each row of Column headers...
var colTree = oColumnSet.tree;
for(i=0; i<colTree.length; i++) {
var elTheadRow = elThead.appendChild(document.createElement("tr"));
elTheadRow.id = this.id+"-hdrow"+i;
var elTheadCell;
// ...and create THEAD cells
for(var j=0; j<colTree[i].length; j++) {
oColumn = colTree[i][j];
elTheadCell = elTheadRow.appendChild(document.createElement("th"));
elTheadCell.id = this.id+"-col" + oColumn.getId();
this._initThEl(elTheadCell,oColumn,i,j);
}
// Set FIRST/LAST on THEAD rows
if(i === 0) {
YAHOO.util.Dom.addClass(elTheadRow, YAHOO.widget.DataTable.CLASS_FIRST);
}
if(i === (colTree.length-1)) {
YAHOO.util.Dom.addClass(elTheadRow, YAHOO.widget.DataTable.CLASS_LAST);
}
}
this._elThead = this._elTable.appendChild(elThead);
// Set FIRST/LAST on THEAD cells using the values in ColumnSet headers array
var aFirstHeaders = oColumnSet.headers[0];
var aLastHeaders = oColumnSet.headers[oColumnSet.headers.length-1];
for(i=0; i<aFirstHeaders.length; i++) {
YAHOO.util.Dom.addClass(YAHOO.util.Dom.get(this.id+"-col"+aFirstHeaders[i]), YAHOO.widget.DataTable.CLASS_FIRST);
}
for(i=0; i<aLastHeaders.length; i++) {
YAHOO.util.Dom.addClass(YAHOO.util.Dom.get(this.id+"-col"+aLastHeaders[i]), YAHOO.widget.DataTable.CLASS_LAST);
}
// Add Resizer only after DOM has been updated
var foundDD = (YAHOO.util.DD) ? true : false;
var needDD = false;
for(i=0; i<this._oColumnSet.keys.length; i++) {
oColumn = this._oColumnSet.keys[i];
var colKey = oColumn.getKey();
var elTheadCellId = YAHOO.util.Dom.get(this.id + "-col" + oColumn.getId());
if(oColumn.resizeable) {
if(foundDD) {
//TODO: fix fixed width tables
// Skip the last column for fixed-width tables
if(!this.fixedWidth || (this.fixedWidth &&
(oColumn.getKeyIndex() != this._oColumnSet.keys.length-1))) {
// TODO: better way to get elTheadContainer
var elThContainer = YAHOO.util.Dom.getElementsByClassName(YAHOO.widget.DataTable.CLASS_HEADER,"div",elTheadCellId)[0];
var elThResizer = elThContainer.appendChild(document.createElement("span"));
elThResizer.id = this.id + "-resizer-" + colKey;
YAHOO.util.Dom.addClass(elThResizer,YAHOO.widget.DataTable.CLASS_RESIZER);
oColumn.ddResizer = new YAHOO.util.ColumnResizer(
this, oColumn, elTheadCellId, elThResizer.id, elThResizer.id);
var cancelClick = function(e) {
YAHOO.util.Event.stopPropagation(e);
};
YAHOO.util.Event.addListener(elThResizer,"click",cancelClick);
}
if(this.fixedWidth) {
//TODO: fix fixedWidth
//elThContainer.style.overflow = "hidden";
//TODO: better way to get elTheadText
var elThLabel = (YAHOO.util.Dom.getElementsByClassName(YAHOO.widget.DataTable.CLASS_LABEL,"span",elTheadCellId))[0];
elThLabel.style.overflow = "hidden";
}
}
else {
needDD = true;
}
}
}
if(needDD) {
YAHOO.log("Could not find DragDrop dependancy for resizeable Columns", "warn", this.toString());
}
YAHOO.log("Column headers for " + this._oColumnSet.keys.length + " keys created","info",this.toString());
};
/**
* Populates TH cell as defined by Column.
*
* @method _initThEl
* @param elTheadCell {HTMLElement} TH cell element reference.
* @param oColumn {YAHOO.widget.Column} Column object.
* @param row {number} Row index.
* @param col {number} Column index.
* @private
*/
YAHOO.widget.DataTable.prototype._initThEl = function(elTheadCell,oColumn,row,col) {
// Clear out the cell of prior content
// TODO: purgeListeners and other validation-related things
var index = this._nIndex;
var colKey = oColumn.getKey();
var colId = oColumn.getId();
elTheadCell.yuiColumnKey = colKey;
elTheadCell.yuiColumnId = colId;
if(oColumn.abbr) {
elTheadCell.abbr = oColumn.abbr;
}
if(oColumn.width) {
elTheadCell.style.width = oColumn.width;
}
var aCustomClasses;
if(YAHOO.lang.isString(oColumn.className)) {
aCustomClasses = [oColumn.className];
}
else if(YAHOO.lang.isArray(oColumn.className)) {
aCustomClasses = oColumn.className;
}
if(aCustomClasses) {
for(var i=0; i<aCustomClasses.length; i++) {
YAHOO.util.Dom.addClass(elTheadCell,aCustomClasses[i]);
}
}
YAHOO.util.Dom.addClass(elTheadCell, "yui-dt-col-"+colKey);
elTheadCell.innerHTML = "";
elTheadCell.rowSpan = oColumn.getRowspan();
elTheadCell.colSpan = oColumn.getColspan();
var elTheadContainer = elTheadCell.appendChild(document.createElement("div"));
elTheadContainer.id = this.id + "-container" + colId;
YAHOO.util.Dom.addClass(elTheadContainer,YAHOO.widget.DataTable.CLASS_HEADER);
var elTheadLabel = elTheadContainer.appendChild(document.createElement("span"));
elTheadLabel.id = this.id + "-label" + colId;
YAHOO.util.Dom.addClass(elTheadLabel,YAHOO.widget.DataTable.CLASS_LABEL);
var sLabel = YAHOO.lang.isValue(oColumn.label) ? oColumn.label : colKey;
if(oColumn.sortable) {
YAHOO.util.Dom.addClass(elTheadCell,YAHOO.widget.DataTable.CLASS_SORTABLE);
//TODO: Make sortLink customizeable
//TODO: Make title configurable
//TODO: Separate label from an accessibility link that says
// "Click to sort ascending" and push it offscreen
var sLabelLinkId = this.id + "-labellink" + colId;
var sortLink = "?key=" + colKey;
elTheadLabel.innerHTML = "<a id=\"" + sLabelLinkId + "\" href=\"" + sortLink + "\" title=\"Click to sort\" class=\"" + YAHOO.widget.DataTable.CLASS_SORTABLE + "\">" + sLabel + "</a>";
if(!this._sFirstLabelLinkId) {
this._sFirstLabelLinkId = sLabelLinkId;
}
}
else {
elTheadLabel.innerHTML = sLabel;
}
};
/**
* Creates HTML markup for Cell Editor.
*
* @method _initCellEditorEl
* @private
*/
YAHOO.widget.DataTable.prototype._initCellEditorEl = function() {
// Attach Cell Editor container element to body
var elCellEditor = document.createElement("div");
elCellEditor.id = this.id + "-celleditor";
elCellEditor.style.display = "none";
YAHOO.util.Dom.addClass(elCellEditor, YAHOO.widget.DataTable.CLASS_EDITOR);
elCellEditor = document.body.appendChild(elCellEditor);
// Internal tracker of Cell Editor values
var oCellEditor = {};
oCellEditor.container = elCellEditor;
oCellEditor.value = null;
oCellEditor.isActive = false;
this._oCellEditor = oCellEditor;
// Handle ESC key
this.subscribe("editorKeydownEvent", function(oArgs) {
var e = oArgs.event;
var elTarget = YAHOO.util.Event.getTarget(e);
// ESC hides Cell Editor
if((e.keyCode == 27)) {
this.cancelCellEditor();
}
});
};
/**
* Initializes Column sorting.
*
* @method _initColumnSort
* @private
*/
YAHOO.widget.DataTable.prototype._initColumnSort = function() {
this.subscribe("headerCellClickEvent", this.onEventSortColumn);
};
/**
* Initializes DOM event listeners.
*
* @method _initDomEvents
* @private
*/
YAHOO.widget.DataTable.prototype._initDomEvents = function() {
var elTable = this._elTable;
var elThead = this._elThead;
var elTbody = this._elTbody;
var elContainer = this._elContainer;
YAHOO.util.Event.addListener(document, "click", this._onDocumentClick, this);
YAHOO.util.Event.addListener(document, "keydown", this._onDocumentKeydown, this);
YAHOO.util.Event.addListener(elTable, "focus", this._onTableFocus, this);
YAHOO.util.Event.addListener(elTable, "mouseover", this._onTableMouseover, this);
YAHOO.util.Event.addListener(elTable, "mouseout", this._onTableMouseout, this);
YAHOO.util.Event.addListener(elTable, "mousedown", this._onTableMousedown, this);
YAHOO.util.Event.addListener(elTable, "keydown", this._onTableKeydown, this);
YAHOO.util.Event.addListener(elTable, "keypress", this._onTableKeypress, this);
// Since we can't listen for click and dblclick on the same element...
YAHOO.util.Event.addListener(elTable, "dblclick", this._onTableDblclick, this);
YAHOO.util.Event.addListener(elThead, "click", this._onTheadClick, this);
YAHOO.util.Event.addListener(elTbody, "click", this._onTbodyClick, this);
YAHOO.util.Event.addListener(elContainer, "scroll", this._onScroll, this); // for IE
YAHOO.util.Event.addListener(elTbody, "scroll", this._onScroll, this); // for everyone else
};
// DOM MUTATION FUNCTIONS
/**
* Adds a TR element to the primary TBODY at the page row index if given, otherwise
* at the end of the page. Formats TD elements within the TR element using data
* from the given Record.
*
* @method _addTrEl
* @param oRecord {YAHOO.widget.Record} Record instance.
* @param index {Number} (optional) The page row index at which to add the TR
* element.
* @return {String} ID of the added TR element, or null.
* @private
*/
YAHOO.widget.DataTable.prototype._addTrEl = function(oRecord, index) {
this.hideTableMessage();
// It's an append if no index provided, or index is negative or too big
var append = (!YAHOO.lang.isNumber(index) || (index < 0) ||
(index >= (this._elTbody.rows.length))) ? true : false;
var oColumnSet = this._oColumnSet;
var oRecordSet = this._oRecordSet;
var isSortedBy = this.get("sortedBy");
var sortedColKeyIndex = null;
var sortedDir, newClass;
if(isSortedBy) {
sortedColKeyIndex = (isSortedBy.column) ?
isSortedBy.column.getKeyIndex() :
this._oColumnSet.getColumn(isSortedBy.key).getKeyIndex();
sortedDir = isSortedBy.dir;
newClass = (sortedDir === "desc") ? YAHOO.widget.DataTable.CLASS_DESC :
YAHOO.widget.DataTable.CLASS_ASC;
}
var elRow = (append) ? this._elTbody.appendChild(document.createElement("tr")) :
this._elTbody.insertBefore(document.createElement("tr"),this._elTbody.rows[index]);
elRow.id = this.id+"-bdrow"+this._nTrCount;
this._nTrCount++;
elRow.yuiRecordId = oRecord.getId();
// Create TD cells
for(var j=0; j<oColumnSet.keys.length; j++) {
var oColumn = oColumnSet.keys[j];
var elCell = elRow.appendChild(document.createElement("td"));
elCell.id = elRow.id+"-cell"+j;
elCell.yuiColumnKey = oColumn.getKey();
elCell.yuiColumnId = oColumn.getId();
for(var k=0; k<oColumnSet.headers[j].length; k++) {
elCell.headers += this.id + "-col" + oColumnSet.headers[j][k] + " ";
}
// For SF2 cellIndex bug: http://www.webreference.com/programming/javascript/ppk2/3.html
elCell.yuiCellIndex = j;
// Update UI
this.formatCell(elCell, oRecord, oColumn);
// Set FIRST/LAST on TD
if (j === 0) {
YAHOO.util.Dom.addClass(elCell, YAHOO.widget.DataTable.CLASS_FIRST);
}
else if (j === this._oColumnSet.keys.length-1) {
YAHOO.util.Dom.addClass(elCell, YAHOO.widget.DataTable.CLASS_LAST);
}
// Remove ASC/DESC
YAHOO.util.Dom.removeClass(elCell, YAHOO.widget.DataTable.CLASS_ASC);
YAHOO.util.Dom.removeClass(elCell, YAHOO.widget.DataTable.CLASS_DESC);
// Set ASC/DESC on TD
if(j === sortedColKeyIndex) {
newClass = (sortedDir === "desc") ?
YAHOO.widget.DataTable.CLASS_DESC :
YAHOO.widget.DataTable.CLASS_ASC;
YAHOO.util.Dom.addClass(elCell, newClass);
}
/*p.abx {word-wrap:break-word;}
ought to solve the problem for Safari (the long words will wrap in your
tds, instead of overflowing to the next td.
(this is supported by IE win as well, so hide it if needed).
One thing, though: it doesn't work in combination with
'white-space:nowrap'.*/
// need a div wrapper for safari?
//TODO: fix fixedWidth
if(this.fixedWidth) {
elCell.style.overflow = "hidden";
//elCell.style.width = "20px";
}
}
return elRow.id;
};
/**
* Formats all TD elements of given TR element with data from the given Record.
*
* @method _updateTrEl
* @param elRow {HTMLElement} The TR element to update.
* @param oRecord {YAHOO.widget.Record} The associated Record instance.
* @return {String} ID of the updated TR element, or null.
* @private
*/
YAHOO.widget.DataTable.prototype._updateTrEl = function(elRow, oRecord) {
this.hideTableMessage();
var isSortedBy = this.get("sortedBy");
var sortedColKeyIndex = null;
var sortedDir, newClass;
if(isSortedBy) {
sortedColKeyIndex = (isSortedBy.column) ?
isSortedBy.column.getKeyIndex() :
this._oColumnSet.getColumn(isSortedBy.key).getKeyIndex();
sortedDir = isSortedBy.dir;
newClass = (sortedDir === "desc") ? YAHOO.widget.DataTable.CLASS_DESC :
YAHOO.widget.DataTable.CLASS_ASC;
}
// Update TD elements with new data
for(var j=0; j<elRow.cells.length; j++) {
var oColumn = this._oColumnSet.keys[j];
var elCell = elRow.cells[j];
this.formatCell(elCell, oRecord, oColumn);
// Remove ASC/DESC
YAHOO.util.Dom.removeClass(elCell, YAHOO.widget.DataTable.CLASS_ASC);
YAHOO.util.Dom.removeClass(elCell, YAHOO.widget.DataTable.CLASS_DESC);
// Set ASC/DESC on TD
if(j === sortedColKeyIndex) {
YAHOO.util.Dom.addClass(elCell, newClass);
}
}
// Update Record ID
elRow.yuiRecordId = oRecord.getId();
return elRow.id;
};
/**
* Deletes TR element by DOM reference or by DataTable page row index.
*
* @method _deleteTrEl
* @param row {HTMLElement | Number} TR element reference or Datatable page row index.
* @return {Boolean} Returns true if successful, else returns false.
* @private
*/
YAHOO.widget.DataTable.prototype._deleteTrEl = function(row) {
var rowIndex;
// Get page row index for the element
if(!YAHOO.lang.isNumber(row)) {
rowIndex = YAHOO.util.Dom.get(row).sectionRowIndex;
}
else {
rowIndex = row;
}
if(YAHOO.lang.isNumber(rowIndex) && (rowIndex > -2) && (rowIndex < this._elTbody.rows.length)) {
this._elTbody.deleteRow(rowIndex);
return true;
}
else {
return false;
}
};
// CSS/STATE FUNCTIONS
/**
* Assigns the class YAHOO.widget.DataTable.CLASS_FIRST to the first TR element
* of the DataTable page and updates internal tracker.
*
* @method _setFirstRow
* @private
*/
YAHOO.widget.DataTable.prototype._setFirstRow = function() {
var rowEl = this.getFirstTrEl();
if(rowEl) {
// Remove FIRST
if(this._sFirstTrId) {
YAHOO.util.Dom.removeClass(this._sFirstTrId, YAHOO.widget.DataTable.CLASS_FIRST);
}
// Set FIRST
YAHOO.util.Dom.addClass(rowEl, YAHOO.widget.DataTable.CLASS_FIRST);
this._sFirstTrId = rowEl.id;
}
else {
this._sFirstTrId = null;
}
};
/**
* Assigns the class YAHOO.widget.DataTable.CLASS_LAST to the last TR element
* of the DataTable page and updates internal tracker.
*
* @method _setLastRow
* @private
*/
YAHOO.widget.DataTable.prototype._setLastRow = function() {
var rowEl = this.getLastTrEl();
if(rowEl) {
// Unassign previous class
if(this._sLastTrId) {
YAHOO.util.Dom.removeClass(this._sLastTrId, YAHOO.widget.DataTable.CLASS_LAST);
}
// Assign class
YAHOO.util.Dom.addClass(rowEl, YAHOO.widget.DataTable.CLASS_LAST);
this._sLastTrId = rowEl.id;
}
else {
this._sLastTrId = null;
}
};
/**
* Assigns the classes YAHOO.widget.DataTable.CLASS_EVEN and
* YAHOO.widget.DataTable.CLASS_ODD to alternating TR elements of the DataTable
* page. For performance, a subset of rows may be specified.
*
* @method _setRowStripes
* @param row {HTMLElement | String | Number} (optional) HTML TR element reference
* or string ID, or page row index of where to start striping.
* @param range {Number} (optional) If given, how many rows to stripe, otherwise
* stripe all the rows until the end.
* @private
*/
YAHOO.widget.DataTable.prototype._setRowStripes = function(row, range) {
// Default values stripe all rows
var allRows = this._elTbody.rows;
var nStartIndex = 0;
var nEndIndex = allRows.length;
// Stripe a subset
if((row !== null) && (row !== undefined)) {
// Validate given start row
var elStartRow = this.getTrEl(row);
if(elStartRow) {
nStartIndex = elStartRow.sectionRowIndex;
// Validate given range
if(YAHOO.lang.isNumber(range) && (range > 1)) {
nEndIndex = nStartIndex + range;
}
}
}
for(var i=nStartIndex; i<nEndIndex; i++) {
if(i%2) {
YAHOO.util.Dom.removeClass(allRows[i], YAHOO.widget.DataTable.CLASS_EVEN);
YAHOO.util.Dom.addClass(allRows[i], YAHOO.widget.DataTable.CLASS_ODD);
}
else {
YAHOO.util.Dom.removeClass(allRows[i], YAHOO.widget.DataTable.CLASS_ODD);
YAHOO.util.Dom.addClass(allRows[i], YAHOO.widget.DataTable.CLASS_EVEN);
}
}
};
/////////////////////////////////////////////////////////////////////////////
//
// Private DOM Event Handlers
//
/////////////////////////////////////////////////////////////////////////////
/**
* Handles scroll events on the CONTAINER (for IE) and TBODY elements (for everyone else).
*
* @method _onScroll
* @param e {HTMLEvent} The scroll event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onScroll = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
if(oSelf._oCellEditor.isActive) {
oSelf.fireEvent("editorBlurEvent", {editor:oSelf._oCellEditor});
oSelf.cancelCellEditor();
}
oSelf.fireEvent("tableScrollEvent", {event:e, target:elTarget});
};
/**
* Handles click events on the DOCUMENT.
*
* @method _onDocumentClick
* @param e {HTMLEvent} The click event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onDocumentClick = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
if(!YAHOO.util.Dom.isAncestor(oSelf._elTable, elTarget)) {
oSelf.fireEvent("tableBlurEvent");
// Fires editorBlurEvent when click is not within the TABLE.
// For cases when click is within the TABLE, due to timing issues,
// the editorBlurEvent needs to get fired by the lower-level DOM click
// handlers below rather than by the TABLE click handler directly.
if(oSelf._oCellEditor && oSelf._oCellEditor.isActive) {
// Only if the click was not within the Cell Editor container
if(!YAHOO.util.Dom.isAncestor(oSelf._oCellEditor.container, elTarget) &&
(oSelf._oCellEditor.container.id !== elTarget.id)) {
oSelf.fireEvent("editorBlurEvent", {editor:oSelf._oCellEditor});
}
}
}
};
/**
* Handles keydown events on the DOCUMENT.
*
* @method _onDocumentKeydown
* @param e {HTMLEvent} The keydown event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onDocumentKeydown = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
if(oSelf._oCellEditor && oSelf._oCellEditor.isActive &&
YAHOO.util.Dom.isAncestor(oSelf._oCellEditor.container, elTarget)) {
oSelf.fireEvent("editorKeydownEvent", {editor:oSelf._oCellEditor, event:e});
}
};
/**
* Handles focus events on the TABLE element.
*
* @method _onTableFocus
* @param e {HTMLEvent} The focus event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTableMouseover = function(e, oSelf) {
oSelf.fireEvent("tableFocusEvent");
};
/**
* Handles mouseover events on the TABLE element.
*
* @method _onTableMouseover
* @param e {HTMLEvent} The mouseover event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTableMouseover = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
while(elTarget && (elTag != "table")) {
switch(elTag) {
case "body":
break;
case "a":
break;
case "td":
oSelf.fireEvent("cellMouseoverEvent",{target:elTarget,event:e});
break;
case "span":
if(YAHOO.util.Dom.hasClass(elTarget, YAHOO.widget.DataTable.CLASS_LABEL)) {
oSelf.fireEvent("headerLabelMouseoverEvent",{target:elTarget,event:e});
}
break;
case "th":
oSelf.fireEvent("headerCellMouseoverEvent",{target:elTarget,event:e});
break;
case "tr":
if(elTarget.parentNode.tagName.toLowerCase() == "thead") {
oSelf.fireEvent("headerRowMouseoverEvent",{target:elTarget,event:e});
}
else {
oSelf.fireEvent("rowMouseoverEvent",{target:elTarget,event:e});
}
break;
default:
break;
}
elTarget = elTarget.parentNode;
if(elTarget) {
elTag = elTarget.tagName.toLowerCase();
}
}
oSelf.fireEvent("tableMouseoverEvent",{target:(elTarget || oSelf._elTable),event:e});
};
/**
* Handles mouseout events on the TABLE element.
*
* @method _onTableMouseout
* @param e {HTMLEvent} The mouseout event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTableMouseout = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
while(elTarget && (elTag != "table")) {
switch(elTag) {
case "body":
break;
case "a":
break;
case "td":
oSelf.fireEvent("cellMouseoutEvent",{target:elTarget,event:e});
break;
case "span":
if(YAHOO.util.Dom.hasClass(elTarget, YAHOO.widget.DataTable.CLASS_LABEL)) {
oSelf.fireEvent("headerLabelMouseoutEvent",{target:elTarget,event:e});
}
break;
case "th":
oSelf.fireEvent("headerCellMouseoutEvent",{target:elTarget,event:e});
break;
case "tr":
if(elTarget.parentNode.tagName.toLowerCase() == "thead") {
oSelf.fireEvent("headerRowMouseoutEvent",{target:elTarget,event:e});
}
else {
oSelf.fireEvent("rowMouseoutEvent",{target:elTarget,event:e});
}
break;
default:
break;
}
elTarget = elTarget.parentNode;
if(elTarget) {
elTag = elTarget.tagName.toLowerCase();
}
}
oSelf.fireEvent("tableMouseoutEvent",{target:(elTarget || oSelf._elTable),event:e});
};
/**
* Handles mousedown events on the TABLE element.
*
* @method _onTableMousedown
* @param e {HTMLEvent} The mousedown event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTableMousedown = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
while(elTarget && (elTag != "table")) {
switch(elTag) {
case "body":
break;
case "a":
break;
case "td":
oSelf.fireEvent("cellMousedownEvent",{target:elTarget,event:e});
break;
case "span":
if(YAHOO.util.Dom.hasClass(elTarget, YAHOO.widget.DataTable.CLASS_LABEL)) {
oSelf.fireEvent("headerLabelMousedownEvent",{target:elTarget,event:e});
}
break;
case "th":
oSelf.fireEvent("headerCellMousedownEvent",{target:elTarget,event:e});
break;
case "tr":
if(elTarget.parentNode.tagName.toLowerCase() == "thead") {
oSelf.fireEvent("headerRowMousedownEvent",{target:elTarget,event:e});
}
else {
oSelf.fireEvent("rowMousedownEvent",{target:elTarget,event:e});
}
break;
default:
break;
}
elTarget = elTarget.parentNode;
if(elTarget) {
elTag = elTarget.tagName.toLowerCase();
}
}
oSelf.fireEvent("tableMousedownEvent",{target:(elTarget || oSelf._elTable),event:e});
};
/**
* Handles dblclick events on the TABLE element.
*
* @method _onTableDblclick
* @param e {HTMLEvent} The dblclick event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTableDblclick = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
while(elTarget && (elTag != "table")) {
switch(elTag) {
case "body":
break;
case "td":
oSelf.fireEvent("cellDblclickEvent",{target:elTarget,event:e});
break;
case "span":
if(YAHOO.util.Dom.hasClass(elTarget, YAHOO.widget.DataTable.CLASS_LABEL)) {
oSelf.fireEvent("headerLabelDblclickEvent",{target:elTarget,event:e});
}
break;
case "th":
oSelf.fireEvent("headerCellDblclickEvent",{target:elTarget,event:e});
break;
case "tr":
if(elTarget.parentNode.tagName.toLowerCase() == "thead") {
oSelf.fireEvent("headerRowDblclickEvent",{target:elTarget,event:e});
}
else {
oSelf.fireEvent("rowDblclickEvent",{target:elTarget,event:e});
}
break;
default:
break;
}
elTarget = elTarget.parentNode;
if(elTarget) {
elTag = elTarget.tagName.toLowerCase();
}
}
oSelf.fireEvent("tableDblclickEvent",{target:(elTarget || oSelf._elTable),event:e});
};
/**
* Handles keydown events on the TABLE element. Handles arrow selection.
*
* @method _onTableKeydown
* @param e {HTMLEvent} The key event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTableKeydown = function(e, oSelf) {
var bSHIFT = e.shiftKey;
var elTarget = YAHOO.util.Event.getTarget(e);
// Ignore actions in the THEAD
if(YAHOO.util.Dom.isAncestor(oSelf._elThead, elTarget)) {
return;
}
var nKey = YAHOO.util.Event.getCharCode(e);
// Handle TAB
if(nKey === 9) {
// From TABLE el focus first TH label link, if any
if(!bSHIFT && (elTarget.id === oSelf._elTable.id) && oSelf._sFirstLabelLinkId) {
YAHOO.util.Event.stopEvent(e);
oSelf._focusEl(YAHOO.util.Dom.get(oSelf._sFirstLabelLinkId));
}
return;
}
// Handle ARROW selection
if((nKey > 36) && (nKey < 41)) {
YAHOO.util.Event.stopEvent(e);
var allRows = oSelf._elTbody.rows;
var sMode = oSelf.get("selectionMode");
var i, oAnchorCell, oAnchorRecord, nAnchorRecordIndex, nAnchorTrIndex, oAnchorColumn, nAnchorColKeyIndex,
oTriggerCell, oTriggerRecord, nTriggerRecordIndex, nTriggerTrIndex, oTriggerColumn, nTriggerColKeyIndex, elTriggerRow,
startIndex, endIndex, anchorPos, elNext;
// Row mode
if((sMode == "standard") || (sMode == "single")) {
// Validate trigger row:
// Arrow selection only works if last selected row is on current page
oTriggerRecord = oSelf.getLastSelectedRecord();
// No selected rows found
if(!oTriggerRecord) {
return;
}
else {
oTriggerRecord = oSelf.getRecord(oTriggerRecord);
nTriggerRecordIndex = oSelf.getRecordIndex(oTriggerRecord);
elTriggerRow = oSelf.getTrEl(oTriggerRecord);
nTriggerTrIndex = oSelf.getTrIndex(elTriggerRow);
// Last selected row not found on this page
if(nTriggerTrIndex === null) {
return;
}
}
// Validate anchor row
oAnchorRecord = oSelf._oAnchorRecord;
if(!oAnchorRecord) {
oAnchorRecord = oSelf._oAnchorRecord = oTriggerRecord;
}
nAnchorRecordIndex = oSelf.getRecordIndex(oAnchorRecord);
nAnchorTrIndex = oSelf.getTrIndex(oAnchorRecord);
// If anchor row is not on this page...
if(nAnchorTrIndex === null) {
// ...set TR index equal to top TR
if(nAnchorRecordIndex < oSelf.getRecordIndex(oSelf.getFirstTrEl())) {
nAnchorTrIndex = 0;
}
// ...set TR index equal to bottom TR
else {
nAnchorTrIndex = oSelf.getRecordIndex(oSelf.getLastTrEl());
}
}
////////////////////////////////////////////////////////////////////////
//
// SHIFT row selection
//
////////////////////////////////////////////////////////////////////////
if(bSHIFT && (sMode != "single")) {
if(nAnchorRecordIndex > nTriggerTrIndex) {
anchorPos = 1;
}
else if(nAnchorRecordIndex < nTriggerTrIndex) {
anchorPos = -1;
}
else {
anchorPos = 0;
}
// Arrow down
if(nKey == 40) {
// Selecting away from anchor row
if(anchorPos <= 0) {
// Select the next row down
if(nTriggerTrIndex < allRows.length-1) {
oSelf.selectRow(allRows[nTriggerTrIndex+1]);
}
}
// Unselecting toward anchor row
else {
// Unselect this row towards the anchor row down
oSelf.unselectRow(allRows[nTriggerTrIndex]);
}
}
// Arrow up
else if(nKey == 38) {
// Selecting away from anchor row
if(anchorPos >= 0) {
// Select the next row up
if(nTriggerTrIndex > 0) {
oSelf.selectRow(allRows[nTriggerTrIndex-1]);
}
}
// Unselect this row towards the anchor row up
else {
oSelf.unselectRow(allRows[nTriggerTrIndex]);
}
}
// Arrow right
else if(nKey == 39) {
// Do nothing
}
// Arrow left
else if(nKey == 37) {
// Do nothing
}
}
////////////////////////////////////////////////////////////////////////
//
// Simple single row selection
//
////////////////////////////////////////////////////////////////////////
else {
// Arrow down
if(nKey == 40) {
oSelf.unselectAllRows();
// Select the next row
if(nTriggerTrIndex < allRows.length-1) {
elNext = allRows[nTriggerTrIndex+1];
oSelf.selectRow(elNext);
}
// Select only the last row
else {
elNext = allRows[nTriggerTrIndex];
oSelf.selectRow(elNext);
}
oSelf._oAnchorRecord = oSelf.getRecord(elNext);
}
// Arrow up
else if(nKey == 38) {
oSelf.unselectAllRows();
// Select the previous row
if(nTriggerTrIndex > 0) {
elNext = allRows[nTriggerTrIndex-1];
oSelf.selectRow(elNext);
}
// Select only the first row
else {
elNext = allRows[nTriggerTrIndex];
oSelf.selectRow(elNext);
}
oSelf._oAnchorRecord = oSelf.getRecord(elNext);
}
// Arrow right
else if(nKey == 39) {
// Do nothing
}
// Arrow left
else if(nKey == 37) {
// Do nothing
}
}
}
// Cell mode
else {
// Validate trigger cell:
// Arrow selection only works if last selected cell is on current page
oTriggerCell = oSelf.getLastSelectedCell();
// No selected cells found
if(!oTriggerCell) {
return;
}
else {
oTriggerRecord = oSelf.getRecord(oTriggerCell.recordId);
nTriggerRecordIndex = oSelf.getRecordIndex(oTriggerRecord);
elTriggerRow = oSelf.getTrEl(oTriggerRecord);
nTriggerTrIndex = oSelf.getTrIndex(elTriggerRow);
// Last selected cell not found on this page
if(nTriggerTrIndex === null) {
return;
}
else {
oTriggerColumn = oSelf.getColumnById(oTriggerCell.columnId);
nTriggerColKeyIndex = oTriggerColumn.getKeyIndex();
}
}
// Validate anchor cell
oAnchorCell = oSelf._oAnchorCell;
if(!oAnchorCell) {
oAnchorCell = oSelf._oAnchorCell = oTriggerCell;
}
oAnchorRecord = oSelf._oAnchorCell.record;
nAnchorRecordIndex = oSelf._oRecordSet.getRecordIndex(oAnchorRecord);
nAnchorTrIndex = oSelf.getTrIndex(oAnchorRecord);
// If anchor cell is not on this page...
if(nAnchorTrIndex === null) {
// ...set TR index equal to top TR
if(nAnchorRecordIndex < oSelf.getRecordIndex(oSelf.getFirstTrEl())) {
nAnchorTrIndex = 0;
}
// ...set TR index equal to bottom TR
else {
nAnchorTrIndex = oSelf.getRecordIndex(oSelf.getLastTrEl());
}
}
oAnchorColumn = oSelf._oAnchorCell.column;
nAnchorColKeyIndex = oAnchorColumn.getKeyIndex();
////////////////////////////////////////////////////////////////////////
//
// SHIFT cell block selection
//
////////////////////////////////////////////////////////////////////////
if(bSHIFT && (sMode == "cellblock")) {
// Arrow DOWN
if(nKey == 40) {
// Is the anchor cell above, below, or same row as trigger
if(nAnchorRecordIndex > nTriggerRecordIndex) {
anchorPos = 1;
}
else if(nAnchorRecordIndex < nTriggerRecordIndex) {
anchorPos = -1;
}
else {
anchorPos = 0;
}
// Selecting away from anchor cell
if(anchorPos <= 0) {
// Select the horiz block on the next row...
// ...making sure there is room below the trigger row
if(nTriggerTrIndex < allRows.length-1) {
// Select in order from anchor to trigger...
startIndex = nAnchorColKeyIndex;
endIndex = nTriggerColKeyIndex;
// ...going left
if(startIndex > endIndex) {
for(i=startIndex; i>=endIndex; i--) {
elNext = allRows[nTriggerTrIndex+1].cells[i];
oSelf.selectCell(elNext);
}
}
// ... going right
else {
for(i=startIndex; i<=endIndex; i++) {
elNext = allRows[nTriggerTrIndex+1].cells[i];
oSelf.selectCell(elNext);
}
}
}
}
// Unselecting towards anchor cell
else {
startIndex = Math.min(nAnchorColKeyIndex, nTriggerColKeyIndex);
endIndex = Math.max(nAnchorColKeyIndex, nTriggerColKeyIndex);
// Unselect the horiz block on this row towards the next row
for(i=startIndex; i<=endIndex; i++) {
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[i]);
}
}
}
// Arrow up
else if(nKey == 38) {
// Is the anchor cell above, below, or same row as trigger
if(nAnchorRecordIndex > nTriggerRecordIndex) {
anchorPos = 1;
}
else if(nAnchorRecordIndex < nTriggerRecordIndex) {
anchorPos = -1;
}
else {
anchorPos = 0;
}
// Selecting away from anchor cell
if(anchorPos >= 0) {
// Select the horiz block on the previous row...
// ...making sure there is room
if(nTriggerTrIndex > 0) {
// Select in order from anchor to trigger...
startIndex = nAnchorColKeyIndex;
endIndex = nTriggerColKeyIndex;
// ...going left
if(startIndex > endIndex) {
for(i=startIndex; i>=endIndex; i--) {
elNext = allRows[nTriggerTrIndex-1].cells[i];
oSelf.selectCell(elNext);
}
}
// ... going right
else {
for(i=startIndex; i<=endIndex; i++) {
elNext = allRows[nTriggerTrIndex-1].cells[i];
oSelf.selectCell(elNext);
}
}
}
}
// Unselecting towards anchor cell
else {
startIndex = Math.min(nAnchorColKeyIndex, nTriggerColKeyIndex);
endIndex = Math.max(nAnchorColKeyIndex, nTriggerColKeyIndex);
// Unselect the horiz block on this row towards the previous row
for(i=startIndex; i<=endIndex; i++) {
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[i]);
}
}
}
// Arrow right
else if(nKey == 39) {
// Is the anchor cell left, right, or same column
if(nAnchorColKeyIndex > nTriggerColKeyIndex) {
anchorPos = 1;
}
else if(nAnchorColKeyIndex < nTriggerColKeyIndex) {
anchorPos = -1;
}
else {
anchorPos = 0;
}
// Selecting away from anchor cell
if(anchorPos <= 0) {
// Select the next vert block to the right...
// ...making sure there is room
if(nTriggerColKeyIndex < allRows[nTriggerTrIndex].cells.length-1) {
// Select in order from anchor to trigger...
startIndex = nAnchorTrIndex;
endIndex = nTriggerTrIndex;
// ...going up
if(startIndex > endIndex) {
for(i=startIndex; i>=endIndex; i--) {
elNext = allRows[i].cells[nTriggerColKeyIndex+1];
oSelf.selectCell(elNext);
}
}
// ... going down
else {
for(i=startIndex; i<=endIndex; i++) {
elNext = allRows[i].cells[nTriggerColKeyIndex+1];
oSelf.selectCell(elNext);
}
}
}
}
// Unselecting towards anchor cell
else {
// Unselect the vert block on this column towards the right
startIndex = Math.min(nAnchorTrIndex, nTriggerTrIndex);
endIndex = Math.max(nAnchorTrIndex, nTriggerTrIndex);
for(i=startIndex; i<=endIndex; i++) {
oSelf.unselectCell(allRows[i].cells[nTriggerColKeyIndex]);
}
}
}
// Arrow left
else if(nKey == 37) {
// Is the anchor cell left, right, or same column
if(nAnchorColKeyIndex > nTriggerColKeyIndex) {
anchorPos = 1;
}
else if(nAnchorColKeyIndex < nTriggerColKeyIndex) {
anchorPos = -1;
}
else {
anchorPos = 0;
}
// Selecting away from anchor cell
if(anchorPos >= 0) {
//Select the previous vert block to the left
if(nTriggerColKeyIndex > 0) {
// Select in order from anchor to trigger...
startIndex = nAnchorTrIndex;
endIndex = nTriggerTrIndex;
// ...going up
if(startIndex > endIndex) {
for(i=startIndex; i>=endIndex; i--) {
elNext = allRows[i].cells[nTriggerColKeyIndex-1];
oSelf.selectCell(elNext);
}
}
// ... going down
else {
for(i=startIndex; i<=endIndex; i++) {
elNext = allRows[i].cells[nTriggerColKeyIndex-1];
oSelf.selectCell(elNext);
}
}
}
}
// Unselecting towards anchor cell
else {
// Unselect the vert block on this column towards the left
startIndex = Math.min(nAnchorTrIndex, nTriggerTrIndex);
endIndex = Math.max(nAnchorTrIndex, nTriggerTrIndex);
for(i=startIndex; i<=endIndex; i++) {
oSelf.unselectCell(allRows[i].cells[nTriggerColKeyIndex]);
}
}
}
}
////////////////////////////////////////////////////////////////////////
//
// SHIFT cell range selection
//
////////////////////////////////////////////////////////////////////////
else if(bSHIFT && (sMode == "cellrange")) {
// Is the anchor cell above, below, or same row as trigger
if(nAnchorRecordIndex > nTriggerRecordIndex) {
anchorPos = 1;
}
else if(nAnchorRecordIndex < nTriggerRecordIndex) {
anchorPos = -1;
}
else {
anchorPos = 0;
}
// Arrow down
if(nKey == 40) {
// Selecting away from anchor cell
if(anchorPos <= 0) {
// Select all cells to the end of this row
for(i=nTriggerColKeyIndex+1; i<allRows[nTriggerTrIndex].cells.length; i++){
elNext = allRows[nTriggerTrIndex].cells[i];
oSelf.selectCell(elNext);
}
// Select some of the cells on the next row down
if(nTriggerTrIndex < allRows.length-1) {
for(i=0; i<=nTriggerColKeyIndex; i++){
elNext = allRows[nTriggerTrIndex+1].cells[i];
oSelf.selectCell(elNext);
}
}
}
// Unselecting towards anchor cell
else {
// Unselect all cells to the end of this row
for(i=nTriggerColKeyIndex; i<allRows[nTriggerTrIndex].cells.length; i++){
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[i]);
}
// Unselect some of the cells on the next row down
for(i=0; i<nTriggerColKeyIndex; i++){
oSelf.unselectCell(allRows[nTriggerTrIndex+1].cells[i]);
}
}
}
// Arrow up
else if(nKey == 38) {
// Selecting away from anchor cell
if(anchorPos >= 0) {
// Select all the cells to the beginning of this row
for(i=nTriggerColKeyIndex-1; i>-1; i--){
elNext = allRows[nTriggerTrIndex].cells[i];
oSelf.selectCell(elNext);
}
// Select some of the cells from the end of the previous row
if(nTriggerTrIndex > 0) {
for(i=allRows[nTriggerTrIndex].cells.length-1; i>=nTriggerColKeyIndex; i--){
elNext = allRows[nTriggerTrIndex-1].cells[i];
oSelf.selectCell(elNext);
}
}
}
// Unselecting towards anchor cell
else {
// Unselect all the cells to the beginning of this row
for(i=nTriggerColKeyIndex; i>-1; i--){
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[i]);
}
// Unselect some of the cells from the end of the previous row
for(i=allRows[nTriggerTrIndex].cells.length-1; i>nTriggerColKeyIndex; i--){
oSelf.unselectCell(allRows[nTriggerTrIndex-1].cells[i]);
}
}
}
// Arrow right
else if(nKey == 39) {
// Selecting away from anchor cell
if(anchorPos < 0) {
// Select the next cell to the right
if(nTriggerColKeyIndex < allRows[nTriggerTrIndex].cells.length-1) {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex+1];
oSelf.selectCell(elNext);
}
// Select the first cell of the next row
else if(nTriggerTrIndex < allRows.length-1) {
elNext = allRows[nTriggerTrIndex+1].cells[0];
oSelf.selectCell(elNext);
}
}
// Unselecting towards anchor cell
else if(anchorPos > 0) {
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex]);
// Unselect this cell towards the right
if(nTriggerColKeyIndex < allRows[nTriggerTrIndex].cells.length-1) {
}
// Unselect this cells towards the first cell of the next row
else {
}
}
// Anchor is on this row
else {
// Selecting away from anchor
if(nAnchorColKeyIndex <= nTriggerColKeyIndex) {
// Select the next cell to the right
if(nTriggerColKeyIndex < allRows[nTriggerTrIndex].cells.length-1) {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex+1];
oSelf.selectCell(elNext);
}
// Select the first cell on the next row
else if(nTriggerTrIndex < allRows.length-1){
elNext = allRows[nTriggerTrIndex+1].cells[0];
oSelf.selectCell(elNext);
}
}
// Unselecting towards anchor
else {
// Unselect this cell towards the right
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex]);
}
}
}
// Arrow left
else if(nKey == 37) {
// Unselecting towards the anchor
if(anchorPos < 0) {
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex]);
// Unselect this cell towards the left
if(nTriggerColKeyIndex > 0) {
}
// Unselect this cell towards the last cell of the previous row
else {
}
}
// Selecting towards the anchor
else if(anchorPos > 0) {
// Select the next cell to the left
if(nTriggerColKeyIndex > 0) {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex-1];
oSelf.selectCell(elNext);
}
// Select the last cell of the previous row
else if(nTriggerTrIndex > 0){
elNext = allRows[nTriggerTrIndex-1].cells[allRows[nTriggerTrIndex-1].cells.length-1];
oSelf.selectCell(elNext);
}
}
// Anchor is on this row
else {
// Selecting away from anchor cell
if(nAnchorColKeyIndex >= nTriggerColKeyIndex) {
// Select the next cell to the left
if(nTriggerColKeyIndex > 0) {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex-1];
oSelf.selectCell(elNext);
}
// Select the last cell of the previous row
else if(nTriggerTrIndex > 0){
elNext = allRows[nTriggerTrIndex-1].cells[allRows[nTriggerTrIndex-1].cells.length-1];
oSelf.selectCell(elNext);
}
}
// Unselecting towards anchor cell
else {
oSelf.unselectCell(allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex]);
// Unselect this cell towards the left
if(nTriggerColKeyIndex > 0) {
}
// Unselect this cell towards the last cell of the previous row
else {
}
}
}
}
}
////////////////////////////////////////////////////////////////////////
//
// Simple single cell selection
//
////////////////////////////////////////////////////////////////////////
else if((sMode == "cellblock") || (sMode == "cellrange") || (sMode == "singlecell")) {
// Arrow down
if(nKey == 40) {
oSelf.unselectAllCells();
// Select the next cell down
if(nTriggerTrIndex < allRows.length-1) {
elNext = allRows[nTriggerTrIndex+1].cells[nTriggerColKeyIndex];
oSelf.selectCell(elNext);
}
// Select only the bottom cell
else {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex];
oSelf.selectCell(elNext);
}
oSelf._oAnchorCell = {record:oSelf.getRecord(elNext), column:oSelf.getColumn(elNext)};
}
// Arrow up
else if(nKey == 38) {
oSelf.unselectAllCells();
// Select the next cell up
if(nTriggerTrIndex > 0) {
elNext = allRows[nTriggerTrIndex-1].cells[nTriggerColKeyIndex];
oSelf.selectCell(elNext);
}
// Select only the top cell
else {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex];
oSelf.selectCell(elNext);
}
oSelf._oAnchorCell = {record:oSelf.getRecord(elNext), column:oSelf.getColumn(elNext)};
}
// Arrow right
else if(nKey == 39) {
oSelf.unselectAllCells();
// Select the next cell to the right
if(nTriggerColKeyIndex < allRows[nTriggerTrIndex].cells.length-1) {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex+1];
oSelf.selectCell(elNext);
}
// Select only the right cell
else {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex];
oSelf.selectCell(elNext);
}
oSelf._oAnchorCell = {record:oSelf.getRecord(elNext), column:oSelf.getColumn(elNext)};
}
// Arrow left
else if(nKey == 37) {
oSelf.unselectAllCells();
// Select the next cell to the left
if(nTriggerColKeyIndex > 0) {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex-1];
oSelf.selectCell(elNext);
}
// Select only the left cell
else {
elNext = allRows[nTriggerTrIndex].cells[nTriggerColKeyIndex];
oSelf.selectCell(elNext);
}
oSelf._oAnchorCell = {record:oSelf.getRecord(elNext), column:oSelf.getColumn(elNext)};
}
}
}
}
else {
//TODO: handle tab across cells
//TODO: handle backspace
//TODO: handle delete
//TODO: handle arrow selection across pages
return;
}
};
/**
* Handles keypress events on the TABLE. Mainly to support stopEvent on Mac.
*
* @method _onTableKeypress
* @param e {HTMLEvent} The key event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTableKeypress = function(e, oSelf) {
var isMac = (navigator.userAgent.toLowerCase().indexOf("mac") != -1);
if(isMac) {
var nKey = YAHOO.util.Event.getCharCode(e);
// arrow down
if(nKey == 40) {
YAHOO.util.Event.stopEvent(e);
}
// arrow up
else if(nKey == 38) {
YAHOO.util.Event.stopEvent(e);
}
}
};
/**
* Handles click events on the THEAD element.
*
* @method _onTheadClick
* @param e {HTMLEvent} The click event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTheadClick = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
if(oSelf._oCellEditor && oSelf._oCellEditor.isActive) {
oSelf.fireEvent("editorBlurEvent", {editor:oSelf._oCellEditor});
}
while(elTarget && (elTag != "thead")) {
switch(elTag) {
case "body":
break;
case "span":
if(YAHOO.util.Dom.hasClass(elTarget, YAHOO.widget.DataTable.CLASS_LABEL)) {
oSelf.fireEvent("headerLabelClickEvent",{target:elTarget,event:e});
}
break;
case "th":
oSelf.fireEvent("headerCellClickEvent",{target:elTarget,event:e});
break;
case "tr":
oSelf.fireEvent("headerRowClickEvent",{target:elTarget,event:e});
break;
default:
break;
}
elTarget = elTarget.parentNode;
if(elTarget) {
elTag = elTarget.tagName.toLowerCase();
}
}
oSelf.fireEvent("tableClickEvent",{target:(elTarget || oSelf._elTable),event:e});
};
/**
* Handles click events on the primary TBODY element.
*
* @method _onTbodyClick
* @param e {HTMLEvent} The click event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onTbodyClick = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
if(oSelf._oCellEditor && oSelf._oCellEditor.isActive) {
oSelf.fireEvent("editorBlurEvent", {editor:oSelf._oCellEditor});
}
while(elTarget && (elTag != "table")) {
switch(elTag) {
case "body":
break;
case "input":
if(elTarget.type.toLowerCase() == "checkbox") {
oSelf.fireEvent("checkboxClickEvent",{target:elTarget,event:e});
}
else if(elTarget.type.toLowerCase() == "radio") {
oSelf.fireEvent("radioClickEvent",{target:elTarget,event:e});
}
oSelf.fireEvent("tableClickEvent",{target:(elTarget || oSelf._elTable),event:e});
return;
case "a":
oSelf.fireEvent("linkClickEvent",{target:elTarget,event:e});
oSelf.fireEvent("tableClickEvent",{target:(elTarget || oSelf._elTable),event:e});
return;
case "button":
oSelf.fireEvent("buttonClickEvent",{target:elTarget,event:e});
oSelf.fireEvent("tableClickEvent",{target:(elTarget || oSelf._elTable),event:e});
return;
case "td":
oSelf.fireEvent("cellClickEvent",{target:elTarget,event:e});
break;
case "tr":
oSelf.fireEvent("rowClickEvent",{target:elTarget,event:e});
break;
default:
break;
}
elTarget = elTarget.parentNode;
if(elTarget) {
elTag = elTarget.tagName.toLowerCase();
}
}
oSelf.fireEvent("tableClickEvent",{target:(elTarget || oSelf._elTable),event:e});
};
/*TODO: delete
* Handles keyup events on the TBODY. Executes deletion.
*
* @method _onTbodyKeyup
* @param e {HTMLEvent} The key event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
/*YAHOO.widget.DataTable.prototype._onTbodyKeyup = function(e, oSelf) {
var nKey = YAHOO.util.Event.getCharCode(e);
// delete
if(nKey == 46) {//TODO: if something is selected
//TODO: delete row
}
};*/
/**
* Handles click events on paginator links.
*
* @method _onPaginatorLinkClick
* @param e {HTMLEvent} The click event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onPaginatorLinkClick = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var elTag = elTarget.tagName.toLowerCase();
if(oSelf._oCellEditor && oSelf._oCellEditor.isActive) {
oSelf.fireEvent("editorBlurEvent", {editor:oSelf._oCellEditor});
}
while(elTarget && (elTag != "table")) {
switch(elTag) {
case "body":
return;
case "a":
YAHOO.util.Event.stopEvent(e);
//TODO: after the showPage call, figure out which link
//TODO: was clicked and reset focus to the new version of it
switch(elTarget.className) {
case YAHOO.widget.DataTable.CLASS_PAGE:
oSelf.showPage(parseInt(elTarget.innerHTML,10));
return;
case YAHOO.widget.DataTable.CLASS_FIRST:
oSelf.showPage(1);
return;
case YAHOO.widget.DataTable.CLASS_LAST:
oSelf.showPage(oSelf.get("paginator").totalPages);
return;
case YAHOO.widget.DataTable.CLASS_PREVIOUS:
oSelf.showPage(oSelf.get("paginator").currentPage - 1);
return;
case YAHOO.widget.DataTable.CLASS_NEXT:
oSelf.showPage(oSelf.get("paginator").currentPage + 1);
return;
}
break;
default:
return;
}
elTarget = elTarget.parentNode;
if(elTarget) {
elTag = elTarget.tagName.toLowerCase();
}
else {
return;
}
}
};
/**
* Handles change events on paginator SELECT element.
*
* @method _onPaginatorDropdownChange
* @param e {HTMLEvent} The change event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onPaginatorDropdownChange = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
var newValue = elTarget[elTarget.selectedIndex].value;
var newRowsPerPage = YAHOO.lang.isValue(parseInt(newValue,10)) ? parseInt(newValue,10) : null;
if(newRowsPerPage !== null) {
var newStartRecordIndex = (oSelf.get("paginator").currentPage-1) * newRowsPerPage;
oSelf.updatePaginator({rowsPerPage:newRowsPerPage, startRecordIndex:newStartRecordIndex});
oSelf.refreshView();
}
else {
YAHOO.log("Could not paginate with " + newValue + " rows per page", "error", oSelf.toString());
}
};
/**
* Handles change events on SELECT elements within DataTable.
*
* @method _onDropdownChange
* @param e {HTMLEvent} The change event.
* @param oSelf {YAHOO.widget.DataTable} DataTable instance.
* @private
*/
YAHOO.widget.DataTable.prototype._onDropdownChange = function(e, oSelf) {
var elTarget = YAHOO.util.Event.getTarget(e);
//TODO: pass what args?
//var value = elTarget[elTarget.selectedIndex].value;
oSelf.fireEvent("dropdownChangeEvent", {event:e, target:elTarget});
};
/////////////////////////////////////////////////////////////////////////////
//
// Public member variables
//
/////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
//
// Public methods
//
/////////////////////////////////////////////////////////////////////////////
// OBJECT ACCESSORS
/**
* Public accessor to the unique name of the DataSource instance.
*
* @method toString
* @return {String} Unique name of the DataSource instance.
*/
YAHOO.widget.DataTable.prototype.toString = function() {
return "DataTable " + this._sName;
};
/**
* Returns the DataTable instance's DataSource instance.
*
* @method getDataSource
* @return {YAHOO.util.DataSource} DataSource instance.
*/
YAHOO.widget.DataTable.prototype.getDataSource = function() {
return this._oDataSource;
};
/**
* Returns the DataTable instance's ColumnSet instance.
*
* @method getColumnSet
* @return {YAHOO.widget.ColumnSet} ColumnSet instance.
*/
YAHOO.widget.DataTable.prototype.getColumnSet = function() {
return this._oColumnSet;
};
/**
* Returns the DataTable instance's RecordSet instance.
*
* @method getRecordSet
* @return {YAHOO.widget.RecordSet} RecordSet instance.
*/
YAHOO.widget.DataTable.prototype.getRecordSet = function() {
return this._oRecordSet;
};
/**
* Returns the DataTable instance's Cell Editor as an object literal with the
* following properties:
* <dl>
* <dt>cell</dt>
* <dd>{HTMLElement} Cell element being edited.</dd>
*
* <dt>column</dt>
* <dd>{YAHOO.widget.Column} Associated Column instance.</dd>
*
* <dt>container</dt>
* <dd>{HTMLElement} Reference to editor's container DIV element.</dd>
*
* <dt>isActive</dt>
* <dd>{Boolean} True if cell is currently being edited.</dd>
*
* <dt>record</dt>
* <dd>{YAHOO.widget.Record} Associated Record instance.</dd>
*
* <dt>validator</dt>
* <dd>{HTMLFunction} Associated validator function called before new data is stored. Called
* within the scope of the DataTable instance, the function receieves the
* following arguments:
*
* <dl>
* <dt>oNewData</dt>
* <dd>{Object} New data to validate.</dd>
*
* <dt>oOldData</dt>
* <dd>{Object} Original data in case of reversion.</dd>
*
* <dt>oCellEditor</dt>
* <dd>{Object} Object literal representation of Editor values.</dd>
* </dl>
*
* </dd>
*
* <dt>value</dt>
* <dd>Current input value</dd>
* </dl>
*
*
*
*
*
*
* @method getCellEditor
* @return {Object} Cell Editor object literal values.
*/
YAHOO.widget.DataTable.prototype.getCellEditor = function() {
return this._oCellEditor;
};
// DOM ACCESSORS
/**
* Returns DOM reference to the DataTable's TABLE element.
*
* @method getTableEl
* @return {HTMLElement} Reference to TABLE element.
*/
YAHOO.widget.DataTable.prototype.getTableEl = function() {
return this._elTable;
};
/**
* Returns DOM reference to the DataTable's THEAD element.
*
* @method getTheadEl
* @return {HTMLElement} Reference to THEAD element.
*/
YAHOO.widget.DataTable.prototype.getTheadEl = function() {
return this._elThead;
};
/**
* Returns DOM reference to the DataTable's primary TBODY element.
*
* @method getTbodyEl
* @return {HTMLElement} Reference to TBODY element.
*/
YAHOO.widget.DataTable.prototype.getTbodyEl = function() {
return this._elTbody;
};
// Backward compatibility
YAHOO.widget.DataTable.prototype.getBody = function() {
YAHOO.log("The method getBody() has been deprecated" +
" in favor of getTbodyEl()", "warn", this.toString());
return this.getTbodyEl();
};
/**
* Returns DOM reference to the DataTable's secondary TBODY element that is
* used to display messages.
*
* @method getMsgTbodyEl
* @return {HTMLElement} Reference to TBODY element.
*/
YAHOO.widget.DataTable.prototype.getMsgTbodyEl = function() {
return this._elMsgTbody;
};
/**
* Returns DOM reference to the TD element within the secondary TBODY that is
* used to display messages.
*
* @method getMsgTdEl
* @return {HTMLElement} Reference to TD element.
*/
YAHOO.widget.DataTable.prototype.getMsgTdEl = function() {
return this._elMsgTd;
};
/**
* Returns the corresponding TR reference for a given DOM element, ID string or
* directly page row index. If the given identifier is a child of a TR element,
* then DOM tree is traversed until a parent TR element is returned, otherwise
* null.
*
* @method getTrEl
* @param row {HTMLElement | String | Number | YAHOO.widget.Record} Which row to
* get: by element reference, ID string, page row index, or Record.
* @return {HTMLElement} Reference to TR element, or null.
*/
YAHOO.widget.DataTable.prototype.getTrEl = function(row) {
var allRows = this._elTbody.rows;
// By Record
if(row instanceof YAHOO.widget.Record) {
var nTrIndex = this.getTrIndex(row);
if(nTrIndex !== null) {
return allRows[nTrIndex];
}
// Not a valid Record
else {
return null;
}
}
// By page row index
else if(YAHOO.lang.isNumber(row) && (row > -1) && (row < allRows.length)) {
return allRows[row];
}
// By ID string or element reference
else {
var elRow;
var el = YAHOO.util.Dom.get(row);
// Validate HTML element
if(el && (el.ownerDocument == document)) {
// Validate TR element
if(el.tagName.toLowerCase() != "tr") {
// Traverse up the DOM to find the corresponding TR element
elRow = YAHOO.util.Dom.getAncestorByTagName(el,"tr");
}
else {
elRow = el;
}
// Make sure the TR is in this TBODY
if(elRow && (elRow.parentNode == this._elTbody)) {
// Now we can return the TR element
return elRow;
}
}
}
YAHOO.log("Could not get TR element for row " + row, "warn", this.toString());
return null;
};
// Backward compatibility
YAHOO.widget.DataTable.prototype.getRow = function(index) {
YAHOO.log("The method getRow() has been deprecated" +
" in favor of getTrEl()", "warn", this.toString());
return this.getTrEl(index);
};
/**
* Returns DOM reference to the first TR element in the DataTable page, or null.
*
* @method getFirstTrEl
* @return {HTMLElement} Reference to TR element.
*/
YAHOO.widget.DataTable.prototype.getFirstTrEl = function() {
return this._elTbody.rows[0] || null;
};
/**
* Returns DOM reference to the last TR element in the DataTable page, or null.
*
* @method getLastTrEl
* @return {HTMLElement} Reference to last TR element.
*/
YAHOO.widget.DataTable.prototype.getLastTrEl = function() {
var allRows = this._elTbody.rows;
if(allRows.length > 0) {
return allRows[allRows.length-1] || null;
}
};
/**
* Returns DOM reference to a TD element.
*
* @method getTdEl
* @param cell {HTMLElement | String | Object} DOM element reference or string ID, or
* object literal of syntax {record:oRecord, column:oColumn}.
* @return {HTMLElement} Reference to TD element.
*/
YAHOO.widget.DataTable.prototype.getTdEl = function(cell) {
var elCell;
var el = YAHOO.util.Dom.get(cell);
// Validate HTML element
if(el && (el.ownerDocument == document)) {
// Validate TD element
if(el.tagName.toLowerCase() != "td") {
// Traverse up the DOM to find the corresponding TR element
elCell = YAHOO.util.Dom.getAncestorByTagName(el, "td");
}
else {
elCell = el;
}
// Make sure the TD is in this TBODY
if(elCell && (elCell.parentNode.parentNode == this._elTbody)) {
// Now we can return the TD element
return elCell;
}
}
else if(cell.record && cell.column && cell.column.getKeyIndex) {
var oRecord = cell.record;
var elRow = this.getTrEl(oRecord);
if(elRow && elRow.cells && elRow.cells.length > 0) {
return elRow.cells[cell.column.getKeyIndex()] || null;
}
}
YAHOO.log("Could not get TD element for cell " + cell, "warn", this.toString());
return null;
};
/**
* Returns DOM reference to a TH element.
*
* @method getThEl
* @param header {YAHOO.widget.Column | HTMLElement | String} Column instance,
* DOM element reference, or string ID.
* @return {HTMLElement} Reference to TH element.
*/
YAHOO.widget.DataTable.prototype.getThEl = function(header) {
var elHeader;
// Validate Column instance
if(header instanceof YAHOO.widget.Column) {
var oColumn = header;
elHeader = YAHOO.util.Dom.get(this.id + "-col" + oColumn.getId());
if(elHeader) {
return elHeader;
}
}
// Validate HTML element
else {
var el = YAHOO.util.Dom.get(header);
if(el && (el.ownerDocument == document)) {
// Validate TH element
if(el.tagName.toLowerCase() != "th") {
// Traverse up the DOM to find the corresponding TR element
elHeader = YAHOO.util.Dom.getAncestorByTagName(el,"th");
}
else {
elHeader = el;
}
// Make sure the TH is in this THEAD
if(elHeader && (elHeader.parentNode.parentNode == this._elThead)) {
// Now we can return the TD element
return elHeader;
}
}
}
YAHOO.log("Could not get TH element for header " + header, "warn", this.toString());
return null;
};
/**
* Returns the page row index of given row. Returns null if the row is not on the
* current DataTable page.
*
* @method getTrIndex
* @param row {HTMLElement | String | YAHOO.widget.Record | Number} DOM or ID
* string reference to an element within the DataTable page, a Record instance,
* or a Record's RecordSet index.
* @return {Number} Page row index, or null if row does not exist or is not on current page.
*/
YAHOO.widget.DataTable.prototype.getTrIndex = function(row) {
var nRecordIndex;
// By Record
if(row instanceof YAHOO.widget.Record) {
nRecordIndex = this._oRecordSet.getRecordIndex(row);
if(nRecordIndex === null) {
// Not a valid Record
return null;
}
}
// Calculate page row index from Record index
else if(YAHOO.lang.isNumber(row)) {
nRecordIndex = row;
}
if(YAHOO.lang.isNumber(nRecordIndex)) {
// Validate the number
if((nRecordIndex > -1) && (nRecordIndex < this._oRecordSet.getLength())) {
// DataTable is paginated
if(this.get("paginated")) {
// Get the first and last Record on current page
var startRecordIndex = this.get("paginator").startRecordIndex;
var endRecordIndex = startRecordIndex + this.get("paginator").rowsPerPage - 1;
// This Record is on current page
if((nRecordIndex >= startRecordIndex) && (nRecordIndex <= endRecordIndex)) {
return nRecordIndex - startRecordIndex;
}
// This Record is not on current page
else {
return null;
}
}
// Not paginated, just return the Record index
else {
return nRecordIndex;
}
}
// RecordSet index is out of range
else {
return null;
}
}
// By element reference or ID string
else {
// Validate TR element
var elRow = this.getTrEl(row);
if(elRow && (elRow.ownerDocument == document) &&
(elRow.parentNode == this._elTbody)) {
return elRow.sectionRowIndex;
}
}
YAHOO.log("Could not get page row index for row " + row, "warn", this.toString());
return null;
};
// TABLE FUNCTIONS
/**
* Resets a RecordSet with the given data and populates the page view
* with the new data. Any previous data and selection states are cleared.
* However, sort states are not cleared, so if the given data is in a particular
* sort order, implementers should take care to reset the sortedBy property. If
* pagination is enabled, the currentPage is shown and Paginator UI updated,
* otherwise all rows are displayed as a single page. For performance, existing
* DOM elements are reused when possible.
*
* @method initializeTable
* @param oData {Object | Object[]} An object literal of data or an array of
* object literals containing data.
*/
YAHOO.widget.DataTable.prototype.initializeTable = function(oData) {
// Clear the RecordSet
this._oRecordSet.reset();
// Add data to RecordSet
var records = this._oRecordSet.addRecords(oData);
// Clear selections
this._unselectAllTrEls();
this._unselectAllTdEls();
this._aSelections = null;
this._oAnchorRecord = null;
this._oAnchorCell = null;
// Refresh the view
this.refreshView();
this.fireEvent("initEvent");
};
/**
* Refreshes the view with existing Records from the RecordSet while
* maintaining sort, pagination, and selection states. For performance, reuses
* existing DOM elements when possible while deleting extraneous elements.
*
* @method refreshView
*/
YAHOO.widget.DataTable.prototype.refreshView = function() {
var i, j, k, l, aRecords;
var oPaginator = this.updatePaginator();
// Paginator is enabled, show a subset of Records and update Paginator UI
if(this.get("paginated")) {
var rowsPerPage = oPaginator.rowsPerPage;
var startRecordIndex = (oPaginator.currentPage - 1) * rowsPerPage;
aRecords = this._oRecordSet.getRecords(startRecordIndex, rowsPerPage);
this.formatPaginators();
}
// Show all records
else {
aRecords = this._oRecordSet.getRecords();
}
var elTbody = this._elTbody;
var elRows = elTbody.rows;
// Has rows
if(YAHOO.lang.isArray(aRecords) && (aRecords.length > 0)) {
this.hideTableMessage();
// Keep track of selected rows
var aSelectedRows = this.getSelectedRows();
// Keep track of selected cells
var aSelectedCells = this.getSelectedCells();
// Anything to reinstate?
var bReselect = (aSelectedRows.length>0) || (aSelectedCells.length > 0);
// Remove extra rows from the bottom so as to preserve ID order
while(elTbody.hasChildNodes() && (elRows.length > aRecords.length)) {
elTbody.deleteRow(-1);
}
// Unselect all TR and TD elements in the UI
if(bReselect) {
this._unselectAllTrEls();
this._unselectAllTdEls();
}
// From the top, update in-place existing rows
for(i=0; i<elRows.length; i++) {
this._updateTrEl(elRows[i], aRecords[i]);
}
// Add TR elements as necessary
for(i=elRows.length; i<aRecords.length; i++) {
this._addTrEl(aRecords[i]);
}
// Reinstate selected and sorted classes
if(bReselect) {
// Loop over each row
for(j=0; j<elRows.length; j++) {
var thisRow = elRows[j];
var sMode = this.get("selectionMode");
if ((sMode == "standard") || (sMode == "single")) {
// Set SELECTED
for(k=0; k<aSelectedRows.length; k++) {
if(aSelectedRows[k] === thisRow.yuiRecordId) {
YAHOO.util.Dom.addClass(thisRow, YAHOO.widget.DataTable.CLASS_SELECTED);
if(j === elRows.length-1) {
this._oAnchorRecord = this.getRecord(thisRow.yuiRecordId);
}
}
}
}
else {
// Loop over each cell
for(k=0; k<thisRow.cells.length; k++) {
var thisCell = thisRow.cells[k];
// Set SELECTED
for(l=0; l<aSelectedCells.length; l++) {
if((aSelectedCells[l].recordId === thisRow.yuiRecordId) &&
(aSelectedCells[l].columnId === thisCell.yuiColumnId)) {
YAHOO.util.Dom.addClass(thisCell, YAHOO.widget.DataTable.CLASS_SELECTED);
if(k === thisRow.cells.length-1) {
this._oAnchorCell = {record:this.getRecord(thisRow.yuiRecordId), column:this.getColumnById(thisCell.yuiColumnId)};
}
}
}
}
}
}
}
// Set FIRST/LAST, EVEN/ODD
this._setFirstRow();
this._setLastRow();
this._setRowStripes();
this.fireEvent("refreshEvent");
YAHOO.log("DataTable showing " + aRecords.length + " of " + this._oRecordSet.getLength() + " rows", "info", this.toString());
}
// Empty
else {
// Remove all rows
while(elTbody.hasChildNodes()) {
elTbody.deleteRow(-1);
}
this.showTableMessage(YAHOO.widget.DataTable.MSG_EMPTY, YAHOO.widget.DataTable.CLASS_EMPTY);
}
};
/**
* Nulls out the entire DataTable instance and related objects, removes attached
* event listeners, and clears out DOM elements inside the container. After
* calling this method, the instance reference should be expliclitly nulled by
* implementer, as in myDataTable = null. Use with caution!
*
* @method destroy
*/
YAHOO.widget.DataTable.prototype.destroy = function() {
// Destroy Cell Editor
YAHOO.util.Event.purgeElement(this._oCellEditor.container, true);
document.body.removeChild(this._oCellEditor.container);
var instanceName = this.toString();
var elContainer = this._elContainer;
// Unhook custom events
this._oRecordSet.unsubscribeAll();
this.unsubscribeAll();
// Unhook DOM events
YAHOO.util.Event.purgeElement(elContainer, true);
// Remove DOM elements
elContainer.innerHTML = "";
// Null out objects
for(var param in this) {
if(YAHOO.lang.hasOwnProperty(this, param)) {
this[param] = null;
}
}
YAHOO.log("DataTable instance destroyed: " + instanceName);
};
/**
* Displays message within secondary TBODY.
*
* @method showTableMessage
* @param sHTML {String} (optional) Value for innerHTML.
* @param sClassName {String} (optional) Classname.
*/
YAHOO.widget.DataTable.prototype.showTableMessage = function(sHTML, sClassName) {
var elCell = this._elMsgTd;
if(YAHOO.lang.isString(sHTML)) {
elCell.innerHTML = sHTML;
}
if(YAHOO.lang.isString(sClassName)) {
YAHOO.util.Dom.addClass(elCell, sClassName);
}
this._elMsgTbody.style.display = "";
this.fireEvent("tableMsgShowEvent", {html:sHTML, className:sClassName});
YAHOO.log("DataTable showing message: " + sHTML, "info", this.toString());
};
/**
* Hides secondary TBODY.
*
* @method hideTableMessage
*/
YAHOO.widget.DataTable.prototype.hideTableMessage = function() {
if(this._elMsgTbody.style.display != "none") {
this._elMsgTbody.style.display = "none";
this.fireEvent("tableMsgHideEvent");
YAHOO.log("DataTable message hidden", "info", this.toString());
}
};
/**
* Brings focus to DataTable instance.
*
* @method focus
*/
YAHOO.widget.DataTable.prototype.focus = function() {
this._focusEl(this._elTable);
};
// RECORDSET FUNCTIONS
/**
* Returns Record index for given TR element or page row index.
*
* @method getRecordIndex
* @param row {YAHOO.widget.Record | HTMLElement | Number} Record instance, TR
* element reference or page row index.
* @return {Number} Record's RecordSet index, or null.
*/
YAHOO.widget.DataTable.prototype.getRecordIndex = function(row) {
var nTrIndex;
if(!YAHOO.lang.isNumber(row)) {
// By Record
if(row instanceof YAHOO.widget.Record) {
return this._oRecordSet.getRecordIndex(row);
}
// By element reference
else {
// Find the TR element
var el = this.getTrEl(row);
if(el) {
nTrIndex = el.sectionRowIndex;
}
}
}
// By page row index
else {
nTrIndex = row;
}
if(YAHOO.lang.isNumber(nTrIndex)) {
if(this.get("paginated")) {
return this.get("paginator").startRecordIndex + nTrIndex;
}
else {
return nTrIndex;
}
}
YAHOO.log("Could not get Record index for row " + row, "warn", this.toString());
return null;
};
/**
* For the given identifier, returns the associated Record instance.
*
* @method getRecord
* @param row {HTMLElement | Number | String} DOM reference to a TR element (or
* child of a TR element), RecordSet position index, or Record ID.
* @return {YAHOO.widget.Record} Record instance.
*/
YAHOO.widget.DataTable.prototype.getRecord = function(row) {
var oRecord = this._oRecordSet.getRecord(row);
if(!oRecord) {
// Validate TR element
var elRow = this.getTrEl(row);
if(elRow) {
oRecord = this._oRecordSet.getRecord(elRow.yuiRecordId);
}
}
if(oRecord instanceof YAHOO.widget.Record) {
return this._oRecordSet.getRecord(oRecord);
}
else {
YAHOO.log("Could not get Record for row at " + row, "warn", this.toString());
return null;
}
};
// COLUMN FUNCTIONS
/**
* For the given identifier, returns the associated Column instance. Note: For
* getting Columns by Column ID string, please use the method getColumnById().
*
* @method getColumn
* @param column {HTMLElement | String | Number} DOM reference or ID string to a
* TH/TD element (or child of a TH/TD element), a Column key, or a ColumnSet key index.
* @return {YAHOO.widget.Column} Column instance.
*/
YAHOO.widget.DataTable.prototype.getColumn = function(column) {
var oColumn = this._oColumnSet.getColumn(column);
if(!oColumn) {
// Validate TD element
var elCell = this.getTdEl(column);
if(elCell) {
oColumn = this._oColumnSet.getColumnById(elCell.yuiColumnId);
}
// Validate TH element
else {
elCell = this.getThEl(column);
if(elCell) {
oColumn = this._oColumnSet.getColumnById(elCell.yuiColumnId);
}
}
}
if(!oColumn) {
YAHOO.log("Could not get Column for column at " + column, "warn", this.toString());
}
return oColumn;
};
/**
* For the given Column ID, returns the associated Column instance. Note: For
* getting Columns by key, please use the method getColumn().
*
* @method getColumnById
* @param column {String} Column ID string.
* @return {YAHOO.widget.Column} Column instance.
*/
YAHOO.widget.DataTable.prototype.getColumnById = function(column) {
return this._oColumnSet.getColumnById(column);
};
/**
* Sorts given Column.
*
* @method sortColumn
* @param oColumn {YAHOO.widget.Column} Column instance.
*/
YAHOO.widget.DataTable.prototype.sortColumn = function(oColumn) {
if(oColumn && (oColumn instanceof YAHOO.widget.Column)) {
if(!oColumn.sortable) {
YAHOO.util.Dom.addClass(this.getThEl(oColumn), YAHOO.widget.DataTable.CLASS_SORTABLE);
}
// What is the default sort direction?
var sortDir = (oColumn.sortOptions && oColumn.sortOptions.defaultOrder) ? oColumn.sortOptions.defaultOrder : "asc";
// Already sorted?
var oSortedBy = this.get("sortedBy");
if(oSortedBy && (oSortedBy.key === oColumn.key)) {
if(oSortedBy.dir) {
sortDir = (oSortedBy.dir == "asc") ? "desc" : "asc";
}
else {
sortDir = (sortDir == "asc") ? "desc" : "asc";
}
}
// Is there a custom sort handler function defined?
var sortFnc = (oColumn.sortOptions && YAHOO.lang.isFunction(oColumn.sortOptions.sortFunction)) ?
oColumn.sortOptions.sortFunction : function(a, b, desc) {
var sorted = YAHOO.util.Sort.compare(a.getData(oColumn.key),b.getData(oColumn.key), desc);
if(sorted === 0) {
return YAHOO.util.Sort.compare(a.getId(),b.getId(), desc);
}
else {
return sorted;
}
};
// Do the actual sort
var desc = (sortDir == "desc") ? true : false;
this._oRecordSet.sortRecords(sortFnc, desc);
// Update sortedBy tracker
this.set("sortedBy", {key:oColumn.key, dir:sortDir, column:oColumn});
// Reset to first page
//TODO: Keep selection in view
this.updatePaginator({currentPage:1});
// Update the UI
this.refreshView();
this.fireEvent("columnSortEvent",{column:oColumn,dir:sortDir});
YAHOO.log("Column \"" + oColumn.key + "\" sorted \"" + sortDir + "\"", "info", this.toString());
}
else {
YAHOO.log("Could not sort Column \"" + oColumn.key + "\"", "warn", this.toString());
}
};
// ROW FUNCTIONS
/**
* Adds one new Record of data into the RecordSet at the index if given,
* otherwise at the end. If the new Record is in page view, the
* corresponding DOM elements are also updated.
*
* @method addRow
* @param oData {Object} Object literal of data for the row.
* @param index {Number} (optional) RecordSet position index at which to add data.
*/
YAHOO.widget.DataTable.prototype.addRow = function(oData, index) {
if(oData && (oData.constructor == Object)) {
var oRecord = this._oRecordSet.addRecord(oData, index);
if(oRecord) {
var nTrIndex = this.getTrIndex(oRecord);
// Row is on current page
if(YAHOO.lang.isNumber(nTrIndex)) {
// Paginated so just refresh the view to keep pagination state
if(this.get("paginated")) {
this.refreshView();
}
// Add the TR element
else {
var newTrId = this._addTrEl(oRecord, nTrIndex);
if(newTrId) {
// Is this an insert or an append?
var append = (YAHOO.lang.isNumber(nTrIndex) &&
(nTrIndex == this._elTbody.rows.length-1)) ? true : false;
// Stripe the one new row
if(append) {
if((this._elTbody.rows.length-1)%2) {
YAHOO.util.Dom.addClass(newTrId, YAHOO.widget.DataTable.CLASS_ODD);
}
else {
YAHOO.util.Dom.addClass(newTrId, YAHOO.widget.DataTable.CLASS_EVEN);
}
}
// Restripe all the rows after the new one
else {
this._setRowStripes(nTrIndex);
}
// If new row is at the bottom
if(append) {
this._setLastRow();
}
// If new row is at the top
else if(YAHOO.lang.isNumber(index) && (nTrIndex === 0)) {
this._setFirstRow();
}
}
}
}
// Record is not on current page so just update pagination UI
else {
this.updatePaginator();
}
// TODO: what args to pass?
this.fireEvent("rowAddEvent", {record:oRecord});
// For log message
nTrIndex = (YAHOO.lang.isValue(nTrIndex))? nTrIndex : "n/a";
YAHOO.log("Added row: Record ID = " + oRecord.getId() +
", Record index = " + this.getRecordIndex(oRecord) +
", page row index = " + nTrIndex, "info", this.toString());
return;
}
}
YAHOO.log("Could not add row with " + YAHOO.lang.dump(oData), "error", this.toString());
};
/**
* Convenience method to add multiple rows.
*
* @method addRows
* @param aData {Object[]} Array of object literal data for the rows.
* @param index {Number} (optional) RecordSet position index at which to add data.
*/
YAHOO.widget.DataTable.prototype.addRows = function(aData, index) {
if(YAHOO.lang.isArray(aData)) {
var i;
if(YAHOO.lang.isNumber(index)) {
for(i=aData.length-1; i>-1; i--) {
this.addRow(aData[i], index);
}
}
else {
for(i=0; i<aData.length; i++) {
this.addRow(aData[i]);
}
}
}
else {
YAHOO.log("Could not add rows " + YAHOO.lang.dump(aData));
}
};
/**
* For the given row, updates the associated Record with the given data. If the
* row is on current page, the corresponding DOM elements are also updated.
*
* @method updateRow
* @param row {YAHOO.widget.Record | Number | HTMLElement | String}
* Which row to update: By Record instance, by Record's RecordSet
* position index, by HTMLElement reference to the TR element, or by ID string
* of the TR element.
* @param oData {Object} Object literal of data for the row.
*/
YAHOO.widget.DataTable.prototype.updateRow = function(row, oData) {
var oldRecord, oldData, updatedRecord, elRow;
// Get the Record directly
if((row instanceof YAHOO.widget.Record) || (YAHOO.lang.isNumber(row))) {
// Get the Record directly
oldRecord = this._oRecordSet.getRecord(row);
// Is this row on current page?
elRow = this.getTrEl(oldRecord);
}
// Get the Record by TR element
else {
elRow = this.getTrEl(row);
if(elRow) {
oldRecord = this.getRecord(elRow);
}
}
// Update the Record
if(oldRecord) {
// Copy data from the Record for the event that gets fired later
var oRecordData = oldRecord.getData();
oldData = {};
for(var param in oRecordData) {
oldData[param] = oRecordData[param];
}
updatedRecord = this._oRecordSet.updateRecord(oldRecord, oData);
}
else {
YAHOO.log("Could not update row " + row + " with the data : " +
YAHOO.lang.dump(oData), "error", this.toString());
return;
}
// Update the TR only if row is on current page
if(elRow) {
this._updateTrEl(elRow, updatedRecord);
}
this.fireEvent("rowUpdateEvent", {record:updatedRecord, oldData:oldData});
YAHOO.log("DataTable row updated: Record ID = " + updatedRecord.getId() +
", Record index = " + this.getRecordIndex(updatedRecord) +
", page row index = " + this.getTrIndex(updatedRecord), "info", this.toString());
};
/**
* Deletes the given row's Record from the RecordSet. If the row is on current page,
* the correspon