[Sommaire] [Imprimer]

   1  <?xml version="1.0" encoding="iso-8859-1"?>
   2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3    <html xmlns="http://www.w3.org/1999/xhtml">
   4          <head>
   5              <!-- template designed by Marco Von Ballmoos -->
   6              <title>Docs For Class TPagedListFetchDataEventParameter</title>
   7              <link rel="stylesheet" href="../media/stylesheet.css" />
   8              <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9          </head>
  10          <body>
  11              <div class="page-body">            
  12  <h2 class="class-name">Class TPagedListFetchDataEventParameter</h2>
  13  
  14  <a name="sec-description"></a>
  15  <div class="info-box">
  16      <div class="info-box-title">Description</div>
  17      <div class="nav-bar">
  18                      <span class="disabled">Description</span> |
  19                                                              <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                      </div>
  22      <div class="info-box-body">
  23                  <!-- ========== Info from phpDoc block ========= -->
  24  <p class="short-description">TPagedListFetchDataEventParameter class.</p>
  25  <p class="description"><p>TPagedListFetchDataEventParameter is used as the parameter for  TPagedList::onFetchData event.  To obtain the new page index, use <a href="../System.Collections/TPagedListFetchDataEventParameter.html#methodgetNewPageIndex">NewPageIndex</a>.  The <a href="../System.Collections/TPagedListFetchDataEventParameter.html#methodgetOffset">Offset</a> property refers to the index  of the first item in the new page, while <a href="../System.Collections/TPagedListFetchDataEventParameter.html#methodgetLimit">Limit</a>  specifies how many items are requested for the page.  Newly fetched data should be saved in <a href="../System.Collections/TPagedListFetchDataEventParameter.html#methodsetData">Data</a> property.</p></p>
  26      <ul class="tags">
  27                  <li><span class="field">since:</span> 3.0</li>
  28                  <li><span class="field">version:</span> $Id: TPagedList.php 1397 2006-09-07 07:55:53Z wei $</li>
  29                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  30              </ul>
  31          <p class="notes">
  32              Located in <a class="field" href="_Collections_TPagedList_php.html">/Collections/TPagedList.php</a> (line <span class="field">417</span>)
  33          </p>
  34          
  35                  
  36          <pre><a href="../System/TComponent.html">TComponent</a>
  37     |
  38     --<a href="../System/TEventParameter.html">TEventParameter</a>
  39        |
  40        --TPagedListFetchDataEventParameter</pre>
  41      
  42              </div>
  43  </div>
  44  
  45  
  46  
  47  
  48      <a name="sec-method-summary"></a>
  49      <div class="info-box">
  50          <div class="info-box-title">Method Summary</span></div>
  51          <div class="nav-bar">
  52              <a href="#sec-description">Description</a> |
  53                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  54          </div>
  55          <div class="info-box-body">            
  56              <div class="method-summary">
  57                                  
  58                  <div class="method-definition">
  59                                              <span class="method-result">TPagedListFetchDataEventParameter</span>
  60                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  61                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$pageIndex</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$limit</span>)
  62                                      </div>
  63                                  
  64                  <div class="method-definition">
  65                                              <span class="method-result">mixed</span>
  66                                          <a href="#getData" title="details" class="method-name">getData</a>
  67                                          ()
  68                                      </div>
  69                                  
  70                  <div class="method-definition">
  71                                              <span class="method-result">integer</span>
  72                                          <a href="#getLimit" title="details" class="method-name">getLimit</a>
  73                                          ()
  74                                      </div>
  75                                  
  76                  <div class="method-definition">
  77                                              <span class="method-result">integer</span>
  78                                          <a href="#getNewPageIndex" title="details" class="method-name">getNewPageIndex</a>
  79                                          ()
  80                                      </div>
  81                                  
  82                  <div class="method-definition">
  83                                              <span class="method-result">integer</span>
  84                                          <a href="#getOffset" title="details" class="method-name">getOffset</a>
  85                                          ()
  86                                      </div>
  87                                  
  88                  <div class="method-definition">
  89                                              <span class="method-result">void</span>
  90                                          <a href="#setData" title="details" class="method-name">setData</a>
  91                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
  92                                      </div>
  93                              </div>
  94          </div>
  95      </div>        
  96  
  97      
  98      <a name="sec-methods"></a>
  99      <div class="info-box">
 100          <div class="info-box-title">Methods</div>
 101          <div class="nav-bar">
 102              <a href="#sec-description">Description</a> |
 103                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 104                          
 105          </div>
 106          <div class="info-box-body">
 107              <A NAME='method_detail'></A>
 108  <a name="method__construct" id="__construct"><!-- --></a>
 109  <div class="oddrow">
 110      
 111      <div class="method-header">
 112          <span class="method-title">Constructor __construct</span> (line <span class="line-number">430</span>)
 113      </div> 
 114      
 115      <!-- ========== Info from phpDoc block ========= -->
 116  <p class="short-description">Constructor.</p>
 117      <ul class="tags">
 118                  <li><span class="field">access:</span> public</li>
 119              </ul>
 120      
 121      <div class="method-signature">
 122          <span class="method-result">TPagedListFetchDataEventParameter</span>
 123          <span class="method-name">
 124              __construct
 125          </span>
 126                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$pageIndex</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$offset</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$limit</span>)
 127              </div>
 128      
 129              <ul class="parameters">
 130                      <li>
 131                  <span class="var-type">integer</span>
 132                  <span class="var-name">$pageIndex</span><span class="var-description">: new page index</span>            </li>
 133                      <li>
 134                  <span class="var-type">integer</span>
 135                  <span class="var-name">$offset</span><span class="var-description">: offset of the first item in the new page</span>            </li>
 136                      <li>
 137                  <span class="var-type">integer</span>
 138                  <span class="var-name">$limit</span><span class="var-description">: number of items in the new page desired</span>            </li>
 139                  </ul>
 140          
 141          
 142      </div>
 143  <a name="methodgetData" id="getData"><!-- --></a>
 144  <div class="evenrow">
 145      
 146      <div class="method-header">
 147          <span class="method-title">getData</span> (line <span class="line-number">464</span>)
 148      </div> 
 149      
 150      <!-- ========== Info from phpDoc block ========= -->
 151      <ul class="tags">
 152                  <li><span class="field">return:</span> new page data</li>
 153                  <li><span class="field">access:</span> public</li>
 154              </ul>
 155      
 156      <div class="method-signature">
 157          <span class="method-result">mixed</span>
 158          <span class="method-name">
 159              getData
 160          </span>
 161                  ()
 162              </div>
 163      
 164          
 165          
 166      </div>
 167  <a name="methodgetLimit" id="getLimit"><!-- --></a>
 168  <div class="oddrow">
 169      
 170      <div class="method-header">
 171          <span class="method-title">getLimit</span> (line <span class="line-number">456</span>)
 172      </div> 
 173      
 174      <!-- ========== Info from phpDoc block ========= -->
 175      <ul class="tags">
 176                  <li><span class="field">return:</span> number of items in the new page</li>
 177                  <li><span class="field">access:</span> public</li>
 178              </ul>
 179      
 180      <div class="method-signature">
 181          <span class="method-result">integer</span>
 182          <span class="method-name">
 183              getLimit
 184          </span>
 185                  ()
 186              </div>
 187      
 188          
 189          
 190      </div>
 191  <a name="methodgetNewPageIndex" id="getNewPageIndex"><!-- --></a>
 192  <div class="evenrow">
 193      
 194      <div class="method-header">
 195          <span class="method-title">getNewPageIndex</span> (line <span class="line-number">440</span>)
 196      </div> 
 197      
 198      <!-- ========== Info from phpDoc block ========= -->
 199      <ul class="tags">
 200                  <li><span class="field">return:</span> the zero-based index of the new page</li>
 201                  <li><span class="field">access:</span> public</li>
 202              </ul>
 203      
 204      <div class="method-signature">
 205          <span class="method-result">integer</span>
 206          <span class="method-name">
 207              getNewPageIndex
 208          </span>
 209                  ()
 210              </div>
 211      
 212          
 213          
 214      </div>
 215  <a name="methodgetOffset" id="getOffset"><!-- --></a>
 216  <div class="oddrow">
 217      
 218      <div class="method-header">
 219          <span class="method-title">getOffset</span> (line <span class="line-number">448</span>)
 220      </div> 
 221      
 222      <!-- ========== Info from phpDoc block ========= -->
 223      <ul class="tags">
 224                  <li><span class="field">return:</span> offset of the first item in the new page</li>
 225                  <li><span class="field">access:</span> public</li>
 226              </ul>
 227      
 228      <div class="method-signature">
 229          <span class="method-result">integer</span>
 230          <span class="method-name">
 231              getOffset
 232          </span>
 233                  ()
 234              </div>
 235      
 236          
 237          
 238      </div>
 239  <a name="methodsetData" id="setData"><!-- --></a>
 240  <div class="evenrow">
 241      
 242      <div class="method-header">
 243          <span class="method-title">setData</span> (line <span class="line-number">472</span>)
 244      </div> 
 245      
 246      <!-- ========== Info from phpDoc block ========= -->
 247      <ul class="tags">
 248                  <li><span class="field">access:</span> public</li>
 249              </ul>
 250      
 251      <div class="method-signature">
 252          <span class="method-result">void</span>
 253          <span class="method-name">
 254              setData
 255          </span>
 256                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
 257              </div>
 258      
 259              <ul class="parameters">
 260                      <li>
 261                  <span class="var-type">mixed</span>
 262                  <span class="var-name">$value</span><span class="var-description">: new page data</span>            </li>
 263                  </ul>
 264          
 265          
 266      </div>
 267                              <h4>Inherited Methods</h4>
 268                  <a name='inherited_methods'><!-- --></a>    
 269                                      <!-- =========== Summary =========== -->
 270                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 271                      <blockquote>
 272                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 273                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 274                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 275                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 276                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 277                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 278                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 279                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 280                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 281                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 282                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 283                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 284                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 285                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 286                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 287                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 288                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 289                                              </blockquote>
 290                                          
 291          </div>
 292      </div>
 293  
 294  
 295      <p class="notes" id="credit">
 296          Documentation generated on Mon, 04 Dec 2006 11:27:15 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 297      </p>
 298      </div></body>
 299  </html>