18017 lines
911 KiB
HTML
18017 lines
911 KiB
HTML
<!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 <span class="subtitle">2.5.1</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_datatable.html">datatable</a>
|
|
> 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" /> Show Private</span>
|
|
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.widget.DataTable</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
<span class="extends">
|
|
- uses
|
|
|
|
<a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>
|
|
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<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
|
|
<HTMLElement>
|
|
</code>
|
|
Container element for the TABLE.
|
|
</dd>
|
|
<dd>
|
|
<code>aColumnDefs
|
|
<Object[]>
|
|
</code>
|
|
Array of object literal Column definitions.
|
|
</dd>
|
|
<dd>
|
|
<code>oDataSource
|
|
<YAHOO.util.DataSource>
|
|
</code>
|
|
DataSource instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oConfigs
|
|
<object>
|
|
</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__aFallbackColResizer">_aFallbackColResizer</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, columnId:sColumnId})
|
|
</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 rather than
|
|
renderEvent.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__bScrollbarX">_bScrollbarX</a>
|
|
<code>- private {Boolean}</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
True if x-scrollbar is currently visible.
|
|
</div>
|
|
</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__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__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__elMsgTbodyCell">_elMsgTbodyCell</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__elMsgTbodyRow">_elMsgTbodyRow</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__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__elTbodyContainer">_elTbodyContainer</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
DOM reference to the container element for the DataTable's primary TBODY.
|
|
</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 primary THEAD element for the DataTable instance.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__elTheadContainer">_elTheadContainer</a>
|
|
<code>- private HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
DOM reference to the container element for the DataTable's primary THEAD.
|
|
</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, columnId:sColumnId}.
|
|
</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__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__oChainSync">_oChainSync</a>
|
|
<code>- private YAHOO.util.Chain</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Sync 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__sLastHighlightedTdElId">_sLastHighlightedTdElId</a>
|
|
<code>- private String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
ID string of last highlighted cell element
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__sLastHighlightedTrElId">_sLastHighlightedTrElId</a>
|
|
<code>- private String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
ID string of last highlighted row element
|
|
</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="private">
|
|
<h4><a name="property__tdElTemplate">_tdElTemplate</a>
|
|
<code>- private {HTMLElement}</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Template cell to create all new cells from.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__trElTemplate">_trElTemplate</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_DataTable._bStylesheetFallback">DataTable._bStylesheetFallback</a>
|
|
<code>- private static boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Set to true if _elStylesheet 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._elStylesheet">DataTable._elStylesheet</a>
|
|
<code>- private static HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to STYLE node that is dynamically created and written to
|
|
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._oStylesheetRules">DataTable._oStylesheetRules</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_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 Editor 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_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_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 class="">
|
|
<h4><a name="property_DataTable.MSG_EMPTY">DataTable.MSG_EMPTY</a>
|
|
<code>- static final 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="property_DataTable.MSG_ERROR">DataTable.MSG_ERROR</a>
|
|
<code>- static final 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="property_DataTable.MSG_LOADING">DataTable.MSG_LOADING</a>
|
|
<code>- static final 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 data..."
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events">__yui_events</a><span class="private">,</span>
|
|
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__addTdEl">_addTdEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
HTMLElement
|
|
<strong>_addTdEl</strong>
|
|
(
|
|
|
|
|
|
elRow
|
|
|
|
|
|
,
|
|
oColumn
|
|
|
|
|
|
,
|
|
index
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Creates a cell within the specified row and column.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elRow <HTMLElement></code>
|
|
The row to add the cell to
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <Column></code>
|
|
The column definition to use for the cell
|
|
</dd>
|
|
<dd>
|
|
<code>index <number></code>
|
|
(optional) the index to add the cell at (default null)
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
HTMLElement
|
|
</code></dt>
|
|
<dd>the new cell</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__addTrEl">_addTrEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
HTMLElement
|
|
<strong>_addTrEl</strong>
|
|
(
|
|
|
|
|
|
oRecord
|
|
|
|
|
|
,
|
|
index
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Adds one TR element at the given index and populates with given Record data.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>index <Number></code>
|
|
TR index.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
HTMLElement
|
|
</code></dt>
|
|
<dd>Reference to new TR element.</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 TR element for a given Record.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></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__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 <HTMLElement | Number></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__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 <HTMLElement></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__forceGeckoRedraw">_forceGeckoRedraw</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_forceGeckoRedraw</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Forces Gecko repaint by removing/adding the no-op class name
|
|
</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__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 <Object></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__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 <HTMLEvent></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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__handleDataReturnPayload">_handleDataReturnPayload</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_handleDataReturnPayload</strong>
|
|
(
|
|
|
|
|
|
oRequest
|
|
|
|
|
|
,
|
|
oResponse
|
|
|
|
|
|
,
|
|
meta
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Updates the DataTable with data sent in an onDataReturn* payload
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oRequest <MIXED></code>
|
|
Original generated request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>meta <MIXED></code>
|
|
Argument(s) provided in payload or response meta
|
|
</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 <HTMLEvent></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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__initCellEditorEl">_initCellEditorEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initCellEditorEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Creates HTML markup for Cell Editor.
|
|
</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 <Object[]></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 <Object></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 container element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elContainer <HTMLElement | String></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 <YAHOO.util.DataSource></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__initNodeTemplates">_initNodeTemplates</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initNodeTemplates</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the HTMLElement templates used to create various table child
|
|
nodes.
|
|
</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__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__initTableEl">_initTableEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initTableEl</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Creates HTML markup for TABLE, THEAD and TBODY 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__initTheadEls">_initTheadEls</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initTheadEls</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes THEAD elements for display and for screen readers.
|
|
</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__initThEl">_initThEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_initThEl</strong>
|
|
(
|
|
|
|
|
|
elTheadCell
|
|
|
|
|
|
,
|
|
oColumn
|
|
|
|
|
|
,
|
|
row
|
|
|
|
|
|
,
|
|
col
|
|
|
|
|
|
,
|
|
bA11y
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Populates TH cell as defined by Column.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elTheadCell <HTMLElement></code>
|
|
TH cell element reference.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column object.
|
|
</dd>
|
|
<dd>
|
|
<code>row <Number></code>
|
|
Row index.
|
|
</dd>
|
|
<dd>
|
|
<code>col <Number></code>
|
|
Column index.
|
|
</dd>
|
|
<dd>
|
|
<code>bA11y <Boolean></code>
|
|
True if TH is for accessibility, so as not to
|
|
initialize presentation elements.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__mergeResponseMeta">_mergeResponseMeta</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
object
|
|
<strong>_mergeResponseMeta</strong>
|
|
(
|
|
|
|
|
|
*
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Merges meta information from the response (as defined in the DataSource's
|
|
responseSchema.metaFields member) into the payload. A few magic keys are
|
|
given special treatment: sortKey and sortDir => sorting.key|dir and all
|
|
keys paginationFoo => pagination.foo. Merging is shallow with the exception
|
|
of the magic keys being added to their respective nested objects.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>* <object></code>
|
|
Any number of objects to merge together. Last in wins.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
object
|
|
</code></dt>
|
|
<dd>A new object containing the combined keys of all objects.</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 <HTMLEvent></code>
|
|
The click event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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__onPaginatorDropdownChange">_onPaginatorDropdownChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onPaginatorDropdownChange</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 Paginator class APIs.
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onPaginatorLinkClick">_onPaginatorLinkClick</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onPaginatorLinkClick</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 Paginator class APIs.
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__onScroll">_onScroll</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onScroll</strong>
|
|
(
|
|
|
|
|
|
e
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Syncs scrolltop and scrollleft of all TABLEs.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>e <HTMLEvent></code>
|
|
The scroll event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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__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 <HTMLEvent></code>
|
|
The dblclick event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The focus event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The key event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The mousedown event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The mouseout event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The mouseover event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The click event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The focus event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The key event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The click event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The focus event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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 <HTMLEvent></code>
|
|
The key event.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></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__setColumnWidth">_setColumnWidth</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_setColumnWidth</strong>
|
|
(
|
|
|
|
|
|
oColumn
|
|
|
|
|
|
,
|
|
sWidth
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets DOM elements of given Column to given pixel width. No validations
|
|
against minimum width and no updating Column.width value.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sWidth <String></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 DT.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 DT.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 alternating TR elements of the DataTable
|
|
page. For performance, a subset of rows may be specified.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>row <HTMLElement | String | Number></code>
|
|
(optional) HTML TR element reference
|
|
or string ID, or page row index of where to start striping.
|
|
</dd>
|
|
<dd>
|
|
<code>range <Number></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__sync">_sync</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_sync</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Post render syncing of Column widths and scroll padding
|
|
</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__syncColWidths">_syncColWidths</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_syncColWidths</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Syncs up widths of THs and TDs across all those Columns without width values.
|
|
Actual adjustment is to the liner DIVs so window resizing will not affect cells.
|
|
</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__syncScrollPadding">_syncScrollPadding</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_syncScrollPadding</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Syncs padding around scrollable tables, including Column header right-padding
|
|
and container width and height.
|
|
</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__unselectAllTdEls">_unselectAllTdEls</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_unselectAllTdEls</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Convenience method to remove the class DT.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 DT.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__updateTrEl">_updateTrEl</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
HTMLElement
|
|
<strong>_updateTrEl</strong>
|
|
(
|
|
|
|
|
|
elRow
|
|
|
|
|
|
,
|
|
oRecord
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Formats all TD elements of given TR element with data from the given Record.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elRow <HTMLElement></code>
|
|
The TR element to update.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></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 <Object></code>
|
|
Object literal of data for the row.
|
|
</dd>
|
|
<dd>
|
|
<code>index <Number></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 <Object[]></code>
|
|
Array of object literal data for the rows.
|
|
</dd>
|
|
<dd>
|
|
<code>index <Number></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 Cell Editor.
|
|
</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 <Object></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._generateRequest">DataTable._generateRequest</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
static
|
|
|
|
void
|
|
<strong>DataTable._generateRequest</strong>
|
|
(
|
|
|
|
|
|
oData
|
|
|
|
|
|
,
|
|
oDataTable
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Translates (proposed) DataTable state data into a form consumable by
|
|
DataSource sendRequest as the request parameter. Use
|
|
set('generateRequest', yourFunc) to use a custom function rather than this
|
|
one.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oData <Object></code>
|
|
Object literal defining the current or proposed state
|
|
</dd>
|
|
<dd>
|
|
<code>oDataTable <DataTable></code>
|
|
Reference to the 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_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="">
|
|
<h4>
|
|
<a name="method_DataTable.editCheckbox">DataTable.editCheckbox</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.editCheckbox</strong>
|
|
(
|
|
|
|
|
|
oEditor
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables CHECKBOX Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oEditor <Object></code>
|
|
Object literal representation of Editor values.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></code>
|
|
Reference back to DataTable instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_DataTable.editDate">DataTable.editDate</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.editDate</strong>
|
|
(
|
|
|
|
|
|
oEditor
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables Date Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oEditor <Object></code>
|
|
Object literal representation of Editor values.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></code>
|
|
Reference back to DataTable instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_DataTable.editDropdown">DataTable.editDropdown</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.editDropdown</strong>
|
|
(
|
|
|
|
|
|
oEditor
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables SELECT Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oEditor <Object></code>
|
|
Object literal representation of Editor values.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></code>
|
|
Reference back to DataTable instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_DataTable.editRadio">DataTable.editRadio</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.editRadio</strong>
|
|
(
|
|
|
|
|
|
oEditor
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables INPUT TYPE=RADIO Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oEditor <Object></code>
|
|
Object literal representation of Editor values.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></code>
|
|
Reference back to DataTable instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_DataTable.editTextarea">DataTable.editTextarea</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.editTextarea</strong>
|
|
(
|
|
|
|
|
|
oEditor
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables TEXTAREA Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oEditor <Object></code>
|
|
Object literal representation of Editor values.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></code>
|
|
Reference back to DataTable instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_DataTable.editTextbox">DataTable.editTextbox</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.editTextbox</strong>
|
|
(
|
|
|
|
|
|
oEditor
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables INPUT TYPE=TEXT Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oEditor <Object></code>
|
|
Object literal representation of Editor values.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></code>
|
|
Reference back to DataTable instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object | Boolean></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <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></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Number></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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.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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement></code>
|
|
The element to format with markup.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oData <Object></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.formatTheadCell">DataTable.formatTheadCell</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.formatTheadCell</strong>
|
|
(
|
|
|
|
|
|
elCellLabel
|
|
|
|
|
|
,
|
|
oColumn
|
|
|
|
|
|
,
|
|
oSelf
|
|
|
|
|
|
)
|
|
</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 <HTMLElement></code>
|
|
The label DIV element within the TH liner.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oSelf <DT></code>
|
|
DataTable instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_DataTable.handleDataSourcePagination">DataTable.handleDataSourcePagination</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.handleDataSourcePagination</strong>
|
|
(
|
|
|
|
|
|
the
|
|
|
|
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles Pag changeRequest events for dynamic DataSources
|
|
such as DataSource.TYPE_XHR or DataSource.TYPE_JSFUNCTION.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>the <object></code>
|
|
requested state of the pagination
|
|
</dd>
|
|
<dd>
|
|
<code>the <DataTable></code>
|
|
DataTable instance
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_DataTable.handleSimplePagination">DataTable.handleSimplePagination</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
void
|
|
<strong>DataTable.handleSimplePagination</strong>
|
|
(
|
|
|
|
|
|
the
|
|
|
|
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles Pag changeRequest events for static DataSources
|
|
(i.e. DataSources that return all data immediately)
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>the <object></code>
|
|
requested state of the pagination
|
|
</dd>
|
|
<dd>
|
|
<code>the <DataTable></code>
|
|
DataTable instance
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</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 Editor input value to type Number, doing type conversion as
|
|
necessary. A valid Number value is return, else the previous value is returned
|
|
if input value does not validate.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oData <Object></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 <HTMLElement | String | Number></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 <HTMLElement | String | Number></code>
|
|
DOM element reference or ID string
|
|
to DataTable page element or RecordSet index.
|
|
</dd>
|
|
<dd>
|
|
<code>count <Number></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_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 <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></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_doBeforeShowCellEditor">doBeforeShowCellEditor</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>doBeforeShowCellEditor</strong>
|
|
(
|
|
|
|
|
|
oCellEditor
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Overridable abstract method to customize Cell Editor UI.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oCellEditor <Object></code>
|
|
Cell Editor object literal.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></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 <HTMLElement></code>
|
|
The liner DIV element within the TD.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
(Optional) Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></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_formatPaginatorDropdown">formatPaginatorDropdown</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>formatPaginatorDropdown</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 Paginator class APIs.
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_formatPaginatorLinks">formatPaginatorLinks</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>formatPaginatorLinks</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 Paginator class APIs.
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_formatPaginators">formatPaginators</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>formatPaginators</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 Paginator class APIs.
|
|
</div>
|
|
</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 <HTMLElement | String | Object} DOM element reference or string ID, or
|
|
object literal of syntax {record:oRecord, column:oColumn></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 <HTMLElement | String | Object} DOM element reference or string ID, or
|
|
object literal of syntax {record:oRecord, column:oColumn></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_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="">
|
|
<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>
|
|
|
|
|
|
|
|
Object
|
|
<strong>getCellEditor</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns the DataTable instance's Cell Editor as an object literal with the
|
|
following properties:
|
|
<dl>
|
|
<dt>cell</dt>
|
|
<dd>{HTMLElement} Cell element being edited.</dd>
|
|
<dt>column</dt>
|
|
<dd>{YAHOO.widget.Column} Associated Column instance.</dd>
|
|
<dt>container</dt>
|
|
<dd>{HTMLElement} Reference to editor's container DIV element.</dd>
|
|
<dt>isActive</dt>
|
|
<dd>{Boolean} True if cell is currently being edited.</dd>
|
|
<dt>record</dt>
|
|
<dd>{YAHOO.widget.Record} Associated Record instance.</dd>
|
|
<dt>validator</dt>
|
|
<dd>{HTMLFunction} Associated validator function called before new data is stored. Called
|
|
within the scope of the DataTable instance, the function receieves the
|
|
following arguments:
|
|
<dl>
|
|
<dt>oNewData</dt>
|
|
<dd>{Object} New data to validate.</dd>
|
|
<dt>oOldData</dt>
|
|
<dd>{Object} Original data in case of reversion.</dd>
|
|
<dt>oCellEditor</dt>
|
|
<dd>{Object} Object literal representation of Editor values.</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt>defaultValue</dt>
|
|
<dd>Dynamically settable default value</dd>
|
|
</dl>
|
|
<dt>value</dt>
|
|
<dd>Current input value</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Object
|
|
</code></dt>
|
|
<dd>Cell Editor object literal values.</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 <HTMLElement | String | Number></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>
|
|
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 <String></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
|
|
|
|
|
|
)
|
|
</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 <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>DataTable.widget.CLASS_ASC or DataTable.widget.CLASS_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 <HTMLElement></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, columnId:sColumnId}.
|
|
</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 <HTMLElement | String | Object} DOM element reference or string ID, or
|
|
object literal of syntax {record:oRecord, column:oColumn></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 <HTMLElement | String | Number | YAHOO.widget.Record></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 <HTMLElement | String | Object} DOM element reference or string ID, or
|
|
object literal of syntax {record:oRecord, column:oColumn></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 <HTMLElement | String | Number | YAHOO.widget.Record></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 <HTMLElement | Number | String></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 <YAHOO.widget.Record | HTMLElement | Number></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="">
|
|
<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, columnId:sColumnId}.
|
|
</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_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 <HTMLElement | String | Object} DOM element reference or string ID, or
|
|
object literal of syntax {record:oRecord, column:oColumn></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 <HTMLElement | String | Object} DOM element reference or string ID, or
|
|
object literal of syntax {record:oRecord, column:oColumn></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 <YAHOO.widget.Column | HTMLElement | String></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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>theadCell <YAHOO.widget.Column | HTMLElement | String></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 <HTMLElement | String | Number | YAHOO.widget.Record></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 <HTMLElement | String | YAHOO.widget.Record | Number></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_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 <YAHOO.widget.Column></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 DT.CLASS_HIGHLIGHTED to the given cell.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>cell <HTMLElement | String></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 DT.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 <HTMLElement | String | Number></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 DT.CLASS_HIGHLIGHTED to the given row.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>row <HTMLElement | String></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 <Object></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. The render method should be called as a separate step in order
|
|
to update the 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_insertColumn">insertColumn</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<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 <Object | YAHOO.widget.Column></code>
|
|
Object literal Column
|
|
definition or a Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>index <Number></code>
|
|
(optional) Column key index.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></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 <String | HTMLElement | YAHOO.widget.Record | Number
|
|
{record:YAHOO.widget.Record, column:YAHOO.widget.Column} ></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 <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></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 <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></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. If applicable,
|
|
creates or updates corresponding TR elements.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>sRequest <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></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_onDataReturnReplaceRows">onDataReturnReplaceRows</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>onDataReturnReplaceRows</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 onDataReturnInitializeTable.
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<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">
|
|
Receives reponse from DataSource and populates the RecordSet with the
|
|
results.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oRequest <MIXED></code>
|
|
Original generated request.
|
|
</dd>
|
|
<dd>
|
|
<code>oResponse <Object></code>
|
|
Response object.
|
|
</dd>
|
|
<dd>
|
|
<code>oPayload <MIXED></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_onEventCancelCellEditor">onEventCancelCellEditor</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>onEventCancelCellEditor</strong>
|
|
(
|
|
|
|
|
|
oArgs.editor
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Overridable custom event handler to cancel Cell Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
Cell Editor object literal.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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>
|
|
(
|
|
|
|
|
|
oArgs.editor
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Overridable custom event handler to save Cell Editor input.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
Cell Editor object literal.
|
|
</dd>
|
|
</dl>
|
|
|
|
<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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
Event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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_onPaginatorChange">onPaginatorChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>onPaginatorChange</strong>
|
|
(
|
|
|
|
|
|
an
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Delegates the Pag changeRequest events to the configured
|
|
handler.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>an <Object></code>
|
|
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_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 <YAHOO.widget.Column></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_resetCellEditor">resetCellEditor</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>resetCellEditor</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Clears Cell Editor of all state 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_saveCellEditor">saveCellEditor</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>saveCellEditor</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Saves Cell Editor input to Record.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<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 <HTMLElement | String></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 <HTMLElement | String | Number></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 <HTMLElement | String | YAHOO.widget.Record | Number></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 <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>nWidth <Number></code>
|
|
New width in pixels.
|
|
</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
|
|
|
|
|
|
,
|
|
oRecord
|
|
|
|
|
|
,
|
|
oColumn
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Shows Cell Editor for given cell.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elCell <HTMLElement | String></code>
|
|
Cell to edit.
|
|
</dd>
|
|
<dd>
|
|
<code>oRecord <YAHOO.widget.Record></code>
|
|
(Optional) Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></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_showCellEditorBtns">showCellEditorBtns</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>showCellEditorBtns</strong>
|
|
(
|
|
|
|
|
|
elContainer
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Adds Save/Cancel buttons to Cell Editor.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>elContainer <HTMLElement></code>
|
|
Cell Editor container.
|
|
</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 <YAHOO.widget.Column></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_showPage">showPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>showPage</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 Paginator class APIs.
|
|
</div>
|
|
</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 <String></code>
|
|
(optional) Value for innerHTMlang.
|
|
</dd>
|
|
<dd>
|
|
<code>sClassName <String></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.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oColumn <YAHOO.widget.Column></code>
|
|
Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>sDir <String></code>
|
|
(Optional) DT.CLASS_ASC or
|
|
DT.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_unhighlightCell">unhighlightCell</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>unhighlightCell</strong>
|
|
(
|
|
|
|
|
|
cell
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Removes the class DT.CLASS_HIGHLIGHTED from the given cell.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>cell <HTMLElement | String></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 DT.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 <HTMLElement | String | Number></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 DT.CLASS_HIGHLIGHTED from the given row.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>row <HTMLElement | String></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 <HTMLElement | String></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 <HTMLElement | String | Number></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 <HTMLElement | String | YAHOO.widget.Record | Number></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_updatePaginator">updatePaginator</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>updatePaginator</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 Paginator class APIs.
|
|
</div>
|
|
</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 <YAHOO.widget.Record | Number | HTMLElement | String></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 <Object></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>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
|
|
</code>
|
|
</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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeHeightChange">beforeHeightChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeHeightChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'height' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforePaginatedChange">beforePaginatedChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforePaginatedChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'paginated' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforePaginationEventHandlerChange">beforePaginationEventHandlerChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforePaginationEventHandlerChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'paginationEventHandler' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeScrollableChange">beforeScrollableChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeScrollableChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'scrollable' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</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>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeWidthChange">beforeWidthChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeWidthChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'width' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current 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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'caption' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLElement></code>
|
|
The formatted TD element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></code>
|
|
The associated Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.column <YAHOO.widget.Column></code>
|
|
The associated Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.key <String></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 <HTMLElement></code>
|
|
The highlighted TD element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></code>
|
|
The associated Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.column <YAHOO.widget.Column></code>
|
|
The associated Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.key <String></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLElement></code>
|
|
The selected TD element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></code>
|
|
The associated Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.column <YAHOO.widget.Column></code>
|
|
The associated Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.key <String></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 <HTMLElement></code>
|
|
The unhighlighted TD element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></code>
|
|
The associated Record instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.column <YAHOO.widget.Column></code>
|
|
The associated Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.key <String></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 <HTMLElement></code>
|
|
The unselected TD element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></code>
|
|
The associated Record.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.column <YAHOO.widget.Column></code>
|
|
The associated Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.key <String></code>
|
|
(deprecated) The key of the unselected cell.
|
|
</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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <YAHOO.widget.Column></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 <YAHOO.widget.Column></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 <YAHOO.widget.Column></code>
|
|
The Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.index <Number></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 <YAHOO.widget.Column></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>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when a ColumnSet is re-initialized due to a Column being drag-reordered.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</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 <YAHOO.widget.Column></code>
|
|
The Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></code>
|
|
The TH element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.width <Number></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 <YAHOO.widget.Column></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 <YAHOO.widget.Column></code>
|
|
The Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.width <Number></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 <YAHOO.widget.Column></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 <YAHOO.widget.Column></code>
|
|
The Column instance.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.dir <String></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 <YAHOO.widget.Column></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 <YAHOO.widget.Column></code>
|
|
The Column instance.
|
|
</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 <String></code>
|
|
Original request.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.response <Object></code>
|
|
Response object.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_draggableColumnsChange">draggableColumnsChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>draggableColumnsChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'draggableColumns' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</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 an active Editor has a blur.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
The Editor object literal.
|
|
</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 Editor input is canceled.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
The Editor object literal.
|
|
</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 an active Editor has a keydown.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
The Editor object literal.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.event <HTMLEvent></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 Editor input is reverted.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
The Editor object literal.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.newData <Object></code>
|
|
New data value from form input field.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.oldData <Object></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 Editor input is saved.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
The Editor object literal.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.newData <Object></code>
|
|
New data value from form input field.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.oldData <Object></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 an Editor is activated.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.editor <Object></code>
|
|
The Editor object literal.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_generateRequestChange">generateRequestChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>generateRequestChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'generateRequest' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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="">
|
|
<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_heightChange">heightChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>heightChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'height' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</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 instance's initialization is complete.
|
|
</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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'initialLoad' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'initialRequest' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></code>
|
|
The A element.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_paginatedChange">paginatedChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>paginatedChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'paginated' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_paginationEventHandlerChange">paginationEventHandlerChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>paginationEventHandlerChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'paginationEventHandler' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'paginator' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 view is rendered.
|
|
</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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'renderLoopSize' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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 <YAHOO.widget.Record></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <Object></code>
|
|
Object literal of the deleted data.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.recordIndex <Number></code>
|
|
Index of the deleted Record.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.trElIndex <Number></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 <HTMLElement></code>
|
|
The highlighted TR element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <YAHOO.widget.Record[]></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 <Object[]></code>
|
|
Array of object literals of the deleted data.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.recordIndex <Number></code>
|
|
Index of the first deleted Record.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.count <Number></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 <HTMLElement></code>
|
|
The selected TR element, if applicable.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></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 <HTMLElement></code>
|
|
The highlighted TR element.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></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 <HTMLElement></code>
|
|
The unselected TR element, if applicable.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.record <YAHOO.widget.Record></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 <YAHOO.widget.Record></code>
|
|
The updated Record.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.oldData <Object></code>
|
|
Object literal of the old data.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_scrollableChange">scrollableChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>scrollableChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'scrollable' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_selectionModeChange">selectionModeChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>selectionModeChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'selectionMode' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'sortedBy' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'summary' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <String></code>
|
|
The HTML displayed.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.className <String></code>
|
|
The className assigned.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_tableScrollEvent">tableScrollEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>tableScrollEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
oArgs.event
|
|
|
|
|
|
,
|
|
oArgs.target
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fired when a fixed scrolling DataTable has a scroll.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oArgs.event <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></code>
|
|
The DataTable's CONTAINER element (in IE)
|
|
or the DataTable's TBODY element (everyone else).
|
|
</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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></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 <HTMLEvent></code>
|
|
The event object.
|
|
</dd>
|
|
<dd>
|
|
<code>oArgs.target <HTMLElement></code>
|
|
The TR element.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</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 class="">
|
|
<h4>
|
|
<a name="event_widthChange">widthChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>widthChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'width' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</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.
|
|
</div>
|
|
</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_generateRequest">generateRequest</a>
|
|
<code>- function</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
A function used to translate proposed DataTable state info
|
|
into a value which is then passed to the DataSource's sendRequest method.
|
|
This function is called to get the DataTable's initial data as well as
|
|
any data changes or requests such as pagination or sorting. The method
|
|
is passed two params, an object literal with the state data and a
|
|
reference to the DataTable.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: DT._generateRequest
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_height">height</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Table height for scrollable tables
|
|
</div>
|
|
</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_paginated">paginated</a>
|
|
<code>- object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated</strong> No longer used, as long as "paginator" value is an instance of
|
|
Paginator class.
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_paginationEventHandler">paginationEventHandler</a>
|
|
<code>- {function|Object}</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
For use with Pag pagination. A
|
|
handler function that receives the requestChange event from the
|
|
configured paginator. The handler method will be passed these
|
|
parameters:
|
|
<ol>
|
|
<li>oState {Object} - an object literal describing the requested
|
|
pagination state</li>
|
|
<li>oSelf {DataTable} - The DataTable instance.</li>
|
|
</ol>
|
|
For pagination through dynamic or server side data, assign
|
|
DT.handleDataSourcePagination or your own custom
|
|
handler.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: DT.handleSimplePagination
|
|
</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">
|
|
Stores an instance of Pag, or (for
|
|
backward compatibility), an object literal of pagination values in the
|
|
following form:<br>
|
|
{ containers:[], // UI container elements <br>
|
|
rowsPerPage:500, // 500 rows <br>
|
|
currentPage:1, // page one <br>
|
|
pageLinks:0, // show all links <br>
|
|
pageLinksStart:1, // first link is page 1 <br>
|
|
dropdownOptions:null, // no dropdown <br>
|
|
links: [], // links elements <br>
|
|
dropdowns: [] } //dropdown elements
|
|
</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_scrollable">scrollable</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
True if primary TBODY should scroll.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</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 DT.CLASS_ASC or DT.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>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_width">width</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Table width for scrollable tables
|
|
</div>
|
|
</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_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_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.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.Paginator.html">YAHOO.widget.Paginator</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.CurrentPageReport.html">YAHOO.widget.Paginator.ui.CurrentPageReport</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.FirstPageLink.html">YAHOO.widget.Paginator.ui.FirstPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.LastPageLink.html">YAHOO.widget.Paginator.ui.LastPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.NextPageLink.html">YAHOO.widget.Paginator.ui.NextPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.PageLinks.html">YAHOO.widget.Paginator.ui.PageLinks</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.PreviousPageLink.html">YAHOO.widget.Paginator.ui.PreviousPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.RowsPerPageDropdown.html">YAHOO.widget.Paginator.ui.RowsPerPageDropdown</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>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<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="Paginator.js.html">Paginator.js</a></li>
|
|
<li class=""><a href="RecordSet.js.html">RecordSet.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class="private"><a href="#property__aFallbackColResizer">_aFallbackColResizer</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__aSelections">_aSelections</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__bInit">_bInit</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__bScrollbarX">_bScrollbarX</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elCaption">_elCaption</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elContainer">_elContainer</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elMsgTbody">_elMsgTbody</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elMsgTbodyCell">_elMsgTbodyCell</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elMsgTbodyRow">_elMsgTbodyRow</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elTbody">_elTbody</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elTbodyContainer">_elTbodyContainer</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elThead">_elThead</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__elTheadContainer">_elTheadContainer</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nIndex">_nIndex</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nTdCount">_nTdCount</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__nTrCount">_nTrCount</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oAnchorCell">_oAnchorCell</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oAnchorRecord">_oAnchorRecord</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oChainRender">_oChainRender</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oChainSync">_oChainSync</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oColumnSet">_oColumnSet</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oDataSource">_oDataSource</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__oRecordSet">_oRecordSet</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sFirstTrId">_sFirstTrId</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sId">_sId</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sLastHighlightedTdElId">_sLastHighlightedTdElId</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sLastHighlightedTrElId">_sLastHighlightedTrElId</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__sLastTrId">_sLastTrId</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__tdElTemplate">_tdElTemplate</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__trElTemplate">_trElTemplate</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DataTable._bStylesheetFallback">DataTable._bStylesheetFallback</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DataTable._elColumnDragTarget">DataTable._elColumnDragTarget</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DataTable._elColumnResizerProxy">DataTable._elColumnResizerProxy</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DataTable._elStylesheet">DataTable._elStylesheet</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DataTable._nCount">DataTable._nCount</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DataTable._nCurrentCount">DataTable._nCurrentCount</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DataTable._oStylesheetRules">DataTable._oStylesheetRules</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_ASC">DataTable.CLASS_ASC</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_BUTTON">DataTable.CLASS_BUTTON</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_CHECKBOX">DataTable.CLASS_CHECKBOX</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_COLTARGET">DataTable.CLASS_COLTARGET</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_DEFAULT">DataTable.CLASS_DEFAULT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_DESC">DataTable.CLASS_DESC</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_DISABLED">DataTable.CLASS_DISABLED</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_DRAGGABLE">DataTable.CLASS_DRAGGABLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_DROPDOWN">DataTable.CLASS_DROPDOWN</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_EDITABLE">DataTable.CLASS_EDITABLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_EDITOR">DataTable.CLASS_EDITOR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_EMPTY">DataTable.CLASS_EMPTY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_ERROR">DataTable.CLASS_ERROR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_EVEN">DataTable.CLASS_EVEN</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_FIRST">DataTable.CLASS_FIRST</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_HIDDEN">DataTable.CLASS_HIDDEN</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_HIGHLIGHTED">DataTable.CLASS_HIGHLIGHTED</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_LABEL">DataTable.CLASS_LABEL</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_LAST">DataTable.CLASS_LAST</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_LINER">DataTable.CLASS_LINER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_LOADING">DataTable.CLASS_LOADING</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_NEXT">DataTable.CLASS_NEXT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_ODD">DataTable.CLASS_ODD</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_PAGE">DataTable.CLASS_PAGE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_PAGINATOR">DataTable.CLASS_PAGINATOR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_PREVIOUS">DataTable.CLASS_PREVIOUS</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_RADIO">DataTable.CLASS_RADIO</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_RESIZEABLE">DataTable.CLASS_RESIZEABLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_RESIZER">DataTable.CLASS_RESIZER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_RESIZERPROXY">DataTable.CLASS_RESIZERPROXY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_SCROLLABLE">DataTable.CLASS_SCROLLABLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_SELECTED">DataTable.CLASS_SELECTED</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.CLASS_SORTABLE">DataTable.CLASS_SORTABLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.Formatter">DataTable.Formatter</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.MSG_EMPTY">DataTable.MSG_EMPTY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.MSG_ERROR">DataTable.MSG_ERROR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_DataTable.MSG_LOADING">DataTable.MSG_LOADING</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="private"><!--<code>HTMLElement</code>-->
|
|
<a href="#method__addTdEl">_addTdEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>HTMLElement</code>-->
|
|
<a href="#method__addTrEl">_addTrEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>HTMLElement</code>-->
|
|
<a href="#method__createTrEl">_createTrEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>Boolean</code>-->
|
|
<a href="#method__deleteTrEl">_deleteTrEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__focusEl">_focusEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__forceGeckoRedraw">_forceGeckoRedraw</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>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__handleDataReturnPayload">_handleDataReturnPayload</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__initCellEditorEl">_initCellEditorEl</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__initNodeTemplates">_initNodeTemplates</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__initRecordSet">_initRecordSet</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__initTableEl">_initTableEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__initTheadEls">_initTheadEls</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__initThEl">_initThEl</a>
|
|
</li>
|
|
<li class="private"><!--<code>object</code>-->
|
|
<a href="#method__mergeResponseMeta">_mergeResponseMeta</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onDocumentClick">_onDocumentClick</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onPaginatorDropdownChange">_onPaginatorDropdownChange</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onPaginatorLinkClick">_onPaginatorLinkClick</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__onScroll">_onScroll</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__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__setColumnWidth">_setColumnWidth</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__sync">_sync</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__syncColWidths">_syncColWidths</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__syncScrollPadding">_syncScrollPadding</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>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._generateRequest">DataTable._generateRequest</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=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.editCheckbox">DataTable.editCheckbox</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.editDate">DataTable.editDate</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.editDropdown">DataTable.editDropdown</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.editRadio">DataTable.editRadio</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.editTextarea">DataTable.editTextarea</a>
|
|
</li>
|
|
<li class=""><!--<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.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=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.formatTheadCell">DataTable.formatTheadCell</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.handleDataSourcePagination">DataTable.handleDataSourcePagination</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_DataTable.handleSimplePagination">DataTable.handleSimplePagination</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>Boolean</code>-->
|
|
<a href="#method_doBeforeLoadData">doBeforeLoadData</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_doBeforeShowCellEditor">doBeforeShowCellEditor</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>void</code>-->
|
|
<a href="#method_formatPaginatorDropdown">formatPaginatorDropdown</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_formatPaginatorLinks">formatPaginatorLinks</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_formatPaginators">formatPaginators</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=""><!--<code>void</code>-->
|
|
<a href="#method_getBody">getBody</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_getCell">getCell</a>
|
|
</li>
|
|
<li class=""><!--<code>Object</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=""><!--<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>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>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>void</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=""><!--<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_onEventCancelCellEditor">onEventCancelCellEditor</a>
|
|
</li>
|
|
<li class=""><!--<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=""><!--<code>void</code>-->
|
|
<a href="#method_onPaginatorChange">onPaginatorChange</a>
|
|
</li>
|
|
<li class=""><!--<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_resetCellEditor">resetCellEditor</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_saveCellEditor">saveCellEditor</a>
|
|
</li>
|
|
<li class=""><!--<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_showCellEditorBtns">showCellEditorBtns</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_showColumn">showColumn</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_showPage">showPage</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_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_updatePaginator">updatePaginator</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_updateRow">updateRow</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_beforeDraggableColumnsChange">beforeDraggableColumnsChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeGenerateRequestChange">beforeGenerateRequestChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeHeightChange">beforeHeightChange</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_beforePaginatedChange">beforePaginatedChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforePaginationEventHandlerChange">beforePaginationEventHandlerChange</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_beforeScrollableChange">beforeScrollableChange</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_beforeWidthChange">beforeWidthChange</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_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_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_dataReturnEvent">dataReturnEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_draggableColumnsChange">draggableColumnsChange</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_generateRequestChange">generateRequestChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerCellClickEvent">headerCellClickEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerCellDblclickEvent">headerCellDblclickEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerCellMousedownEvent">headerCellMousedownEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerCellMouseoutEvent">headerCellMouseoutEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerCellMouseoverEvent">headerCellMouseoverEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerLabelClickEvent">headerLabelClickEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerLabelDbllickEvent">headerLabelDbllickEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerLabelMousedownEvent">headerLabelMousedownEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerLabelMouseoutEvent">headerLabelMouseoutEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerLabelMouseoverEvent">headerLabelMouseoverEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerRowClickEvent">headerRowClickEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerRowDblclickEvent">headerRowDblclickEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerRowMousedownEvent">headerRowMousedownEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerRowMouseoutEvent">headerRowMouseoutEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_headerRowMouseoverEvent">headerRowMouseoverEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_heightChange">heightChange</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_paginatedChange">paginatedChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_paginationEventHandlerChange">paginationEventHandlerChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_paginatorChange">paginatorChange</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_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_scrollableChange">scrollableChange</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_tableMsgHideEvent">tableMsgHideEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_tableMsgShowEvent">tableMsgShowEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_tableScrollEvent">tableScrollEvent</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_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_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_unselectAllCellsEvent">unselectAllCellsEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_unselectAllRowsEvent">unselectAllRowsEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_widthChange">widthChange</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_draggableColumns">draggableColumns</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_generateRequest">generateRequest</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_height">height</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_paginated">paginated</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_paginationEventHandler">paginationEventHandler</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_scrollable">scrollable</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>
|
|
<li class="">
|
|
<a href="#config_width">width</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2007 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|