Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / pagination / PageableController.html
blob: d9463a3f4d0afcfdec7cff3458cc6e01d4a881fe [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Jul 23 15:58:46 CEST 2020 -->
<title>PageableController</title>
<meta name="date" content="2020-07-23">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PageableController";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PageableController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/nebula/widgets/pagination/LazyItemsSelectionListener.html" title="class in org.eclipse.nebula.widgets.pagination"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageChangedAdapter.html" title="class in org.eclipse.nebula.widgets.pagination"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/pagination/PageableController.html" target="_top">Frames</a></li>
<li><a href="PageableController.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.nebula.widgets.pagination</div>
<h2 title="Class PageableController" class="title">Class PageableController</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.pagination.PageableController</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PageableController</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">The pagination controller is used to store information about pagination :
<ul>
<li>the current page index: index of the selected page.</li>
<li>the page size: number items to display per page.</li>
<li>the total elements: the total elements of the paginated list.</li>
<li>the current sort information: the property name and direction of the
sort.</li>
</ul>
<p>
The controller fire events as soon as pagination information change
(ex:selected page change). Those information can be observed by adding
<a href="../../../../../org/eclipse/nebula/widgets/pagination/IPageChangedListener.html" title="interface in org.eclipse.nebula.widgets.pagination"><code>IPageChangedListener</code></a> to the controller.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.eclipse.nebula.widgets.pagination.PageableController">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#DEFAULT_PAGE_INDEX">DEFAULT_PAGE_INDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#DEFAULT_PAGE_SIZE">DEFAULT_PAGE_SIZE</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#PageableController--">PageableController</a></span>()</code>
<div class="block">Constructor with default page size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#PageableController-int-">PageableController</a></span>(int&nbsp;pageSize)</code>
<div class="block">Constructor with page size.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#addPageChangedListener-org.eclipse.nebula.widgets.pagination.IPageChangedListener-">addPageChangedListener</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pagination/IPageChangedListener.html" title="interface in org.eclipse.nebula.widgets.pagination">IPageChangedListener</a>&nbsp;listener)</code>
<div class="block">Adds the listener to the collection of listeners who will be notified
when the page controller changed ( the current page page size, total
elements or sort change.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#getCurrentPage--">getCurrentPage</a></span>()</code>
<div class="block">Returns the current page index.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#getPageOffset--">getPageOffset</a></span>()</code>
<div class="block">Returns the current page offset.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#getPageSize--">getPageSize</a></span>()</code>
<div class="block">Returns the page size: number items to display per page.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#getSortDirection--">getSortDirection</a></span>()</code>
<div class="block">Returns the sort direction <code>SWT.UP</code>, <code>SWT.DOWN</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#getSortPropertyName--">getSortPropertyName</a></span>()</code>
<div class="block">Returns the property name used to sort.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#getTotalElements--">getTotalElements</a></span>()</code>
<div class="block">Returns the total elements.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#getTotalPages--">getTotalPages</a></span>()</code>
<div class="block">Returns the total pages.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#hasNextPage--">hasNextPage</a></span>()</code>
<div class="block">Returns true if there is a next page and false otherwise.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#hasPreviousPage--">hasPreviousPage</a></span>()</code>
<div class="block">Returns true if there is a previous page and false otherwise.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#isFirstPage--">isFirstPage</a></span>()</code>
<div class="block">Returns whether the current page is the first one.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#isLastPage--">isLastPage</a></span>()</code>
<div class="block">Returns whether the current page is the last one.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#removePageChangedListener-org.eclipse.nebula.widgets.pagination.IPageChangedListener-">removePageChangedListener</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pagination/IPageChangedListener.html" title="interface in org.eclipse.nebula.widgets.pagination">IPageChangedListener</a>&nbsp;listener)</code>
<div class="block">Removes the listener from the collection of listeners who will be
notified when page controller changed ( the current page page size, total
elements or sort change.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#reset--">reset</a></span>()</code>
<div class="block">Reset the current page index and force the fire events of page index
changed.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#setCurrentPage-int-">setCurrentPage</a></span>(int&nbsp;currentPage)</code>
<div class="block">Set the current page index and fire events if the given page index is
different from the current page index.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#setLocale-java.util.Locale-">setLocale</a></span>(java.util.Locale&nbsp;locale)</code>
<div class="block">Set the local for the resources.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#setPageSize-int-">setPageSize</a></span>(int&nbsp;pageSize)</code>
<div class="block">Set the page size and fire events if the given page size is different
from the current page size.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#setSort-java.lang.String-int-">setSort</a></span>(java.lang.String&nbsp;propertyName,
int&nbsp;sortDirection)</code>
<div class="block">Set the sort and fire events if the given sort is different from the
current sort.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#setTotalElements-long-">setTotalElements</a></span>(long&nbsp;totalElements)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_PAGE_INDEX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_PAGE_INDEX</h4>
<pre>public static final&nbsp;int DEFAULT_PAGE_INDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.pagination.PageableController.DEFAULT_PAGE_INDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_PAGE_SIZE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_PAGE_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_PAGE_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.pagination.PageableController.DEFAULT_PAGE_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PageableController--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PageableController</h4>
<pre>public&nbsp;PageableController()</pre>
<div class="block">Constructor with default page size.</div>
</li>
</ul>
<a name="PageableController-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PageableController</h4>
<pre>public&nbsp;PageableController(int&nbsp;pageSize)</pre>
<div class="block">Constructor with page size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageSize</code> - size of the page (number items displayed per page).</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addPageChangedListener-org.eclipse.nebula.widgets.pagination.IPageChangedListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPageChangedListener</h4>
<pre>public&nbsp;void&nbsp;addPageChangedListener(<a href="../../../../../org/eclipse/nebula/widgets/pagination/IPageChangedListener.html" title="interface in org.eclipse.nebula.widgets.pagination">IPageChangedListener</a>&nbsp;listener)</pre>
<div class="block">Adds the listener to the collection of listeners who will be notified
when the page controller changed ( the current page page size, total
elements or sort change.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener which should be notified when the controller
change.</dd>
<dd><code>listener</code> - </dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/pagination/IPageChangedListener.html" title="interface in org.eclipse.nebula.widgets.pagination"><code>IPageChangedListener</code></a>,
<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#removePageChangedListener-org.eclipse.nebula.widgets.pagination.IPageChangedListener-"><code>removePageChangedListener(IPageChangedListener)</code></a></dd>
</dl>
</li>
</ul>
<a name="removePageChangedListener-org.eclipse.nebula.widgets.pagination.IPageChangedListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePageChangedListener</h4>
<pre>public&nbsp;void&nbsp;removePageChangedListener(<a href="../../../../../org/eclipse/nebula/widgets/pagination/IPageChangedListener.html" title="interface in org.eclipse.nebula.widgets.pagination">IPageChangedListener</a>&nbsp;listener)</pre>
<div class="block">Removes the listener from the collection of listeners who will be
notified when page controller changed ( the current page page size, total
elements or sort change.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener which should no longer be notified</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/nebula/widgets/pagination/IPageChangedListener.html" title="interface in org.eclipse.nebula.widgets.pagination"><code>IPageChangedListener</code></a>,
<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html#addPageChangedListener-org.eclipse.nebula.widgets.pagination.IPageChangedListener-"><code>addPageChangedListener(IPageChangedListener)</code></a></dd>
</dl>
</li>
</ul>
<a name="hasPreviousPage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPreviousPage</h4>
<pre>public&nbsp;boolean&nbsp;hasPreviousPage()</pre>
<div class="block">Returns true if there is a previous page and false otherwise.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there is a previous page and false otherwise.</dd>
</dl>
</li>
</ul>
<a name="isFirstPage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFirstPage</h4>
<pre>public&nbsp;boolean&nbsp;isFirstPage()</pre>
<div class="block">Returns whether the current page is the first one.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="hasNextPage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNextPage</h4>
<pre>public&nbsp;boolean&nbsp;hasNextPage()</pre>
<div class="block">Returns true if there is a next page and false otherwise.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there is a next page and false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getCurrentPage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentPage</h4>
<pre>public&nbsp;int&nbsp;getCurrentPage()</pre>
<div class="block">Returns the current page index.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="setCurrentPage-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCurrentPage</h4>
<pre>public&nbsp;void&nbsp;setCurrentPage(int&nbsp;currentPage)</pre>
<div class="block">Set the current page index and fire events if the given page index is
different from the current page index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentPage</code> - new current page index.</dd>
</dl>
</li>
</ul>
<a name="getPageSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageSize</h4>
<pre>public&nbsp;int&nbsp;getPageSize()</pre>
<div class="block">Returns the page size: number items to display per page.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="setPageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageSize</h4>
<pre>public&nbsp;void&nbsp;setPageSize(int&nbsp;pageSize)</pre>
<div class="block">Set the page size and fire events if the given page size is different
from the current page size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageSize</code> - page size: number items to display per page.</dd>
</dl>
</li>
</ul>
<a name="getTotalPages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalPages</h4>
<pre>public&nbsp;int&nbsp;getTotalPages()</pre>
<div class="block">Returns the total pages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="isLastPage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLastPage</h4>
<pre>public&nbsp;boolean&nbsp;isLastPage()</pre>
<div class="block">Returns whether the current page is the last one.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="setTotalElements-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTotalElements</h4>
<pre>public&nbsp;void&nbsp;setTotalElements(long&nbsp;totalElements)</pre>
</li>
</ul>
<a name="getTotalElements--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalElements</h4>
<pre>public&nbsp;long&nbsp;getTotalElements()</pre>
<div class="block">Returns the total elements.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getPageOffset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageOffset</h4>
<pre>public&nbsp;int&nbsp;getPageOffset()</pre>
<div class="block">Returns the current page offset.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="setSort-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSort</h4>
<pre>public&nbsp;void&nbsp;setSort(java.lang.String&nbsp;propertyName,
int&nbsp;sortDirection)</pre>
<div class="block">Set the sort and fire events if the given sort is different from the
current sort.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propertyName</code> - the sort property name.</dd>
<dd><code>sortDirection</code> - the sort direction <code>SWT.UP</code>, <code>SWT.DOWN</code>.</dd>
</dl>
</li>
</ul>
<a name="getSortPropertyName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortPropertyName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSortPropertyName()</pre>
<div class="block">Returns the property name used to sort.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sort property name.</dd>
</dl>
</li>
</ul>
<a name="getSortDirection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortDirection</h4>
<pre>public&nbsp;int&nbsp;getSortDirection()</pre>
<div class="block">Returns the sort direction <code>SWT.UP</code>, <code>SWT.DOWN</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block">Reset the current page index and force the fire events of page index
changed.</div>
</li>
</ul>
<a name="setLocale-java.util.Locale-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setLocale</h4>
<pre>public&nbsp;void&nbsp;setLocale(java.util.Locale&nbsp;locale)</pre>
<div class="block">Set the local for the resources.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locale</code> - </dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PageableController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/nebula/widgets/pagination/LazyItemsSelectionListener.html" title="class in org.eclipse.nebula.widgets.pagination"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/nebula/widgets/pagination/PageChangedAdapter.html" title="class in org.eclipse.nebula.widgets.pagination"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/nebula/widgets/pagination/PageableController.html" target="_top">Frames</a></li>
<li><a href="PageableController.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>