Configuring the Paginator
<!--
Software License Agreement (BSD License)
Copyright (c) 2009, Yahoo! Inc.
All rights reserved.
Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Sources of Intellectual Property Included in the YUI Library
YUI is issued by Yahoo! under the BSD license above. Below is a list of certain publicly available software that is the source of intellectual property in YUI, along with the licensing terms that pertain to thosesources of IP. This list is for informational purposes only and is not intended to represent an exhaustive list of third party contributions to the YUI.
* Douglas Crockford's JSON parsing and stringifying methods: In the JSON Utility, Douglas Crockford's JSON parsing and stringifying methods are adapted from work published at JSON.org. The adapted work is in the public domain.
* Robert Penner's animation-easing algorithms: In the Animation Utility, YUI makes use of Robert Penner's algorithms for easing.
* Geoff Stearns's SWFObject: In the Charts Control and the Uploader versions through 2.7.0, YUI makes use of Geoff Stearns's SWFObject v1.5 for Flash Player detection and embedding. More information on SWFObject can be found here (http://blog.deconcept.com/swfobject/). SWFObject is (c) 2007 Geoff Stearns and is released under the MIT License (http://www.opensource.org/licenses/mit-license.php).
* Diego Perini's IEContentLoaded technique: The Event Utility employs a technique developed by Diego Perini and licensed under GPL. YUI's use of this technique is included under our BSD license with the author's permission.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Configuring the Paginator</title>
<style type="text/css">
/*margin and padding on body element
can introduce errors in determining
element position and are not recommended;
we turn them off as a foundation for YUI
CSS treatments. */
body {
margin:0;
padding:0;
}
</style>
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" />
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/paginator/assets/skins/sam/paginator.css" />
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/datatable/assets/skins/sam/datatable.css" />
<script type="text/javascript" src="yui_2.7.0b-lib/yahoo-dom-event/yahoo-dom-event.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/element/element-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/paginator/paginator-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/datasource/datasource-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/datatable/datatable-min.js"></script>
<!--begin custom header content for this example-->
<style type="text/css">
#demo {
width: 525px;
}
#pag {
display: inline;
float: left;
width: 250px;
margin-top: 0;
}
#pag a {
color: #0000de;
}
#pag label {
display: block;
margin: 1ex 0;
}
#pag p {
margin: .25ex 0;
}
.yui-skin-sam #pag .yui-pg-pages {
display: block;
}
.yui-skin-sam #pag .yui-pg-page {
display: block;
background: transparent;
border: none;
padding: .5ex 0;
white-space: normal;
}
.yui-skin-sam #pag .yui-pg-current-page {
padding: .5ex 0;
background-color: #ffe;
font-style: italic;
}
.yui-skin-sam #pag .yui-pg-current {
margin: 0;
white-space: normal;
font-weight: bold;
font-size: 113%;
}
.yui-skin-sam #demo .yui-dt caption {
margin: 0.2em 0 0;
color: #e76300;
font-weight: bold;
}
</style>
<!--end custom header content for this example-->
</head>
<body class=" yui-skin-sam">
<h1>Configuring the Paginator</h1>
<div class="exampleIntro">
<p>In this example we'll demonstrate the use of all of Paginator's configuration options, including the options added by the bundled UI Components. Most notably, we'll use the <code>template</code> and <code>pageLabelBuilder</code> options to render the pagination controls in a custom layout with more descriptive page links. All content in the left column is generated by the Paginator.</p>
</div>
<!--BEGIN SOURCE CODE FOR EXAMPLE -->
<div id="demo">
<div id="pag"></div>
<div id="tbl"></div>
</div>
<script type="text/javascript" src="yui_2.7.0b-assets/paginator-assets/areacodes.js"></script>
<script type="text/javascript">
YAHOO.util.Event.onDOMReady(function () {
var Ex = YAHOO.namespace('example');
// Sort our data by state, then area code
Ex.data.areacodes.sort(function (a,b) {
return YAHOO.util.Sort.compare(a.state,b.state) ||
YAHOO.util.Sort.compare(a.areacode,b.areacode);
});
// Custom function we'll use for the page links
Ex.buildPageLabel = function (recs) {
var data = Ex.data.areacodes,
start = recs[0],
end = recs[1];
// Nested function to find the smallest substring
// to indicate how two strings differ
var diffNames = function (a,b) {
var aa = a.state.toLowerCase(),
bb = b.state.toLowerCase();
for (var i = 0, len = aa.length; i < len; ++i) {
if (aa.charAt(i) !== bb.charAt(i)) {
return a.state.substr(0,i+1);
}
}
return a.state + ' ('+a.areacode+')';
};
// Build label as "A - C" or "Abc - Def"
var label = '';
if (!start) {
label = data[0].state.substr(0,2) + ' - ';
} else {
label = diffNames(data[start], data[start-1]) + ' - ';
}
if (data[end+1]) {
label += diffNames(data[end], data[end+1]);
} else {
label += diffNames(data[end], data[start]);
}
return label;
};
// Paginator configurations
Ex.config = {
// REQUIRED
rowsPerPage : 20,
// REQUIRED, but DataTable will default if not provided
containers : 'pag',
// If not provided, there is no last page or total pages.
// DataTable will set this in the DataSource callback, so this is
// redundant.
totalRecords : Ex.data.areacodes.length,
// page to activate at load
initialPage : 3,
// Class the element(s) that will contain the controls
containerClass : 'yui-pg-container', // default
// Define the innerHTML of the container(s) using placeholders
// to identify where the controls will be located
template :
'<h3>Now showing:</h3>' +
'<p>{CurrentPageReport}</p>' +
'<p class="pg-nav">' +
'{FirstPageLink} {PreviousPageLink} ' +
'{NextPageLink} {LastPageLink}' +
'</p>' +
'<label>Page size: {RowsPerPageDropdown}</label>' +
'<h3>Directory</h3>' +
'{PageLinks}',
// If there is less data than would display on one page, pagination
// controls can be omitted by setting this to false.
alwaysVisible : true, // default
// Override setPage (et al) to immediately update internal values
// and update the pagination controls in response to user actions.
// Default is false; requests are delegated through the changeRequest
// event subscriber.
updateOnChange : false, // default
// Options for FirstPageLink component
firstPageLinkLabel : "<<",
firstPageLinkClass : "yui-pg-first", // default
// Options for LastPageLink component
lastPageLinkLabel : ">>",
lastPageLinkClass : "yui-pg-last", // default
// Options for PreviousPageLink component
previousPageLinkLabel : "< previous",
previousPageLinkClass : "yui-pg-previous", // default
// Options for NextPageLink component
nextPageLinkLabel : "next >", // default
nextPageLinkClass : "yui-pg-next", // default
// Options for PageLinks component
pageLinksContainerClass : 'yui-pg-pages', // default
pageLinkClass : 'yui-pg-page', // default
currentPageClass : 'yui-pg-current-page', // default
// Display a maximum of X page links. Use
// YAHOO.widget.Paginator.VALUE_UNLIMITED to show all page links
pageLinks : YAHOO.widget.Paginator.VALUE_UNLIMITED,
// Create custom page link labels
pageLabelBuilder : function (page,paginator) {
return Ex.buildPageLabel(paginator.getPageRecords(page));
},
// Options for RowsPerPageDropdown component
rowsPerPageDropdownClass : "yui-pg-rpp-options", // default
rowsPerPageOptions : [
{ value : 20, text : "small" },
{ value : 40, text : "medium" },
{ value : 100, text : "large" }
],
// Options for CurrentPageReport component
pageReportClass : 'yui-pg-current', // default
// Provide a key:value map for use by the pageReportTemplate.
// Unlikely this will need to be customized; see API docs for the
// template keys made available by the default value generator
pageReportValueGenerator : function (paginator) {
var recs = paginator.getPageRecords();
return {
start : Ex.data.areacodes[recs[0]].state,
end : Ex.data.areacodes[recs[1]].state
};
},
// How to render the notification of the Paginator's current state
pageReportTemplate : '{start} - {end}'
};
// Create the Paginator for our DataTable to use
Ex.paginator = new YAHOO.widget.Paginator(Ex.config);
// Normal DataTable configuration
Ex.tableCols = [ {key:"state", label:"State", minWidth: 150},
{key:"areacode", label:"Code", width: 30}];
Ex.dataSource = new YAHOO.util.DataSource(Ex.data.areacodes, {
responseType : YAHOO.util.DataSource.TYPE_JSARRAY,
responseSchema : {
fields : ["state","areacode"]
}
});
// Pass the Paginator in the DataTable config
Ex.tableConfig = {
paginator : Ex.paginator,
caption : 'Area Codes by State'
};
Ex.dataTable = new YAHOO.widget.DataTable('tbl',
Ex.tableCols, Ex.dataSource, Ex.tableConfig);
});
</script>
<!--END SOURCE CODE FOR EXAMPLE -->
</body>
</html>
<!-- presentbright.corp.yahoo.com uncompressed/chunked Thu Feb 19 10:53:18 PST 2009 -->
yui_2.7.0b.zip( 4,431 k)Related examples in the same category