20f8df1291
data tables are going to need some work yet, but the other stuff seems to be working 100%
3176 lines
148 KiB
HTML
3176 lines
148 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: paginator YAHOO.widget.Paginator (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
|
|
<h3>paginator <span class="subtitle">2.6.0</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_paginator.html">paginator</a>
|
|
> YAHOO.widget.Paginator
|
|
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form name="yui-classopts-form">
|
|
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.widget.Paginator</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
Instantiate a Paginator, passing a configuration object to the contructor.
|
|
The configuration object should contain the following properties:
|
|
<ul>
|
|
<li>rowsPerPage : <em>n</em> (int)</li>
|
|
<li>totalRecords : <em>n</em> (int or Paginator.VALUE_UNLIMITED)</li>
|
|
<li>containers : <em>id | el | arr</em> (HTMLElement reference, its id, or an array of either)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.widget.Paginator</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
config
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>config
|
|
<Object>
|
|
</code>
|
|
Object literal to set instance and ui component
|
|
configuration.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="protected">
|
|
<h4><a name="property__batch">_batch</a>
|
|
<code>- protected boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Flag used to indicate multiple attributes are being updated via setState
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__containers">_containers</a>
|
|
<code>- private Array(HTMLElement)</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Array of nodes in which to render pagination controls. This is set via
|
|
the "containers" attribute.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property__pageChanged">_pageChanged</a>
|
|
<code>- protected boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Used by setState to indicate when a page change has occurred
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property__state">_state</a>
|
|
<code>- protected Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Temporary state cache used by setState to keep track of the previous
|
|
state for eventual pageChange event firing
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property_id">id</a>
|
|
<code>- private static number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Incrementing index used to give instances unique ids.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property_ID_BASE">ID_BASE</a>
|
|
<code>- private static string</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Base of id strings used for ui components.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_TEMPLATE_DEFAULT">TEMPLATE_DEFAULT</a>
|
|
<code>- static string</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Default template used by Paginator instances. Update this if you want
|
|
all new Paginators to use a different default template.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_TEMPLATE_ROWS_PER_PAGE">TEMPLATE_ROWS_PER_PAGE</a>
|
|
<code>- static string</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Common alternate pagination format, including page links, links for
|
|
previous, next, first and last pages as well as a rows-per-page
|
|
dropdown. Offered as a convenience.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_ui">ui</a>
|
|
<code>- static object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Storage object for UI Components
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_VALUE_UNLIMITED">VALUE_UNLIMITED</a>
|
|
<code>- static final number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Used to identify unset, optional configurations, or used explicitly in
|
|
the case of totalRecords to indicate unlimited pagination.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="protected">
|
|
<h4>
|
|
<a name="method__firePageChange">_firePageChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_firePageChange</strong>
|
|
(
|
|
|
|
|
|
state
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires a pageChange event in the form of a standard attribute change
|
|
event with additional properties prevState and newState.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>state <Object></code>
|
|
the result of getState(oldState)
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4>
|
|
<a name="method__handleStateChange">_handleStateChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_handleStateChange</strong>
|
|
(
|
|
|
|
|
|
e
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires the pageChange event when the state attributes have changed in
|
|
such a way as to locate the current recordOffset on a new page.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>e <Event></code>
|
|
the attribute change event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4>
|
|
<a name="method__selfSubscribe">_selfSubscribe</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_selfSubscribe</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Subscribes to instance attribute change events to automate certain
|
|
behaviors.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4>
|
|
<a name="method__syncRecordOffset">_syncRecordOffset</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_syncRecordOffset</strong>
|
|
(
|
|
|
|
|
|
e
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets recordOffset to the starting index of the previous page when
|
|
totalRecords is reduced below the current recordOffset.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>e <Event></code>
|
|
totalRecordsChange event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_destroy">destroy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>destroy</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Removes controls from the page and unhooks events.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getContainerNodes">getContainerNodes</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Array
|
|
<strong>getContainerNodes</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the configured container nodes
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Array
|
|
</code></dt>
|
|
<dd>array of HTMLElement nodes</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getCurrentPage">getCurrentPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
number
|
|
<strong>getCurrentPage</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the page number corresponding to the current record offset.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
number
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getNextPage">getNextPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
number
|
|
<strong>getNextPage</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the page number of the next page, or null if the current page is the
|
|
last page.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
number
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getPageRecords">getPageRecords</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Array
|
|
<strong>getPageRecords</strong>
|
|
(
|
|
|
|
|
|
page
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the start and end record indexes of the specified page.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>page <number></code>
|
|
(optional) The page (current page if not specified)
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Array
|
|
</code></dt>
|
|
<dd>[start_index, end_index]</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getPreviousPage">getPreviousPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
number
|
|
<strong>getPreviousPage</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the page number of the previous page, or null if the current page
|
|
is the first page.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
number
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getRowsPerPage">getRowsPerPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
number
|
|
<strong>getRowsPerPage</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the number of rows per page.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
number
|
|
</code></dt>
|
|
<dd>the current setting of the rowsPerPage attribute</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getStartIndex">getStartIndex</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
number
|
|
<strong>getStartIndex</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the index of the first record on the current page
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
number
|
|
</code></dt>
|
|
<dd>the index of the first record on the current page</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getState">getState</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
object
|
|
<strong>getState</strong>
|
|
(
|
|
|
|
|
|
changes
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get an object literal describing the current state of the paginator. If
|
|
an object literal of proposed values is passed, the proposed state will
|
|
be returned as an object literal with the following keys:
|
|
<ul>
|
|
<li>paginator - instance of the Paginator</li>
|
|
<li>page - number</li>
|
|
<li>totalRecords - number</li>
|
|
<li>recordOffset - number</li>
|
|
<li>rowsPerPage - number</li>
|
|
<li>records - [ start_index, end_index ]</li>
|
|
<li>before - (OPTIONAL) { state object literal for current state }</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>changes <object></code>
|
|
OPTIONAL object literal with proposed values
|
|
Supported change keys include:
|
|
<ul>
|
|
<li>rowsPerPage</li>
|
|
<li>totalRecords</li>
|
|
<li>recordOffset OR</li>
|
|
<li>page</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
object
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getTotalPages">getTotalPages</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
number
|
|
<strong>getTotalPages</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the total number of pages in the data set according to the current
|
|
rowsPerPage and totalRecords values. If totalRecords is not set, or
|
|
set to YAHOO.widget.Paginator.VALUE_UNLIMITED, returns
|
|
YAHOO.widget.Paginator.VALUE_UNLIMITED.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
number
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getTotalRecords">getTotalRecords</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
number
|
|
<strong>getTotalRecords</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Get the total number of records.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
number
|
|
</code></dt>
|
|
<dd>the current setting of totalRecords attribute</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_hasNextPage">hasNextPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong>hasNextPage</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Are there records on the next page?
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_hasPage">hasPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong>hasPage</strong>
|
|
(
|
|
|
|
|
|
page
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Does the requested page have any records?
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>page <number></code>
|
|
the page in question
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_hasPreviousPage">hasPreviousPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
boolean
|
|
<strong>hasPreviousPage</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Is there a page before the current page?
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method_initConfig">initConfig</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>initConfig</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initialize the Paginator's attributes (see YAHOO.util.Element class
|
|
AttributeProvider).
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method_initEvents">initEvents</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>initEvents</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initialize this instance's CustomEvents.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method_initUIComponents">initUIComponents</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>initUIComponents</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initialize registered ui components onto this instance.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_render">render</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>render</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Render the pagination controls per the format attribute into the
|
|
specified container nodes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setPage">setPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setPage</strong>
|
|
(
|
|
|
|
|
|
newPage
|
|
|
|
|
|
,
|
|
silent
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Set the current page to the provided page number if possible.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>newPage <number></code>
|
|
the new page number
|
|
</dd>
|
|
<dd>
|
|
<code>silent <boolean></code>
|
|
whether to forcibly avoid firing the
|
|
changeRequest event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setRowsPerPage">setRowsPerPage</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setRowsPerPage</strong>
|
|
(
|
|
|
|
|
|
rpp
|
|
|
|
|
|
,
|
|
silent
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Set the number of rows per page.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>rpp <number></code>
|
|
the new number of rows per page
|
|
</dd>
|
|
<dd>
|
|
<code>silent <boolean></code>
|
|
whether to forcibly avoid firing the
|
|
changeRequest event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setStartIndex">setStartIndex</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setStartIndex</strong>
|
|
(
|
|
|
|
|
|
offset
|
|
|
|
|
|
,
|
|
silent
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Move the record offset to a new starting index. This will likely cause
|
|
the calculated current page to change. You should probably use setPage.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>offset <number></code>
|
|
the new record offset
|
|
</dd>
|
|
<dd>
|
|
<code>silent <boolean></code>
|
|
whether to forcibly avoid firing the changeRequest event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setState">setState</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setState</strong>
|
|
(
|
|
|
|
|
|
state
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Convenience method to facilitate setting state attributes rowsPerPage,
|
|
totalRecords, recordOffset in batch. Also supports calculating
|
|
recordOffset from state.page if state.recordOffset is not provided.
|
|
Fires only a single pageChange event, if appropriate.
|
|
This will not fire a changeRequest event.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>state <Object></code>
|
|
Object literal of attribute:value pairs to set
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setTotalRecords">setTotalRecords</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setTotalRecords</strong>
|
|
(
|
|
|
|
|
|
total
|
|
|
|
|
|
,
|
|
silent
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Set the total number of records.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>total <number></code>
|
|
the new total number of records
|
|
</dd>
|
|
<dd>
|
|
<code>silent <boolean></code>
|
|
whether to forcibly avoid firing the changeRequest event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_updateVisibility">updateVisibility</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>updateVisibility</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Hides the containers if there is only one page of data and attribute
|
|
alwaysVisible is false. Conversely, it displays the containers if either
|
|
there is more than one page worth of data or alwaysVisible is turned on.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section method details">
|
|
<h3 id="events">Events</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_alwaysVisibleChange">alwaysVisibleChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>alwaysVisibleChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'alwaysVisible' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeAlwaysVisibleChange">beforeAlwaysVisibleChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeAlwaysVisibleChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'alwaysVisible' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeContainerClassChange">beforeContainerClassChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeContainerClassChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'containerClass' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeContainersChange">beforeContainersChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeContainersChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'containers' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeDestroy">beforeDestroy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeDestroy</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event that fires before the destroy event.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeIdChange">beforeIdChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeIdChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'id' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeInitialPageChange">beforeInitialPageChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeInitialPageChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'initialPage' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeRecordOffsetChange">beforeRecordOffsetChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeRecordOffsetChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'recordOffset' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeRenderedChange">beforeRenderedChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeRenderedChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'rendered' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeRowsPerPageChange">beforeRowsPerPageChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeRowsPerPageChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'rowsPerPage' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeTemplateChange">beforeTemplateChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeTemplateChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'template' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeTotalRecordsChange">beforeTotalRecordsChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeTotalRecordsChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'totalRecords' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeUpdateOnChangeChange">beforeUpdateOnChangeChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeUpdateOnChangeChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'updateOnChange' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_changeRequest">changeRequest</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>changeRequest</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event fired when a change in pagination values is requested,
|
|
either by interacting with the various ui components or via the
|
|
setStartIndex(n) etc APIs.
|
|
Subscribers will receive the proposed state as the first parameter.
|
|
The proposed state object will contain the following keys:
|
|
<ul>
|
|
<li>paginator - the Paginator instance</li>
|
|
<li>page</li>
|
|
<li>totalRecords</li>
|
|
<li>recordOffset - index of the first record on the new page</li>
|
|
<li>rowsPerPage</li>
|
|
<li>records - array containing [start index, end index] for the records on the new page</li>
|
|
<li>before - object literal with all these keys for the current state</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_containerClassChange">containerClassChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>containerClassChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'containerClass' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_containersChange">containersChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>containersChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'containers' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_destroy">destroy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>destroy</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event used to trigger cleanup of ui components
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_idChange">idChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>idChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'id' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_initialPageChange">initialPageChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>initialPageChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'initialPage' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_pageChange">pageChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>pageChange</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event fired when attribute changes have resulted in the calculated
|
|
current page changing.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_recordOffsetChange">recordOffsetChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>recordOffsetChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'recordOffset' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_render">render</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>render</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event fired when the Paginator is initially rendered
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated">
|
|
<h4>
|
|
<a name="event_rendered">rendered</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>rendered</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event fired when the Paginator is initially rendered
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated</strong> use render event
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_renderedChange">renderedChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>renderedChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'rendered' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_rowsPerPageChange">rowsPerPageChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>rowsPerPageChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'rowsPerPage' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_templateChange">templateChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>templateChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'template' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_totalRecordsChange">totalRecordsChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>totalRecordsChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'totalRecords' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_updateOnChangeChange">updateOnChangeChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>updateOnChangeChange</strong>
|
|
|
|
(
|
|
|
|
|
|
event
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'updateOnChange' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>event <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="section field details">
|
|
<h3 id="configattributes">Configuration Attributes</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4><a name="config_alwaysVisible">alwaysVisible</a>
|
|
<code>- boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Display pagination controls even when there is only one page. Set
|
|
to false to forgo rendering and/or hide the containers when there
|
|
is only one page of data. Note if you are using the rowsPerPage
|
|
dropdown ui component, visibility will be maintained as long as the
|
|
number of records exceeds the smallest page size.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_containerClass">containerClass</a>
|
|
<code>- string</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Class assigned to the element(s) containing pagination controls.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 'yui-pg-container'
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_containers">containers</a>
|
|
<code>- {string|HTMLElement|Array(string|HTMLElement)}</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
REQUIRED. Node references or ids of nodes in which to render the
|
|
pagination controls.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_id">id</a>
|
|
<code>- readonly integer</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Unique id assigned to this instance
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_initialPage">initialPage</a>
|
|
<code>- integer</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Page to display on initial paint
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 1
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_recordOffset">recordOffset</a>
|
|
<code>- integer</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Zero based index of the record considered first on the current page.
|
|
For page based interactions, don't modify this attribute directly;
|
|
use setPage(n).
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 0
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_rendered">rendered</a>
|
|
<code>- readonly boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Indicator of whether the DOM nodes have been initially created
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_rowsPerPage">rowsPerPage</a>
|
|
<code>- integer</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
REQUIRED. Number of records constituting a "page"
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_template">template</a>
|
|
<code>- string</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Template used to render controls. The string will be used as
|
|
innerHTML on all specified container nodes. Bracketed keys
|
|
(e.g. {pageLinks}) in the string will be replaced with an instance
|
|
of the so named ui component.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_totalRecords">totalRecords</a>
|
|
<code>- integer</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Total number of records to paginate through
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: 0
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_updateOnChange">updateOnChange</a>
|
|
<code>- boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Update the UI immediately upon interaction. If false, changeRequest
|
|
subscribers or other external code will need to explicitly set the
|
|
new values in the paginator to trigger repaint.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
|
|
<li class=""><a href="module_animation.html">animation</a></li>
|
|
|
|
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
|
|
|
|
<li class=""><a href="module_button.html">button</a></li>
|
|
|
|
<li class=""><a href="module_calendar.html">calendar</a></li>
|
|
|
|
<li class=""><a href="module_carousel.html">carousel</a></li>
|
|
|
|
<li class=""><a href="module_charts.html">charts</a></li>
|
|
|
|
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
|
|
|
|
<li class=""><a href="module_connection.html">connection</a></li>
|
|
|
|
<li class=""><a href="module_container.html">container</a></li>
|
|
|
|
<li class=""><a href="module_cookie.html">cookie</a></li>
|
|
|
|
<li class=""><a href="module_datasource.html">datasource</a></li>
|
|
|
|
<li class=""><a href="module_datatable.html">datatable</a></li>
|
|
|
|
<li class=""><a href="module_dom.html">dom</a></li>
|
|
|
|
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
|
|
|
|
<li class=""><a href="module_editor.html">editor</a></li>
|
|
|
|
<li class=""><a href="module_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_get.html">get</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</a></li>
|
|
|
|
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
|
|
|
|
<li class=""><a href="module_imageloader.html">imageloader</a></li>
|
|
|
|
<li class=""><a href="module_json.html">json</a></li>
|
|
|
|
<li class=""><a href="module_layout.html">layout</a></li>
|
|
|
|
<li class=""><a href="module_logger.html">logger</a></li>
|
|
|
|
<li class=""><a href="module_menu.html">menu</a></li>
|
|
|
|
<li class="selected"><a href="module_paginator.html">paginator</a></li>
|
|
|
|
<li class=""><a href="module_profiler.html">profiler</a></li>
|
|
|
|
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
|
|
|
|
<li class=""><a href="module_resize.html">resize</a></li>
|
|
|
|
<li class=""><a href="module_selector.html">selector</a></li>
|
|
|
|
<li class=""><a href="module_slider.html">slider</a></li>
|
|
|
|
<li class=""><a href="module_tabview.html">tabview</a></li>
|
|
|
|
<li class=""><a href="module_treeview.html">treeview</a></li>
|
|
|
|
<li class=""><a href="module_uploader.html">uploader</a></li>
|
|
|
|
<li class=""><a href="module_yahoo.html">yahoo</a></li>
|
|
|
|
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
|
|
|
|
<li class=""><a href="module_yuitest.html">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class="selected"><a href="YAHOO.widget.Paginator.html">YAHOO.widget.Paginator</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.CurrentPageReport.html">YAHOO.widget.Paginator.ui.CurrentPageReport</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.FirstPageLink.html">YAHOO.widget.Paginator.ui.FirstPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.LastPageLink.html">YAHOO.widget.Paginator.ui.LastPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.NextPageLink.html">YAHOO.widget.Paginator.ui.NextPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.PageLinks.html">YAHOO.widget.Paginator.ui.PageLinks</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.PreviousPageLink.html">YAHOO.widget.Paginator.ui.PreviousPageLink</a></li>
|
|
<li class=""><a href="YAHOO.widget.Paginator.ui.RowsPerPageDropdown.html">YAHOO.widget.Paginator.ui.RowsPerPageDropdown</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="CurrentPageReport.js.html">CurrentPageReport.js</a></li>
|
|
<li class=""><a href="FirstPageLink.js.html">FirstPageLink.js</a></li>
|
|
<li class=""><a href="LastPageLink.js.html">LastPageLink.js</a></li>
|
|
<li class=""><a href="NextPageLink.js.html">NextPageLink.js</a></li>
|
|
<li class=""><a href="PageLinks.js.html">PageLinks.js</a></li>
|
|
<li class=""><a href="Paginator.js.html">Paginator.js</a></li>
|
|
<li class=""><a href="PreviousPageLink.js.html">PreviousPageLink.js</a></li>
|
|
<li class=""><a href="RowsPerPageDropDown.js.html">RowsPerPageDropDown.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class="protected"><a href="#property__batch">_batch</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__containers">_containers</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property__pageChanged">_pageChanged</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property__state">_state</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_id">id</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_ID_BASE">ID_BASE</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_TEMPLATE_DEFAULT">TEMPLATE_DEFAULT</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_TEMPLATE_ROWS_PER_PAGE">TEMPLATE_ROWS_PER_PAGE</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_ui">ui</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_VALUE_UNLIMITED">VALUE_UNLIMITED</a>
|
|
<!--<code><number></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="protected"><!--<code>void</code>-->
|
|
<a href="#method__firePageChange">_firePageChange</a>
|
|
</li>
|
|
<li class="protected"><!--<code>void</code>-->
|
|
<a href="#method__handleStateChange">_handleStateChange</a>
|
|
</li>
|
|
<li class="protected"><!--<code>void</code>-->
|
|
<a href="#method__selfSubscribe">_selfSubscribe</a>
|
|
</li>
|
|
<li class="protected"><!--<code>void</code>-->
|
|
<a href="#method__syncRecordOffset">_syncRecordOffset</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_destroy">destroy</a>
|
|
</li>
|
|
<li class=""><!--<code>Array</code>-->
|
|
<a href="#method_getContainerNodes">getContainerNodes</a>
|
|
</li>
|
|
<li class=""><!--<code>number</code>-->
|
|
<a href="#method_getCurrentPage">getCurrentPage</a>
|
|
</li>
|
|
<li class=""><!--<code>number</code>-->
|
|
<a href="#method_getNextPage">getNextPage</a>
|
|
</li>
|
|
<li class=""><!--<code>Array</code>-->
|
|
<a href="#method_getPageRecords">getPageRecords</a>
|
|
</li>
|
|
<li class=""><!--<code>number</code>-->
|
|
<a href="#method_getPreviousPage">getPreviousPage</a>
|
|
</li>
|
|
<li class=""><!--<code>number</code>-->
|
|
<a href="#method_getRowsPerPage">getRowsPerPage</a>
|
|
</li>
|
|
<li class=""><!--<code>number</code>-->
|
|
<a href="#method_getStartIndex">getStartIndex</a>
|
|
</li>
|
|
<li class=""><!--<code>object</code>-->
|
|
<a href="#method_getState">getState</a>
|
|
</li>
|
|
<li class=""><!--<code>number</code>-->
|
|
<a href="#method_getTotalPages">getTotalPages</a>
|
|
</li>
|
|
<li class=""><!--<code>number</code>-->
|
|
<a href="#method_getTotalRecords">getTotalRecords</a>
|
|
</li>
|
|
<li class=""><!--<code>boolean</code>-->
|
|
<a href="#method_hasNextPage">hasNextPage</a>
|
|
</li>
|
|
<li class=""><!--<code>boolean</code>-->
|
|
<a href="#method_hasPage">hasPage</a>
|
|
</li>
|
|
<li class=""><!--<code>boolean</code>-->
|
|
<a href="#method_hasPreviousPage">hasPreviousPage</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method_initConfig">initConfig</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method_initEvents">initEvents</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method_initUIComponents">initUIComponents</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_render">render</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setPage">setPage</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setRowsPerPage">setRowsPerPage</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setStartIndex">setStartIndex</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setState">setState</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setTotalRecords">setTotalRecords</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_updateVisibility">updateVisibility</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#event_alwaysVisibleChange">alwaysVisibleChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeAlwaysVisibleChange">beforeAlwaysVisibleChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeContainerClassChange">beforeContainerClassChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeContainersChange">beforeContainersChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeDestroy">beforeDestroy</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeIdChange">beforeIdChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeInitialPageChange">beforeInitialPageChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeRecordOffsetChange">beforeRecordOffsetChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeRenderedChange">beforeRenderedChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeRowsPerPageChange">beforeRowsPerPageChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeTemplateChange">beforeTemplateChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeTotalRecordsChange">beforeTotalRecordsChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeUpdateOnChangeChange">beforeUpdateOnChangeChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_changeRequest">changeRequest</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_containerClassChange">containerClassChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_containersChange">containersChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_destroy">destroy</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_idChange">idChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_initialPageChange">initialPageChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_pageChange">pageChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_recordOffsetChange">recordOffsetChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_render">render</a>
|
|
</li>
|
|
<li class=" deprecated">
|
|
<a href="#event_rendered">rendered</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_renderedChange">renderedChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_rowsPerPageChange">rowsPerPageChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_templateChange">templateChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_totalRecordsChange">totalRecordsChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_updateOnChangeChange">updateOnChangeChange</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Configuration Attributes</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#config_alwaysVisible">alwaysVisible</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_containerClass">containerClass</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_containers">containers</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_id">id</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_initialPage">initialPage</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_recordOffset">recordOffset</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_rendered">rendered</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_rowsPerPage">rowsPerPage</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_template">template</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_totalRecords">totalRecords</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_updateOnChange">updateOnChange</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2008 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|