webgui/www/extras/yui/docs/YAHOO.widget.Paginator.ui.LastPageLink.html
2008-03-25 16:13:25 +00:00

792 lines
38 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: datatable YAHOO.widget.Paginator.ui.LastPageLink (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>DataTable Widget&nbsp; <span class="subtitle">2.5.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_datatable.html">datatable</a>
&gt; YAHOO.widget.Paginator.ui.LastPageLink
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.Paginator.ui.LastPageLink</b>
<span class="extends">
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
ui Component to generate the link to jump to the last page.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Paginator.ui.LastPageLink</strong>
<code>
(
p
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p
&lt;Pagintor&gt;
</code>
Paginator instance to attach to
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property_current">current</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Currently placed HTMLElement node
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_link">link</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Link HTMLElement node
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_na">na</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Empty place holder node for when the last page link is inappropriate to
display in any form (unlimited paging).
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_span">span</a>
<code>- private HTMLElement</code>
</h4>
<div class="detail">
<div class="description">
Span node (inactive link)
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail">
<code>
private
void
<strong>destroy</strong>
(
)
</code>
<div class="description">
Removes the onClick listener from the link in preparation for content
removal.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
static
void
<strong>init</strong>
(
paginator
)
</code>
<div class="description">
Decorates Paginator instances with new attributes. Called during
Paginator instantiation.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>paginator &lt;Paginator&gt;</code>
Paginator instance to decorate
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onClick">onClick</a></h4>
<div class="detail">
<code>
void
<strong>onClick</strong>
(
e
)
</code>
<div class="description">
Listener for the link's onclick event. Passes to setPage method.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The click event
</dd>
</dl>
<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>
HTMLElement
<strong>render</strong>
(
id_base
)
</code>
<div class="description">
Generate the nodes and return the appropriate node given the current
pagination state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>id_base &lt;string&gt;</code>
used to create unique ids for generated nodes
</dd>
</dl>
<dl>
<dt>Returns:
<code>
HTMLElement
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_update">update</a></h4>
<div class="detail">
<code>
void
<strong>update</strong>
(
e
)
</code>
<div class="description">
Swap the link, span, and na nodes if appropriate.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;CustomEvent&gt;</code>
The calling change event (ignored)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_beforeLastPageLinkClassChange">beforeLastPageLinkClassChange</a></h4>
<div class="detail">
<code>
<strong>beforeLastPageLinkClassChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'lastPageLinkClass' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeLastPageLinkLabelChange">beforeLastPageLinkLabelChange</a></h4>
<div class="detail">
<code>
<strong>beforeLastPageLinkLabelChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'lastPageLinkLabel' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_lastPageLinkClassChange">lastPageLinkClassChange</a></h4>
<div class="detail">
<code>
<strong>lastPageLinkClassChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'lastPageLinkClass' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_lastPageLinkLabelChange">lastPageLinkLabelChange</a></h4>
<div class="detail">
<code>
<strong>lastPageLinkLabelChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'lastPageLinkLabel' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_lastPageLinkClass">lastPageLinkClass</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
CSS class assigned to the link/span
</div>
</div>
<div class="default">
Default Value: 'yui-pg-last'
</div>
<hr />
</div>
<div class="">
<h4><a name="config_lastPageLinkLabel">lastPageLinkLabel</a>
<code>- object</code>
</h4>
<div class="detail">
<div class="description">
Used as innerHTML for the last page link/span.
</div>
</div>
<div class="default">
Default Value: 'last&nbsp;&gt;&gt;'
</div>
<hr />
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class="selected"><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.util.Chain.html">YAHOO.util.Chain</a></li>
<li class=""><a href="YAHOO.util.ColumnDD.html">YAHOO.util.ColumnDD</a></li>
<li class=""><a href="YAHOO.util.ColumnResizer.html">YAHOO.util.ColumnResizer</a></li>
<li class=""><a href="YAHOO.util.Sort.html">YAHOO.util.Sort</a></li>
<li class=""><a href="YAHOO.widget.Column.html">YAHOO.widget.Column</a></li>
<li class=""><a href="YAHOO.widget.ColumnSet.html">YAHOO.widget.ColumnSet</a></li>
<li class=""><a href="YAHOO.widget.DataTable.html">YAHOO.widget.DataTable</a></li>
<li class=""><a href="YAHOO.widget.Paginator.html">YAHOO.widget.Paginator</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.CurrentPageReport.html">YAHOO.widget.Paginator.ui.CurrentPageReport</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.FirstPageLink.html">YAHOO.widget.Paginator.ui.FirstPageLink</a></li>
<li class="selected"><a href="YAHOO.widget.Paginator.ui.LastPageLink.html">YAHOO.widget.Paginator.ui.LastPageLink</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.NextPageLink.html">YAHOO.widget.Paginator.ui.NextPageLink</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.PageLinks.html">YAHOO.widget.Paginator.ui.PageLinks</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.PreviousPageLink.html">YAHOO.widget.Paginator.ui.PreviousPageLink</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.RowsPerPageDropdown.html">YAHOO.widget.Paginator.ui.RowsPerPageDropdown</a></li>
<li class=""><a href="YAHOO.widget.Record.html">YAHOO.widget.Record</a></li>
<li class=""><a href="YAHOO.widget.RecordSet.html">YAHOO.widget.RecordSet</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Chain.js.html">Chain.js</a></li>
<li class=""><a href="ColumnSet.js.html">ColumnSet.js</a></li>
<li class=""><a href="DataTable.js.html">DataTable.js</a></li>
<li class=""><a href="Paginator.js.html">Paginator.js</a></li>
<li class=""><a href="RecordSet.js.html">RecordSet.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property_current">current</a>
<!--<code>&lt;HTMLElement&gt;</code>-->
</li>
<li class="private"><a href="#property_link">link</a>
<!--<code>&lt;HTMLElement&gt;</code>-->
</li>
<li class="private"><a href="#property_na">na</a>
<!--<code>&lt;HTMLElement&gt;</code>-->
</li>
<li class="private"><a href="#property_span">span</a>
<!--<code>&lt;HTMLElement&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#method_destroy">destroy</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onClick">onClick</a>
</li>
<li class=""><!--<code>HTMLElement</code>-->
<a href="#method_render">render</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_update">update</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_beforeLastPageLinkClassChange">beforeLastPageLinkClassChange</a>
</li>
<li class="">
<a href="#event_beforeLastPageLinkLabelChange">beforeLastPageLinkLabelChange</a>
</li>
<li class="">
<a href="#event_lastPageLinkClassChange">lastPageLinkClassChange</a>
</li>
<li class="">
<a href="#event_lastPageLinkLabelChange">lastPageLinkLabelChange</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_lastPageLinkClass">lastPageLinkClass</a>
</li>
<li class="">
<a href="#config_lastPageLinkLabel">lastPageLinkLabel</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>