view release on metacpan or  search on metacpan

doc/html/Paginator.html  view on Meta::CPAN

<div id='TN_tree'>
  <div class="TN_node">
   <h1 class="TN_label">Alien::GvaScript::Paginator</h1>
   <div class="TN_content">
     <p><em>API for data pagination
</em></p>
     <div class="TN_node"  onPing="jumpto_href">
       <h3 class="TN_label">Table of contents</h3>
       <div class="TN_content">
         <div class="TN_leaf">
  <a class="TN_label" href="#NAME">NAME</a>
  <div class="TN_content"></div>
</div>
<div class="TN_leaf">
  <a class="TN_label" href="#SYNOPSIS">SYNOPSIS</a>
  <div class="TN_content"></div>
</div>
<div class="TN_node">
  <a class="TN_label" href="#DESCRIPTION">DESCRIPTION</a>
  <div class="TN_content"><div class="TN_leaf">
  <a class="TN_label" href="#Pagination_Parameters">Pagination Parameters</a>
  <div class="TN_content"></div>
</div>
<div class="TN_node">
  <a class="TN_label" href="#Navigation_Links">Navigation Links</a>
  <div class="TN_content"><div class="TN_leaf">
  <a class="TN_label" href="#HTML">HTML</a>
  <div class="TN_content"></div>
</div>
<div class="TN_leaf">
  <a class="TN_label" href="#CSS">CSS</a>
  <div class="TN_content"></div>
</div>
</div>
</div>
</div>
</div>
<div class="TN_node">
  <a class="TN_label" href="#Programming_Interface">Programming Interface</a>
  <div class="TN_content"><div class="TN_node">
  <a class="TN_label" href="#Methods">Methods</a>
  <div class="TN_content"><div class="TN_leaf">
  <a class="TN_label" href="#new_GvaScript_Paginator">new GvaScript.Paginator</a>
  <div class="TN_content"></div>
</div>
<div class="TN_leaf">
  <a class="TN_label" href="#Flipping_the_Pages">Flipping the Pages</a>
  <div class="TN_content"></div>
</div>
<div class="TN_leaf">
  <a class="TN_label" href="#destroy">destroy</a>
  <div class="TN_content"></div>
</div>
</div>
</div>
</div>
</div>

       </div>
     </div>
     <hr/>
   </div>
  </div>
  <div class="TN_node" id="NAME">
    <h2 class="TN_label">NAME</h2>
    <div class="TN_content">
      <p>Alien::GvaScript::Paginator - API for data pagination</p>

    </div>
  </div>
  <div class="TN_node" id="SYNOPSIS">
    <h2 class="TN_label">SYNOPSIS</h2>
    <div class="TN_content">
      <pre>  var url = '/app/my/paginated/data';
  var mypaginator = new GvaScript.Paginator(url, {
    list_container  : 'list_result_container', 
    links_container : 'pagination_links_container'

    onSuccess   : onSuccessHandler,
    parameters  : {param1: 'val1', param2: 'val2'},
    step        : 20
  }</pre>


    </div>
  </div>
  <div class="TN_node" id="DESCRIPTION">
    <h2 class="TN_label">DESCRIPTION</h2>
    <div class="TN_content">
      <p>Paginated data is a set of data that can be divided into differnent pages. 
It is best described as a list of items that overflow one page and best presented in several pages.
The Paginator Object is used in this case to manage retrieval (through AJAX Requests) and handling (through an onSuccess handler).
It also will take care of creating the navigation links (first, prev, next, last) and rendering them into provided container.
Navigation links are used for an on demand <i>page flipping</i>.</p>
<p>Data will be requested using an HTTP call to a provided URL.
Data Index and Size are decided using <code>INDEX</code> and <code>STEP</code> parameters respectively. 
It is up to you to make use of these parameters to decide on the items to display.</p>
  <div class="TN_node" id="Pagination_Parameters">
    <h3 class="TN_label">Pagination Parameters</h3>
    <div class="TN_content">
      <p>The Paginator Object will manage the 2 request parameters</p>
<ul>
<li><a name="item__code_INDEX__code__start_index_of_items_to_retrieve"></a><b><code>INDEX</code> start index of items to retrieve</b>
</li>
<li><a name="item__code_STEP__code___number_if_items_to_include_per_page"></a><b><code>STEP</code>  number if items to include per page</b>
<p>These two parameters would help you in deciding which part of the dataset to return.</p>
</li>
</ul>

    </div>
  </div>
  <div class="TN_node" id="Navigation_Links">
    <h3 class="TN_label">Navigation Links</h3>
    <div class="TN_content">
      <p>Navigation links are the icons used to navigate through pages (page flipping). Along with icons, a 
text with start-to-end index of displayed records / number of total records is displayed.</p>
  <div class="TN_node" id="HTML">
    <h4 class="TN_label">HTML</h4>
    <div class="TN_content">
      <pre>  &lt;div class="gva-paginatorbar"&gt;
    &lt;div title="Derni&#xe8;re page" class="last"/&gt;