oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui/docs/DataTable.html
JT Smith 547ced6500 upgraded yui to 2.2.2 and yui-ext to 1.0.1a
2007-07-05 04:23:55 +00:00

7904 lines
392 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: datatable DataTable (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1>Yahoo! UI Library</h1>
<h3>DataTable Widget&nbsp; <span class="subtitle">2.2.2</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_datatable.html">datatable</a>
&gt; DataTable
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<h2>
Class <b>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><a name="constructor_detail">Constructor</a></h3>
<div class="content">
<div class="detail">
<strong>DataTable</strong>
<code>
(
elContainer
,
oColumnSet
,
oDataSource
,
oConfigs
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elContainer
&lt;HTMLElement&gt;
</code>
Container element for the TABLE.
</dd>
<dd>
<code>oColumnSet
&lt;YAHOO.widget.ColumnSet&gt;
</code>
ColumnSet instance.
</dd>
<dd>
<code>oDataSource
&lt;YAHOO.util.DataSource&gt;
</code>
DataSource instance.
</dd>
<dd>
<code>oConfigs
&lt;object&gt;
</code>
(optional) Object literal of configuration values.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3><a name="field_detail">Properties</a></h3>
<div class="content">
<h4><a name="_aSelectedRecords">_aSelectedRecords</a>
<code>- private YAHOO.widget.Record[]</code>
</h4>
<div class="detail">
<div class="description">
Array of Records that are in the selected state.
</div>
</div>
<hr />
<h4><a name="_bFocused">_bFocused</a>
<code>- private Boolean</code>
</h4>
<div class="detail">
<div class="description">
Internal variable to track whether widget has focus.
</div>
</div>
<hr />
<h4><a name="_elBody">_elBody</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
TBODY element reference.
</div>
</div>
<hr />
<h4><a name="_elContainer">_elContainer</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Container element reference. Is null unless the TABLE is built from scratch into the
provided container.
</div>
</div>
<hr />
<h4><a name="_elFirstRow">_elFirstRow</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
First TR element reference pointer.
</div>
</div>
<hr />
<h4><a name="_elLastRow">_elLastRow</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Last TR element reference pointer.
</div>
</div>
<hr />
<h4><a name="_elTable">_elTable</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
TABLE element reference.
</div>
</div>
<hr />
<h4><a name="_nCount">_nCount</a>
<code>- private static Number</code>
</h4>
<div class="detail">
<div class="description">
Internal class variable to index multiple DataTable instances.
</div>
</div>
<hr />
<h4><a name="_nIndex">_nIndex</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Instance index.
</div>
</div>
<hr />
<h4><a name="_oColumnSet">_oColumnSet</a>
<code>- private YAHOO.widget.ColumnSet</code>
</h4>
<div class="detail">
<div class="description">
ColumnSet instance.
</div>
</div>
<hr />
<h4><a name="_oRecordSet">_oRecordSet</a>
<code>- private YAHOO.widget.RecordSet</code>
</h4>
<div class="detail">
<div class="description">
RecordSet instance.
</div>
</div>
<hr />
<h4><a name="_paginator">_paginator</a>
<code>- private Object[]</code>
</h4>
<div class="detail">
<div class="description">
Internal object literal to track built-in paginator values.
</div>
</div>
<hr />
<h4><a name="_paginator.containers">_paginator.containers</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Array of pagination container elements.
</div>
</div>
<hr />
<h4><a name="_paginator.currentPage">_paginator.currentPage</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Tracks current page.
</div>
</div>
<hr />
<h4><a name="_paginator.dropdownOptions">_paginator.dropdownOptions</a>
<code>- private Number[] | Object[]</code>
</h4>
<div class="detail">
<div class="description">
Internal variable to track paginator dropdown options.
</div>
</div>
<hr />
<h4><a name="_paginator.dropdowns">_paginator.dropdowns</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Array of pagination SELECT elements.
</div>
</div>
<hr />
<h4><a name="_paginator.links">_paginator.links</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Array of pagination link container elements.
</div>
</div>
<hr />
<h4><a name="_paginator.pageLinks">_paginator.pageLinks</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Internal variable to track paginator page links.
</div>
</div>
<hr />
<h4><a name="_paginator.rowsPerPage">_paginator.rowsPerPage</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Tracks rows per page.
</div>
</div>
<hr />
<h4><a name="_paginator.totalPages">_paginator.totalPages</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Tracks total number of pages, calculated on the fly.
</div>
</div>
<hr />
<h4><a name="_selectRowAnchorId">_selectRowAnchorId</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
Id of anchor row for multiple selections.
</div>
</div>
<hr />
<h4><a name="_sName">_sName</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
Unique instance name.
</div>
</div>
<hr />
<h4><a name="caption">caption</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Defines value of CAPTION attribute.
</div>
</div>
<hr />
<h4><a name="CLASS_BODY">CLASS_BODY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TBODY element that holds data rows.
</div>
</div>
<div class="default">
Default Value: "yui-dt-body"
</div>
<hr />
<h4><a name="CLASS_CHECKBOX">CLASS_CHECKBOX</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TD elements of type "checkbox".
</div>
</div>
<div class="default">
Default Value: "yui-dt-checkbox"
</div>
<hr />
<h4><a name="CLASS_CURRENCY">CLASS_CURRENCY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TD elements of type "currency".
</div>
</div>
<div class="default">
Default Value: "yui-dt-currency"
</div>
<hr />
<h4><a name="CLASS_CURRENTPAGE">CLASS_CURRENTPAGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to pagination links for specific page numbers that are disabled.
</div>
</div>
<div class="default">
Default Value: "yui-dt-currentpage"
</div>
<hr />
<h4><a name="CLASS_DATE">CLASS_DATE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TD elements of type "date".
</div>
</div>
<div class="default">
Default Value: "yui-dt-date"
</div>
<hr />
<h4><a name="CLASS_EDITABLE">CLASS_EDITABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to editable TD elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-editable"
</div>
<hr />
<h4><a name="CLASS_EDITOR">CLASS_EDITOR</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to editor DIV elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-editor"
</div>
<hr />
<h4><a name="CLASS_EMAIL">CLASS_EMAIL</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TD elements of type "email".
</div>
</div>
<div class="default">
Default Value: "yui-dt-email"
</div>
<hr />
<h4><a name="CLASS_EMPTY">CLASS_EMPTY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to empty elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-empty"
</div>
<hr />
<h4><a name="CLASS_ERROR">CLASS_ERROR</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to elements with error messaging.
</div>
</div>
<div class="default">
Default Value: "yui-dt-error"
</div>
<hr />
<h4><a name="CLASS_EVEN">CLASS_EVEN</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to even TR elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-even"
</div>
<hr />
<h4><a name="CLASS_FIRST">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 />
<h4><a name="CLASS_FIRSTLINK">CLASS_FIRSTLINK</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&lt;&lt;".
</div>
</div>
<div class="default">
Default Value: "yui-dt-firstlink"
</div>
<hr />
<h4><a name="CLASS_FIRSTPAGE">CLASS_FIRSTPAGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&lt;&lt;" when it is disabled.
</div>
</div>
<div class="default">
Default Value: "yui-dt-firstpage"
</div>
<hr />
<h4><a name="CLASS_HEADCONTAINER">CLASS_HEADCONTAINER</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to container element within THEAD.
</div>
</div>
<hr />
<h4><a name="CLASS_HEADRESIZER">CLASS_HEADRESIZER</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to resizer handle element within THEAD.
</div>
</div>
<div class="default">
Default Value: "yui-dt-headresizer"
</div>
<hr />
<h4><a name="CLASS_HEADTEXT">CLASS_HEADTEXT</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to text displayed within THEAD.
</div>
</div>
<div class="default">
Default Value: "yui-dt-headtext"
</div>
<hr />
<h4><a name="CLASS_HIGHLIGHT">CLASS_HIGHLIGHT</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to highlighted element.
</div>
</div>
<div class="default">
Default Value: "yui-dt-highlight"
</div>
<hr />
<h4><a name="CLASS_LAST">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 />
<h4><a name="CLASS_LASTLINK">CLASS_LASTLINK</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&gt;&gt;".
</div>
</div>
<div class="default">
Default Value: "yui-dt-lastlink"
</div>
<hr />
<h4><a name="CLASS_LASTPAGE">CLASS_LASTPAGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&gt;&gt;" when it is disabled.
</div>
</div>
<div class="default">
Default Value: "yui-dt-lastpage"
</div>
<hr />
<h4><a name="CLASS_LINK">CLASS_LINK</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TD elements of type "link".
</div>
</div>
<div class="default">
Default Value: "yui-dt-link"
</div>
<hr />
<h4><a name="CLASS_LOADING">CLASS_LOADING</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to loading message.
</div>
</div>
<div class="default">
Default Value: "yui-dt-loading"
</div>
<hr />
<h4><a name="CLASS_NEXTLINK">CLASS_NEXTLINK</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&gt;".
</div>
</div>
<div class="default">
Default Value: "yui-dt-nextlink"
</div>
<hr />
<h4><a name="CLASS_NEXTPAGE">CLASS_NEXTPAGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&gt;" when it is disabled.
</div>
</div>
<div class="default">
Default Value: "yui-dt-nextpage"
</div>
<hr />
<h4><a name="CLASS_NUMBER">CLASS_NUMBER</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TD elements of type "number".
</div>
</div>
<div class="default">
Default Value: "yui-dt-number"
</div>
<hr />
<h4><a name="CLASS_ODD">CLASS_ODD</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to odd TR elements.
</div>
</div>
<div class="default">
Default Value: "yui-dt-odd"
</div>
<hr />
<h4><a name="CLASS_PAGELINK">CLASS_PAGELINK</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to pagination links to specific page numbers.
</div>
</div>
<div class="default">
Default Value: "yui-dt-pagelink"
</div>
<hr />
<h4><a name="CLASS_PAGELINKS">CLASS_PAGELINKS</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination links container element.
</div>
</div>
<div class="default">
Default Value: "yui-dt-pagelinks"
</div>
<hr />
<h4><a name="CLASS_PAGESELECT">CLASS_PAGESELECT</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination SELECT element.
</div>
</div>
<div class="default">
Default Value: "yui-dt-pageselect"
</div>
<hr />
<h4><a name="CLASS_PAGINATOR">CLASS_PAGINATOR</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the paginator container element.
</div>
</div>
<div class="default">
Default Value: "yui-dt-paginator"
</div>
<hr />
<h4><a name="CLASS_PREVLINK">CLASS_PREVLINK</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&lt;".
</div>
</div>
<div class="default">
Default Value: "yui-dt-prevlink"
</div>
<hr />
<h4><a name="CLASS_PREVPAGE">CLASS_PREVPAGE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to the pagination link "&lt;" when it is disabled.
</div>
</div>
<div class="default">
Default Value: "yui-dt-prevpage"
</div>
<hr />
<h4><a name="CLASS_SCROLLABLE">CLASS_SCROLLABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to container of a scrollable DataTable.
</div>
</div>
<div class="default">
Default Value: "yui-dt-scrollable"
</div>
<hr />
<h4><a name="CLASS_SCROLLBODY">CLASS_SCROLLBODY</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to scrolling TBODY element of a scrollable DataTable.
</div>
</div>
<div class="default">
Default Value: "yui-dt-scrollbody"
</div>
<hr />
<h4><a name="CLASS_SELECTED">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 />
<h4><a name="CLASS_SORTABLE">CLASS_SORTABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to column headers of sortable Columns.
</div>
</div>
<div class="default">
Default Value: "yui-dt-sortable"
</div>
<hr />
<h4><a name="CLASS_SORTEDBYASC">CLASS_SORTEDBYASC</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to column headers when sorted in ascending order.
</div>
</div>
<div class="default">
Default Value: "yui-dt-sortedbyasc"
</div>
<hr />
<h4><a name="CLASS_SORTEDBYDESC">CLASS_SORTEDBYDESC</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to column headers when sorted in descending order.
</div>
</div>
<div class="default">
Default Value: "yui-dt-sortedbydesc"
</div>
<hr />
<h4><a name="CLASS_STRING">CLASS_STRING</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TD elements of type "string".
</div>
</div>
<div class="default">
Default Value: "yui-dt-string"
</div>
<hr />
<h4><a name="CLASS_TABLE">CLASS_TABLE</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Class name assigned to TABLE element.
</div>
</div>
<div class="default">
Default Value: "yui-dt"
</div>
<hr />
<h4><a name="contextMenu">contextMenu</a>
<code>- YAHOO.widget.ContextMenu</code>
</h4>
<div class="detail">
<div class="description">
ContextMenu instance.
</div>
</div>
<hr />
<h4><a name="dataSource">dataSource</a>
<code>- YAHOO.util.DataSource</code>
</h4>
<div class="detail">
<div class="description">
DataSource instance.
</div>
</div>
<hr />
<h4><a name="fixedWidth">fixedWidth</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if DataTable's width is a fixed size.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="initialRequest">initialRequest</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Initial request to send to DataSource.
</div>
</div>
<div class="default">
Default Value: ""
</div>
<hr />
<h4><a name="isEmpty">isEmpty</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>No longer used.
</div>
<hr />
<h4><a name="isLoading">isLoading</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>No longer used.
</div>
<hr />
<h4><a name="MSG_EMPTY">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 />
<h4><a name="MSG_ERROR">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 />
<h4><a name="MSG_LOADING">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 />
<h4><a name="pageCurrent">pageCurrent</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>Deprecated. Please use paginatorOptions.currentPage
</div>
<hr />
<h4><a name="pageLinksLength">pageLinksLength</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>Deprecated. Please use paginatorOptions.pageLinks
</div>
<hr />
<h4><a name="pageLinksStart">pageLinksStart</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>Deprecated. Please use paginatorOptions.pageLinksStart.
</div>
<hr />
<h4><a name="pagers">pagers</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>Deprecated. Please use paginatorOptions.containers
</div>
<hr />
<h4><a name="paginator">paginator</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if built-in paginator is enabled.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="paginatorOptions">paginatorOptions</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Object literal of initial paginator key:value properties.
</div>
</div>
<div class="default">
Default Value: {}
</div>
<hr />
<h4><a name="paginatorOptions.containers">paginatorOptions.containers</a>
<code>- HTMLElement[]</code>
</h4>
<div class="detail">
<div class="description">
Array of container elements to hold paginator UI, if enabled. If null,
2 containers will be created dynamically, one before and one after the
TABLE element.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
<h4><a name="paginatorOptions.currentPage">paginatorOptions.currentPage</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
If built-in paginator is enabled, current page to display.
</div>
</div>
<div class="default">
Default Value: 1
</div>
<hr />
<h4><a name="paginatorOptions.dropdownOptions">paginatorOptions.dropdownOptions</a>
<code>- Number[] | Object{}</code>
</h4>
<div class="detail">
<div class="description">
Values to show in the SELECT dropdown. Can be an array of numbers to populate
each OPTION's value and text with the same value, or an array of object
literals of syntax {value:myValue, text:myText} will populate OPTION with
corresponding value and text. A null value or empty array prevents the
dropdown from displayed altogether.
</div>
</div>
<hr />
<h4><a name="paginatorOptions.pageLinks">paginatorOptions.pageLinks</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Maximum number of links to page numbers to show in paginator UI. Any pages
not linked would be available through the next/previous style links. A 0
value displays all page links. A negative value disables all page links.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
<h4><a name="paginatorOptions.rowsPerPage">paginatorOptions.rowsPerPage</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
If built-in paginator is enabled, each page will display up to the given
number of rows per page. A value less than 1 will display all available
rows.
</div>
</div>
<div class="default">
Default Value: 500
</div>
<hr />
<h4><a name="rowSingleSelect">rowSingleSelect</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if only one row may be selected at a time.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="rowsPerPage">rowsPerPage</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>Deprecated. Please use paginatorOptions.rowsPerPage
</div>
<hr />
<h4><a name="rowsPerPageDropdown">rowsPerPageDropdown</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>Deprecated. Please use paginatorOptions.dropdownOptions
</div>
<hr />
<h4><a name="scrollable">scrollable</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
True if TBODY should scroll while THEAD remains fixed.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="sortedBy">sortedBy</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Object literal holds sort metadata:
sortedBy.colKey
sortedBy.dir
</div>
</div>
<hr />
<h4><a name="startRecordIndex">startRecordIndex</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
</div>
</div>
<div class="deprecated">
<strong>Deprecated: </strong>Deprecated. Please use paginatorOptions.startRecordIndex.
</div>
<hr />
<h4><a name="summary">summary</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Defines value of SUMMARY attribute.
</div>
</div>
<hr />
</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 href="YAHOO.util.EventProvider.html#__yui_events">__yui_events</a>,
<a href="YAHOO.util.EventProvider.html#__yui_subscribers">__yui_subscribers</a>
</code>
</div>
</div>
<div class="section method details">
<h3><a name="methodDetails">Methods</a></h3>
<div class="content">
<h4>
<a name="_addRecords">_addRecords</a></h4>
<div class="detail">
<code>
private
String
<strong>_addRecords</strong>
(
oData
,
index
)
</code>
<div class="description">
Creates a new Record to add to RecordSet at position i if given, or to the
end otherwise.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oData &lt;YAHOO.widget.Record&gt;</code>
Array of object literals containing data.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
Index position at which to add Record.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Array of Records.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_addRowEl">_addRowEl</a></h4>
<div class="detail">
<code>
private
String
<strong>_addRowEl</strong>
(
oRecord
,
index
)
</code>
<div class="description">
Add a new TR element to table body at position i if given, or to the bottom
otherwise. Populates cells with data from given Record.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
Index position at which to add TR.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>ID of the added TR element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_deleteRecord">_deleteRecord</a></h4>
<div class="detail">
<code>
private
void
<strong>_deleteRecord</strong>
(
identifier
)
</code>
<div class="description">
Deletes a given Record from the RecordSet.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>identifier &lt;Number | String&gt;</code>
Record identifier.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_deleteRowEl">_deleteRowEl</a></h4>
<div class="detail">
<code>
private
void
<strong>_deleteRowEl</strong>
(
row
)
</code>
<div class="description">
Deletes a given TR element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | Number&gt;</code>
HTML TR element reference or position index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_initHead">_initHead</a></h4>
<div class="detail">
<code>
private
void
<strong>_initHead</strong>
(
)
</code>
<div class="description">
Populates THEAD element with TH cells as defined by ColumnSet.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_initHeadCell">_initHeadCell</a></h4>
<div class="detail">
<code>
private
void
<strong>_initHeadCell</strong>
(
elHeadCell
,
oColumn
,
row
,
col
)
</code>
<div class="description">
Populates TH cell as defined by Column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elHeadCell &lt;HTMLElement&gt;</code>
TH cell element reference.
</dd>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column object.
</dd>
<dd>
<code>row &lt;number&gt;</code>
Row index.
</dd>
<dd>
<code>col &lt;number&gt;</code>
Column index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_initPaginator">_initPaginator</a></h4>
<div class="detail">
<code>
private
void
<strong>_initPaginator</strong>
(
)
</code>
<div class="description">
If pagination is enabled, initializes paginator container elements and sets
internal tracking variables.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_initTable">_initTable</a></h4>
<div class="detail">
<code>
private
void
<strong>_initTable</strong>
(
)
</code>
<div class="description">
Creates HTML markup for TABLE, THEAD, TBODY.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onBlur">_onBlur</a></h4>
<div class="detail">
<code>
private
void
<strong>_onBlur</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles blur events on the TABLE element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The blur event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onClick">_onClick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onClick</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles click events on the TABLE element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_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. Hides active editor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onDocumentKeydown">_onDocumentKeydown</a></h4>
<div class="detail">
<code>
private
void
<strong>_onDocumentKeydown</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles keydown events on the DOCUMENT. Executes interaction with editor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The key event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onDoubleclick">_onDoubleclick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onDoubleclick</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles doubleclick events on the TABLE element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The doubleclick event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onKeydown">_onKeydown</a></h4>
<div class="detail">
<code>
private
void
<strong>_onKeydown</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles keydown events on the TABLE. Executes arrow selection.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The key event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onKeypress">_onKeypress</a></h4>
<div class="detail">
<code>
private
void
<strong>_onKeypress</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles keypress events on the TABLE. Mainly to support stopEvent on Mac.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The key event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onKeyup">_onKeyup</a></h4>
<div class="detail">
<code>
private
void
<strong>_onKeyup</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles keyup events on the TABLE. Executes deletion
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The key event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMousedown">_onMousedown</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMousedown</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles mousedown events on the TABLE element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The mousedown event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMouseout">_onMouseout</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMouseout</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles mouseout events on the TABLE element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The mouseout event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMouseover">_onMouseover</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMouseover</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles mouseover events on the TABLE element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The mouseover event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onPagerClick">_onPagerClick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onPagerClick</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles click events on paginator links.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The click event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onPagerSelect">_onPagerSelect</a></h4>
<div class="detail">
<code>
private
void
<strong>_onPagerSelect</strong>
(
e
,
oSelf
)
</code>
<div class="description">
Handles change events on paginator SELECT.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;HTMLEvent&gt;</code>
The change event.
</dd>
<dd>
<code>oSelf &lt;YAHOO.widget.DataTable&gt;</code>
DataTable instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onRowDelete">_onRowDelete</a></h4>
<div class="detail">
<code>
private
void
<strong>_onRowDelete</strong>
(
oArgs.rowIndexes
)
</code>
<div class="description">
Handles row delete events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.rowIndexes &lt;Number[]&gt;</code>
The indexes of the deleted rows.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_select">_select</a></h4>
<div class="detail">
<code>
private
void
<strong>_select</strong>
(
els
)
</code>
<div class="description">
Sets elements to selected state. Does not fire any events. Does not affect
internal tracker.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>els &lt;HTMLElement | String | HTMLElement[] | String[]&gt;</code>
HTML element by
reference or ID string, or array of HTML elements by reference or ID string.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_setFirstRow">_setFirstRow</a></h4>
<div class="detail">
<code>
private
void
<strong>_setFirstRow</strong>
(
)
</code>
<div class="description">
Sets first row with class YAHOO.widget.DataTable.CLASS_FIRST.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_setLastRow">_setLastRow</a></h4>
<div class="detail">
<code>
private
void
<strong>_setLastRow</strong>
(
)
</code>
<div class="description">
Sets last row with class YAHOO.widget.DataTable.CLASS_LAST.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_setRowStripes">_setRowStripes</a></h4>
<div class="detail">
<code>
private
void
<strong>_setRowStripes</strong>
(
range
)
</code>
<div class="description">
Stripes rows by applying class YAHOO.widget.DataTable.CLASS_EVEN or
YAHOO.widget.DataTable.CLASS_ODD.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>range &lt;Number&gt;</code>
(optional) Range defines a subset of rows to stripe.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_unselect">_unselect</a></h4>
<div class="detail">
<code>
private
void
<strong>_unselect</strong>
(
els
)
</code>
<div class="description">
Sets elements to the unselected state. Does not fire any events. Does not
affect internal tracker.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>els &lt;HTMLElement | String | HTMLElement[] | String[]&gt;</code>
HTMLElement by
reference or ID string, or array of HTML elements by reference or ID string.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_unselectAllCells">_unselectAllCells</a></h4>
<div class="detail">
<code>
private
void
<strong>_unselectAllCells</strong>
(
)
</code>
<div class="description">
Unselects all selected cells.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_unselectAllRows">_unselectAllRows</a></h4>
<div class="detail">
<code>
private
void
<strong>_unselectAllRows</strong>
(
)
</code>
<div class="description">
Unselects all selected rows. Does not fire any events. Does not affect internal
tracker.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_updateRowEl">_updateRowEl</a></h4>
<div class="detail">
<code>
private
String
<strong>_updateRowEl</strong>
(
oRecord
,
index
)
</code>
<div class="description">
Updates all cells of existing TR element at given position with data from the
given Record.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
Position at which to update row.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>ID of the updated TR element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="addRow">addRow</a></h4>
<div class="detail">
<code>
void
<strong>addRow</strong>
(
oRecord
,
index
)
</code>
<div class="description">
Convenience method to add a new row to table body at position index if given,
or to the bottom otherwise.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
(optional) Position at which to add row.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="appendRows">appendRows</a></h4>
<div class="detail">
<code>
void
<strong>appendRows</strong>
(
aRecords
)
</code>
<div class="description">
Add rows to bottom of table body.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aRecords &lt;YAHOO.widget.Record[]&gt;</code>
Array of Records.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cancelEditorData">cancelEditorData</a></h4>
<div class="detail">
<code>
void
<strong>cancelEditorData</strong>
(
)
</code>
<div class="description">
Hides active editor, not saving any data.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="deleteRow">deleteRow</a></h4>
<div class="detail">
<code>
void
<strong>deleteRow</strong>
(
elRow
)
</code>
<div class="description">
Deletes a given row element as well its corresponding Record in the RecordSet.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elRow &lt;HTMLElement&gt;</code>
HTML table row element reference.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="deleteRows">deleteRows</a></h4>
<div class="detail">
<code>
void
<strong>deleteRows</strong>
(
elRows
)
</code>
<div class="description">
Calls delete on given rows.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elRows &lt;HTMLElement[]&gt;</code>
Array of HTML table row element reference.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="doBeforeLoadData">doBeforeLoadData</a></h4>
<div class="detail">
<code>
Boolean
<strong>doBeforeLoadData</strong>
(
sRequest
,
oResponse
)
</code>
<div class="description">
Overridable method gives implementers a hook to access data before
it gets added to RecordSet and rendered to the TBODY.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
</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 />
<h4>
<a name="editCell">editCell</a></h4>
<div class="detail">
<code>
void
<strong>editCell</strong>
(
elCell
)
</code>
<div class="description">
Shows editor for given cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elCell &lt;HTMLElement&gt;</code>
Cell element to edit.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="focusTable">focusTable</a></h4>
<div class="detail">
<code>
void
<strong>focusTable</strong>
(
)
</code>
<div class="description">
Sets focus on the TABLE element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="formatCell">formatCell</a></h4>
<div class="detail">
<code>
void
<strong>formatCell</strong>
(
elCell
)
</code>
<div class="description">
Formats given cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>elCell &lt;HTMLElement&gt;</code>
Cell element to format.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="formatPaginatorDropdown">formatPaginatorDropdown</a></h4>
<div class="detail">
<code>
void
<strong>formatPaginatorDropdown</strong>
(
oElReferences
)
</code>
<div class="description">
Updates Paginator dropdown. If dropdown doesn't exist, the markup is created.
Sets dropdown's "selected" value.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oElReferences &lt;Object&gt;</code>
Object literal of pointers to Paginator UI
elements.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="formatPaginatorLinks">formatPaginatorLinks</a></h4>
<div class="detail">
<code>
void
<strong>formatPaginatorLinks</strong>
(
)
</code>
<div class="description">
Updates Paginator links container with markup.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="formatPaginators">formatPaginators</a></h4>
<div class="detail">
<code>
void
<strong>formatPaginators</strong>
(
)
</code>
<div class="description">
Updates Paginator containers with markup. Override this method to customize pagination UI.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getBody">getBody</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getBody</strong>
(
)
</code>
<div class="description">
Returns element reference to TBODY.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TBODY element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getCell">getCell</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getCell</strong>
(
rowIndex
,
colIndex
)
</code>
<div class="description">
Returns element reference to TD element at given row and column positions.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>rowIndex &lt;Number&gt;</code>
Row index.
</dd>
<dd>
<code>colIndex &lt;Number&gt;</code>
Column index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TD element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getColumnSet">getColumnSet</a></h4>
<div class="detail">
<code>
YAHOO.widget.ColumnSet
<strong>getColumnSet</strong>
(
)
</code>
<div class="description">
Returns pointer to 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 />
<h4>
<a name="getFirstRow">getFirstRow</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getFirstRow</strong>
(
)
</code>
<div class="description">
Returns element reference to first TR element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to first TR element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getHead">getHead</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getHead</strong>
(
)
</code>
<div class="description">
Returns element reference to THEAD.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to THEAD element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getLastRow">getLastRow</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getLastRow</strong>
(
)
</code>
<div class="description">
Returns element reference to last TR element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to last TR element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getPaginator">getPaginator</a></h4>
<div class="detail">
<code>
Object
<strong>getPaginator</strong>
(
)
</code>
<div class="description">
Returns paginator object literal.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object
</code></dt>
<dd>Paginator object literal with following properties:
<ul>
<li>currentPage: current page number</li>
<li>dropdownOptions: array of numbers to show in dropdown</li>
<li>elements: array of object literals that define where to show
paginator UI with following properties:
<ul>
<li>container: element reference to paginator container</li>
<li>links: element reference to page links container</li>
<li>select: element reference to dropdown</li>
</ul>
</li>
<li>pageLinks: number of page links displayed</li>
<li>pageLinkStart: page number of first link</li>
<li>rowsPerPage: number of rows displayed</li>
<li>totalPages: total number of pages</li>
</ul></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getRecordSet">getRecordSet</a></h4>
<div class="detail">
<code>
YAHOO.widget.RecordSet
<strong>getRecordSet</strong>
(
)
</code>
<div class="description">
Returns pointer to 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 />
<h4>
<a name="getRow">getRow</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getRow</strong>
(
index
)
</code>
<div class="description">
Returns element reference to TR element at given index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>index &lt;Number&gt;</code>
Row number.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TR element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getSelectedCells">getSelectedCells</a></h4>
<div class="detail">
<code>
HTMLElement[]
<strong>getSelectedCells</strong>
(
)
</code>
<div class="description">
Returns array of selected TD cells.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement[]
</code></dt>
<dd>Array of selected TD elements.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getSelectedRecordIds">getSelectedRecordIds</a></h4>
<div class="detail">
<code>
HTMLElement[]
<strong>getSelectedRecordIds</strong>
(
)
</code>
<div class="description">
Returns array of selected Record IDs.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement[]
</code></dt>
<dd>Array of selected TR elements.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getSelectedRows">getSelectedRows</a></h4>
<div class="detail">
<code>
HTMLElement[]
<strong>getSelectedRows</strong>
(
)
</code>
<div class="description">
Returns array of selected rows.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement[]
</code></dt>
<dd>Array of selected TR elements.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getTable">getTable</a></h4>
<div class="detail">
<code>
HTMLElement
<strong>getTable</strong>
(
)
</code>
<div class="description">
Returns element reference to TABLE.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd>Reference to TABLE element.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="hideTableMessage">hideTableMessage</a></h4>
<div class="detail">
<code>
void
<strong>hideTableMessage</strong>
(
)
</code>
<div class="description">
Hide placeholder message.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="hideTableMessages">hideTableMessages</a></h4>
<div class="detail">
<code>
void
<strong>hideTableMessages</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> Deprecated. Please use hideTableMessage().
</div>
</div>
</div>
<hr />
<h4>
<a name="highlight">highlight</a></h4>
<div class="detail">
<code>
void
<strong>highlight</strong>
(
els
)
</code>
<div class="description">
Sets one or more elements to the highlighted state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>els &lt;HTMLElement | String | HTMLElement[] | String[]&gt;</code>
HTML TR element
reference, TR String ID, array of HTML TR element, or array of TR element IDs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="insertRows">insertRows</a></h4>
<div class="detail">
<code>
void
<strong>insertRows</strong>
(
aRecords
)
</code>
<div class="description">
Add rows to top of table body.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aRecords &lt;YAHOO.widget.Record[]&gt;</code>
Array of Records.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="isSelected">isSelected</a></h4>
<div class="detail">
<code>
Boolean
<strong>isSelected</strong>
(
el
)
</code>
<div class="description">
Returns true if given element is select, false otherwise.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;HTMLElement&gt;</code>
HTML element reference or ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd>True if element is selected.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onDataReturnAppendRows">onDataReturnAppendRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnAppendRows</strong>
(
sRequest
,
oResponse
,
bError
)
</code>
<div class="description">
Add new data to end of table.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>bError &lt;Boolean&gt;</code>
(optional) True if there was a data error.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onDataReturnInsertRows">onDataReturnInsertRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnInsertRows</strong>
(
sRequest
,
oResponse
,
bError
)
</code>
<div class="description">
Handles data return for inserting new rows to top of table.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>bError &lt;Boolean&gt;</code>
(optional) True if there was a data error.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onDataReturnPaginateRows">onDataReturnPaginateRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnPaginateRows</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> Deprecated. Please use onDataReturnPopulateTable().
</div>
</div>
</div>
<hr />
<h4>
<a name="onDataReturnPopulateTable">onDataReturnPopulateTable</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnPopulateTable</strong>
(
sRequest
,
oResponse
,
bError
)
</code>
<div class="description">
Calls populateTable() with new data.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>bError &lt;Boolean&gt;</code>
(optional) True if there was a data error.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onDataReturnReplaceRows">onDataReturnReplaceRows</a></h4>
<div class="detail">
<code>
void
<strong>onDataReturnReplaceRows</strong>
(
sRequest
,
oResponse
,
bError
)
</code>
<div class="description">
Handles data return for replacing all existing of table with new rows.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sRequest &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oResponse &lt;Object&gt;</code>
Response object.
</dd>
<dd>
<code>bError &lt;Boolean&gt;</code>
(optional) True if there was a data error.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onEventEditCell">onEventEditCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventEditCell</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to edit cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onEventFormatCell">onEventFormatCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventFormatCell</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to format cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="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.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onEventSelectCell">onEventSelectCell</a></h4>
<div class="detail">
<code>
void
<strong>onEventSelectCell</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to select cell.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="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 select row according to desktop paradigm.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onEventSortColumn">onEventSortColumn</a></h4>
<div class="detail">
<code>
void
<strong>onEventSortColumn</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Overridable custom event handler to sort column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="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.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
Event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
Target element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="populateTable">populateTable</a></h4>
<div class="detail">
<code>
void
<strong>populateTable</strong>
(
oData
)
</code>
<div class="description">
Replaces all Records in RecordSet and populates TBODY rows with the
new data. Blows away old data. If pagination is enabled, displays only
current page, otherwise displays all rows.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oData &lt;Object | Object[]&gt;</code>
An object literal of data or an array of
object literals containing data.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
<div class="deprecated">
<strong>Deprecated</strong> Deprecated in favor of populateTable().
</div>
</div>
</div>
<hr />
<h4>
<a name="refreshTable">refreshTable</a></h4>
<div class="detail">
<code>
void
<strong>refreshTable</strong>
(
)
</code>
<div class="description">
Refreshes table view into existing RecordSet. For performance, reuses
existing rows while deleting extraneous rows.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="saveEditorData">saveEditorData</a></h4>
<div class="detail">
<code>
void
<strong>saveEditorData</strong>
(
)
</code>
<div class="description">
Saves data in active editor.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="select">select</a></h4>
<div class="detail">
<code>
void
<strong>select</strong>
(
els
)
</code>
<div class="description">
Sets one or more elements to the selected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>els &lt;HTMLElement | String | HTMLElement[] | String[]&gt;</code>
HTML TR element
reference, TR String ID, array of HTML TR element, or array of TR element IDs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="selectRow">selectRow</a></h4>
<div class="detail">
<code>
void
<strong>selectRow</strong>
(
row
)
</code>
<div class="description">
Sets a row to the selected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String&gt;</code>
HTML TR element reference or ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="showEmptyMessage">showEmptyMessage</a></h4>
<div class="detail">
<code>
void
<strong>showEmptyMessage</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> Deprecated. Please use showTableMessage().
</div>
</div>
</div>
<hr />
<h4>
<a name="showLoadingMessage">showLoadingMessage</a></h4>
<div class="detail">
<code>
void
<strong>showLoadingMessage</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> Deprecated. Please use showTableMessage().
</div>
</div>
</div>
<hr />
<h4>
<a name="showPage">showPage</a></h4>
<div class="detail">
<code>
void
<strong>showPage</strong>
(
nPage
)
</code>
<div class="description">
Displays a specific page of a paginated DataTable.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>nPage &lt;Number&gt;</code>
Which page.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="showTableMessage">showTableMessage</a></h4>
<div class="detail">
<code>
void
<strong>showTableMessage</strong>
(
sHTML
,
sClassName
)
</code>
<div class="description">
Displays placeholder row with a message when there are no data rows.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>sHTML &lt;String&gt;</code>
(optional) Value for innerHTML.
</dd>
<dd>
<code>sClassName &lt;String&gt;</code>
(optional) Classname.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="sortColumn">sortColumn</a></h4>
<div class="detail">
<code>
void
<strong>sortColumn</strong>
(
oColumn
)
</code>
<div class="description">
Sort given column.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oColumn &lt;YAHOO.widget.Column&gt;</code>
Column instance.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Public accessor to the unique name of the DataSource instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique name of the DataSource instance.</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="unhighlight">unhighlight</a></h4>
<div class="detail">
<code>
void
<strong>unhighlight</strong>
(
els
)
</code>
<div class="description">
Sets one or more elements to the unhighlighted state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>els &lt;HTMLElement | String | HTMLElement[] | String[]&gt;</code>
HTML TR element
reference, TR String ID, array of HTML TR element, or array of TR element IDs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="unselect">unselect</a></h4>
<div class="detail">
<code>
void
<strong>unselect</strong>
(
els
)
</code>
<div class="description">
Sets one or more elements to the unselected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>els &lt;HTMLElement | String | HTMLElement[] | String[]&gt;</code>
HTML element
reference, element ID, array of HTML elements, or array of element IDs
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="unselectAllCells">unselectAllCells</a></h4>
<div class="detail">
<code>
void
<strong>unselectAllCells</strong>
(
)
</code>
<div class="description">
Unselects all selected cells.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="unselectAllRows">unselectAllRows</a></h4>
<div class="detail">
<code>
void
<strong>unselectAllRows</strong>
(
)
</code>
<div class="description">
Unselects all selected rows (across all pages, if applicable).
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="unselectRow">unselectRow</a></h4>
<div class="detail">
<code>
void
<strong>unselectRow</strong>
(
row
)
</code>
<div class="description">
Sets a row to the unselected state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>row &lt;HTMLElement | String&gt;</code>
HTML TR element reference or ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="updatePaginator">updatePaginator</a></h4>
<div class="detail">
<code>
void
<strong>updatePaginator</strong>
(
)
</code>
<div class="description">
Updates Paginator internal values and UI.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="updateRow">updateRow</a></h4>
<div class="detail">
<code>
void
<strong>updateRow</strong>
(
oRecord
,
index
)
</code>
<div class="description">
Updates existing Record and row at position index with given data.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oRecord &lt;YAHOO.widget.Record&gt;</code>
Record instance.
</dd>
<dd>
<code>index &lt;Number&gt;</code>
Position at which to update row.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</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 href="YAHOO.util.EventProvider.html#createEvent">createEvent</a>,
<a href="YAHOO.util.EventProvider.html#fireEvent">fireEvent</a>,
<a href="YAHOO.util.EventProvider.html#hasEvent">hasEvent</a>,
<a href="YAHOO.util.EventProvider.html#subscribe">subscribe</a>,
<a href="YAHOO.util.EventProvider.html#unsubscribe">unsubscribe</a>,
<a href="YAHOO.util.EventProvider.html#unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section method details">
<h3><a name="methodDetails">Events</a></h3>
<div class="content">
<h4>
<a name="_onRecordUpdate">_onRecordUpdate</a></h4>
<div class="detail">
<code>
private
<strong>_onRecordUpdate</strong>
(
oArgs.record
,
oArgs.key
,
oArgs.newData
,
oArgs.oldData
)
</code>
<div class="description">
Passes along recordSetUpdate Event when recordUpdateEvent is caught from RecordSet.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The Record instance.
</dd>
<dd>
<code>oArgs.key &lt;String&gt;</code>
The Record key.
</dd>
<dd>
<code>oArgs.newData &lt;Object&gt;</code>
New data.
</dd>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
New data.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cellClickEvent">cellClickEvent</a></h4>
<div class="detail">
<code>
<strong>cellClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TD element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cellDoubleclickEvent">cellDoubleclickEvent</a></h4>
<div class="detail">
<code>
<strong>cellDoubleclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TD element is doubleclicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cellEditEvent">cellEditEvent</a></h4>
<div class="detail">
<code>
<strong>cellEditEvent</strong>
(
oArgs.target
,
oArgs.newData
,
oArgs.oldData
)
</code>
<div class="description">
Fired when a cell is edited.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
<dd>
<code>oArgs.newData &lt;Object&gt;</code>
New data value.
</dd>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
Old data value.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cellFormatEvent">cellFormatEvent</a></h4>
<div class="detail">
<code>
<strong>cellFormatEvent</strong>
(
oArgs.el
)
</code>
<div class="description">
Fired when a TD element is formatted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
Reference to the TD element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cellMousedownEvent">cellMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>cellMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a mousedown occurs on a TD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cellMouseoutEvent">cellMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>cellMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a mouseout occurs on a TD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="cellMouseoverEvent">cellMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>cellMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a mouseover occurs on a TD element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="checkboxClickEvent">checkboxClickEvent</a></h4>
<div class="detail">
<code>
<strong>checkboxClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a CHECKBOX element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The CHECKBOX element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="columnResizeEvent">columnResizeEvent</a></h4>
<div class="detail">
<code>
<strong>columnResizeEvent</strong>
(
oArgs.target
)
</code>
<div class="description">
Fired when a column is resized.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="columnSortEvent">columnSortEvent</a></h4>
<div class="detail">
<code>
<strong>columnSortEvent</strong>
(
oArgs.column
,
oArgs.dir
)
</code>
<div class="description">
Fired when a column is sorted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
<dd>
<code>oArgs.dir &lt;String&gt;</code>
Sort direction "asc" or "desc".
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="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.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.request &lt;String&gt;</code>
Original request.
</dd>
<dd>
<code>oArgs.response &lt;Object&gt;</code>
Response object.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="editorShowEvent">editorShowEvent</a></h4>
<div class="detail">
<code>
<strong>editorShowEvent</strong>
(
oArgs.target
,
oArgs.column
)
</code>
<div class="description">
Fired when an editor is activated.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TD element.
</dd>
<dd>
<code>oArgs.column &lt;YAHOO.widget.Column&gt;</code>
The Column instance.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="headCellClickEvent">headCellClickEvent</a></h4>
<div class="detail">
<code>
<strong>headCellClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TH cell element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="headCellDoubleclickEvent">headCellDoubleclickEvent</a></h4>
<div class="detail">
<code>
<strong>headCellDoubleclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TH cell element is doubleclicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="headCellMousedownEvent">headCellMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>headCellMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TH cell element is mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="headCellMouseoutEvent">headCellMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>headCellMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TH cell element is mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="headCellMouseoverEvent">headCellMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>headCellMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TH cell element is mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TH element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="highlightEvent">highlightEvent</a></h4>
<div class="detail">
<code>
<strong>highlightEvent</strong>
(
oArgs.els
)
</code>
<div class="description">
Fired when an element is highlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.els &lt;Array&gt;</code>
An array of the highlighted element(s).
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="paginateEvent">paginateEvent</a></h4>
<div class="detail">
<code>
<strong>paginateEvent</strong>
(
)
</code>
<div class="description">
Fired when DataTable is paginated.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="radioClickEvent">radioClickEvent</a></h4>
<div class="detail">
<code>
<strong>radioClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a RADIO element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The RADIO element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="recordSetUpdateEvent">recordSetUpdateEvent</a></h4>
<div class="detail">
<code>
<strong>recordSetUpdateEvent</strong>
(
oArgs.record
,
oArgs.key
,
oArgs.newData
,
oArgs.oldData
)
</code>
<div class="description">
Fired when a Record is updated in the RecordSet.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The Record instance.
</dd>
<dd>
<code>oArgs.key &lt;String&gt;</code>
The Record key.
</dd>
<dd>
<code>oArgs.newData &lt;Object&gt;</code>
New data.
</dd>
<dd>
<code>oArgs.oldData &lt;Object&gt;</code>
New data.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="rowAppendEvent">rowAppendEvent</a></h4>
<div class="detail">
<code>
<strong>rowAppendEvent</strong>
(
oArgs.rowIds
)
</code>
<div class="description">
Fired when one or more TR elements are appended.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.rowIds &lt;Array&gt;</code>
The IDs of the appended rows.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="rowDeleteEvent">rowDeleteEvent</a></h4>
<div class="detail">
<code>
<strong>rowDeleteEvent</strong>
(
oArgs.rowIndexes
)
</code>
<div class="description">
Fired when one or more TR elements are deleted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.rowIndexes &lt;Array&gt;</code>
The indexes of the deleted rows.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="rowSelectEvent">rowSelectEvent</a></h4>
<div class="detail">
<code>
<strong>rowSelectEvent</strong>
(
oArgs.el
,
oArgs.record
)
</code>
<div class="description">
Fired when a TR element is selected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The selected TR element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The associated Record instance.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="rowUnselectEvent">rowUnselectEvent</a></h4>
<div class="detail">
<code>
<strong>rowUnselectEvent</strong>
(
oArgs.el
,
oArgs.record
)
</code>
<div class="description">
Fired when a TR element is unselected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.el &lt;HTMLElement&gt;</code>
The unselected TR element.
</dd>
<dd>
<code>oArgs.record &lt;YAHOO.widget.Record&gt;</code>
The associated Record instance.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="rowUpdateEvent">rowUpdateEvent</a></h4>
<div class="detail">
<code>
<strong>rowUpdateEvent</strong>
(
oArgs.rowIds
)
</code>
<div class="description">
Fired when one or more TR elements are updated.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.rowIds &lt;Array&gt;</code>
The IDs of the updated rows.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="selectEvent">selectEvent</a></h4>
<div class="detail">
<code>
<strong>selectEvent</strong>
(
oArgs.els
)
</code>
<div class="description">
Fired when an element is selected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.els &lt;Array&gt;</code>
An array of the selected element(s).
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="tableClickEvent">tableClickEvent</a></h4>
<div class="detail">
<code>
<strong>tableClickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TABLE element is clicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="tableDoubleclickEvent">tableDoubleclickEvent</a></h4>
<div class="detail">
<code>
<strong>tableDoubleclickEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TABLE element is doubleclicked.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="tableFocusEvent">tableFocusEvent</a></h4>
<div class="detail">
<code>
<strong>tableFocusEvent</strong>
(
)
</code>
<div class="description">
Fired when DataTable instance is focused.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="tableInitEvent">tableInitEvent</a></h4>
<div class="detail">
<code>
<strong>tableInitEvent</strong>
(
)
</code>
<div class="description">
Fired when DataTable instance is first initialized.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="tableMousedownEvent">tableMousedownEvent</a></h4>
<div class="detail">
<code>
<strong>tableMousedownEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TABLE element is mousedown.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="tableMouseoutEvent">tableMouseoutEvent</a></h4>
<div class="detail">
<code>
<strong>tableMouseoutEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TABLE element is mouseout.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="tableMouseoverEvent">tableMouseoverEvent</a></h4>
<div class="detail">
<code>
<strong>tableMouseoverEvent</strong>
(
oArgs.event
,
oArgs.target
)
</code>
<div class="description">
Fired when a TABLE element is mouseover.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.event &lt;HTMLEvent&gt;</code>
The event object.
</dd>
<dd>
<code>oArgs.target &lt;HTMLElement&gt;</code>
The TABLE element.
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="tableRefreshEvent">tableRefreshEvent</a></h4>
<div class="detail">
<code>
<strong>tableRefreshEvent</strong>
(
)
</code>
<div class="description">
Fired when DataTable view is refreshed.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="unhighlightEvent">unhighlightEvent</a></h4>
<div class="detail">
<code>
<strong>unhighlightEvent</strong>
(
oArgs.els
)
</code>
<div class="description">
Fired when an element is unhighlighted.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.els &lt;Array&gt;</code>
An array of the unhighlighted element(s).
</dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="unselectEvent">unselectEvent</a></h4>
<div class="detail">
<code>
<strong>unselectEvent</strong>
(
oArgs.els
)
</code>
<div class="description">
Fired when an element is unselected.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>oArgs.els &lt;Array&gt;</code>
An array of the unselected element(s).
</dd>
</dl>
</div>
</div>
<hr />
</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_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</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_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_history.html">history</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_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_yahoo.html">yahoo</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="Column.html">Column</a></li>
<li class=""><a href="ColumnEditor.html">ColumnEditor</a></li>
<li class=""><a href="ColumnSet.html">ColumnSet</a></li>
<li class="selected"><a href="DataTable.html">DataTable</a></li>
<li class=""><a href="Record.html">Record</a></li>
<li class=""><a href="RecordSet.html">RecordSet</a></li>
<li class=""><a href="Sort.html">Sort</a></li>
<li class=""><a href="WidthResizer.html">WidthResizer</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="ColumnSet.js.html">ColumnSet.js</a></li>
<li class=""><a href="DataTable.js.html">DataTable.js</a></li>
<li class=""><a href="RecordSet.js.html">RecordSet.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li><a href="#_aSelectedRecords">_aSelectedRecords</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_bFocused">_bFocused</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_elBody">_elBody</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_elContainer">_elContainer</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_elFirstRow">_elFirstRow</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_elLastRow">_elLastRow</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_elTable">_elTable</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_nCount">_nCount</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_nIndex">_nIndex</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_oColumnSet">_oColumnSet</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_oRecordSet">_oRecordSet</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator">_paginator</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.containers">_paginator.containers</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.currentPage">_paginator.currentPage</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.dropdownOptions">_paginator.dropdownOptions</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.dropdowns">_paginator.dropdowns</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.links">_paginator.links</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.pageLinks">_paginator.pageLinks</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.rowsPerPage">_paginator.rowsPerPage</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_paginator.totalPages">_paginator.totalPages</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_selectRowAnchorId">_selectRowAnchorId</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#_sName">_sName</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#caption">caption</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_BODY">CLASS_BODY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_CHECKBOX">CLASS_CHECKBOX</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_CURRENCY">CLASS_CURRENCY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_CURRENTPAGE">CLASS_CURRENTPAGE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_DATE">CLASS_DATE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_EDITABLE">CLASS_EDITABLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_EDITOR">CLASS_EDITOR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_EMAIL">CLASS_EMAIL</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_EMPTY">CLASS_EMPTY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_ERROR">CLASS_ERROR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_EVEN">CLASS_EVEN</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_FIRST">CLASS_FIRST</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_FIRSTLINK">CLASS_FIRSTLINK</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_FIRSTPAGE">CLASS_FIRSTPAGE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_HEADCONTAINER">CLASS_HEADCONTAINER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_HEADRESIZER">CLASS_HEADRESIZER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_HEADTEXT">CLASS_HEADTEXT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_HIGHLIGHT">CLASS_HIGHLIGHT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_LAST">CLASS_LAST</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_LASTLINK">CLASS_LASTLINK</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_LASTPAGE">CLASS_LASTPAGE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_LINK">CLASS_LINK</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_LOADING">CLASS_LOADING</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_NEXTLINK">CLASS_NEXTLINK</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_NEXTPAGE">CLASS_NEXTPAGE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_NUMBER">CLASS_NUMBER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_ODD">CLASS_ODD</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_PAGELINK">CLASS_PAGELINK</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_PAGELINKS">CLASS_PAGELINKS</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_PAGESELECT">CLASS_PAGESELECT</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_PAGINATOR">CLASS_PAGINATOR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_PREVLINK">CLASS_PREVLINK</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_PREVPAGE">CLASS_PREVPAGE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_SCROLLABLE">CLASS_SCROLLABLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_SCROLLBODY">CLASS_SCROLLBODY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_SELECTED">CLASS_SELECTED</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_SORTABLE">CLASS_SORTABLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_SORTEDBYASC">CLASS_SORTEDBYASC</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_SORTEDBYDESC">CLASS_SORTEDBYDESC</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_STRING">CLASS_STRING</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#CLASS_TABLE">CLASS_TABLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#contextMenu">contextMenu</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#dataSource">dataSource</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#fixedWidth">fixedWidth</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#initialRequest">initialRequest</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#isEmpty">isEmpty</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#isLoading">isLoading</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#MSG_EMPTY">MSG_EMPTY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#MSG_ERROR">MSG_ERROR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#MSG_LOADING">MSG_LOADING</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#pageCurrent">pageCurrent</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#pageLinksLength">pageLinksLength</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#pageLinksStart">pageLinksStart</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#pagers">pagers</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#paginator">paginator</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#paginatorOptions">paginatorOptions</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#paginatorOptions.containers">paginatorOptions.containers</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#paginatorOptions.currentPage">paginatorOptions.currentPage</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#paginatorOptions.dropdownOptions">paginatorOptions.dropdownOptions</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#paginatorOptions.pageLinks">paginatorOptions.pageLinks</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#paginatorOptions.rowsPerPage">paginatorOptions.rowsPerPage</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#rowSingleSelect">rowSingleSelect</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#rowsPerPage">rowsPerPage</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#rowsPerPageDropdown">rowsPerPageDropdown</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#scrollable">scrollable</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#sortedBy">sortedBy</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#startRecordIndex">startRecordIndex</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li><a href="#summary">summary</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li><!--<code>String</code>-->
<a href="#_addRecords">_addRecords</a>
</li>
<li><!--<code>String</code>-->
<a href="#_addRowEl">_addRowEl</a>
</li>
<li><!--<code>void</code>-->
<a href="#_deleteRecord">_deleteRecord</a>
</li>
<li><!--<code>void</code>-->
<a href="#_deleteRowEl">_deleteRowEl</a>
</li>
<li><!--<code>void</code>-->
<a href="#_initHead">_initHead</a>
</li>
<li><!--<code>void</code>-->
<a href="#_initHeadCell">_initHeadCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#_initPaginator">_initPaginator</a>
</li>
<li><!--<code>void</code>-->
<a href="#_initTable">_initTable</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onBlur">_onBlur</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onClick">_onClick</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onDocumentClick">_onDocumentClick</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onDocumentKeydown">_onDocumentKeydown</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onDoubleclick">_onDoubleclick</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onKeydown">_onKeydown</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onKeypress">_onKeypress</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onKeyup">_onKeyup</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMousedown">_onMousedown</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMouseout">_onMouseout</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMouseover">_onMouseover</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onPagerClick">_onPagerClick</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onPagerSelect">_onPagerSelect</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onRowDelete">_onRowDelete</a>
</li>
<li><!--<code>void</code>-->
<a href="#_select">_select</a>
</li>
<li><!--<code>void</code>-->
<a href="#_setFirstRow">_setFirstRow</a>
</li>
<li><!--<code>void</code>-->
<a href="#_setLastRow">_setLastRow</a>
</li>
<li><!--<code>void</code>-->
<a href="#_setRowStripes">_setRowStripes</a>
</li>
<li><!--<code>void</code>-->
<a href="#_unselect">_unselect</a>
</li>
<li><!--<code>void</code>-->
<a href="#_unselectAllCells">_unselectAllCells</a>
</li>
<li><!--<code>void</code>-->
<a href="#_unselectAllRows">_unselectAllRows</a>
</li>
<li><!--<code>String</code>-->
<a href="#_updateRowEl">_updateRowEl</a>
</li>
<li><!--<code>void</code>-->
<a href="#addRow">addRow</a>
</li>
<li><!--<code>void</code>-->
<a href="#appendRows">appendRows</a>
</li>
<li><!--<code>void</code>-->
<a href="#cancelEditorData">cancelEditorData</a>
</li>
<li><!--<code>void</code>-->
<a href="#deleteRow">deleteRow</a>
</li>
<li><!--<code>void</code>-->
<a href="#deleteRows">deleteRows</a>
</li>
<li><!--<code>Boolean</code>-->
<a href="#doBeforeLoadData">doBeforeLoadData</a>
</li>
<li><!--<code>void</code>-->
<a href="#editCell">editCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#focusTable">focusTable</a>
</li>
<li><!--<code>void</code>-->
<a href="#formatCell">formatCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#formatPaginatorDropdown">formatPaginatorDropdown</a>
</li>
<li><!--<code>void</code>-->
<a href="#formatPaginatorLinks">formatPaginatorLinks</a>
</li>
<li><!--<code>void</code>-->
<a href="#formatPaginators">formatPaginators</a>
</li>
<li><!--<code>HTMLElement</code>-->
<a href="#getBody">getBody</a>
</li>
<li><!--<code>HTMLElement</code>-->
<a href="#getCell">getCell</a>
</li>
<li><!--<code>YAHOO.widget.ColumnSet</code>-->
<a href="#getColumnSet">getColumnSet</a>
</li>
<li><!--<code>HTMLElement</code>-->
<a href="#getFirstRow">getFirstRow</a>
</li>
<li><!--<code>HTMLElement</code>-->
<a href="#getHead">getHead</a>
</li>
<li><!--<code>HTMLElement</code>-->
<a href="#getLastRow">getLastRow</a>
</li>
<li><!--<code>Object</code>-->
<a href="#getPaginator">getPaginator</a>
</li>
<li><!--<code>YAHOO.widget.RecordSet</code>-->
<a href="#getRecordSet">getRecordSet</a>
</li>
<li><!--<code>HTMLElement</code>-->
<a href="#getRow">getRow</a>
</li>
<li><!--<code>HTMLElement[]</code>-->
<a href="#getSelectedCells">getSelectedCells</a>
</li>
<li><!--<code>HTMLElement[]</code>-->
<a href="#getSelectedRecordIds">getSelectedRecordIds</a>
</li>
<li><!--<code>HTMLElement[]</code>-->
<a href="#getSelectedRows">getSelectedRows</a>
</li>
<li><!--<code>HTMLElement</code>-->
<a href="#getTable">getTable</a>
</li>
<li><!--<code>void</code>-->
<a href="#hideTableMessage">hideTableMessage</a>
</li>
<li><!--<code>void</code>-->
<a href="#hideTableMessages">hideTableMessages</a>
</li>
<li><!--<code>void</code>-->
<a href="#highlight">highlight</a>
</li>
<li><!--<code>void</code>-->
<a href="#insertRows">insertRows</a>
</li>
<li><!--<code>Boolean</code>-->
<a href="#isSelected">isSelected</a>
</li>
<li><!--<code>void</code>-->
<a href="#onDataReturnAppendRows">onDataReturnAppendRows</a>
</li>
<li><!--<code>void</code>-->
<a href="#onDataReturnInsertRows">onDataReturnInsertRows</a>
</li>
<li><!--<code>void</code>-->
<a href="#onDataReturnPaginateRows">onDataReturnPaginateRows</a>
</li>
<li><!--<code>void</code>-->
<a href="#onDataReturnPopulateTable">onDataReturnPopulateTable</a>
</li>
<li><!--<code>void</code>-->
<a href="#onDataReturnReplaceRows">onDataReturnReplaceRows</a>
</li>
<li><!--<code>void</code>-->
<a href="#onEventEditCell">onEventEditCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#onEventFormatCell">onEventFormatCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#onEventHighlightCell">onEventHighlightCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#onEventSelectCell">onEventSelectCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#onEventSelectRow">onEventSelectRow</a>
</li>
<li><!--<code>void</code>-->
<a href="#onEventSortColumn">onEventSortColumn</a>
</li>
<li><!--<code>void</code>-->
<a href="#onEventUnhighlightCell">onEventUnhighlightCell</a>
</li>
<li><!--<code>void</code>-->
<a href="#populateTable">populateTable</a>
</li>
<li><!--<code>void</code>-->
<a href="#refreshTable">refreshTable</a>
</li>
<li><!--<code>void</code>-->
<a href="#saveEditorData">saveEditorData</a>
</li>
<li><!--<code>void</code>-->
<a href="#select">select</a>
</li>
<li><!--<code>void</code>-->
<a href="#selectRow">selectRow</a>
</li>
<li><!--<code>void</code>-->
<a href="#showEmptyMessage">showEmptyMessage</a>
</li>
<li><!--<code>void</code>-->
<a href="#showLoadingMessage">showLoadingMessage</a>
</li>
<li><!--<code>void</code>-->
<a href="#showPage">showPage</a>
</li>
<li><!--<code>void</code>-->
<a href="#showTableMessage">showTableMessage</a>
</li>
<li><!--<code>void</code>-->
<a href="#sortColumn">sortColumn</a>
</li>
<li><!--<code>String</code>-->
<a href="#toString">toString</a>
</li>
<li><!--<code>void</code>-->
<a href="#unhighlight">unhighlight</a>
</li>
<li><!--<code>void</code>-->
<a href="#unselect">unselect</a>
</li>
<li><!--<code>void</code>-->
<a href="#unselectAllCells">unselectAllCells</a>
</li>
<li><!--<code>void</code>-->
<a href="#unselectAllRows">unselectAllRows</a>
</li>
<li><!--<code>void</code>-->
<a href="#unselectRow">unselectRow</a>
</li>
<li><!--<code>void</code>-->
<a href="#updatePaginator">updatePaginator</a>
</li>
<li><!--<code>void</code>-->
<a href="#updateRow">updateRow</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li>
<a href="#_onRecordUpdate">_onRecordUpdate</a>
</li>
<li>
<a href="#cellClickEvent">cellClickEvent</a>
</li>
<li>
<a href="#cellDoubleclickEvent">cellDoubleclickEvent</a>
</li>
<li>
<a href="#cellEditEvent">cellEditEvent</a>
</li>
<li>
<a href="#cellFormatEvent">cellFormatEvent</a>
</li>
<li>
<a href="#cellMousedownEvent">cellMousedownEvent</a>
</li>
<li>
<a href="#cellMouseoutEvent">cellMouseoutEvent</a>
</li>
<li>
<a href="#cellMouseoverEvent">cellMouseoverEvent</a>
</li>
<li>
<a href="#checkboxClickEvent">checkboxClickEvent</a>
</li>
<li>
<a href="#columnResizeEvent">columnResizeEvent</a>
</li>
<li>
<a href="#columnSortEvent">columnSortEvent</a>
</li>
<li>
<a href="#dataReturnEvent">dataReturnEvent</a>
</li>
<li>
<a href="#editorShowEvent">editorShowEvent</a>
</li>
<li>
<a href="#headCellClickEvent">headCellClickEvent</a>
</li>
<li>
<a href="#headCellDoubleclickEvent">headCellDoubleclickEvent</a>
</li>
<li>
<a href="#headCellMousedownEvent">headCellMousedownEvent</a>
</li>
<li>
<a href="#headCellMouseoutEvent">headCellMouseoutEvent</a>
</li>
<li>
<a href="#headCellMouseoverEvent">headCellMouseoverEvent</a>
</li>
<li>
<a href="#highlightEvent">highlightEvent</a>
</li>
<li>
<a href="#paginateEvent">paginateEvent</a>
</li>
<li>
<a href="#radioClickEvent">radioClickEvent</a>
</li>
<li>
<a href="#recordSetUpdateEvent">recordSetUpdateEvent</a>
</li>
<li>
<a href="#rowAppendEvent">rowAppendEvent</a>
</li>
<li>
<a href="#rowDeleteEvent">rowDeleteEvent</a>
</li>
<li>
<a href="#rowSelectEvent">rowSelectEvent</a>
</li>
<li>
<a href="#rowUnselectEvent">rowUnselectEvent</a>
</li>
<li>
<a href="#rowUpdateEvent">rowUpdateEvent</a>
</li>
<li>
<a href="#selectEvent">selectEvent</a>
</li>
<li>
<a href="#tableClickEvent">tableClickEvent</a>
</li>
<li>
<a href="#tableDoubleclickEvent">tableDoubleclickEvent</a>
</li>
<li>
<a href="#tableFocusEvent">tableFocusEvent</a>
</li>
<li>
<a href="#tableInitEvent">tableInitEvent</a>
</li>
<li>
<a href="#tableMousedownEvent">tableMousedownEvent</a>
</li>
<li>
<a href="#tableMouseoutEvent">tableMouseoutEvent</a>
</li>
<li>
<a href="#tableMouseoverEvent">tableMouseoverEvent</a>
</li>
<li>
<a href="#tableRefreshEvent">tableRefreshEvent</a>
</li>
<li>
<a href="#unhighlightEvent">unhighlightEvent</a>
</li>
<li>
<a href="#unselectEvent">unselectEvent</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink