Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / f998bb2b16354fd59b8a5b5c8f47d9f4a3020c64 / . / releases / 2.4.2 / javadoc / org / eclipse / nebula / widgets / pagination / PaginationHelper.html
blob: 48c5f0b61736b8987925b3e848a9215e2a64798f [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:47 CEST 2020 -->
<title>PaginationHelper</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="PaginationHelper";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/PaginationHelper.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/PageLoaderStrategyHelper.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/Resources.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/PaginationHelper.html" target="_top">Frames</a></li>
<li><a href="PaginationHelper.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 PaginationHelper" class="title">Class PaginationHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.nebula.widgets.pagination.PaginationHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PaginationHelper</span>
extends java.lang.Object</pre>
<div class="block">Pagination Utilities.</div>
</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/PaginationHelper.html#SEPARATOR">SEPARATOR</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/PaginationHelper.html#PaginationHelper--">PaginationHelper</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PaginationHelper.html#getController-org.eclipse.swt.widgets.Widget-">getController</a></span>(org.eclipse.swt.widgets.Widget&nbsp;widget)</code>
<div class="block">Returns the attached <a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination"><code>PageableController</code></a> to the given widget.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static int[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PaginationHelper.html#getPageIndexes-int-int-int-">getPageIndexes</a></span>(int&nbsp;currentPageIndex,
int&nbsp;totalPages,
int&nbsp;nbMax)</code>
<div class="block">Returns an array of int with the page indexes for the given
currentPageIndex, totalPages abd nbMax.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PaginationHelper.html#getPageText-int-int-java.util.Locale-">getPageText</a></span>(int&nbsp;pageIndex,
int&nbsp;totalPage,
java.util.Locale&nbsp;locale)</code>
<div class="block">urns the page text (ex : Page 1/2).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PaginationHelper.html#getResultsText-int-int-long-org.eclipse.nebula.widgets.pagination.PageableController-java.lang.String-">getResultsText</a></span>(int&nbsp;start,
int&nbsp;end,
long&nbsp;total,
<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller,
java.lang.String&nbsp;resultsMessage)</code>
<div class="block">Returns the results text (ex: "Results 1-5 of 10") for the given
pagination information start, end and total.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PaginationHelper.html#getResultsText-org.eclipse.nebula.widgets.pagination.PageableController-java.util.Locale-">getResultsText</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller,
java.util.Locale&nbsp;locale)</code>
<div class="block">Returns the results text (ex: "Results 1-5 of 10") for the given
pagination controller.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PaginationHelper.html#getResultsText-org.eclipse.nebula.widgets.pagination.PageableController-java.lang.String-">getResultsText</a></span>(<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller,
java.lang.String&nbsp;resultsMessage)</code>
<div class="block">Returns the results text (ex: "Results 1-5 of 10") for the given
pagination controller.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/nebula/widgets/pagination/PaginationHelper.html#setController-org.eclipse.swt.widgets.Widget-org.eclipse.nebula.widgets.pagination.PageableController-">setController</a></span>(org.eclipse.swt.widgets.Widget&nbsp;widget,
<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller)</code>
<div class="block">Attach the given <a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination"><code>PageableController</code></a> to the given widget.</div>
</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="SEPARATOR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SEPARATOR</h4>
<pre>public static final&nbsp;int SEPARATOR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.nebula.widgets.pagination.PaginationHelper.SEPARATOR">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="PaginationHelper--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PaginationHelper</h4>
<pre>public&nbsp;PaginationHelper()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPageIndexes-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageIndexes</h4>
<pre>public static&nbsp;int[]&nbsp;getPageIndexes(int&nbsp;currentPageIndex,
int&nbsp;totalPages,
int&nbsp;nbMax)</pre>
<div class="block">Returns an array of int with the page indexes for the given
currentPageIndex, totalPages abd nbMax.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentPageIndex</code> - </dd>
<dd><code>totalPages</code> - </dd>
<dd><code>nbMax</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getController-org.eclipse.swt.widgets.Widget-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getController</h4>
<pre>public static&nbsp;<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;getController(org.eclipse.swt.widgets.Widget&nbsp;widget)</pre>
<div class="block">Returns the attached <a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination"><code>PageableController</code></a> to the given widget.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>widget</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="setController-org.eclipse.swt.widgets.Widget-org.eclipse.nebula.widgets.pagination.PageableController-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setController</h4>
<pre>public static&nbsp;void&nbsp;setController(org.eclipse.swt.widgets.Widget&nbsp;widget,
<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller)</pre>
<div class="block">Attach the given <a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination"><code>PageableController</code></a> to the given widget.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>widget</code> - </dd>
<dd><code>controller</code> - </dd>
</dl>
</li>
</ul>
<a name="getResultsText-org.eclipse.nebula.widgets.pagination.PageableController-java.util.Locale-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultsText</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getResultsText(<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller,
java.util.Locale&nbsp;locale)</pre>
<div class="block">Returns the results text (ex: "Results 1-5 of 10") for the given
pagination controller. The given locale is used to translate the results
text.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>controller</code> - the pagination controller.</dd>
<dd><code>locale</code> - the locale.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getResultsText-org.eclipse.nebula.widgets.pagination.PageableController-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultsText</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getResultsText(<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller,
java.lang.String&nbsp;resultsMessage)</pre>
<div class="block">Returns the results text (ex: "Results 1-5 of 10") for the given
pagination controller. The resultsMessage (ex: "Results {0}-{1} of {2}")
is used to compute the text.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>controller</code> - the pagination controller.</dd>
<dd><code>resultsMessage</code> - the results message.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getResultsText-int-int-long-org.eclipse.nebula.widgets.pagination.PageableController-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultsText</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getResultsText(int&nbsp;start,
int&nbsp;end,
long&nbsp;total,
<a href="../../../../../org/eclipse/nebula/widgets/pagination/PageableController.html" title="class in org.eclipse.nebula.widgets.pagination">PageableController</a>&nbsp;controller,
java.lang.String&nbsp;resultsMessage)</pre>
<div class="block">Returns the results text (ex: "Results 1-5 of 10") for the given
pagination information start, end and total. The resultsMessage (ex:
"Results {0}-{1} of {2}") is used to compute the text.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - first page offset.</dd>
<dd><code>end</code> - last page offset</dd>
<dd><code>total</code> - total elements.</dd>
<dd><code>controller</code> - </dd>
<dd><code>resultsMessage</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getPageText-int-int-java.util.Locale-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPageText</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getPageText(int&nbsp;pageIndex,
int&nbsp;totalPage,
java.util.Locale&nbsp;locale)</pre>
<div class="block">urns the page text (ex : Page 1/2).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageIndex</code> - the page index.</dd>
<dd><code>totalPage</code> - the total page.</dd>
<dd><code>locale</code> - the locale.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
</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/PaginationHelper.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/PageLoaderStrategyHelper.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/Resources.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/PaginationHelper.html" target="_top">Frames</a></li>
<li><a href="PaginationHelper.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>