oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui/docs/YAHOO.widget.DataTable.html
JT Smith 20f8df1291 upgrading to YUI 2.6 
data tables are going to need some work yet, but the other stuff seems to be working 100%
2008-10-22 23:53:29 +00:00

22314 lines
1.1 MiB
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: datatable YAHOO.widget.DataTable (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>DataTable Widget&nbsp; <span class="subtitle">2.6.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_datatable.html">datatable</a>
&gt; YAHOO.widget.DataTable
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>YAHOO.widget.DataTable</b>
<span class="extends">
- extends <a href="Element.html">Element</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<dl class="subclasses">
<dt>Known Subclasses:</dd>
<dd>
<a href="YAHOO.widget.ScrollingDataTable.html">YAHOO.widget.ScrollingDataTable</a>
</dd>
</dl>
<div class="summary description">
DataTable class for the YUI DataTable widget.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.DataTable</strong>
<code>
(
elContainer
,
aColumnDefs
,
oDataSource
,
oConfigs
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer
&lt;HTMLElement&gt;
</code>
Container element for the TABLE.
</dd>
<dd>
<code>aColumnDefs
&lt;Object[]&gt;
</code>
Array of object literal Column definitions.
</dd>
<dd>
<code>oDataSource
&lt;YAHOO.util.DataSource&gt;
</code>
DataSource instance.
</dd>
<dd>
<code>oConfigs
&lt;object&gt;
</code>
(optional) Object literal of configuration values.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property__aDynFunctions">_aDynFunctions</a>
<code>- private Array</code>
</h4>
<div class="detail">
<div class="description">
Sparse array of custom functions to set column widths for browsers that don't
support dynamic CSS rules. Functions are added at the index representing
the number of rows they update.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__aSelections">_aSelections</a>
<code>- private Object[]</code>
</h4>
<div class="detail">
<div class="description">
Array to track row selections (by sRecordId) and/or cell selections
(by {recordId:sRecordId, columnKey:sColumnKey})
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__bInit">_bInit</a>
<code>- private Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if instance is initialized, so as to fire the initEvent after render.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elCaption">_elCaption</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the CAPTION element for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elColgroup">_elColgroup</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the COLGROUP element for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elContainer">_elContainer</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the container element for the DataTable instance into which
all other elements get created.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elMask">_elMask</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the mask element for the DataTable instance which disables it.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elMsgTbody">_elMsgTbody</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the secondary TBODY element used to display DataTable messages.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elMsgTd">_elMsgTd</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the secondary TBODY element's single TD element used to display DataTable messages.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elMsgTr">_elMsgTr</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the secondary TBODY element's single TR element used to display DataTable messages.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elTable">_elTable</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the TABLE element for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elTbody">_elTbody</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the primary TBODY element for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elThead">_elThead</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
DOM reference to the THEAD element for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__elTrTemplate">_elTrTemplate</a>
<code>- private {HTMLElement}</code>
</h4>
<div class="detail">
<div class="description">
Template row to create all new rows from.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__nIndex">_nIndex</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Index assigned to instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__nTdCount">_nTdCount</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Counter for IDs assigned to TD elements.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__nTrCount">_nTrCount</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Counter for IDs assigned to TR elements.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__oAnchorCell">_oAnchorCell</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
Object literal representing cell selection anchor:
{recordId:sRecordId, columnKey:sColumnKey}.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__oAnchorRecord">_oAnchorRecord</a>
<code>- private YAHOO.widget.Record</code>
</h4>
<div class="detail">
<div class="description">
Record instance of the row selection anchor.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__oCellEditor">_oCellEditor</a>
<code>- private YAHOO.widget.CellEditor</code>
</h4>
<div class="detail">
<div class="description">
The active CellEditor instance for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__oChainRender">_oChainRender</a>
<code>- private YAHOO.util.Chain</code>
</h4>
<div class="detail">
<div class="description">
Render chain.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__oColumnSet">_oColumnSet</a>
<code>- private YAHOO.widget.ColumnSet</code>
</h4>
<div class="detail">
<div class="description">
ColumnSet instance for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__oDataSource">_oDataSource</a>
<code>- private YAHOO.util.DataSource</code>
</h4>
<div class="detail">
<div class="description">
DataSource instance for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__oRecordSet">_oRecordSet</a>
<code>- private YAHOO.widget.RecordSet</code>
</h4>
<div class="detail">
<div class="description">
RecordSet instance for the DataTable instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__sFirstTrId">_sFirstTrId</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
ID string of first TR element of the current DataTable page.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__sId">_sId</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
Unique id assigned to instance "yui-dtN", useful prefix for generating unique
DOM ID strings and log messages.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__sLastTrId">_sLastTrId</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
ID string of the last TR element of the current DataTable page.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_configs">configs</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Returns object literal of initial configs.
</div>
</div>
<div class="default">
Default Value: {}
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DataTable._bDynStylesFallback">DataTable._bDynStylesFallback</a>
<code>- private static boolean</code>
</h4>
<div class="detail">
<div class="description">
Set to true if _elDynStyleNode cannot be populated due to browser incompatibility.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DataTable._elColumnDragTarget">DataTable._elColumnDragTarget</a>
<code>- private static HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Element reference to shared Column drag target.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DataTable._elColumnResizerProxy">DataTable._elColumnResizerProxy</a>
<code>- private static HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Element reference to shared Column resizer proxy.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DataTable._elDynStyleNode">DataTable._elDynStyleNode</a>
<code>- private static HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Reference to the STYLE node that is dynamically created and updated
in order to manage Column widths.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DataTable._nCount">DataTable._nCount</a>
<code>- private static Number</code>
</h4>
<div class="detail">
<div class="description">
Internal class variable for indexing multiple DataTable instances.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DataTable._nCurrentCount">DataTable._nCurrentCount</a>
<code>- private static Number</code>
</h4>
<div class="detail">
<div class="description">
Internal class variable tracking current number of DataTable instances,
so that certain class values can be reset when all instances are destroyed.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_DataTable._oDynStyles">DataTable._oDynStyles</a>
<code>- private static Object</code>
</h4>
<div class="detail">
<div class="description">
Object literal hash of Columns and their dynamically create style rules.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_ASC">DataTable.CLASS_ASC</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to ascending elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-asc"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_BUTTON">DataTable.CLASS_BUTTON</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to BUTTON elements and/or container elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-button"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_CHECKBOX">DataTable.CLASS_CHECKBOX</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to INPUT TYPE=CHECKBOX elements and/or container elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-checkbox"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_COLTARGET">DataTable.CLASS_COLTARGET</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to Column drag target.
</div>
</div>
<div class="default">
Default Value: "yui-dt-coltarget"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_DATA">DataTable.CLASS_DATA</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to data elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-data"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_DATATABLE">DataTable.CLASS_DATATABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to outer DataTable container.
</div>
</div>
<div class="default">
Default Value: "yui-dt"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_DEFAULT">DataTable.CLASS_DEFAULT</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to default indicators.
</div>
</div>
<div class="default">
Default Value: "yui-dt-default"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_DESC">DataTable.CLASS_DESC</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to descending elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-desc"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_DISABLED">DataTable.CLASS_DISABLED</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to disabled elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-disabled"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_DRAGGABLE">DataTable.CLASS_DRAGGABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to draggable elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-draggable"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_DROPDOWN">DataTable.CLASS_DROPDOWN</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to SELECT elements and/or container elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-dropdown"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_EDITABLE">DataTable.CLASS_EDITABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to editable elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-editable"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_EDITOR">DataTable.CLASS_EDITOR</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to CellEditor container elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-editor"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_EMPTY">DataTable.CLASS_EMPTY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to empty indicators.
</div>
</div>
<div class="default">
Default Value: "yui-dt-empty"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_ERROR">DataTable.CLASS_ERROR</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to error indicators.
</div>
</div>
<div class="default">
Default Value: "yui-dt-error"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_EVEN">DataTable.CLASS_EVEN</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to even elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-even"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_FIRST">DataTable.CLASS_FIRST</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to first elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-first"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_HIDDEN">DataTable.CLASS_HIDDEN</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to hidden elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-hidden"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_HIGHLIGHTED">DataTable.CLASS_HIGHLIGHTED</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to highlighted elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-highlighted"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_LABEL">DataTable.CLASS_LABEL</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to display label elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-label"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_LAST">DataTable.CLASS_LAST</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to last elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-last"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_LINER">DataTable.CLASS_LINER</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to liner DIV elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-liner"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_LOADING">DataTable.CLASS_LOADING</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to loading indicatorx.
</div>
</div>
<div class="default">
Default Value: "yui-dt-loading"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_MASK">DataTable.CLASS_MASK</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to mask element when DataTable is disabled.
</div>
</div>
<div class="default">
Default Value: "yui-dt-mask"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_MESSAGE">DataTable.CLASS_MESSAGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to messaging elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-message"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_NEXT">DataTable.CLASS_NEXT</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned next indicators.
</div>
</div>
<div class="default">
Default Value: "yui-dt-next"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_ODD">DataTable.CLASS_ODD</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to odd elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-odd"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_PAGE">DataTable.CLASS_PAGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to page number indicators.
</div>
</div>
<div class="default">
Default Value: "yui-dt-page"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_PAGINATOR">DataTable.CLASS_PAGINATOR</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to paginator container elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-paginator"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_PREVIOUS">DataTable.CLASS_PREVIOUS</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to previous indicators.
</div>
</div>
<div class="default">
Default Value: "yui-dt-previous"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_RADIO">DataTable.CLASS_RADIO</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to INPUT TYPE=RADIO elements and/or container elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-radio"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_RESIZEABLE">DataTable.CLASS_RESIZEABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to resizeable elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-resizeable"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_RESIZER">DataTable.CLASS_RESIZER</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to resizer handle elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-resizer"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_RESIZERLINER">DataTable.CLASS_RESIZERLINER</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to resizer liner elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-resizerliner"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_RESIZERPROXY">DataTable.CLASS_RESIZERPROXY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to resizer proxy elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-resizerproxy"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_SCROLLABLE">DataTable.CLASS_SCROLLABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to scrollable elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-scrollable"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_SELECTED">DataTable.CLASS_SELECTED</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to selected elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-selected"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.CLASS_SORTABLE">DataTable.CLASS_SORTABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to sortable elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-sortable"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_DataTable.Formatter">DataTable.Formatter</a>
<code>- static Object</code>
</h4>
<div class="detail">
<div class="description">
Cell formatting functions.
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method__clearMinWidth">_clearMinWidth</a></h4>
<div class="detail">
<code>
private
void
<strong>_clearMinWidth</strong>
(
oColumn
)
</code>
<div class="description">
Clears minWidth.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Which Column.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__clearTrTemplateEl">_clearTrTemplateEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_clearTrTemplateEl</strong>
(
)
</code>
<div class="description">
Clears TR element template in response to any Column state change.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__createTrEl">_createTrEl</a></h4>
<div class="detail">
<code>
private
HTMLElement
<strong>_createTrEl</strong>
(
oRecord
)
</code>
<div class="description">
Create a new TR element for a given Record and appends it with the correct
number of Column-state-classed TD elements. Striping is the responsibility of
the calling function, which may decide to stripe the single row, a subset of
rows, or all the rows.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>The new TR element. This must be added to the DOM.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__defaultPaginatorContainers">_defaultPaginatorContainers</a></h4>
<div class="detail">
<code>
private
void
<strong>_defaultPaginatorContainers</strong>
(
create
)
</code>
<div class="description">
Returns the default containers used for Paginators. If create param is
passed, the containers will be created and added to the DataTable container.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>create &lt;boolean&gt;</code>
Create the default containers if not found
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__deleteTrEl">_deleteTrEl</a></h4>
<div class="detail">
<code>
private
Boolean
<strong>_deleteTrEl</strong>
(
row
)
</code>
<div class="description">
Deletes TR element by DOM reference or by DataTable page row index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | Number&gt;</code>
TR element reference or Datatable page row index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>Returns true if successful, else returns false.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyColgroupEl">_destroyColgroupEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyColgroupEl</strong>
(
)
</code>
<div class="description">
Destroy's the DataTable COLGROUP element, if available.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyColumnHelpers">_destroyColumnHelpers</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyColumnHelpers</strong>
(
)
</code>
<div class="description">
Destroys elements associated with Column functionality: ColumnDD and ColumnResizers.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyContainerEl">_destroyContainerEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyContainerEl</strong>
(
elContainer
)
</code>
<div class="description">
Destroy's the DataTable outer container element, if available.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer &lt;HTMLElement&gt;</code>
Reference to the container element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyDraggableColumns">_destroyDraggableColumns</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyDraggableColumns</strong>
(
)
</code>
<div class="description">
Disables DD from top-level Column TH elements.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyMsgTbodyEl">_destroyMsgTbodyEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyMsgTbodyEl</strong>
(
)
</code>
<div class="description">
Destroy's the DataTable message TBODY element, if available.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyResizeableColumns">_destroyResizeableColumns</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyResizeableColumns</strong>
(
)
</code>
<div class="description">
Disables resizeability on key Column TH elements.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyTableEl">_destroyTableEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyTableEl</strong>
(
)
</code>
<div class="description">
Destroy's the DataTable TABLE element, if available.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyTbodyEl">_destroyTbodyEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyTbodyEl</strong>
(
)
</code>
<div class="description">
Destroy's the DataTable TBODY element, if available.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__destroyTheadEl">_destroyTheadEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_destroyTheadEl</strong>
(
)
</code>
<div class="description">
Destroy's the DataTable THEAD element, if available.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__focusEl">_focusEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_focusEl</strong>
(
el
)
</code>
<div class="description">
Sets focus on the given element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
Element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__formatTdEl">_formatTdEl</a></h4>
<div class="detail">
<code>
private
HTMLElement
<strong>_formatTdEl</strong>
(
oColumn
,
elTd
,
index
,
isLast
)
</code>
<div class="description">
Formats a basic TD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Associated Column instance.
</dd>
<dd>
<code>elTd &lt;HTMLElement&gt;</code>
An unformatted TD element.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
Column key index.
</dd>
<dd>
<code>isLast &lt;Boolean&gt;</code>
True if Column is last key of the ColumnSet.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>A formatted TD element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__getColumnClassnames">_getColumnClassnames</a></h4>
<div class="detail">
<code>
private
String
<strong>_getColumnClassnames</strong>
(
oColumn
,
aAddClasses
)
</code>
<div class="description">
Retruns classnames to represent current Column states.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>aAddClasses &lt;String[]&gt;</code>
An array of additional classnames to add to the
return value.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>A String of classnames to be assigned to TH or TD elements
for given Column.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__getSelectionAnchor">_getSelectionAnchor</a></h4>
<div class="detail">
<code>
private
void
<strong>_getSelectionAnchor</strong>
(
oTrigger
)
</code>
<div class="description">
Returns object literal of values that represent the selection anchor. Used
to determine selection behavior resulting from a user event.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oTrigger &lt;Object&gt;</code>
(Optional) Object literal of selection trigger values
(for key events).
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__getSelectionTrigger">_getSelectionTrigger</a></h4>
<div class="detail">
<code>
private
void
<strong>_getSelectionTrigger</strong>
(
)
</code>
<div class="description">
Returns object literal of values that represent the selection trigger. Used
to determine selection behavior resulting from a key event.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__getTrTemplateEl">_getTrTemplateEl</a></h4>
<div class="detail">
<code>
private
HTMLElement
<strong>_getTrTemplateEl</strong>
(
)
</code>
<div class="description">
Returns a new TR element template with TD elements classed with current
Column states.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>A TR element to be cloned and added to the DOM.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleCellBlockSelectionByKey">_handleCellBlockSelectionByKey</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleCellBlockSelectionByKey</strong>
(
e
)
</code>
<div class="description">
Determines selection behavior resulting from a key event when selection mode
is set to "cellblock".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
Event object.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleCellBlockSelectionByMouse">_handleCellBlockSelectionByMouse</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleCellBlockSelectionByMouse</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Determines selection behavior resulting from a mouse event when selection mode
is set to "cellblock".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleCellRangeSelectionByKey">_handleCellRangeSelectionByKey</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleCellRangeSelectionByKey</strong>
(
e
)
</code>
<div class="description">
Determines selection behavior resulting from a key event when selection mode
is set to "cellrange".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
Event object.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleCellRangeSelectionByMouse">_handleCellRangeSelectionByMouse</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleCellRangeSelectionByMouse</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Determines selection behavior resulting from a mouse event when selection mode
is set to "cellrange".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handlePaginatorChange">_handlePaginatorChange</a></h4>
<div class="detail">
<code>
private
void
<strong>_handlePaginatorChange</strong>
(
e
)
</code>
<div class="description">
Update the UI infrastructure in response to a "paginator" attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;Object&gt;</code>
Change event object containing keys 'type','newValue',
and 'prevValue'
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleSingleCellSelectionByKey">_handleSingleCellSelectionByKey</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleSingleCellSelectionByKey</strong>
(
e
)
</code>
<div class="description">
Determines selection behavior resulting from a key event when selection mode
is set to "singlecell".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
Event object.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleSingleCellSelectionByMouse">_handleSingleCellSelectionByMouse</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleSingleCellSelectionByMouse</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Determines selection behavior resulting from a mouse event when selection mode
is set to "singlecell".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleSingleSelectionByKey">_handleSingleSelectionByKey</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleSingleSelectionByKey</strong>
(
e
)
</code>
<div class="description">
Determines selection behavior resulting from a key event when selection mode
is set to "single".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
Event object.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleSingleSelectionByMouse">_handleSingleSelectionByMouse</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleSingleSelectionByMouse</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Determines selection behavior resulting from a mouse event when selection mode
is set to "single".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleStandardSelectionByKey">_handleStandardSelectionByKey</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleStandardSelectionByKey</strong>
(
e
)
</code>
<div class="description">
Determines selection behavior resulting from a key event when selection mode
is set to "standard".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
Event object.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleStandardSelectionByMouse">_handleStandardSelectionByMouse</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleStandardSelectionByMouse</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Determines selection behavior resulting from a mouse event when selection mode
is set to "standard".
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initCaptionEl">_initCaptionEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initCaptionEl</strong>
(
sCaption
)
</code>
<div class="description">
Creates HTML markup CAPTION element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sCaption &lt;String&gt;</code>
Text for caption.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initCellEditing">_initCellEditing</a></h4>
<div class="detail">
<code>
private
void
<strong>_initCellEditing</strong>
(
)
</code>
<div class="description">
Initializes CellEditor integration.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private deprecated">
<h4>
<a name="method__initCellEditorEl">_initCellEditorEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initCellEditorEl</strong>
(
)
</code>
<div class="description">
Backward compatibility.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> &#160;
</div>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initColgroupEl">_initColgroupEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initColgroupEl</strong>
(
elTable
)
</code>
<div class="description">
Initializes COLGROUP and COL elements for managing minWidth.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elTable &lt;HTMLElement&gt;</code>
TABLE element into which to create COLGROUP.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initColumnHelpers">_initColumnHelpers</a></h4>
<div class="detail">
<code>
private
void
<strong>_initColumnHelpers</strong>
(
)
</code>
<div class="description">
Initializes elements associated with Column functionality: ColumnDD and ColumnResizers.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initColumnSet">_initColumnSet</a></h4>
<div class="detail">
<code>
private
void
<strong>_initColumnSet</strong>
(
aColumnDefs
)
</code>
<div class="description">
Initializes ColumnSet.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aColumnDefs &lt;Object[]&gt;</code>
Array of object literal Column definitions.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initColumnSort">_initColumnSort</a></h4>
<div class="detail">
<code>
private
void
<strong>_initColumnSort</strong>
(
)
</code>
<div class="description">
Initializes Column sorting.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initConfigs">_initConfigs</a></h4>
<div class="detail">
<code>
private
void
<strong>_initConfigs</strong>
(
oConfig
)
</code>
<div class="description">
Initializes object literal of config values.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oConfig &lt;Object&gt;</code>
Object literal of config values.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initContainerEl">_initContainerEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initContainerEl</strong>
(
elContainer
)
</code>
<div class="description">
Initializes the DataTable outer container element, including a mask.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer &lt;HTMLElement | String&gt;</code>
HTML DIV element by reference or ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initDataSource">_initDataSource</a></h4>
<div class="detail">
<code>
private
void
<strong>_initDataSource</strong>
(
oDataSource
)
</code>
<div class="description">
Initializes DataSource.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oDataSource &lt;YAHOO.util.DataSource&gt;</code>
DataSource instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initDomElements">_initDomElements</a></h4>
<div class="detail">
<code>
private
void
<strong>_initDomElements</strong>
(
elContainer
)
</code>
<div class="description">
Initializes DOM elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer &lt;HTMLElement | String} HTML DIV element by reference or ID.
return {Boolean&gt;</code>
False in case of error, otherwise true
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initDraggableColumns">_initDraggableColumns</a></h4>
<div class="detail">
<code>
private
void
<strong>_initDraggableColumns</strong>
(
)
</code>
<div class="description">
Initializes top-level Column TH elements into DD instances.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initEvents">_initEvents</a></h4>
<div class="detail">
<code>
private
void
<strong>_initEvents</strong>
(
)
</code>
<div class="description">
Initialize internal event listeners
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initMsgTbodyEl">_initMsgTbodyEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initMsgTbodyEl</strong>
(
elTable
)
</code>
<div class="description">
Initializes TBODY element for messaging.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elTable &lt;HTMLElement&gt;</code>
TABLE element into which to create TBODY
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initRecordSet">_initRecordSet</a></h4>
<div class="detail">
<code>
private
void
<strong>_initRecordSet</strong>
(
)
</code>
<div class="description">
Initializes RecordSet.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initResizeableColumns">_initResizeableColumns</a></h4>
<div class="detail">
<code>
private
void
<strong>_initResizeableColumns</strong>
(
)
</code>
<div class="description">
Initializes resizeability on key Column TH elements.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initTableEl">_initTableEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initTableEl</strong>
(
elContainer
)
</code>
<div class="description">
Creates HTML markup for TABLE, COLGROUP, THEAD and TBODY elements in outer
container element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer &lt;HTMLElement&gt;</code>
Container element into which to create TABLE.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initTbodyEl">_initTbodyEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initTbodyEl</strong>
(
elTable
)
</code>
<div class="description">
Initializes TBODY element for data.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elTable &lt;HTMLElement&gt;</code>
TABLE element into which to create TBODY .
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initTheadEl">_initTheadEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initTheadEl</strong>
(
elTable
,
Initialized
)
</code>
<div class="description">
Initializes THEAD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elTable &lt;HTMLElement&gt;</code>
TABLE element into which to create COLGROUP.
</dd>
<dd>
<code>Initialized &lt;HTMLElement&gt;</code>
THEAD element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initThEl">_initThEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_initThEl</strong>
(
elTh
,
oColumn
)
</code>
<div class="description">
Populates TH element as defined by Column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elTh &lt;HTMLElement&gt;</code>
TH element reference.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column object.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__insertColgroupColEl">_insertColgroupColEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_insertColgroupColEl</strong>
(
index
)
</code>
<div class="description">
Adds a COL element to COLGROUP at given index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>index &lt;Number&gt;</code>
Index of new COL element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onDocumentClick">_onDocumentClick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onDocumentClick</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles click events on the DOCUMENT.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onDropdownChange">_onDropdownChange</a></h4>
<div class="detail">
<code>
private
void
<strong>_onDropdownChange</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles change events on SELECT elements within DataTable.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The change event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorBlockEvent">_onEditorBlockEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorBlockEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through blockEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorBlurEvent">_onEditorBlurEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorBlurEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through blurEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorCancelEvent">_onEditorCancelEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorCancelEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through cancelEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorKeydownEvent">_onEditorKeydownEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorKeydownEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through keydownEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorRevertEvent">_onEditorRevertEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorRevertEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through revertEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorSaveEvent">_onEditorSaveEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorSaveEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through saveEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorShowEvent">_onEditorShowEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorShowEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through showEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onEditorUnblockEvent">_onEditorUnblockEvent</a></h4>
<div class="detail">
<code>
private
void
<strong>_onEditorUnblockEvent</strong>
(
oArgs
)
</code>
<div class="description">
Passes through unblockEvent of the active CellEditor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onRenderChainEnd">_onRenderChainEnd</a></h4>
<div class="detail">
<code>
private
void
<strong>_onRenderChainEnd</strong>
(
)
</code>
<div class="description">
Validates minWidths whenever the render chain ends.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTableDblclick">_onTableDblclick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTableDblclick</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles dblclick events on the DataTable instance.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The dblclick event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTableFocus">_onTableFocus</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTableFocus</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles focus events on the DataTable instance.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The focus event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTableKeypress">_onTableKeypress</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTableKeypress</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles keypress events on the TABLE. Mainly to support stopEvent on Mac.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The key event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTableMousedown">_onTableMousedown</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTableMousedown</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles mousedown events on the DataTable instance.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The mousedown event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTableMouseout">_onTableMouseout</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTableMouseout</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles mouseout events on the DataTable instance.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The mouseout event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTableMouseover">_onTableMouseover</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTableMouseover</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles mouseover events on the DataTable instance.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The mouseover event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTableMouseup">_onTableMouseup</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTableMouseup</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles mouseup events on the DataTable instance.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The mouseup event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTbodyClick">_onTbodyClick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTbodyClick</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles click events on the primary TBODY element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTbodyFocus">_onTbodyFocus</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTbodyFocus</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles focus events on the TBODY element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The focus event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTbodyKeydown">_onTbodyKeydown</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTbodyKeydown</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles keydown events on the TBODY element. Handles selection behavior,
provides hooks for ENTER to edit functionality.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The key event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTheadClick">_onTheadClick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTheadClick</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles click events on the THEAD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTheadFocus">_onTheadFocus</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTheadFocus</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles focus events on the THEAD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The focus event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onTheadKeydown">_onTheadKeydown</a></h4>
<div class="detail">
<code>
private
void
<strong>_onTheadKeydown</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles keydown events on the THEAD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The key event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.wiget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__removeColgroupColEl">_removeColgroupColEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_removeColgroupColEl</strong>
(
index
)
</code>
<div class="description">
Removes a COL element to COLGROUP at given index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>index &lt;Number&gt;</code>
Index of removed COL element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__reorderColgroupColEl">_reorderColgroupColEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_reorderColgroupColEl</strong>
(
aKeyIndexes
,
newIndex
)
</code>
<div class="description">
Reorders a COL element from old index(es) to new index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aKeyIndexes &lt;Number[]&gt;</code>
Array of indexes of removed COL element.
</dd>
<dd>
<code>newIndex &lt;Number&gt;</code>
New index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__repaintGecko">_repaintGecko</a></h4>
<div class="detail">
<code>
private
void
<strong>_repaintGecko</strong>
(
)
</code>
<div class="description">
Forces Gecko repaint.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__repaintOpera">_repaintOpera</a></h4>
<div class="detail">
<code>
private
void
<strong>_repaintOpera</strong>
(
)
</code>
<div class="description">
Forces Opera repaint.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__repaintWebkit">_repaintWebkit</a></h4>
<div class="detail">
<code>
private
void
<strong>_repaintWebkit</strong>
(
)
</code>
<div class="description">
Forces Webkit repaint.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__restoreMinWidth">_restoreMinWidth</a></h4>
<div class="detail">
<code>
private
void
<strong>_restoreMinWidth</strong>
(
oColumn
)
</code>
<div class="description">
Restores minWidth.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Which Column.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__runRenderChain">_runRenderChain</a></h4>
<div class="detail">
<code>
private
void
<strong>_runRenderChain</strong>
(
)
</code>
<div class="description">
Internal wrapper calls run() on render Chain instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setColumnWidth">_setColumnWidth</a></h4>
<div class="detail">
<code>
private
void
<strong>_setColumnWidth</strong>
(
oColumn
,
sWidth
,
sOverflow
)
</code>
<div class="description">
Sets liner DIV elements of given Column to given width. When value should be
auto-calculated to fit content overflow is set to visible, otherwise overflow
is set to hidden. No validations against minimum width and no updating
Column.width value.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>sWidth &lt;String&gt;</code>
New width value.
</dd>
<dd>
<code>sOverflow &lt;String&gt;</code>
Should be "hidden" when Column width is explicitly
being set to a value, but should be "visible" when Column is meant to auto-fit content.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setColumnWidthDynFunction">_setColumnWidthDynFunction</a></h4>
<div class="detail">
<code>
private
void
<strong>_setColumnWidthDynFunction</strong>
(
oColumn
,
sWidth
)
</code>
<div class="description">
Updates width of a Column's liner DIV elements by dynamically creating a
function to update all element style properties in one pass. Note: This
technique is not supported in sandboxed environments that prohibit EVALs.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>sWidth &lt;String&gt;</code>
New width value.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setColumnWidthDynStyles">_setColumnWidthDynStyles</a></h4>
<div class="detail">
<code>
private
void
<strong>_setColumnWidthDynStyles</strong>
(
oColumn
,
sWidth
)
</code>
<div class="description">
Updates width of a Column's liner DIV elements by dynamically creating a
STYLE node and writing and updating CSS style rules to it. If this fails during
runtime, the fallback method _setColumnWidthDynFunction() will be called.
Notes: This technique is not performant in IE6. IE7 crashes if DataTable is
nested within another TABLE element. For these cases, it is recommended to
use the method _setColumnWidthDynFunction by setting _bDynStylesFallback to TRUE.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>sWidth &lt;String&gt;</code>
New width value.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setFirstRow">_setFirstRow</a></h4>
<div class="detail">
<code>
private
void
<strong>_setFirstRow</strong>
(
)
</code>
<div class="description">
Assigns the class YAHOO.widget.DataTable.CLASS_FIRST to the first TR element
of the DataTable page and updates internal tracker.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setLastRow">_setLastRow</a></h4>
<div class="detail">
<code>
private
void
<strong>_setLastRow</strong>
(
)
</code>
<div class="description">
Assigns the class YAHOO.widget.DataTable.CLASS_LAST to the last TR element
of the DataTable page and updates internal tracker.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setRowStripes">_setRowStripes</a></h4>
<div class="detail">
<code>
private
void
<strong>_setRowStripes</strong>
(
row
,
range
)
</code>
<div class="description">
Assigns the classes DT.CLASS_EVEN and DT.CLASS_ODD to one, many, or all TR elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | Number&gt;</code>
(optional) HTML TR element reference
or string ID, or page row index of where to start striping.
</dd>
<dd>
<code>range &lt;Number&gt;</code>
(optional) If given, how many rows to stripe, otherwise
stripe all the rows until the end.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__setSelections">_setSelections</a></h4>
<div class="detail">
<code>
private
void
<strong>_setSelections</strong>
(
)
</code>
<div class="description">
Assigns the class DT.CLASS_SELECTED to TR and TD elements.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method__syncColWidths">_syncColWidths</a></h4>
<div class="detail">
<code>
void
<strong>_syncColWidths</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use validateColumnWidths.
</div>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__unselectAllTdEls">_unselectAllTdEls</a></h4>
<div class="detail">
<code>
private
void
<strong>_unselectAllTdEls</strong>
(
)
</code>
<div class="description">
Convenience method to remove the class YAHOO.widget.DataTable.CLASS_SELECTED
from all TD elements in the internal tracker.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__unselectAllTrEls">_unselectAllTrEls</a></h4>
<div class="detail">
<code>
private
void
<strong>_unselectAllTrEls</strong>
(
)
</code>
<div class="description">
Convenience method to remove the class YAHOO.widget.DataTable.CLASS_SELECTED
from all TR elements on the page.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__unsetFirstRow">_unsetFirstRow</a></h4>
<div class="detail">
<code>
private
void
<strong>_unsetFirstRow</strong>
(
)
</code>
<div class="description">
Removes the class YAHOO.widget.DataTable.CLASS_FIRST from the first TR element
of the DataTable page and updates internal tracker.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__unsetLastRow">_unsetLastRow</a></h4>
<div class="detail">
<code>
private
void
<strong>_unsetLastRow</strong>
(
)
</code>
<div class="description">
Removes the class YAHOO.widget.DataTable.CLASS_LAST from the last TR element
of the DataTable page and updates internal tracker.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__updatePaginator">_updatePaginator</a></h4>
<div class="detail">
<code>
private
void
<strong>_updatePaginator</strong>
(
newPag
)
</code>
<div class="description">
Method executed during set() operation for the "paginator" attribute.
Adds and/or severs event listeners between DataTable and Paginator
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>newPag &lt;Paginator&gt;</code>
Paginator instance (or null) for DataTable to use
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__updateTrEl">_updateTrEl</a></h4>
<div class="detail">
<code>
private
HTMLElement
<strong>_updateTrEl</strong>
(
elTr
,
oRecord
)
</code>
<div class="description">
Formats the contents of the given TR's TD elements with data from the given
Record. Only innerHTML should change, nothing structural.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elTr &lt;HTMLElement&gt;</code>
The TR element to update.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
The associated Record instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>DOM reference to the new TR element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addRow">addRow</a></h4>
<div class="detail">
<code>
void
<strong>addRow</strong>
(
oData
,
index
)
</code>
<div class="description">
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.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oData &lt;Object&gt;</code>
Object literal of data for the row.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
(optional) RecordSet position index at which to add data.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addRows">addRows</a></h4>
<div class="detail">
<code>
void
<strong>addRows</strong>
(
aData
,
index
)
</code>
<div class="description">
Convenience method to add multiple rows.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aData &lt;Object[]&gt;</code>
Array of object literal data for the rows.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
(optional) RecordSet position index at which to add data.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cancelCellEditor">cancelCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>cancelCellEditor</strong>
(
)
</code>
<div class="description">
Cancels active CellEditor.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_clearTextSelection">clearTextSelection</a></h4>
<div class="detail">
<code>
void
<strong>clearTextSelection</strong>
(
)
</code>
<div class="description">
Clears browser text selection. Useful to call on rowSelectEvent or
cellSelectEvent to prevent clicks or dblclicks from selecting text in the
browser.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_DataTable._cloneObject">DataTable._cloneObject</a></h4>
<div class="detail">
<code>
private
static
void
<strong>DataTable._cloneObject</strong>
(
o
)
</code>
<div class="description">
Clones object literal or array of object literals.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>o &lt;Object&gt;</code>
Object.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_DataTable._destroyColumnDragTargetEl">DataTable._destroyColumnDragTargetEl</a></h4>
<div class="detail">
<code>
private
static
void
<strong>DataTable._destroyColumnDragTargetEl</strong>
(
)
</code>
<div class="description">
Destroys shared Column drag target.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_DataTable._destroyColumnResizerProxyEl">DataTable._destroyColumnResizerProxyEl</a></h4>
<div class="detail">
<code>
private
static
HTMLElement
<strong>DataTable._destroyColumnResizerProxyEl</strong>
(
)
</code>
<div class="description">
Destroys shared Column resizer proxy.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to Column resizer proxy.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_DataTable._initColumnDragTargetEl">DataTable._initColumnDragTargetEl</a></h4>
<div class="detail">
<code>
private
static
HTMLElement
<strong>DataTable._initColumnDragTargetEl</strong>
(
)
</code>
<div class="description">
Creates HTML markup for shared Column drag target.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to Column drag target.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_DataTable._initColumnResizerProxyEl">DataTable._initColumnResizerProxyEl</a></h4>
<div class="detail">
<code>
private
static
HTMLElement
<strong>DataTable._initColumnResizerProxyEl</strong>
(
)
</code>
<div class="description">
Creates HTML markup for shared Column resizer proxy.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to Column resizer proxy.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_DataTable.editCheckbox">DataTable.editCheckbox</a></h4>
<div class="detail">
<code>
void
<strong>DataTable.editCheckbox</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use YAHOO.widget.CheckboxCellEditor.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_DataTable.editDate">DataTable.editDate</a></h4>
<div class="detail">
<code>
void
<strong>DataTable.editDate</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use YAHOO.widget.DateCellEditor.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_DataTable.editDropdown">DataTable.editDropdown</a></h4>
<div class="detail">
<code>
void
<strong>DataTable.editDropdown</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use YAHOO.widget.DropdownCellEditor.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_DataTable.editRadio">DataTable.editRadio</a></h4>
<div class="detail">
<code>
void
<strong>DataTable.editRadio</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use YAHOO.widget.RadioCellEditor.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_DataTable.editTextarea">DataTable.editTextarea</a></h4>
<div class="detail">
<code>
void
<strong>DataTable.editTextarea</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use YAHOO.widget.TextareaCellEditor
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_DataTable.editTextbox">DataTable.editTextbox</a></h4>
<div class="detail">
<code>
void
<strong>DataTable.editTextbox</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use YAHOO.widget.TextboxCellEditor
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatButton">DataTable.formatButton</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatButton</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats a BUTTON element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object | Boolean&gt;</code>
Data value for the cell. By default, the value
is what gets written to the BUTTON.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatCheckbox">DataTable.formatCheckbox</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatCheckbox</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats a CHECKBOX element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object | Boolean} Data value for the cell. Can be a simple
Boolean to indicate whether checkbox is checked or not. Can be object literal
{checked:bBoolean, label:sLabel&gt;</code>
. Other forms of oData require a custom
formatter.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatCurrency">DataTable.formatCurrency</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatCurrency</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats currency. Default unit is USD.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Number&gt;</code>
Data value for the cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatDate">DataTable.formatDate</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatDate</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats JavaScript Dates.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
Data value for the cell, or null.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatDefault">DataTable.formatDefault</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatDefault</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Default cell formatter
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
(Optional) Data value for the cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatDropdown">DataTable.formatDropdown</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatDropdown</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats SELECT elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
Data value for the cell, or null.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatEmail">DataTable.formatEmail</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatEmail</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats emails.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
Data value for the cell, or null.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatLink">DataTable.formatLink</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatLink</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats links.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
Data value for the cell, or null.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatNumber">DataTable.formatNumber</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatNumber</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats numbers.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
Data value for the cell, or null.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatRadio">DataTable.formatRadio</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatRadio</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats INPUT TYPE=RADIO elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
(Optional) Data value for the cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatText">DataTable.formatText</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatText</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats text strings.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
(Optional) Data value for the cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatTextarea">DataTable.formatTextarea</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatTextarea</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats TEXTAREA elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
(Optional) Data value for the cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.formatTextbox">DataTable.formatTextbox</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.formatTextbox</strong>
(
el
,
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
Formats INPUT TYPE=TEXT elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element to format with markup.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
(Optional) Data value for the cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_DataTable.formatTheadCell">DataTable.formatTheadCell</a></h4>
<div class="detail">
<code>
void
<strong>DataTable.formatTheadCell</strong>
(
elCellLabel
,
oColumn
,
oSortedBy
)
</code>
<div class="description">
Outputs markup into the given TH based on given Column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elCellLabel &lt;HTMLElement&gt;</code>
The label SPAN element within the TH liner,
not the liner DIV element.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oSortedBy &lt;Object&gt;</code>
Sort state object literal.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use formatTheadCell.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_DataTable.validateNumber">DataTable.validateNumber</a></h4>
<div class="detail">
<code>
static
void
<strong>DataTable.validateNumber</strong>
(
oData
)
</code>
<div class="description">
Validates data value to type Number, doing type conversion as
necessary. A valid Number value is return, else null is returned
if input value does not validate.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oData &lt;Object&gt;</code>
Data to validate.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_deleteRow">deleteRow</a></h4>
<div class="detail">
<code>
void
<strong>deleteRow</strong>
(
row
)
</code>
<div class="description">
Deletes the given row's Record from the RecordSet. If the row is on current page,
the corresponding DOM elements are also deleted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | Number&gt;</code>
DOM element reference or ID string
to DataTable page element or RecordSet index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_deleteRows">deleteRows</a></h4>
<div class="detail">
<code>
void
<strong>deleteRows</strong>
(
row
,
count
)
</code>
<div class="description">
Convenience method to delete multiple rows.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | Number&gt;</code>
DOM element reference or ID string
to DataTable page element or RecordSet index.
</dd>
<dd>
<code>count &lt;Number&gt;</code>
(optional) How many rows to delete. A negative value
will delete towards the beginning.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail">
<code>
void
<strong>destroy</strong>
(
)
</code>
<div class="description">
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!
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_destroyCellEditor">destroyCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>destroyCellEditor</strong>
(
)
</code>
<div class="description">
Destroys active CellEditor instance and UI.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_disable">disable</a></h4>
<div class="detail">
<code>
void
<strong>disable</strong>
(
)
</code>
<div class="description">
Disables DataTable UI.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doBeforeLoadData">doBeforeLoadData</a></h4>
<div class="detail">
<code>
Boolean
<strong>doBeforeLoadData</strong>
(
sRequest
,
oResponse
,
oPayload
)
</code>
<div class="description">
Overridable method gives implementers a hook to access data before
it gets added to RecordSet and rendered to the TBODY.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>oPayload &lt;MIXED&gt;</code>
additional arguments
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>Return true to continue loading data into RecordSet and
updating DataTable with new Records, false to cancel.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doBeforePaginatorChange">doBeforePaginatorChange</a></h4>
<div class="detail">
<code>
Boolean
<strong>doBeforePaginatorChange</strong>
(
oPaginatorState
)
</code>
<div class="description">
Overridable method gives implementers a hook to show loading message before
changing Paginator value.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oPaginatorState &lt;Object&gt;</code>
An object literal describing the proposed pagination state.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>Return true to continue changing Paginator value.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doBeforeShowCellEditor">doBeforeShowCellEditor</a></h4>
<div class="detail">
<code>
Boolean
<strong>doBeforeShowCellEditor</strong>
(
oCellEditor
)
</code>
<div class="description">
Overridable abstract method to customize CellEditor before showing.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oCellEditor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>Return true to continue showing CellEditor.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doBeforeSortColumn">doBeforeSortColumn</a></h4>
<div class="detail">
<code>
Boolean
<strong>doBeforeSortColumn</strong>
(
oColumn
,
sSortDir
)
</code>
<div class="description">
Overridable method gives implementers a hook to show loading message before
sorting Column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>sSortDir &lt;String&gt;</code>
YAHOO.widget.DataTable.CLASS_ASC or
YAHOO.widget.DataTable.CLASS_DESC.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>Return true to continue sorting Column.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focus">focus</a></h4>
<div class="detail">
<code>
void
<strong>focus</strong>
(
)
</code>
<div class="description">
Brings focus to the TBODY element. Alias to focusTbodyEl.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focusTbodyEl">focusTbodyEl</a></h4>
<div class="detail">
<code>
void
<strong>focusTbodyEl</strong>
(
)
</code>
<div class="description">
Brings focus to the TBODY element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focusTheadEl">focusTheadEl</a></h4>
<div class="detail">
<code>
void
<strong>focusTheadEl</strong>
(
)
</code>
<div class="description">
Brings focus to the THEAD element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_formatCell">formatCell</a></h4>
<div class="detail">
<code>
void
<strong>formatCell</strong>
(
elCell
,
oRecord
,
oColumn
)
</code>
<div class="description">
Outputs markup into the given TD based on given Record.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elCell &lt;HTMLElement&gt;</code>
The liner DIV element within the TD.
</dd>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
(Optional) Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
(Optional) Column instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getAboveTdEl">getAboveTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getAboveTdEl</strong>
(
cell
)
</code>
<div class="description">
Returns DOM reference to the above TD element from the given cell, or null.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String | Object} DOM element reference or string ID, or
object literal of syntax {record:oRecord, column:oColumn&gt;</code>
from which to get next TD element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to next TD element, or null.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getBelowTdEl">getBelowTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getBelowTdEl</strong>
(
cell
)
</code>
<div class="description">
Returns DOM reference to the below TD element from the given cell, or null.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String | Object} DOM element reference or string ID, or
object literal of syntax {record:oRecord, column:oColumn&gt;</code>
from which to get previous TD element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to previous TD element, or null.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_getBody">getBody</a></h4>
<div class="detail">
<code>
void
<strong>getBody</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use getTbodyEl().
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_getCell">getCell</a></h4>
<div class="detail">
<code>
void
<strong>getCell</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use getTdEl().
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getCellEditor">getCellEditor</a></h4>
<div class="detail">
<code>
YAHOO.widget.CellEditor
<strong>getCellEditor</strong>
(
)
</code>
<div class="description">
Returns current CellEditor instance, or null.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
YAHOO.widget.CellEditor
</code></dt>
<dd>CellEditor instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getColumn">getColumn</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column
<strong>getColumn</strong>
(
column
)
</code>
<div class="description">
For the given identifier, returns the associated Column instance. Note: For
getting Columns by Column ID string, please use the method getColumnById().
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;HTMLElement | String | Number&gt;</code>
TH/TD element (or child of a
TH/TD element), a Column key, or a ColumnSet key index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column
</code></dt>
<dd>Column instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getColumnById">getColumnById</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column
<strong>getColumnById</strong>
(
column
)
</code>
<div class="description">
For the given Column ID, returns the associated Column instance. Note: For
getting Columns by key, please use the method getColumn().
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;String&gt;</code>
Column ID string.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column
</code></dt>
<dd>Column instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getColumnSet">getColumnSet</a></h4>
<div class="detail">
<code>
YAHOO.widget.ColumnSet
<strong>getColumnSet</strong>
(
)
</code>
<div class="description">
Returns the DataTable instance's ColumnSet instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
YAHOO.widget.ColumnSet
</code></dt>
<dd>ColumnSet instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getColumnSortDir">getColumnSortDir</a></h4>
<div class="detail">
<code>
String
<strong>getColumnSortDir</strong>
(
oColumn
,
oSortedBy
)
</code>
<div class="description">
For the given Column instance, returns next direction to sort.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>oSortedBy &lt;Object&gt;</code>
(optional) Specify the state, or use current state.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>YAHOO.widget.DataTable.CLASS_ASC or YAHOO.widget.DataTableCLASS_DESC.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getContainerEl">getContainerEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getContainerEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the DataTable's container element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to DIV element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getDataSource">getDataSource</a></h4>
<div class="detail">
<code>
YAHOO.util.DataSource
<strong>getDataSource</strong>
(
)
</code>
<div class="description">
Returns the DataTable instance's DataSource instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
YAHOO.util.DataSource
</code></dt>
<dd>DataSource instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getFirstTdEl">getFirstTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getFirstTdEl</strong>
(
row
)
</code>
<div class="description">
Returns DOM reference to the first TD element in the DataTable page (by default),
the first TD element of the optionally given row, or null.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement&gt;</code>
(optional) row from which to get first TD
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TD element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getFirstTrEl">getFirstTrEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getFirstTrEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the first TR element in the DataTable page, or null.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TR element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getId">getId</a></h4>
<div class="detail">
<code>
String
<strong>getId</strong>
(
)
</code>
<div class="description">
Returns unique id assigned to instance, which is a useful prefix for
generating unique DOM ID strings.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique ID of the DataSource instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getLastSelectedCell">getLastSelectedCell</a></h4>
<div class="detail">
<code>
Object
<strong>getLastSelectedCell</strong>
(
)
</code>
<div class="description">
Returns last selected cell as an object literal:
{recordId:sRecordId, columnKey:sColumnKey}.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>Object literal representation of a cell.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getLastSelectedRecord">getLastSelectedRecord</a></h4>
<div class="detail">
<code>
String
<strong>getLastSelectedRecord</strong>
(
)
</code>
<div class="description">
Returns last selected Record ID.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Record ID of last selected row.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getLastTdEl">getLastTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getLastTdEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the last TD element in the DataTable page (by default),
the first TD element of the optionally given row, or null.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to last TD element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getLastTrEl">getLastTrEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getLastTrEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the last TR element in the DataTable page, or null.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to last TR element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getMsgTbodyEl">getMsgTbodyEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getMsgTbodyEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the DataTable's secondary TBODY element that is
used to display messages.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TBODY element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getMsgTdEl">getMsgTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getMsgTdEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the TD element within the secondary TBODY that is
used to display messages.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TD element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getNextTdEl">getNextTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getNextTdEl</strong>
(
cell
)
</code>
<div class="description">
Returns DOM reference to the next TD element from the given cell, or null.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String | Object} DOM element reference or string ID, or
object literal of syntax {record:oRecord, column:oColumn&gt;</code>
from which to get next TD element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to next TD element, or null.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getNextTrEl">getNextTrEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getNextTrEl</strong>
(
row
)
</code>
<div class="description">
Returns DOM reference to the next TR element from the given TR element, or null.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | Number | YAHOO.widget.Record&gt;</code>
Element
reference, ID string, page row index, or Record from which to get next TR element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to next TR element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getPreviousTdEl">getPreviousTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getPreviousTdEl</strong>
(
cell
)
</code>
<div class="description">
Returns DOM reference to the previous TD element from the given cell, or null.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String | Object} DOM element reference or string ID, or
object literal of syntax {record:oRecord, column:oColumn&gt;</code>
from which to get previous TD element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to previous TD element, or null.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getPreviousTrEl">getPreviousTrEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getPreviousTrEl</strong>
(
row
)
</code>
<div class="description">
Returns DOM reference to the previous TR element from the given TR element, or null.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | Number | YAHOO.widget.Record&gt;</code>
Element
reference, ID string, page row index, or Record from which to get previous TR element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to previous TR element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getRecord">getRecord</a></h4>
<div class="detail">
<code>
YAHOO.widget.Record
<strong>getRecord</strong>
(
row
)
</code>
<div class="description">
For the given identifier, returns the associated Record instance.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | Number | String&gt;</code>
DOM reference to a TR element (or
child of a TR element), RecordSet position index, or Record ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Record
</code></dt>
<dd>Record instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getRecordIndex">getRecordIndex</a></h4>
<div class="detail">
<code>
Number
<strong>getRecordIndex</strong>
(
row
)
</code>
<div class="description">
Returns Record index for given TR element or page row index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;YAHOO.widget.Record | HTMLElement | Number&gt;</code>
Record instance, TR
element reference or page row index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Number
</code></dt>
<dd>Record's RecordSet index, or null.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getRecordSet">getRecordSet</a></h4>
<div class="detail">
<code>
YAHOO.widget.RecordSet
<strong>getRecordSet</strong>
(
)
</code>
<div class="description">
Returns the DataTable instance's RecordSet instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
YAHOO.widget.RecordSet
</code></dt>
<dd>RecordSet instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_getRow">getRow</a></h4>
<div class="detail">
<code>
void
<strong>getRow</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use getTrEl().
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSelectedCells">getSelectedCells</a></h4>
<div class="detail">
<code>
Object[]
<strong>getSelectedCells</strong>
(
)
</code>
<div class="description">
Returns selected cells as an array of object literals:
{recordId:sRecordId, columnKey:sColumnKey}.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object[]
</code></dt>
<dd>Array of selected cells by Record ID and Column ID.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSelectedColumns">getSelectedColumns</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column[]
<strong>getSelectedColumns</strong>
(
)
</code>
<div class="description">
Returns an array selected Column instances.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column[]
</code></dt>
<dd>Array of Column instances.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSelectedRows">getSelectedRows</a></h4>
<div class="detail">
<code>
String[]
<strong>getSelectedRows</strong>
(
)
</code>
<div class="description">
Returns selected rows as an array of Record IDs.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String[]
</code></dt>
<dd>Array of selected rows by Record ID.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSelectedTdEls">getSelectedTdEls</a></h4>
<div class="detail">
<code>
HTMLElement[]
<strong>getSelectedTdEls</strong>
(
)
</code>
<div class="description">
Returns array of selected TD elements on the page.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement[]
</code></dt>
<dd>Array of selected TD elements.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getSelectedTrEls">getSelectedTrEls</a></h4>
<div class="detail">
<code>
HTMLElement[]
<strong>getSelectedTrEls</strong>
(
)
</code>
<div class="description">
Returns array of selected TR elements on the page.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement[]
</code></dt>
<dd>Array of selected TR elements.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getState">getState</a></h4>
<div class="detail">
<code>
Object
<strong>getState</strong>
(
)
</code>
<div class="description">
Returns on object literal representing the DataTable instance's current
state with the following properties:
<dl>
<dt>pagination</dt>
<dd>Instance of YAHOO.widget.Paginator</dd>
<dt>sortedBy</dt>
<dd>
<dl>
<dt>sortedBy.key</dt>
<dd>{String} Key of sorted Column</dd>
<dt>sortedBy.dir</dt>
<dd>{String} Initial sort direction, either YAHOO.widget.DataTable.CLASS_ASC or YAHOO.widget.DataTable.CLASS_DESC</dd>
</dl>
</dd>
<dt>selectedRows</dt>
<dd>Array of selected rows by Record ID.</dd>
<dt>selectedCells</dt>
<dd>Selected cells as an array of object literals:
{recordId:sRecordId, columnKey:sColumnKey}</dd>
</dl>
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>DataTable instance state object literal values.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getTableEl">getTableEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getTableEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the DataTable's TABLE element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TABLE element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getTbodyEl">getTbodyEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getTbodyEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the DataTable's primary TBODY element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TBODY element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getTdEl">getTdEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getTdEl</strong>
(
cell
)
</code>
<div class="description">
Returns DOM reference to a TD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String | Object} TD element or child of a TD element, or
object literal of syntax {record:oRecord, column:oColumn&gt;</code>
.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TD element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getTdLinerEl">getTdLinerEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getTdLinerEl</strong>
(
cell
)
</code>
<div class="description">
Returns DOM reference to a TD liner element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | Object} TD element or child of a TD element, or
object literal of syntax {record:oRecord, column:oColumn&gt;</code>
.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TD liner element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getTheadEl">getTheadEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getTheadEl</strong>
(
)
</code>
<div class="description">
Returns DOM reference to the DataTable's THEAD element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to THEAD element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getThEl">getThEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getThEl</strong>
(
theadCell
)
</code>
<div class="description">
Returns DOM reference to a TH element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>theadCell &lt;YAHOO.widget.Column | HTMLElement | String&gt;</code>
Column instance,
DOM element reference, or string ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TH element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getThLinerEl">getThLinerEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getThLinerEl</strong>
(
theadCell
)
</code>
<div class="description">
Returns DOM reference to a TH liner element. Needed to normalize for resizeable
Columns, which have an additional resizer liner DIV element between the TH
element and the liner DIV element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>theadCell &lt;YAHOO.widget.Column | HTMLElement | String&gt;</code>
Column instance,
DOM element reference, or string ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TH liner element.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getTrEl">getTrEl</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getTrEl</strong>
(
row
)
</code>
<div class="description">
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.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | Number | YAHOO.widget.Record&gt;</code>
Which row to
get: by element reference, ID string, page row index, or Record.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TR element, or null.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getTrIndex">getTrIndex</a></h4>
<div class="detail">
<code>
Number
<strong>getTrIndex</strong>
(
row
)
</code>
<div class="description">
Returns the page row index of given row. Returns null if the row is not on the
current DataTable page.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | YAHOO.widget.Record | Number&gt;</code>
DOM or ID
string reference to an element within the DataTable page, a Record instance,
or a Record's RecordSet index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Number
</code></dt>
<dd>Page row index, or null if row does not exist or is not on current page.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_handleDataReturnPayload">handleDataReturnPayload</a></h4>
<div class="detail">
<code>
MIXED
<strong>handleDataReturnPayload</strong>
(
oRequest
,
oResponse
,
oPayload
)
</code>
<div class="description">
Hook to update oPayload before consumption.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRequest &lt;MIXED&gt;</code>
Original generated request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>oPayload &lt;MIXED&gt;</code>
State values.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
MIXED
</code></dt>
<dd>oPayload State values.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hideColumn">hideColumn</a></h4>
<div class="detail">
<code>
void
<strong>hideColumn</strong>
(
oColumn
)
</code>
<div class="description">
Hides given Column. NOTE: You cannot hide/show nested Columns. You can only
hide/show non-nested Columns, and top-level parent Columns (which will
hide/show all children Columns).
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hideTableMessage">hideTableMessage</a></h4>
<div class="detail">
<code>
void
<strong>hideTableMessage</strong>
(
)
</code>
<div class="description">
Hides secondary TBODY.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_highlightCell">highlightCell</a></h4>
<div class="detail">
<code>
void
<strong>highlightCell</strong>
(
cell
)
</code>
<div class="description">
Assigns the class YAHOO.widget.DataTable.CLASS_HIGHLIGHTED to the given cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String&gt;</code>
DOM element reference or ID string.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_highlightColumn">highlightColumn</a></h4>
<div class="detail">
<code>
void
<strong>highlightColumn</strong>
(
column
)
</code>
<div class="description">
Assigns the class YAHOO.widget.DataTable.CLASS_HIGHLIGHTED to cells of the given Column.
NOTE: You cannot highlight/unhighlight nested Columns. You can only
highlight/unhighlight non-nested Columns, and bottom-level key Columns.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;HTMLElement | String | Number&gt;</code>
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.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_highlightRow">highlightRow</a></h4>
<div class="detail">
<code>
void
<strong>highlightRow</strong>
(
row
)
</code>
<div class="description">
Assigns the class YAHOO.widget.DataTable.CLASS_HIGHLIGHTED to the given row.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String&gt;</code>
DOM element reference or ID string.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_initAttributes">initAttributes</a></h4>
<div class="detail">
<code>
private
void
<strong>initAttributes</strong>
(
oConfigs
)
</code>
<div class="description">
Implementation of Element's abstract method. Sets up config values.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oConfigs &lt;Object&gt;</code>
(Optional) Object literal definition of configuration values.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initializeTable">initializeTable</a></h4>
<div class="detail">
<code>
void
<strong>initializeTable</strong>
(
)
</code>
<div class="description">
Resets a RecordSet with the given data and populates the page view
with the new data. Any previous data, and selection and sort states are
cleared. New data should be added as a separate step.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_insertColumn">insertColumn</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column
<strong>insertColumn</strong>
(
oColumn
,
index
)
</code>
<div class="description">
Inserts given Column at the index if given, otherwise at the end. NOTE: You
can only add non-nested Columns and top-level parent Columns. You cannot add
a nested Column to an existing parent.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;Object | YAHOO.widget.Column&gt;</code>
Object literal Column
definition or a Column instance.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
(optional) New tree index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column
</code></dt>
<dd>oColumn Inserted Column instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isSelected">isSelected</a></h4>
<div class="detail">
<code>
Boolean
<strong>isSelected</strong>
(
o
)
</code>
<div class="description">
Returns true if given item is selected, false otherwise.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>o &lt;String | HTMLElement | YAHOO.widget.Record | Number
{record:YAHOO.widget.Record, column:YAHOO.widget.Column} &gt;</code>
TR or TD element by
reference or ID string, a Record instance, a RecordSet position index,
or an object literal representation
of a cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>True if item is selected.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDataReturnAppendRows">onDataReturnAppendRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnAppendRows</strong>
(
sRequest
,
oResponse
,
oPayload
)
</code>
<div class="description">
Callback function receives data from DataSource and appends to an existing
DataTable new Records and, if applicable, creates or updates
corresponding TR elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>oPayload &lt;MIXED&gt;</code>
(optional) Additional argument(s)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDataReturnInitializeTable">onDataReturnInitializeTable</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnInitializeTable</strong>
(
sRequest
,
oResponse
,
oPayload
)
</code>
<div class="description">
Callback function receives data from DataSource and populates an entire
DataTable with Records and TR elements, clearing previous Records, if any.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>oPayload &lt;MIXED&gt;</code>
(optional) Additional argument(s)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDataReturnInsertRows">onDataReturnInsertRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnInsertRows</strong>
(
sRequest
,
oResponse
,
oPayload
)
</code>
<div class="description">
Callback function receives data from DataSource and inserts new records
starting at the index specified in oPayload.insertIndex. The value for
oPayload.insertIndex can be populated when sending the request to the DataSource,
or by accessing oPayload.insertIndex with the doBeforeLoadData() method at runtime.
If applicable, creates or updates corresponding TR elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>oPayload &lt;MIXED&gt;</code>
Argument payload, looks in oPayload.insertIndex.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDataReturnReplaceRows">onDataReturnReplaceRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnReplaceRows</strong>
(
oRequest
,
oResponse
,
oPayload
)
</code>
<div class="description">
Callback function receives reponse from DataSource, replaces all existing
Records in RecordSet, updates TR elements with new data, and updates state
UI for pagination and sorting from payload data, if necessary.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRequest &lt;MIXED&gt;</code>
Original generated request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>oPayload &lt;MIXED&gt;</code>
(optional) Additional argument(s)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_onDataReturnSetRecords">onDataReturnSetRecords</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnSetRecords</strong>
(
)
</code>
<div class="description">
Alias for onDataReturnSetRows for backward compatibility
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use onDataReturnSetRows
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onDataReturnSetRows">onDataReturnSetRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnSetRows</strong>
(
oRequest
,
oResponse
,
oPayload
)
</code>
<div class="description">
Callback function receives reponse from DataSource and populates the
RecordSet with the results.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRequest &lt;MIXED&gt;</code>
Original generated request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>oPayload &lt;MIXED&gt;</code>
(optional) Additional argument(s)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEditorBlockEvent">onEditorBlockEvent</a></h4>
<div class="detail">
<code>
void
<strong>onEditorBlockEvent</strong>
(
oArgs
)
</code>
<div class="description">
Public handler of the editorBlockEvent. By default, disables DataTable UI.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEditorBlurEvent">onEditorBlurEvent</a></h4>
<div class="detail">
<code>
void
<strong>onEditorBlurEvent</strong>
(
oArgs
)
</code>
<div class="description">
Public handler of the editorBlurEvent. By default, saves on blur if
disableBtns is true, otherwise cancels on blur.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEditorUnblockEvent">onEditorUnblockEvent</a></h4>
<div class="detail">
<code>
void
<strong>onEditorUnblockEvent</strong>
(
oArgs
)
</code>
<div class="description">
Public handler of the editorUnblockEvent. By default, undisables DataTable UI.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs &lt;Object&gt;</code>
Custom Event args.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventCancelCellEditor">onEventCancelCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>onEventCancelCellEditor</strong>
(
)
</code>
<div class="description">
Overridable custom event handler to cancel active CellEditor.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_onEventEditCell">onEventEditCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventEditCell</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use onEventShowCellEditor.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventFormatCell">onEventFormatCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventFormatCell</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to format cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventHighlightCell">onEventHighlightCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventHighlightCell</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to highlight cell. Accounts for spurious
caused-by-child events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventHighlightColumn">onEventHighlightColumn</a></h4>
<div class="detail">
<code>
void
<strong>onEventHighlightColumn</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to highlight Column. Accounts for spurious
caused-by-child events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventHighlightRow">onEventHighlightRow</a></h4>
<div class="detail">
<code>
void
<strong>onEventHighlightRow</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to highlight row. Accounts for spurious
caused-by-child events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventSaveCellEditor">onEventSaveCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>onEventSaveCellEditor</strong>
(
)
</code>
<div class="description">
Overridable custom event handler to save active CellEditor input.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventSelectCell">onEventSelectCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventSelectCell</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to select cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventSelectColumn">onEventSelectColumn</a></h4>
<div class="detail">
<code>
void
<strong>onEventSelectColumn</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to select Column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventSelectRow">onEventSelectRow</a></h4>
<div class="detail">
<code>
void
<strong>onEventSelectRow</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to manage selection according to desktop paradigm.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventShowCellEditor">onEventShowCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>onEventShowCellEditor</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to edit cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventSortColumn">onEventSortColumn</a></h4>
<div class="detail">
<code>
void
<strong>onEventSortColumn</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to sort Column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventUnhighlightCell">onEventUnhighlightCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventUnhighlightCell</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to unhighlight cell. Accounts for spurious
caused-by-child events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventUnhighlightColumn">onEventUnhighlightColumn</a></h4>
<div class="detail">
<code>
void
<strong>onEventUnhighlightColumn</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to unhighlight Column. Accounts for spurious
caused-by-child events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onEventUnhighlightRow">onEventUnhighlightRow</a></h4>
<div class="detail">
<code>
void
<strong>onEventUnhighlightRow</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to unhighlight row. Accounts for spurious
caused-by-child events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_onPaginatorChange">onPaginatorChange</a></h4>
<div class="detail">
<code>
void
<strong>onPaginatorChange</strong>
(
)
</code>
<div class="description">
Alias for onPaginatorChange for backward compatibility
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use onPaginatorChangeRequest
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onPaginatorChangeRequest">onPaginatorChangeRequest</a></h4>
<div class="detail">
<code>
void
<strong>onPaginatorChangeRequest</strong>
(
oPaginatorState
)
</code>
<div class="description">
Responds to new Pagination states. By default, updates the UI to reflect the
new state. If "dynamicData" is true, current selections are purged before
a request is sent to the DataSource for data for the new state (using the
request returned by "generateRequest()").
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oPaginatorState &lt;Object&gt;</code>
An object literal describing the proposed pagination state.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onShow">onShow</a></h4>
<div class="detail">
<code>
void
<strong>onShow</strong>
(
)
</code>
<div class="description">
Setting display:none on DataTable or any parent may impact width validations.
After setting display back to "", implementers should call this method to
manually perform those validations.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_refreshView">refreshView</a></h4>
<div class="detail">
<code>
void
<strong>refreshView</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use render.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeColumn">removeColumn</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column
<strong>removeColumn</strong>
(
oColumn
)
</code>
<div class="description">
Removes given Column. NOTE: You cannot remove nested Columns. You can only remove
non-nested Columns, and top-level parent Columns (which will remove all
children Columns).
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column
</code></dt>
<dd>oColumn Removed Column instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_render">render</a></h4>
<div class="detail">
<code>
void
<strong>render</strong>
(
)
</code>
<div class="description">
Renders 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.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_renderPaginator">renderPaginator</a></h4>
<div class="detail">
<code>
void
<strong>renderPaginator</strong>
(
)
</code>
<div class="description">
Renders the Paginator to the DataTable UI
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_reorderColumn">reorderColumn</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column
<strong>reorderColumn</strong>
(
oColumn
,
index
)
</code>
<div class="description">
Removes given Column and inserts into given tree index. NOTE: You
can only reorder non-nested Columns and top-level parent Columns. You cannot
reorder a nested Column to an existing parent.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
New tree index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column
</code></dt>
<dd>oColumn Reordered Column instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_resetCellEditor">resetCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>resetCellEditor</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use destroyCellEditor
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_saveCellEditor">saveCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>saveCellEditor</strong>
(
)
</code>
<div class="description">
Saves active CellEditor input to Record and upates DOM UI.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="method_select">select</a></h4>
<div class="detail">
<code>
void
<strong>select</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Use selectRow.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_selectCell">selectCell</a></h4>
<div class="detail">
<code>
void
<strong>selectCell</strong>
(
cell
)
</code>
<div class="description">
Sets given cell to the selected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String&gt;</code>
DOM element reference or ID string
to DataTable page element or RecordSet index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_selectColumn">selectColumn</a></h4>
<div class="detail">
<code>
void
<strong>selectColumn</strong>
(
column
)
</code>
<div class="description">
Selects given Column. NOTE: You cannot select/unselect nested Columns. You can only
select/unselect non-nested Columns, and bottom-level key Columns.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;HTMLElement | String | Number&gt;</code>
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.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_selectRow">selectRow</a></h4>
<div class="detail">
<code>
void
<strong>selectRow</strong>
(
row
)
</code>
<div class="description">
Sets given row to the selected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | YAHOO.widget.Record | Number&gt;</code>
HTML element
reference or ID string, Record instance, or RecordSet position index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_setColumnWidth">setColumnWidth</a></h4>
<div class="detail">
<code>
void
<strong>setColumnWidth</strong>
(
oColumn
,
nWidth
)
</code>
<div class="description">
Sets given Column to given pixel width. If new width is less than minimum
width, sets to minimum width. Updates oColumn.width value.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>nWidth &lt;Number&gt;</code>
New width in pixels. A null value auto-sizes Column,
subject to minWidth and maxAutoWidth validations.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_showCellEditor">showCellEditor</a></h4>
<div class="detail">
<code>
void
<strong>showCellEditor</strong>
(
elCell
)
</code>
<div class="description">
Activates and shows CellEditor instance for the given cell while deactivating and
canceling previous CellEditor. It is baked into DataTable that only one CellEditor
can be active at any given time.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elCell &lt;HTMLElement | String&gt;</code>
Cell to edit.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_showColumn">showColumn</a></h4>
<div class="detail">
<code>
void
<strong>showColumn</strong>
(
oColumn
)
</code>
<div class="description">
Shows given Column. NOTE: You cannot hide/show nested Columns. You can only
hide/show non-nested Columns, and top-level parent Columns (which will
hide/show all children Columns).
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_showTableMessage">showTableMessage</a></h4>
<div class="detail">
<code>
void
<strong>showTableMessage</strong>
(
sHTML
,
sClassName
)
</code>
<div class="description">
Displays message within secondary TBODY.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sHTML &lt;String&gt;</code>
(optional) Value for innerHTMlang.
</dd>
<dd>
<code>sClassName &lt;String&gt;</code>
(optional) Classname.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_sortColumn">sortColumn</a></h4>
<div class="detail">
<code>
void
<strong>sortColumn</strong>
(
oColumn
,
sDir
)
</code>
<div class="description">
Sorts given Column. If "dynamicData" is true, current selections are purged before
a request is sent to the DataSource for data for the new state (using the
request returned by "generateRequest()").
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
<dd>
<code>sDir &lt;String&gt;</code>
(Optional) YAHOO.widget.DataTable.CLASS_ASC or
YAHOO.widget.DataTable.CLASS_DESC
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
DataSource instance name, for logging.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique name of the DataSource instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_undisable">undisable</a></h4>
<div class="detail">
<code>
void
<strong>undisable</strong>
(
)
</code>
<div class="description">
Undisables DataTable UI.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unhighlightCell">unhighlightCell</a></h4>
<div class="detail">
<code>
void
<strong>unhighlightCell</strong>
(
cell
)
</code>
<div class="description">
Removes the class YAHOO.widget.DataTable.CLASS_HIGHLIGHTED from the given cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String&gt;</code>
DOM element reference or ID string.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unhighlightColumn">unhighlightColumn</a></h4>
<div class="detail">
<code>
void
<strong>unhighlightColumn</strong>
(
column
)
</code>
<div class="description">
Removes the class YAHOO.widget.DataTable.CLASS_HIGHLIGHTED to cells of the given Column.
NOTE: You cannot highlight/unhighlight nested Columns. You can only
highlight/unhighlight non-nested Columns, and bottom-level key Columns.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;HTMLElement | String | Number&gt;</code>
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.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unhighlightRow">unhighlightRow</a></h4>
<div class="detail">
<code>
void
<strong>unhighlightRow</strong>
(
row
)
</code>
<div class="description">
Removes the class YAHOO.widget.DataTable.CLASS_HIGHLIGHTED from the given row.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String&gt;</code>
DOM element reference or ID string.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unselectAllCells">unselectAllCells</a></h4>
<div class="detail">
<code>
void
<strong>unselectAllCells</strong>
(
)
</code>
<div class="description">
Clears out all cell selections.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unselectAllRows">unselectAllRows</a></h4>
<div class="detail">
<code>
void
<strong>unselectAllRows</strong>
(
)
</code>
<div class="description">
Clears out all row selections.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unselectCell">unselectCell</a></h4>
<div class="detail">
<code>
void
<strong>unselectCell</strong>
(
cell
)
</code>
<div class="description">
Sets given cell to the unselected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>cell &lt;HTMLElement | String&gt;</code>
DOM element reference or ID string
to DataTable page element or RecordSet index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unselectColumn">unselectColumn</a></h4>
<div class="detail">
<code>
void
<strong>unselectColumn</strong>
(
column
)
</code>
<div class="description">
Unselects given Column. NOTE: You cannot select/unselect nested Columns. You can only
select/unselect non-nested Columns, and bottom-level key Columns.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;HTMLElement | String | Number&gt;</code>
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.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_unselectRow">unselectRow</a></h4>
<div class="detail">
<code>
void
<strong>unselectRow</strong>
(
row
)
</code>
<div class="description">
Sets given row to the selected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String | YAHOO.widget.Record | Number&gt;</code>
HTML element
reference or ID string, Record instance, or RecordSet position index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_updateCell">updateCell</a></h4>
<div class="detail">
<code>
void
<strong>updateCell</strong>
(
oRecord
,
oColumn
,
oData
)
</code>
<div class="description">
For the given row and column, updates the Record with the given data. If the
cell is on current page, the corresponding DOM elements are also updated.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column | String | Number&gt;</code>
A Column key, or a ColumnSet key index.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
Object literal of data for the cell.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_updateRow">updateRow</a></h4>
<div class="detail">
<code>
void
<strong>updateRow</strong>
(
row
,
oData
)
</code>
<div class="description">
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.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;YAHOO.widget.Record | Number | HTMLElement | String&gt;</code>
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.
</dd>
<dd>
<code>oData &lt;Object&gt;</code>
Object literal of data for the row.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_validateColumnWidths">validateColumnWidths</a></h4>
<div class="detail">
<code>
void
<strong>validateColumnWidths</strong>
(
oArg.column
)
</code>
<div class="description">
For one or all Columns, when Column is not hidden, width is not set, and minWidth
and/or maxAutoWidth is set, validates auto-width against minWidth and maxAutoWidth.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArg.column &lt;YAHOO.widget.Column&gt;</code>
(optional) One Column to validate. If null, all Columns' widths are validated.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_beforeCaptionChange">beforeCaptionChange</a></h4>
<div class="detail">
<code>
<strong>beforeCaptionChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'caption' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeCurrencyOptionsChange">beforeCurrencyOptionsChange</a></h4>
<div class="detail">
<code>
<strong>beforeCurrencyOptionsChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'currencyOptions' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeCurrencySymbolChange">beforeCurrencySymbolChange</a></h4>
<div class="detail">
<code>
<strong>beforeCurrencySymbolChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'currencySymbol' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeDateOptionsChange">beforeDateOptionsChange</a></h4>
<div class="detail">
<code>
<strong>beforeDateOptionsChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'dateOptions' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeDraggableColumnsChange">beforeDraggableColumnsChange</a></h4>
<div class="detail">
<code>
<strong>beforeDraggableColumnsChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'draggableColumns' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeDynamicDataChange">beforeDynamicDataChange</a></h4>
<div class="detail">
<code>
<strong>beforeDynamicDataChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'dynamicData' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeFormatRowChange">beforeFormatRowChange</a></h4>
<div class="detail">
<code>
<strong>beforeFormatRowChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'formatRow' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeGenerateRequestChange">beforeGenerateRequestChange</a></h4>
<div class="detail">
<code>
<strong>beforeGenerateRequestChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'generateRequest' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeInitialLoadChange">beforeInitialLoadChange</a></h4>
<div class="detail">
<code>
<strong>beforeInitialLoadChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'initialLoad' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeInitialRequestChange">beforeInitialRequestChange</a></h4>
<div class="detail">
<code>
<strong>beforeInitialRequestChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'initialRequest' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeMSG_EMPTYChange">beforeMSG_EMPTYChange</a></h4>
<div class="detail">
<code>
<strong>beforeMSG_EMPTYChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'MSG_EMPTY' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeMSG_ERRORChange">beforeMSG_ERRORChange</a></h4>
<div class="detail">
<code>
<strong>beforeMSG_ERRORChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'MSG_ERROR' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeMSG_LOADINGChange">beforeMSG_LOADINGChange</a></h4>
<div class="detail">
<code>
<strong>beforeMSG_LOADINGChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'MSG_LOADING' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeMSG_SORTASCChange">beforeMSG_SORTASCChange</a></h4>
<div class="detail">
<code>
<strong>beforeMSG_SORTASCChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'MSG_SORTASC' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeMSG_SORTDESCChange">beforeMSG_SORTDESCChange</a></h4>
<div class="detail">
<code>
<strong>beforeMSG_SORTDESCChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'MSG_SORTDESC' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeNumberOptionsChange">beforeNumberOptionsChange</a></h4>
<div class="detail">
<code>
<strong>beforeNumberOptionsChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'numberOptions' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforePaginatorChange">beforePaginatorChange</a></h4>
<div class="detail">
<code>
<strong>beforePaginatorChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'paginator' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeRenderLoopSizeChange">beforeRenderLoopSizeChange</a></h4>
<div class="detail">
<code>
<strong>beforeRenderLoopSizeChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'renderLoopSize' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeSelectionModeChange">beforeSelectionModeChange</a></h4>
<div class="detail">
<code>
<strong>beforeSelectionModeChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'selectionMode' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeSortedByChange">beforeSortedByChange</a></h4>
<div class="detail">
<code>
<strong>beforeSortedByChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'sortedBy' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeSummaryChange">beforeSummaryChange</a></h4>
<div class="detail">
<code>
<strong>beforeSummaryChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'summary' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_buttonClickEvent">buttonClickEvent</a></h4>
<div class="detail">
<code>
<strong>buttonClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a BUTTON element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The BUTTON element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_captionChange">captionChange</a></h4>
<div class="detail">
<code>
<strong>captionChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'caption' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellClickEvent">cellClickEvent</a></h4>
<div class="detail">
<code>
<strong>cellClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a cell has a click.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellDblclickEvent">cellDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>cellDblclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a cell has a dblclick.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellFormatEvent">cellFormatEvent</a></h4>
<div class="detail">
<code>
<strong>cellFormatEvent</strong>
(
oArgs.el
,
oArgs.record
,
oArgs.column
,
oArgs.key
)
</code>
<div class="description">
Fired when a cell is formatted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The formatted TD element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The associated Record instance.
</dd>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The associated Column instance.
</dd>
<dd>
<code>oArgs.key &lt;String&gt;</code>
(deprecated) The key of the formatted cell.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellHighlightEvent">cellHighlightEvent</a></h4>
<div class="detail">
<code>
<strong>cellHighlightEvent</strong>
(
oArgs.el
,
oArgs.record
,
oArgs.column
,
oArgs.key
)
</code>
<div class="description">
Fired when a cell is highlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The highlighted TD element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The associated Record instance.
</dd>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The associated Column instance.
</dd>
<dd>
<code>oArgs.key &lt;String&gt;</code>
(deprecated) The key of the highlighted cell.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellMousedownEvent">cellMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>cellMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a cell has a mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellMouseoutEvent">cellMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>cellMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a cell has a mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellMouseoverEvent">cellMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>cellMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a cell has a mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellMouseupEvent">cellMouseupEvent</a></h4>
<div class="detail">
<code>
<strong>cellMouseupEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a cell has a mouseup.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellSelectEvent">cellSelectEvent</a></h4>
<div class="detail">
<code>
<strong>cellSelectEvent</strong>
(
oArgs.el
,
oArgs.record
,
oArgs.column
,
oArgs.key
)
</code>
<div class="description">
Fired when a cell is selected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The selected TD element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The associated Record instance.
</dd>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The associated Column instance.
</dd>
<dd>
<code>oArgs.key &lt;String&gt;</code>
(deprecated) The key of the selected cell.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellUnhighlightEvent">cellUnhighlightEvent</a></h4>
<div class="detail">
<code>
<strong>cellUnhighlightEvent</strong>
(
oArgs.el
,
oArgs.record
,
oArgs.column
,
oArgs.key
)
</code>
<div class="description">
Fired when a cell is unhighlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The unhighlighted TD element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The associated Record instance.
</dd>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The associated Column instance.
</dd>
<dd>
<code>oArgs.key &lt;String&gt;</code>
(deprecated) The key of the unhighlighted cell.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellUnselectEvent">cellUnselectEvent</a></h4>
<div class="detail">
<code>
<strong>cellUnselectEvent</strong>
(
oArgs.el
,
oArgs.record
,
oArgs.column
,
oArgs.key
)
</code>
<div class="description">
Fired when a cell is unselected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The unselected TD element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The associated Record.
</dd>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The associated Column instance.
</dd>
<dd>
<code>oArgs.key &lt;String&gt;</code>
(deprecated) The key of the unselected cell.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_cellUpdateEvent">cellUpdateEvent</a></h4>
<div class="detail">
<code>
<strong>cellUpdateEvent</strong>
(
oArgs.record
,
oArgs.column
,
oArgs.oldData
)
</code>
<div class="description">
Fired when a cell is updated.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The updated Record.
</dd>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The updated Column.
</dd>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
Object literal of the old data.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_checkboxClickEvent">checkboxClickEvent</a></h4>
<div class="detail">
<code>
<strong>checkboxClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a CHECKBOX element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The CHECKBOX element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnHideEvent">columnHideEvent</a></h4>
<div class="detail">
<code>
<strong>columnHideEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column is hidden.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnHighlightEvent">columnHighlightEvent</a></h4>
<div class="detail">
<code>
<strong>columnHighlightEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column is highlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The highlighted Column.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnInsertEvent">columnInsertEvent</a></h4>
<div class="detail">
<code>
<strong>columnInsertEvent</strong>
(
oArgs.column
,
oArgs.index
)
</code>
<div class="description">
Fired when a column is inserted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
<dd>
<code>oArgs.index &lt;Number&gt;</code>
The index position.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnRemoveEvent">columnRemoveEvent</a></h4>
<div class="detail">
<code>
<strong>columnRemoveEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column is removed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnReorderEvent">columnReorderEvent</a></h4>
<div class="detail">
<code>
<strong>columnReorderEvent</strong>
(
oArgs.column
,
oArgs.oldIndex
)
</code>
<div class="description">
Fired when a Column is moved to a new index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
<dd>
<code>oArgs.oldIndex &lt;Number&gt;</code>
The previous index position.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnResizeEvent">columnResizeEvent</a></h4>
<div class="detail">
<code>
<strong>columnResizeEvent</strong>
(
oArgs.column
,
oArgs.target
,
oArgs.width
)
</code>
<div class="description">
Fired when a column is drag-resized.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
<dd>
<code>oArgs.width &lt;Number&gt;</code>
Width in pixels.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnSelectEvent">columnSelectEvent</a></h4>
<div class="detail">
<code>
<strong>columnSelectEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column is selected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnSetWidthEvent">columnSetWidthEvent</a></h4>
<div class="detail">
<code>
<strong>columnSetWidthEvent</strong>
(
oArgs.column
,
oArgs.width
)
</code>
<div class="description">
Fired when a column width is set.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
<dd>
<code>oArgs.width &lt;Number&gt;</code>
The width in pixels.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnShowEvent">columnShowEvent</a></h4>
<div class="detail">
<code>
<strong>columnShowEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column is shown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnSortEvent">columnSortEvent</a></h4>
<div class="detail">
<code>
<strong>columnSortEvent</strong>
(
oArgs.column
,
oArgs.dir
)
</code>
<div class="description">
Fired when a column is sorted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
<dd>
<code>oArgs.dir &lt;String&gt;</code>
Sort direction: YAHOO.widget.DataTable.CLASS_ASC
or YAHOO.widget.DataTable.CLASS_DESC.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnUnhighlightEvent">columnUnhighlightEvent</a></h4>
<div class="detail">
<code>
<strong>columnUnhighlightEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column is unhighlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The unhighlighted Column.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnUnselectEvent">columnUnselectEvent</a></h4>
<div class="detail">
<code>
<strong>columnUnselectEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column is unselected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_columnUnsetWidthEvent">columnUnsetWidthEvent</a></h4>
<div class="detail">
<code>
<strong>columnUnsetWidthEvent</strong>
(
oArgs.column
)
</code>
<div class="description">
Fired when a column width is unset.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_currencyOptionsChange">currencyOptionsChange</a></h4>
<div class="detail">
<code>
<strong>currencyOptionsChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'currencyOptions' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_currencySymbolChange">currencySymbolChange</a></h4>
<div class="detail">
<code>
<strong>currencySymbolChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'currencySymbol' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dataReturnEvent">dataReturnEvent</a></h4>
<div class="detail">
<code>
<strong>dataReturnEvent</strong>
(
oArgs.request
,
oArgs.response
)
</code>
<div class="description">
Fired when data is returned from DataSource but before it is consumed by
DataTable.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.request &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oArgs.response &lt;Object&gt;</code>
Response object.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dateOptionsChange">dateOptionsChange</a></h4>
<div class="detail">
<code>
<strong>dateOptionsChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'dateOptions' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_disableEvent">disableEvent</a></h4>
<div class="detail">
<code>
<strong>disableEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable is disabled.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_draggableColumnsChange">draggableColumnsChange</a></h4>
<div class="detail">
<code>
<strong>draggableColumnsChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'draggableColumns' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dropdownChangeEvent">dropdownChangeEvent</a></h4>
<div class="detail">
<code>
<strong>dropdownChangeEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a SELECT element is changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The SELECT element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_dynamicDataChange">dynamicDataChange</a></h4>
<div class="detail">
<code>
<strong>dynamicDataChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'dynamicData' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorBlockEvent">editorBlockEvent</a></h4>
<div class="detail">
<code>
<strong>editorBlockEvent</strong>
(
oArgs.editor
)
</code>
<div class="description">
Fired when a CellEditor is blocked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorBlurEvent">editorBlurEvent</a></h4>
<div class="detail">
<code>
<strong>editorBlurEvent</strong>
(
oArgs.editor
)
</code>
<div class="description">
Fired when a CellEditor has a blur event.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorCancelEvent">editorCancelEvent</a></h4>
<div class="detail">
<code>
<strong>editorCancelEvent</strong>
(
oArgs.editor
)
</code>
<div class="description">
Fired when a CellEditor input is canceled.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorKeydownEvent">editorKeydownEvent</a></h4>
<div class="detail">
<code>
<strong>editorKeydownEvent</strong>
(
oArgs.editor
,
oArgs.event
)
</code>
<div class="description">
Fired when a CellEditor has a keydown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorRevertEvent">editorRevertEvent</a></h4>
<div class="detail">
<code>
<strong>editorRevertEvent</strong>
(
oArgs.editor
,
oArgs.newData
,
oArgs.oldData
)
</code>
<div class="description">
Fired when a CellEditor input is reverted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
<dd>
<code>oArgs.newData &lt;Object&gt;</code>
New data value from form input field.
</dd>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
Old data value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorSaveEvent">editorSaveEvent</a></h4>
<div class="detail">
<code>
<strong>editorSaveEvent</strong>
(
oArgs.editor
,
oArgs.newData
,
oArgs.oldData
)
</code>
<div class="description">
Fired when a CellEditor input is saved.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
<dd>
<code>oArgs.newData &lt;Object&gt;</code>
New data value from form input field.
</dd>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
Old data value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorShowEvent">editorShowEvent</a></h4>
<div class="detail">
<code>
<strong>editorShowEvent</strong>
(
oArgs.editor
)
</code>
<div class="description">
Fired when a CellEditor is shown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_editorUnblockEvent">editorUnblockEvent</a></h4>
<div class="detail">
<code>
<strong>editorUnblockEvent</strong>
(
oArgs.editor
)
</code>
<div class="description">
Fired when a CellEditor is unblocked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.editor &lt;YAHOO.widget.CellEditor&gt;</code>
The CellEditor instance.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_editorUpdateEvent">editorUpdateEvent</a></h4>
<div class="detail">
<code>
<strong>editorUpdateEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use CellEditor class.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_formatRowChange">formatRowChange</a></h4>
<div class="detail">
<code>
<strong>formatRowChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'formatRow' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_generateRequestChange">generateRequestChange</a></h4>
<div class="detail">
<code>
<strong>generateRequestChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'generateRequest' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerCellClickEvent">headerCellClickEvent</a></h4>
<div class="detail">
<code>
<strong>headerCellClickEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadCellClickEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerCellDblclickEvent">headerCellDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>headerCellDblclickEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadCellDblclickEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerCellMousedownEvent">headerCellMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>headerCellMousedownEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadCellMousedownEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerCellMouseoutEvent">headerCellMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>headerCellMouseoutEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadCellMouseoutEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerCellMouseoverEvent">headerCellMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>headerCellMouseoverEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadCellMouseoverEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerLabelClickEvent">headerLabelClickEvent</a></h4>
<div class="detail">
<code>
<strong>headerLabelClickEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadLabelClickEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerLabelDbllickEvent">headerLabelDbllickEvent</a></h4>
<div class="detail">
<code>
<strong>headerLabelDbllickEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadLabelDblclickEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerLabelMousedownEvent">headerLabelMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>headerLabelMousedownEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadLabelMousedownEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerLabelMouseoutEvent">headerLabelMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>headerLabelMouseoutEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadLabelMouseoutEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerLabelMouseoverEvent">headerLabelMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>headerLabelMouseoverEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadLabelMouseoverEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerRowClickEvent">headerRowClickEvent</a></h4>
<div class="detail">
<code>
<strong>headerRowClickEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadRowClickEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerRowDblclickEvent">headerRowDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>headerRowDblclickEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadRowDblclickEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerRowMousedownEvent">headerRowMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>headerRowMousedownEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadRowMousedownEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerRowMouseoutEvent">headerRowMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>headerRowMouseoutEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadRowMouseoutEvent.
</div>
</div>
</div>
<hr />
</div>
<div class=" deprecated">
<h4>
<a name="event_headerRowMouseoverEvent">headerRowMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>headerRowMouseoverEvent</strong>
(
)
</code>
<div class="description">
</div>
<div class="description">
<div class="deprecated">
<strong>Deprecated</strong> Use theadRowMouseoverEvent.
</div>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_initEvent">initEvent</a></h4>
<div class="detail">
<code>
<strong>initEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable's rows are rendered from an initialized state.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_initialLoadChange">initialLoadChange</a></h4>
<div class="detail">
<code>
<strong>initialLoadChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'initialLoad' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_initialRequestChange">initialRequestChange</a></h4>
<div class="detail">
<code>
<strong>initialRequestChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'initialRequest' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_linkClickEvent">linkClickEvent</a></h4>
<div class="detail">
<code>
<strong>linkClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a link is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The A element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_MSG_EMPTYChange">MSG_EMPTYChange</a></h4>
<div class="detail">
<code>
<strong>MSG_EMPTYChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'MSG_EMPTY' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_MSG_ERRORChange">MSG_ERRORChange</a></h4>
<div class="detail">
<code>
<strong>MSG_ERRORChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'MSG_ERROR' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_MSG_LOADINGChange">MSG_LOADINGChange</a></h4>
<div class="detail">
<code>
<strong>MSG_LOADINGChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'MSG_LOADING' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_MSG_SORTASCChange">MSG_SORTASCChange</a></h4>
<div class="detail">
<code>
<strong>MSG_SORTASCChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'MSG_SORTASC' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_MSG_SORTDESCChange">MSG_SORTDESCChange</a></h4>
<div class="detail">
<code>
<strong>MSG_SORTDESCChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'MSG_SORTDESC' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_numberOptionsChange">numberOptionsChange</a></h4>
<div class="detail">
<code>
<strong>numberOptionsChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'numberOptions' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_paginatorChange">paginatorChange</a></h4>
<div class="detail">
<code>
<strong>paginatorChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'paginator' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_postRenderEvent">postRenderEvent</a></h4>
<div class="detail">
<code>
<strong>postRenderEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable's post-render routine is complete, including
Column width validations.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_radioClickEvent">radioClickEvent</a></h4>
<div class="detail">
<code>
<strong>radioClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a RADIO element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The RADIO element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_renderEvent">renderEvent</a></h4>
<div class="detail">
<code>
<strong>renderEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable's DOM is rendered or modified.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_renderLoopSizeChange">renderLoopSizeChange</a></h4>
<div class="detail">
<code>
<strong>renderLoopSizeChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'renderLoopSize' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowAddEvent">rowAddEvent</a></h4>
<div class="detail">
<code>
<strong>rowAddEvent</strong>
(
oArgs.record
)
</code>
<div class="description">
Fired when a row is added.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The added Record.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowClickEvent">rowClickEvent</a></h4>
<div class="detail">
<code>
<strong>rowClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a row has a click.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowDblclickEvent">rowDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>rowDblclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a row has a dblclick.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowDeleteEvent">rowDeleteEvent</a></h4>
<div class="detail">
<code>
<strong>rowDeleteEvent</strong>
(
oArgs.oldData
,
oArgs.recordIndex
,
oArgs.trElIndex
)
</code>
<div class="description">
Fired when a row is deleted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
Object literal of the deleted data.
</dd>
<dd>
<code>oArgs.recordIndex &lt;Number&gt;</code>
Index of the deleted Record.
</dd>
<dd>
<code>oArgs.trElIndex &lt;Number&gt;</code>
Index of the deleted TR element, if on current page.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowHighlightEvent">rowHighlightEvent</a></h4>
<div class="detail">
<code>
<strong>rowHighlightEvent</strong>
(
oArgs.el
,
oArgs.record
)
</code>
<div class="description">
Fired when a row is highlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The highlighted TR element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The highlighted Record.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowMousedownEvent">rowMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>rowMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a row has a mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowMouseoutEvent">rowMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>rowMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a row has a mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowMouseoverEvent">rowMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>rowMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a row has a mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowMouseupEvent">rowMouseupEvent</a></h4>
<div class="detail">
<code>
<strong>rowMouseupEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a row has a mouseup.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowsAddEvent">rowsAddEvent</a></h4>
<div class="detail">
<code>
<strong>rowsAddEvent</strong>
(
oArgs.record
)
</code>
<div class="description">
Fired when rows are added.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record[]&gt;</code>
The added Records.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowsDeleteEvent">rowsDeleteEvent</a></h4>
<div class="detail">
<code>
<strong>rowsDeleteEvent</strong>
(
oArgs.oldData
,
oArgs.recordIndex
,
oArgs.count
)
</code>
<div class="description">
Fired when rows are deleted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.oldData &lt;Object[]&gt;</code>
Array of object literals of the deleted data.
</dd>
<dd>
<code>oArgs.recordIndex &lt;Number&gt;</code>
Index of the first deleted Record.
</dd>
<dd>
<code>oArgs.count &lt;Number&gt;</code>
Number of deleted Records.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowSelectEvent">rowSelectEvent</a></h4>
<div class="detail">
<code>
<strong>rowSelectEvent</strong>
(
oArgs.el
,
oArgs.record
)
</code>
<div class="description">
Fired when a row is selected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The selected TR element, if applicable.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The selected Record.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowUnhighlightEvent">rowUnhighlightEvent</a></h4>
<div class="detail">
<code>
<strong>rowUnhighlightEvent</strong>
(
oArgs.el
,
oArgs.record
)
</code>
<div class="description">
Fired when a row is unhighlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The highlighted TR element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The highlighted Record.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowUnselectEvent">rowUnselectEvent</a></h4>
<div class="detail">
<code>
<strong>rowUnselectEvent</strong>
(
oArgs.el
,
oArgs.record
)
</code>
<div class="description">
Fired when a row is unselected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The unselected TR element, if applicable.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The unselected Record.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_rowUpdateEvent">rowUpdateEvent</a></h4>
<div class="detail">
<code>
<strong>rowUpdateEvent</strong>
(
oArgs.record
,
oArgs.oldData
)
</code>
<div class="description">
Fired when a row is updated.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The updated Record.
</dd>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
Object literal of the old data.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_selectionModeChange">selectionModeChange</a></h4>
<div class="detail">
<code>
<strong>selectionModeChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'selectionMode' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_sortedByChange">sortedByChange</a></h4>
<div class="detail">
<code>
<strong>sortedByChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'sortedBy' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_summaryChange">summaryChange</a></h4>
<div class="detail">
<code>
<strong>summaryChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'summary' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableBlurEvent">tableBlurEvent</a></h4>
<div class="detail">
<code>
<strong>tableBlurEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable has a blur event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableClickEvent">tableClickEvent</a></h4>
<div class="detail">
<code>
<strong>tableClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable has a click.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableDblclickEvent">tableDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>tableDblclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable has a dblclick.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableFocusEvent">tableFocusEvent</a></h4>
<div class="detail">
<code>
<strong>tableFocusEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable has a focus event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableKeyEvent">tableKeyEvent</a></h4>
<div class="detail">
<code>
<strong>tableKeyEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable has a key event.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableMousedownEvent">tableMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>tableMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable has a mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableMouseoutEvent">tableMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>tableMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable has a mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableMouseoverEvent">tableMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>tableMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable has a mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableMouseupEvent">tableMouseupEvent</a></h4>
<div class="detail">
<code>
<strong>tableMouseupEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable has a mouseup.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableMsgHideEvent">tableMsgHideEvent</a></h4>
<div class="detail">
<code>
<strong>tableMsgHideEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable's message element is hidden.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tableMsgShowEvent">tableMsgShowEvent</a></h4>
<div class="detail">
<code>
<strong>tableMsgShowEvent</strong>
(
oArgs.html
,
oArgs.className
)
</code>
<div class="description">
Fired when a message is shown in the DataTable's message element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.html &lt;String&gt;</code>
The HTML displayed.
</dd>
<dd>
<code>oArgs.className &lt;String&gt;</code>
The className assigned.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tbodyFocusEvent">tbodyFocusEvent</a></h4>
<div class="detail">
<code>
<strong>tbodyFocusEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable TBODY element has a focus event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_tbodyKeyEvent">tbodyKeyEvent</a></h4>
<div class="detail">
<code>
<strong>tbodyKeyEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable TBODY element has a key event.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadCellClickEvent">theadCellClickEvent</a></h4>
<div class="detail">
<code>
<strong>theadCellClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD cell has a click.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadCellDblclickEvent">theadCellDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>theadCellDblclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD cell has a dblclick.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadCellMousedownEvent">theadCellMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>theadCellMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD cell has a mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadCellMouseoutEvent">theadCellMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>theadCellMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD cell has a mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadCellMouseoverEvent">theadCellMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>theadCellMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD cell has a mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadCellMouseupEvent">theadCellMouseupEvent</a></h4>
<div class="detail">
<code>
<strong>theadCellMouseupEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD cell has a mouseup.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadFocusEvent">theadFocusEvent</a></h4>
<div class="detail">
<code>
<strong>theadFocusEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable THEAD element has a focus event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadKeyEvent">theadKeyEvent</a></h4>
<div class="detail">
<code>
<strong>theadKeyEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when the DataTable THEAD element has a key event.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The DataTable's TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadLabelClickEvent">theadLabelClickEvent</a></h4>
<div class="detail">
<code>
<strong>theadLabelClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD label has a click.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The SPAN element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadLabelDblclickEvent">theadLabelDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>theadLabelDblclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD label has a dblclick.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The SPAN element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadLabelMousedownEvent">theadLabelMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>theadLabelMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD label has a mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The SPAN element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadLabelMouseoutEvent">theadLabelMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>theadLabelMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD label has a mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The SPAN element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadLabelMouseoverEvent">theadLabelMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>theadLabelMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD label has a mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The SPAN element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadLabelMouseupEvent">theadLabelMouseupEvent</a></h4>
<div class="detail">
<code>
<strong>theadLabelMouseupEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD label has a mouseup.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The SPAN element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadRowClickEvent">theadRowClickEvent</a></h4>
<div class="detail">
<code>
<strong>theadRowClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD row has a click.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadRowDblclickEvent">theadRowDblclickEvent</a></h4>
<div class="detail">
<code>
<strong>theadRowDblclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD row has a dblclick.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadRowMousedownEvent">theadRowMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>theadRowMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD row has a mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadRowMouseoutEvent">theadRowMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>theadRowMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD row has a mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadRowMouseoverEvent">theadRowMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>theadRowMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD row has a mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_theadRowMouseupEvent">theadRowMouseupEvent</a></h4>
<div class="detail">
<code>
<strong>theadRowMouseupEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a THEAD row has a mouseup.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TR element.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_undisableEvent">undisableEvent</a></h4>
<div class="detail">
<code>
<strong>undisableEvent</strong>
(
)
</code>
<div class="description">
Fired when the DataTable is undisabled.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_unselectAllCellsEvent">unselectAllCellsEvent</a></h4>
<div class="detail">
<code>
<strong>unselectAllCellsEvent</strong>
(
)
</code>
<div class="description">
Fired when all cell selections are cleared.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_unselectAllRowsEvent">unselectAllRowsEvent</a></h4>
<div class="detail">
<code>
<strong>unselectAllRowsEvent</strong>
(
)
</code>
<div class="description">
Fired when all row selections are cleared.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_caption">caption</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Value for the CAPTION element. NB: Not supported in
ScrollingDataTable.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_currencyOptions">currencyOptions</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Default config passed to YAHOO.util.Number.format() by the 'currency' Column formatter.
</div>
</div>
<div class="default">
Default Value: {prefix: $, decimalPlaces:2, decimalSeparator:".", thousandsSeparator:","}
</div>
<hr />
</div>
<div class=" deprecated">
<h4><a name="config_currencySymbol">currencySymbol</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated</strong> &#160;
</div>
<hr />
</div>
<div class="">
<h4><a name="config_dateOptions">dateOptions</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Default config passed to YAHOO.util.Date.format() by the 'date' Column formatter.
</div>
</div>
<div class="default">
Default Value: {format:"%m/%d/%Y", locale:"en"}
</div>
<hr />
</div>
<div class="">
<h4><a name="config_draggableColumns">draggableColumns</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if Columns are draggable to reorder, false otherwise.
The Drag & Drop Utility is required to enable this feature. Only top-level
and non-nested Columns are draggable. Write once.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_dynamicData">dynamicData</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
If true, sorting and pagination are relegated to the DataSource
for handling, using the request returned by the "generateRequest" function.
Each new DataSource response blows away all previous Records. False by default, so
sorting and pagination will be handled directly on the client side, without
causing any new requests for data from the DataSource.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_formatRow">formatRow</a>
<code>- function</code>
</h4>
<div class="detail">
<div class="description">
A function that accepts a TR element and its associated Record
for custom formatting. The function must return TRUE in order to automatically
continue formatting of child TD elements, else TD elements will not be
automatically formatted.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_generateRequest">generateRequest</a>
<code>- function</code>
</h4>
<div class="detail">
<div class="description">
A function that converts an object literal of desired DataTable
states into a request value which is then passed to the DataSource's
sendRequest method in order to retrieve data for those states. This
function is passed an object literal of state data and a reference to the
DataTable instance:
<dl>
<dt>pagination<dt>
<dd>
<dt>offsetRecord</dt>
<dd>{Number} Index of the first Record of the desired page</dd>
<dt>rowsPerPage</dt>
<dd>{Number} Number of rows per page</dd>
</dd>
<dt>sortedBy</dt>
<dd>
<dt>key</dt>
<dd>{String} Key of sorted Column</dd>
<dt>dir</dt>
<dd>{String} Sort direction, either YAHOO.widget.DataTable.CLASS_ASC or YAHOO.widget.DataTable.CLASS_DESC</dd>
</dd>
<dt>self</dt>
<dd>The DataTable instance</dd>
</dl>
and by default returns a String of syntax:
"sort={sortColumn}&dir={sortDir}&startIndex={pageStartIndex}&results={rowsPerPage}"
</div>
</div>
<div class="default">
Default Value: HTMLFunction
</div>
<hr />
</div>
<div class="">
<h4><a name="config_initialLoad">initialLoad</a>
<code>- Boolean | Object</code>
</h4>
<div class="detail">
<div class="description">
Determines whether or not to load data at instantiation. By
default, will trigger a sendRequest() to the DataSource and pass in the
request defined by initialRequest. If set to false, data will not load
at instantiation. Alternatively, implementers who wish to work with a
custom payload may pass in an object literal with the following values:
<dl>
<dt>request (MIXED)</dt>
<dd>Request value.</dd>
<dt>argument (MIXED)</dt>
<dd>Custom data that will be passed through to the callback function.</dd>
</dl>
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="config_initialRequest">initialRequest</a>
<code>- MIXED</code>
</h4>
<div class="detail">
<div class="description">
Defines the initial request that gets sent to the DataSource
during initialization. Value is ignored if initialLoad is set to any value
other than true.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MSG_EMPTY">MSG_EMPTY</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Message to display if DataTable has no data.
</div>
</div>
<div class="default">
Default Value: "No records found."
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MSG_ERROR">MSG_ERROR</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Message to display while DataTable has data error.
</div>
</div>
<div class="default">
Default Value: "Data error."
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MSG_LOADING">MSG_LOADING</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Message to display while DataTable is loading data.
</div>
</div>
<div class="default">
Default Value: "Loading..."
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MSG_SORTASC">MSG_SORTASC</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Message to display in tooltip to sort Column in ascending order.
</div>
</div>
<div class="default">
Default Value: "Click to sort ascending"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_MSG_SORTDESC">MSG_SORTDESC</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Message to display in tooltip to sort Column in descending order.
</div>
</div>
<div class="default">
Default Value: "Click to sort descending"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_numberOptions">numberOptions</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Default config passed to YAHOO.util.Number.format() by the 'number' Column formatter.
</div>
</div>
<div class="default">
Default Value: {decimalPlaces:0, thousandsSeparator:","}
</div>
<hr />
</div>
<div class="">
<h4><a name="config_paginator">paginator</a>
<code>- {Object|YAHOO.widget.Paginator}</code>
</h4>
<div class="detail">
<div class="description">
An instance of YAHOO.widget.Paginator.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_renderLoopSize">renderLoopSize</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
A value greater than 0 enables DOM rendering of rows to be
executed from a non-blocking timeout queue and sets how many rows to be
rendered per timeout. Recommended for very large data sets.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="">
<h4><a name="config_selectionMode">selectionMode</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="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>
</div>
</div>
<div class="default">
Default Value: "standard"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_sortedBy">sortedBy</a>
<code>- Object | null</code>
</h4>
<div class="detail">
<div class="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 YAHOO.widget.DataTable.CLASS_ASC or YAHOO.widget.DataTable.CLASS_DESC</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_summary">summary</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Value for the SUMMARY attribute.
</div>
</div>
<div class="default">
Default Value: ""
</div>
<hr />
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_carousel.html">carousel</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class="selected"><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_paginator.html">paginator</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.util.Chain.html">YAHOO.util.Chain</a></li>
<li class=""><a href="YAHOO.util.ColumnDD.html">YAHOO.util.ColumnDD</a></li>
<li class=""><a href="YAHOO.util.ColumnResizer.html">YAHOO.util.ColumnResizer</a></li>
<li class=""><a href="YAHOO.util.Sort.html">YAHOO.util.Sort</a></li>
<li class=""><a href="YAHOO.widget.BaseCellEditor.html">YAHOO.widget.BaseCellEditor</a></li>
<li class=""><a href="YAHOO.widget.CellEditor.html">YAHOO.widget.CellEditor</a></li>
<li class=""><a href="YAHOO.widget.CheckboxCellEditor.html">YAHOO.widget.CheckboxCellEditor</a></li>
<li class=""><a href="YAHOO.widget.Column.html">YAHOO.widget.Column</a></li>
<li class=""><a href="YAHOO.widget.ColumnSet.html">YAHOO.widget.ColumnSet</a></li>
<li class="selected"><a href="YAHOO.widget.DataTable.html">YAHOO.widget.DataTable</a></li>
<li class=""><a href="YAHOO.widget.DateCellEditor.html">YAHOO.widget.DateCellEditor</a></li>
<li class=""><a href="YAHOO.widget.DropdownCellEditor.html">YAHOO.widget.DropdownCellEditor</a></li>
<li class=""><a href="YAHOO.widget.RadioCellEditor.html">YAHOO.widget.RadioCellEditor</a></li>
<li class=""><a href="YAHOO.widget.Record.html">YAHOO.widget.Record</a></li>
<li class=""><a href="YAHOO.widget.RecordSet.html">YAHOO.widget.RecordSet</a></li>
<li class=""><a href="YAHOO.widget.ScrollingDataTable.html">YAHOO.widget.ScrollingDataTable</a></li>
<li class=""><a href="YAHOO.widget.TextareaCellEditor.html">YAHOO.widget.TextareaCellEditor</a></li>
<li class=""><a href="YAHOO.widget.TextboxCellEditor.html">YAHOO.widget.TextboxCellEditor</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="CellEditor.js.html">CellEditor.js</a></li>
<li class=""><a href="Chain.js.html">Chain.js</a></li>
<li class=""><a href="ColumnSet.js.html">ColumnSet.js</a></li>
<li class=""><a href="DataTable.js.html">DataTable.js</a></li>
<li class=""><a href="RecordSet.js.html">RecordSet.js</a></li>
<li class=""><a href="ScrollingDataTable.js.html">ScrollingDataTable.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__aDynFunctions">_aDynFunctions</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__aSelections">_aSelections</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__bInit">_bInit</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elCaption">_elCaption</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elColgroup">_elColgroup</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elContainer">_elContainer</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elMask">_elMask</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elMsgTbody">_elMsgTbody</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elMsgTd">_elMsgTd</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elMsgTr">_elMsgTr</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elTable">_elTable</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elTbody">_elTbody</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elThead">_elThead</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__elTrTemplate">_elTrTemplate</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__nIndex">_nIndex</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__nTdCount">_nTdCount</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__nTrCount">_nTrCount</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__oAnchorCell">_oAnchorCell</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__oAnchorRecord">_oAnchorRecord</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__oCellEditor">_oCellEditor</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__oChainRender">_oChainRender</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__oColumnSet">_oColumnSet</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__oDataSource">_oDataSource</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__oRecordSet">_oRecordSet</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__sFirstTrId">_sFirstTrId</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__sId">_sId</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property__sLastTrId">_sLastTrId</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_configs">configs</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property_DataTable._bDynStylesFallback">DataTable._bDynStylesFallback</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property_DataTable._elColumnDragTarget">DataTable._elColumnDragTarget</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property_DataTable._elColumnResizerProxy">DataTable._elColumnResizerProxy</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property_DataTable._elDynStyleNode">DataTable._elDynStyleNode</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property_DataTable._nCount">DataTable._nCount</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property_DataTable._nCurrentCount">DataTable._nCurrentCount</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class="private"><a href="#property_DataTable._oDynStyles">DataTable._oDynStyles</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_ASC">DataTable.CLASS_ASC</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_BUTTON">DataTable.CLASS_BUTTON</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_CHECKBOX">DataTable.CLASS_CHECKBOX</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_COLTARGET">DataTable.CLASS_COLTARGET</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_DATA">DataTable.CLASS_DATA</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_DATATABLE">DataTable.CLASS_DATATABLE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_DEFAULT">DataTable.CLASS_DEFAULT</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_DESC">DataTable.CLASS_DESC</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_DISABLED">DataTable.CLASS_DISABLED</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_DRAGGABLE">DataTable.CLASS_DRAGGABLE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_DROPDOWN">DataTable.CLASS_DROPDOWN</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_EDITABLE">DataTable.CLASS_EDITABLE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_EDITOR">DataTable.CLASS_EDITOR</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_EMPTY">DataTable.CLASS_EMPTY</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_ERROR">DataTable.CLASS_ERROR</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_EVEN">DataTable.CLASS_EVEN</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_FIRST">DataTable.CLASS_FIRST</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_HIDDEN">DataTable.CLASS_HIDDEN</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_HIGHLIGHTED">DataTable.CLASS_HIGHLIGHTED</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_LABEL">DataTable.CLASS_LABEL</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_LAST">DataTable.CLASS_LAST</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_LINER">DataTable.CLASS_LINER</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_LOADING">DataTable.CLASS_LOADING</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_MASK">DataTable.CLASS_MASK</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_MESSAGE">DataTable.CLASS_MESSAGE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_NEXT">DataTable.CLASS_NEXT</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_ODD">DataTable.CLASS_ODD</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_PAGE">DataTable.CLASS_PAGE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_PAGINATOR">DataTable.CLASS_PAGINATOR</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_PREVIOUS">DataTable.CLASS_PREVIOUS</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_RADIO">DataTable.CLASS_RADIO</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_RESIZEABLE">DataTable.CLASS_RESIZEABLE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_RESIZER">DataTable.CLASS_RESIZER</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_RESIZERLINER">DataTable.CLASS_RESIZERLINER</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_RESIZERPROXY">DataTable.CLASS_RESIZERPROXY</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_SCROLLABLE">DataTable.CLASS_SCROLLABLE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_SELECTED">DataTable.CLASS_SELECTED</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.CLASS_SORTABLE">DataTable.CLASS_SORTABLE</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
<li class=""><a href="#property_DataTable.Formatter">DataTable.Formatter</a>
<!--<code>&lt;Object&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#method__clearMinWidth">_clearMinWidth</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__clearTrTemplateEl">_clearTrTemplateEl</a>
</li>
<li class="private"><!--<code>HTMLElement</code>-->
<a href="#method__createTrEl">_createTrEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__defaultPaginatorContainers">_defaultPaginatorContainers</a>
</li>
<li class="private"><!--<code>Boolean</code>-->
<a href="#method__deleteTrEl">_deleteTrEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyColgroupEl">_destroyColgroupEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyColumnHelpers">_destroyColumnHelpers</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyContainerEl">_destroyContainerEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyDraggableColumns">_destroyDraggableColumns</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyMsgTbodyEl">_destroyMsgTbodyEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyResizeableColumns">_destroyResizeableColumns</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyTableEl">_destroyTableEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyTbodyEl">_destroyTbodyEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__destroyTheadEl">_destroyTheadEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__focusEl">_focusEl</a>
</li>
<li class="private"><!--<code>HTMLElement</code>-->
<a href="#method__formatTdEl">_formatTdEl</a>
</li>
<li class="private"><!--<code>String</code>-->
<a href="#method__getColumnClassnames">_getColumnClassnames</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__getSelectionAnchor">_getSelectionAnchor</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__getSelectionTrigger">_getSelectionTrigger</a>
</li>
<li class="private"><!--<code>HTMLElement</code>-->
<a href="#method__getTrTemplateEl">_getTrTemplateEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleCellBlockSelectionByKey">_handleCellBlockSelectionByKey</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleCellBlockSelectionByMouse">_handleCellBlockSelectionByMouse</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleCellRangeSelectionByKey">_handleCellRangeSelectionByKey</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleCellRangeSelectionByMouse">_handleCellRangeSelectionByMouse</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handlePaginatorChange">_handlePaginatorChange</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleSingleCellSelectionByKey">_handleSingleCellSelectionByKey</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleSingleCellSelectionByMouse">_handleSingleCellSelectionByMouse</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleSingleSelectionByKey">_handleSingleSelectionByKey</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleSingleSelectionByMouse">_handleSingleSelectionByMouse</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleStandardSelectionByKey">_handleStandardSelectionByKey</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleStandardSelectionByMouse">_handleStandardSelectionByMouse</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initCaptionEl">_initCaptionEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initCellEditing">_initCellEditing</a>
</li>
<li class="private deprecated"><!--<code>void</code>-->
<a href="#method__initCellEditorEl">_initCellEditorEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initColgroupEl">_initColgroupEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initColumnHelpers">_initColumnHelpers</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initColumnSet">_initColumnSet</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initColumnSort">_initColumnSort</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initConfigs">_initConfigs</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initContainerEl">_initContainerEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initDataSource">_initDataSource</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initDomElements">_initDomElements</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initDraggableColumns">_initDraggableColumns</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initEvents">_initEvents</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initMsgTbodyEl">_initMsgTbodyEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initRecordSet">_initRecordSet</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initResizeableColumns">_initResizeableColumns</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initTableEl">_initTableEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initTbodyEl">_initTbodyEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initTheadEl">_initTheadEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initThEl">_initThEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__insertColgroupColEl">_insertColgroupColEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onDocumentClick">_onDocumentClick</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onDropdownChange">_onDropdownChange</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorBlockEvent">_onEditorBlockEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorBlurEvent">_onEditorBlurEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorCancelEvent">_onEditorCancelEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorKeydownEvent">_onEditorKeydownEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorRevertEvent">_onEditorRevertEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorSaveEvent">_onEditorSaveEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorShowEvent">_onEditorShowEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onEditorUnblockEvent">_onEditorUnblockEvent</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onRenderChainEnd">_onRenderChainEnd</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTableDblclick">_onTableDblclick</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTableFocus">_onTableFocus</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTableKeypress">_onTableKeypress</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTableMousedown">_onTableMousedown</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTableMouseout">_onTableMouseout</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTableMouseover">_onTableMouseover</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTableMouseup">_onTableMouseup</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTbodyClick">_onTbodyClick</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTbodyFocus">_onTbodyFocus</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTbodyKeydown">_onTbodyKeydown</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTheadClick">_onTheadClick</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTheadFocus">_onTheadFocus</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onTheadKeydown">_onTheadKeydown</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__removeColgroupColEl">_removeColgroupColEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__reorderColgroupColEl">_reorderColgroupColEl</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__repaintGecko">_repaintGecko</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__repaintOpera">_repaintOpera</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__repaintWebkit">_repaintWebkit</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__restoreMinWidth">_restoreMinWidth</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__runRenderChain">_runRenderChain</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setColumnWidth">_setColumnWidth</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setColumnWidthDynFunction">_setColumnWidthDynFunction</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setColumnWidthDynStyles">_setColumnWidthDynStyles</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setFirstRow">_setFirstRow</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setLastRow">_setLastRow</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setRowStripes">_setRowStripes</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__setSelections">_setSelections</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method__syncColWidths">_syncColWidths</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__unselectAllTdEls">_unselectAllTdEls</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__unselectAllTrEls">_unselectAllTrEls</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__unsetFirstRow">_unsetFirstRow</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__unsetLastRow">_unsetLastRow</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__updatePaginator">_updatePaginator</a>
</li>
<li class="private"><!--<code>HTMLElement</code>-->
<a href="#method__updateTrEl">_updateTrEl</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addRow">addRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addRows">addRows</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cancelCellEditor">cancelCellEditor</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_clearTextSelection">clearTextSelection</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_DataTable._cloneObject">DataTable._cloneObject</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_DataTable._destroyColumnDragTargetEl">DataTable._destroyColumnDragTargetEl</a>
</li>
<li class="private"><!--<code>HTMLElement</code>-->
<a href="#method_DataTable._destroyColumnResizerProxyEl">DataTable._destroyColumnResizerProxyEl</a>
</li>
<li class="private"><!--<code>HTMLElement</code>-->
<a href="#method_DataTable._initColumnDragTargetEl">DataTable._initColumnDragTargetEl</a>
</li>
<li class="private"><!--<code>HTMLElement</code>-->
<a href="#method_DataTable._initColumnResizerProxyEl">DataTable._initColumnResizerProxyEl</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_DataTable.editCheckbox">DataTable.editCheckbox</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_DataTable.editDate">DataTable.editDate</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_DataTable.editDropdown">DataTable.editDropdown</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_DataTable.editRadio">DataTable.editRadio</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_DataTable.editTextarea">DataTable.editTextarea</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_DataTable.editTextbox">DataTable.editTextbox</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatButton">DataTable.formatButton</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatCheckbox">DataTable.formatCheckbox</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatCurrency">DataTable.formatCurrency</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatDate">DataTable.formatDate</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatDefault">DataTable.formatDefault</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatDropdown">DataTable.formatDropdown</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatEmail">DataTable.formatEmail</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatLink">DataTable.formatLink</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatNumber">DataTable.formatNumber</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatRadio">DataTable.formatRadio</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatText">DataTable.formatText</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatTextarea">DataTable.formatTextarea</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.formatTextbox">DataTable.formatTextbox</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_DataTable.formatTheadCell">DataTable.formatTheadCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_DataTable.validateNumber">DataTable.validateNumber</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_deleteRow">deleteRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_deleteRows">deleteRows</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_destroy">destroy</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_destroyCellEditor">destroyCellEditor</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_disable">disable</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_doBeforeLoadData">doBeforeLoadData</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_doBeforePaginatorChange">doBeforePaginatorChange</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_doBeforeShowCellEditor">doBeforeShowCellEditor</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_doBeforeSortColumn">doBeforeSortColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focus">focus</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focusTbodyEl">focusTbodyEl</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focusTheadEl">focusTheadEl</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_formatCell">formatCell</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getAboveTdEl">getAboveTdEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getBelowTdEl">getBelowTdEl</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_getBody">getBody</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_getCell">getCell</a>
</li>
<li class=""><!--<code>YAHOO.widget.CellEditor</code>-->
<a href="#method_getCellEditor">getCellEditor</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column</code>-->
<a href="#method_getColumn">getColumn</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column</code>-->
<a href="#method_getColumnById">getColumnById</a>
</li>
<li class=""><!--<code>YAHOO.widget.ColumnSet</code>-->
<a href="#method_getColumnSet">getColumnSet</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_getColumnSortDir">getColumnSortDir</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getContainerEl">getContainerEl</a>
</li>
<li class=""><!--<code>YAHOO.util.DataSource</code>-->
<a href="#method_getDataSource">getDataSource</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getFirstTdEl">getFirstTdEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getFirstTrEl">getFirstTrEl</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_getId">getId</a>
</li>
<li class=""><!--<code>Object</code>-->
<a href="#method_getLastSelectedCell">getLastSelectedCell</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_getLastSelectedRecord">getLastSelectedRecord</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getLastTdEl">getLastTdEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getLastTrEl">getLastTrEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getMsgTbodyEl">getMsgTbodyEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getMsgTdEl">getMsgTdEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getNextTdEl">getNextTdEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getNextTrEl">getNextTrEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getPreviousTdEl">getPreviousTdEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getPreviousTrEl">getPreviousTrEl</a>
</li>
<li class=""><!--<code>YAHOO.widget.Record</code>-->
<a href="#method_getRecord">getRecord</a>
</li>
<li class=""><!--<code>Number</code>-->
<a href="#method_getRecordIndex">getRecordIndex</a>
</li>
<li class=""><!--<code>YAHOO.widget.RecordSet</code>-->
<a href="#method_getRecordSet">getRecordSet</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_getRow">getRow</a>
</li>
<li class=""><!--<code>Object[]</code>-->
<a href="#method_getSelectedCells">getSelectedCells</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column[]</code>-->
<a href="#method_getSelectedColumns">getSelectedColumns</a>
</li>
<li class=""><!--<code>String[]</code>-->
<a href="#method_getSelectedRows">getSelectedRows</a>
</li>
<li class=""><!--<code>HTMLElement[]</code>-->
<a href="#method_getSelectedTdEls">getSelectedTdEls</a>
</li>
<li class=""><!--<code>HTMLElement[]</code>-->
<a href="#method_getSelectedTrEls">getSelectedTrEls</a>
</li>
<li class=""><!--<code>Object</code>-->
<a href="#method_getState">getState</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getTableEl">getTableEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getTbodyEl">getTbodyEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getTdEl">getTdEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getTdLinerEl">getTdLinerEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getTheadEl">getTheadEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getThEl">getThEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getThLinerEl">getThLinerEl</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_getTrEl">getTrEl</a>
</li>
<li class=""><!--<code>Number</code>-->
<a href="#method_getTrIndex">getTrIndex</a>
</li>
<li class=""><!--<code>MIXED</code>-->
<a href="#method_handleDataReturnPayload">handleDataReturnPayload</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_hideColumn">hideColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_hideTableMessage">hideTableMessage</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_highlightCell">highlightCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_highlightColumn">highlightColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_highlightRow">highlightRow</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_initAttributes">initAttributes</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initializeTable">initializeTable</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column</code>-->
<a href="#method_insertColumn">insertColumn</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_isSelected">isSelected</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDataReturnAppendRows">onDataReturnAppendRows</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDataReturnInitializeTable">onDataReturnInitializeTable</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDataReturnInsertRows">onDataReturnInsertRows</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDataReturnReplaceRows">onDataReturnReplaceRows</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_onDataReturnSetRecords">onDataReturnSetRecords</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onDataReturnSetRows">onDataReturnSetRows</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEditorBlockEvent">onEditorBlockEvent</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEditorBlurEvent">onEditorBlurEvent</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEditorUnblockEvent">onEditorUnblockEvent</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventCancelCellEditor">onEventCancelCellEditor</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_onEventEditCell">onEventEditCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventFormatCell">onEventFormatCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventHighlightCell">onEventHighlightCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventHighlightColumn">onEventHighlightColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventHighlightRow">onEventHighlightRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventSaveCellEditor">onEventSaveCellEditor</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventSelectCell">onEventSelectCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventSelectColumn">onEventSelectColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventSelectRow">onEventSelectRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventShowCellEditor">onEventShowCellEditor</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventSortColumn">onEventSortColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventUnhighlightCell">onEventUnhighlightCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventUnhighlightColumn">onEventUnhighlightColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onEventUnhighlightRow">onEventUnhighlightRow</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_onPaginatorChange">onPaginatorChange</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onPaginatorChangeRequest">onPaginatorChangeRequest</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onShow">onShow</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_refreshView">refreshView</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column</code>-->
<a href="#method_removeColumn">removeColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_render">render</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_renderPaginator">renderPaginator</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column</code>-->
<a href="#method_reorderColumn">reorderColumn</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_resetCellEditor">resetCellEditor</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_saveCellEditor">saveCellEditor</a>
</li>
<li class=" deprecated"><!--<code>void</code>-->
<a href="#method_select">select</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_selectCell">selectCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_selectColumn">selectColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_selectRow">selectRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_setColumnWidth">setColumnWidth</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_showCellEditor">showCellEditor</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_showColumn">showColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_showTableMessage">showTableMessage</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_sortColumn">sortColumn</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_undisable">undisable</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unhighlightCell">unhighlightCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unhighlightColumn">unhighlightColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unhighlightRow">unhighlightRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unselectAllCells">unselectAllCells</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unselectAllRows">unselectAllRows</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unselectCell">unselectCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unselectColumn">unselectColumn</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_unselectRow">unselectRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_updateCell">updateCell</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_updateRow">updateRow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_validateColumnWidths">validateColumnWidths</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_beforeCaptionChange">beforeCaptionChange</a>
</li>
<li class="">
<a href="#event_beforeCurrencyOptionsChange">beforeCurrencyOptionsChange</a>
</li>
<li class="">
<a href="#event_beforeCurrencySymbolChange">beforeCurrencySymbolChange</a>
</li>
<li class="">
<a href="#event_beforeDateOptionsChange">beforeDateOptionsChange</a>
</li>
<li class="">
<a href="#event_beforeDraggableColumnsChange">beforeDraggableColumnsChange</a>
</li>
<li class="">
<a href="#event_beforeDynamicDataChange">beforeDynamicDataChange</a>
</li>
<li class="">
<a href="#event_beforeFormatRowChange">beforeFormatRowChange</a>
</li>
<li class="">
<a href="#event_beforeGenerateRequestChange">beforeGenerateRequestChange</a>
</li>
<li class="">
<a href="#event_beforeInitialLoadChange">beforeInitialLoadChange</a>
</li>
<li class="">
<a href="#event_beforeInitialRequestChange">beforeInitialRequestChange</a>
</li>
<li class="">
<a href="#event_beforeMSG_EMPTYChange">beforeMSG_EMPTYChange</a>
</li>
<li class="">
<a href="#event_beforeMSG_ERRORChange">beforeMSG_ERRORChange</a>
</li>
<li class="">
<a href="#event_beforeMSG_LOADINGChange">beforeMSG_LOADINGChange</a>
</li>
<li class="">
<a href="#event_beforeMSG_SORTASCChange">beforeMSG_SORTASCChange</a>
</li>
<li class="">
<a href="#event_beforeMSG_SORTDESCChange">beforeMSG_SORTDESCChange</a>
</li>
<li class="">
<a href="#event_beforeNumberOptionsChange">beforeNumberOptionsChange</a>
</li>
<li class="">
<a href="#event_beforePaginatorChange">beforePaginatorChange</a>
</li>
<li class="">
<a href="#event_beforeRenderLoopSizeChange">beforeRenderLoopSizeChange</a>
</li>
<li class="">
<a href="#event_beforeSelectionModeChange">beforeSelectionModeChange</a>
</li>
<li class="">
<a href="#event_beforeSortedByChange">beforeSortedByChange</a>
</li>
<li class="">
<a href="#event_beforeSummaryChange">beforeSummaryChange</a>
</li>
<li class="">
<a href="#event_buttonClickEvent">buttonClickEvent</a>
</li>
<li class="">
<a href="#event_captionChange">captionChange</a>
</li>
<li class="">
<a href="#event_cellClickEvent">cellClickEvent</a>
</li>
<li class="">
<a href="#event_cellDblclickEvent">cellDblclickEvent</a>
</li>
<li class="">
<a href="#event_cellFormatEvent">cellFormatEvent</a>
</li>
<li class="">
<a href="#event_cellHighlightEvent">cellHighlightEvent</a>
</li>
<li class="">
<a href="#event_cellMousedownEvent">cellMousedownEvent</a>
</li>
<li class="">
<a href="#event_cellMouseoutEvent">cellMouseoutEvent</a>
</li>
<li class="">
<a href="#event_cellMouseoverEvent">cellMouseoverEvent</a>
</li>
<li class="">
<a href="#event_cellMouseupEvent">cellMouseupEvent</a>
</li>
<li class="">
<a href="#event_cellSelectEvent">cellSelectEvent</a>
</li>
<li class="">
<a href="#event_cellUnhighlightEvent">cellUnhighlightEvent</a>
</li>
<li class="">
<a href="#event_cellUnselectEvent">cellUnselectEvent</a>
</li>
<li class="">
<a href="#event_cellUpdateEvent">cellUpdateEvent</a>
</li>
<li class="">
<a href="#event_checkboxClickEvent">checkboxClickEvent</a>
</li>
<li class="">
<a href="#event_columnHideEvent">columnHideEvent</a>
</li>
<li class="">
<a href="#event_columnHighlightEvent">columnHighlightEvent</a>
</li>
<li class="">
<a href="#event_columnInsertEvent">columnInsertEvent</a>
</li>
<li class="">
<a href="#event_columnRemoveEvent">columnRemoveEvent</a>
</li>
<li class="">
<a href="#event_columnReorderEvent">columnReorderEvent</a>
</li>
<li class="">
<a href="#event_columnResizeEvent">columnResizeEvent</a>
</li>
<li class="">
<a href="#event_columnSelectEvent">columnSelectEvent</a>
</li>
<li class="">
<a href="#event_columnSetWidthEvent">columnSetWidthEvent</a>
</li>
<li class="">
<a href="#event_columnShowEvent">columnShowEvent</a>
</li>
<li class="">
<a href="#event_columnSortEvent">columnSortEvent</a>
</li>
<li class="">
<a href="#event_columnUnhighlightEvent">columnUnhighlightEvent</a>
</li>
<li class="">
<a href="#event_columnUnselectEvent">columnUnselectEvent</a>
</li>
<li class="">
<a href="#event_columnUnsetWidthEvent">columnUnsetWidthEvent</a>
</li>
<li class="">
<a href="#event_currencyOptionsChange">currencyOptionsChange</a>
</li>
<li class="">
<a href="#event_currencySymbolChange">currencySymbolChange</a>
</li>
<li class="">
<a href="#event_dataReturnEvent">dataReturnEvent</a>
</li>
<li class="">
<a href="#event_dateOptionsChange">dateOptionsChange</a>
</li>
<li class="">
<a href="#event_disableEvent">disableEvent</a>
</li>
<li class="">
<a href="#event_draggableColumnsChange">draggableColumnsChange</a>
</li>
<li class="">
<a href="#event_dropdownChangeEvent">dropdownChangeEvent</a>
</li>
<li class="">
<a href="#event_dynamicDataChange">dynamicDataChange</a>
</li>
<li class="">
<a href="#event_editorBlockEvent">editorBlockEvent</a>
</li>
<li class="">
<a href="#event_editorBlurEvent">editorBlurEvent</a>
</li>
<li class="">
<a href="#event_editorCancelEvent">editorCancelEvent</a>
</li>
<li class="">
<a href="#event_editorKeydownEvent">editorKeydownEvent</a>
</li>
<li class="">
<a href="#event_editorRevertEvent">editorRevertEvent</a>
</li>
<li class="">
<a href="#event_editorSaveEvent">editorSaveEvent</a>
</li>
<li class="">
<a href="#event_editorShowEvent">editorShowEvent</a>
</li>
<li class="">
<a href="#event_editorUnblockEvent">editorUnblockEvent</a>
</li>
<li class=" deprecated">
<a href="#event_editorUpdateEvent">editorUpdateEvent</a>
</li>
<li class="">
<a href="#event_formatRowChange">formatRowChange</a>
</li>
<li class="">
<a href="#event_generateRequestChange">generateRequestChange</a>
</li>
<li class=" deprecated">
<a href="#event_headerCellClickEvent">headerCellClickEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerCellDblclickEvent">headerCellDblclickEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerCellMousedownEvent">headerCellMousedownEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerCellMouseoutEvent">headerCellMouseoutEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerCellMouseoverEvent">headerCellMouseoverEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerLabelClickEvent">headerLabelClickEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerLabelDbllickEvent">headerLabelDbllickEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerLabelMousedownEvent">headerLabelMousedownEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerLabelMouseoutEvent">headerLabelMouseoutEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerLabelMouseoverEvent">headerLabelMouseoverEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerRowClickEvent">headerRowClickEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerRowDblclickEvent">headerRowDblclickEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerRowMousedownEvent">headerRowMousedownEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerRowMouseoutEvent">headerRowMouseoutEvent</a>
</li>
<li class=" deprecated">
<a href="#event_headerRowMouseoverEvent">headerRowMouseoverEvent</a>
</li>
<li class="">
<a href="#event_initEvent">initEvent</a>
</li>
<li class="">
<a href="#event_initialLoadChange">initialLoadChange</a>
</li>
<li class="">
<a href="#event_initialRequestChange">initialRequestChange</a>
</li>
<li class="">
<a href="#event_linkClickEvent">linkClickEvent</a>
</li>
<li class="">
<a href="#event_MSG_EMPTYChange">MSG_EMPTYChange</a>
</li>
<li class="">
<a href="#event_MSG_ERRORChange">MSG_ERRORChange</a>
</li>
<li class="">
<a href="#event_MSG_LOADINGChange">MSG_LOADINGChange</a>
</li>
<li class="">
<a href="#event_MSG_SORTASCChange">MSG_SORTASCChange</a>
</li>
<li class="">
<a href="#event_MSG_SORTDESCChange">MSG_SORTDESCChange</a>
</li>
<li class="">
<a href="#event_numberOptionsChange">numberOptionsChange</a>
</li>
<li class="">
<a href="#event_paginatorChange">paginatorChange</a>
</li>
<li class="">
<a href="#event_postRenderEvent">postRenderEvent</a>
</li>
<li class="">
<a href="#event_radioClickEvent">radioClickEvent</a>
</li>
<li class="">
<a href="#event_renderEvent">renderEvent</a>
</li>
<li class="">
<a href="#event_renderLoopSizeChange">renderLoopSizeChange</a>
</li>
<li class="">
<a href="#event_rowAddEvent">rowAddEvent</a>
</li>
<li class="">
<a href="#event_rowClickEvent">rowClickEvent</a>
</li>
<li class="">
<a href="#event_rowDblclickEvent">rowDblclickEvent</a>
</li>
<li class="">
<a href="#event_rowDeleteEvent">rowDeleteEvent</a>
</li>
<li class="">
<a href="#event_rowHighlightEvent">rowHighlightEvent</a>
</li>
<li class="">
<a href="#event_rowMousedownEvent">rowMousedownEvent</a>
</li>
<li class="">
<a href="#event_rowMouseoutEvent">rowMouseoutEvent</a>
</li>
<li class="">
<a href="#event_rowMouseoverEvent">rowMouseoverEvent</a>
</li>
<li class="">
<a href="#event_rowMouseupEvent">rowMouseupEvent</a>
</li>
<li class="">
<a href="#event_rowsAddEvent">rowsAddEvent</a>
</li>
<li class="">
<a href="#event_rowsDeleteEvent">rowsDeleteEvent</a>
</li>
<li class="">
<a href="#event_rowSelectEvent">rowSelectEvent</a>
</li>
<li class="">
<a href="#event_rowUnhighlightEvent">rowUnhighlightEvent</a>
</li>
<li class="">
<a href="#event_rowUnselectEvent">rowUnselectEvent</a>
</li>
<li class="">
<a href="#event_rowUpdateEvent">rowUpdateEvent</a>
</li>
<li class="">
<a href="#event_selectionModeChange">selectionModeChange</a>
</li>
<li class="">
<a href="#event_sortedByChange">sortedByChange</a>
</li>
<li class="">
<a href="#event_summaryChange">summaryChange</a>
</li>
<li class="">
<a href="#event_tableBlurEvent">tableBlurEvent</a>
</li>
<li class="">
<a href="#event_tableClickEvent">tableClickEvent</a>
</li>
<li class="">
<a href="#event_tableDblclickEvent">tableDblclickEvent</a>
</li>
<li class="">
<a href="#event_tableFocusEvent">tableFocusEvent</a>
</li>
<li class="">
<a href="#event_tableKeyEvent">tableKeyEvent</a>
</li>
<li class="">
<a href="#event_tableMousedownEvent">tableMousedownEvent</a>
</li>
<li class="">
<a href="#event_tableMouseoutEvent">tableMouseoutEvent</a>
</li>
<li class="">
<a href="#event_tableMouseoverEvent">tableMouseoverEvent</a>
</li>
<li class="">
<a href="#event_tableMouseupEvent">tableMouseupEvent</a>
</li>
<li class="">
<a href="#event_tableMsgHideEvent">tableMsgHideEvent</a>
</li>
<li class="">
<a href="#event_tableMsgShowEvent">tableMsgShowEvent</a>
</li>
<li class="">
<a href="#event_tbodyFocusEvent">tbodyFocusEvent</a>
</li>
<li class="">
<a href="#event_tbodyKeyEvent">tbodyKeyEvent</a>
</li>
<li class="">
<a href="#event_theadCellClickEvent">theadCellClickEvent</a>
</li>
<li class="">
<a href="#event_theadCellDblclickEvent">theadCellDblclickEvent</a>
</li>
<li class="">
<a href="#event_theadCellMousedownEvent">theadCellMousedownEvent</a>
</li>
<li class="">
<a href="#event_theadCellMouseoutEvent">theadCellMouseoutEvent</a>
</li>
<li class="">
<a href="#event_theadCellMouseoverEvent">theadCellMouseoverEvent</a>
</li>
<li class="">
<a href="#event_theadCellMouseupEvent">theadCellMouseupEvent</a>
</li>
<li class="">
<a href="#event_theadFocusEvent">theadFocusEvent</a>
</li>
<li class="">
<a href="#event_theadKeyEvent">theadKeyEvent</a>
</li>
<li class="">
<a href="#event_theadLabelClickEvent">theadLabelClickEvent</a>
</li>
<li class="">
<a href="#event_theadLabelDblclickEvent">theadLabelDblclickEvent</a>
</li>
<li class="">
<a href="#event_theadLabelMousedownEvent">theadLabelMousedownEvent</a>
</li>
<li class="">
<a href="#event_theadLabelMouseoutEvent">theadLabelMouseoutEvent</a>
</li>
<li class="">
<a href="#event_theadLabelMouseoverEvent">theadLabelMouseoverEvent</a>
</li>
<li class="">
<a href="#event_theadLabelMouseupEvent">theadLabelMouseupEvent</a>
</li>
<li class="">
<a href="#event_theadRowClickEvent">theadRowClickEvent</a>
</li>
<li class="">
<a href="#event_theadRowDblclickEvent">theadRowDblclickEvent</a>
</li>
<li class="">
<a href="#event_theadRowMousedownEvent">theadRowMousedownEvent</a>
</li>
<li class="">
<a href="#event_theadRowMouseoutEvent">theadRowMouseoutEvent</a>
</li>
<li class="">
<a href="#event_theadRowMouseoverEvent">theadRowMouseoverEvent</a>
</li>
<li class="">
<a href="#event_theadRowMouseupEvent">theadRowMouseupEvent</a>
</li>
<li class="">
<a href="#event_undisableEvent">undisableEvent</a>
</li>
<li class="">
<a href="#event_unselectAllCellsEvent">unselectAllCellsEvent</a>
</li>
<li class="">
<a href="#event_unselectAllRowsEvent">unselectAllRowsEvent</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_caption">caption</a>
</li>
<li class="">
<a href="#config_currencyOptions">currencyOptions</a>
</li>
<li class=" deprecated">
<a href="#config_currencySymbol">currencySymbol</a>
</li>
<li class="">
<a href="#config_dateOptions">dateOptions</a>
</li>
<li class="">
<a href="#config_draggableColumns">draggableColumns</a>
</li>
<li class="">
<a href="#config_dynamicData">dynamicData</a>
</li>
<li class="">
<a href="#config_formatRow">formatRow</a>
</li>
<li class="">
<a href="#config_generateRequest">generateRequest</a>
</li>
<li class="">
<a href="#config_initialLoad">initialLoad</a>
</li>
<li class="">
<a href="#config_initialRequest">initialRequest</a>
</li>
<li class="">
<a href="#config_MSG_EMPTY">MSG_EMPTY</a>
</li>
<li class="">
<a href="#config_MSG_ERROR">MSG_ERROR</a>
</li>
<li class="">
<a href="#config_MSG_LOADING">MSG_LOADING</a>
</li>
<li class="">
<a href="#config_MSG_SORTASC">MSG_SORTASC</a>
</li>
<li class="">
<a href="#config_MSG_SORTDESC">MSG_SORTDESC</a>
</li>
<li class="">
<a href="#config_numberOptions">numberOptions</a>
</li>
<li class="">
<a href="#config_paginator">paginator</a>
</li>
<li class="">
<a href="#config_renderLoopSize">renderLoopSize</a>
</li>
<li class="">
<a href="#config_selectionMode">selectionMode</a>
</li>
<li class="">
<a href="#config_sortedBy">sortedBy</a>
</li>
<li class="">
<a href="#config_summary">summary</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink