docs/api/awl/DataEntry/EntryForm.html

   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 EntryForm</title>
   7                         <link rel="stylesheet" href="../../media/stylesheet.css" />
   8                                                 <script src="../../media/lib/classTree.js"></script>
   9                                                                                                 <script language="javascript" type="text/javascript">
  10                                 var imgPlus = new Image();
  11                                 var imgMinus = new Image();
  12                                 imgPlus.src = "../../media/images/plus.png";
  13                                 imgMinus.src = "../../media/images/minus.png";
  14
  15                                 function showNode(Node){
  16                                                         switch(navigator.family){
  17                                                                 case 'nn4':
  18                                                                         // Nav 4.x code fork...
  19                                                         var oTable = document.layers["span" + Node];
  20                                                         var oImg = document.layers["img" + Node];
  21                                                                         break;
  22                                                                 case 'ie4':
  23                                                                         // IE 4/5 code fork...
  24                                                         var oTable = document.all["span" + Node];
  25                                                         var oImg = document.all["img" + Node];
  26                                                                         break;
  27                                                                 case 'gecko':
  28                                                                         // Standards Compliant code fork...
  29                                                         var oTable = document.getElementById("span" + Node);
  30                                                         var oImg = document.getElementById("img" + Node);
  31                                                                         break;
  32                                                         }
  33                                         oImg.src = imgMinus.src;
  34                                         oTable.style.display = "block";
  35                                 }
  36
  37                                 function hideNode(Node){
  38                                                         switch(navigator.family){
  39                                                                 case 'nn4':
  40                                                                         // Nav 4.x code fork...
  41                                                         var oTable = document.layers["span" + Node];
  42                                                         var oImg = document.layers["img" + Node];
  43                                                                         break;
  44                                                                 case 'ie4':
  45                                                                         // IE 4/5 code fork...
  46                                                         var oTable = document.all["span" + Node];
  47                                                         var oImg = document.all["img" + Node];
  48                                                                         break;
  49                                                                 case 'gecko':
  50                                                                         // Standards Compliant code fork...
  51                                                         var oTable = document.getElementById("span" + Node);
  52                                                         var oImg = document.getElementById("img" + Node);
  53                                                                         break;
  54                                                         }
  55                                         oImg.src = imgPlus.src;
  56                                         oTable.style.display = "none";
  57                                 }
  58
  59                                 function nodeIsVisible(Node){
  60                                                         switch(navigator.family){
  61                                                                 case 'nn4':
  62                                                                         // Nav 4.x code fork...
  63                                                         var oTable = document.layers["span" + Node];
  64                                                                         break;
  65                                                                 case 'ie4':
  66                                                                         // IE 4/5 code fork...
  67                                                         var oTable = document.all["span" + Node];
  68                                                                         break;
  69                                                                 case 'gecko':
  70                                                                         // Standards Compliant code fork...
  71                                                         var oTable = document.getElementById("span" + Node);
  72                                                                         break;
  73                                                         }
  74                                         return (oTable && oTable.style.display == "block");
  75                                 }
  76
  77                                 function toggleNodeVisibility(Node){
  78                                         if (nodeIsVisible(Node)){
  79                                                 hideNode(Node);
  80                                         }else{
  81                                                 showNode(Node);
  82                                         }
  83                                 }
  84                         </script>
  85                                         </head>
  86                 <body>
  87                         <div class="page-body">
  88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
  89                                                                                                                 alt=" Class"
  90                                                                                                                 title=" Class"
  91                                                                                                                 style="vertical-align: middle"> EntryForm</h2>
  92
  93 <a name="sec-description"></a>
  94 <div class="info-box">
  95         <div class="info-box-title">Description</div>
  96         <div class="nav-bar">
  97                                         <span class="disabled">Description</span> |
  98                                                                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  99
 100                                         </div>
 101         <div class="info-box-body">
 102                         <!-- ========== Info from phpDoc block ========= -->
 103 <p class="short-description">A class to handle displaying a form on the page (for editing) or a structured  layout of non-editable content (for viewing), with a simple switch to flip from  view mode to edit mode.</p>
 104                 <p class="notes">
 105                         Located in <a class="field" href="_DataEntry.php.html">/DataEntry.php</a> (line <span class="field">334</span>)
 106                 </p>
 107
 108
 109                 <pre></pre>
 110
 111                         </div>
 112 </div>
 113
 114
 115
 116
 117         <a name="sec-method-summary"></a>
 118         <div class="info-box">
 119                 <div class="info-box-title">Method Summary</span></div>
 120                 <div class="nav-bar">
 121                         <a href="#sec-description">Description</a> |
 122                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 123                 </div>
 124                 <div class="info-box-body">
 125                         <div class="method-summary">
 126
 127                                 <div class="method-definition">
 128                                         <img src="../../media/images/StaticMethod.png" alt=" "/>
 129                                         static                                          <span class="method-result">string</span>
 130                                                                                 <a href="#_ParseAttributes" title="details" class="method-name">_ParseAttributes</a>
 131                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 132                                                                         </div>
 133
 134                                 <div class="method-definition">
 135                                         <img src="../../media/images/Constructor.png" alt=" "/>
 136                                                                                         <span class="method-result">EntryForm</span>
 137                                                                                 <a href="#EntryForm" title="details" class="method-name">EntryForm</a>
 138                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$editing</span> = <span class="var-default">false</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$editmode</span>)
 139                                                                         </div>
 140
 141                                 <div class="method-definition">
 142                                         <img src="../../media/images/Method.png" alt=" "/>
 143                                                                                         <span class="method-result">string</span>
 144                                                                                 <a href="#BreakLine" title="details" class="method-name">BreakLine</a>
 145                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">''</span>])
 146                                                                         </div>
 147
 148                                 <div class="method-definition">
 149                                         <img src="../../media/images/Method.png" alt=" "/>
 150                                                                                         <span class="method-result">string</span>
 151                                                                                 <a href="#DataEntryField" title="details" class="method-name">DataEntryField</a>
 152                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$base_fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 153                                                                         </div>
 154
 155                                 <div class="method-definition">
 156                                         <img src="../../media/images/Method.png" alt=" "/>
 157                                                                                         <span class="method-result">string</span>
 158                                                                                 <a href="#DataEntryLine" title="details" class="method-name">DataEntryLine</a>
 159                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$field_format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 160                                                                         </div>
 161
 162                                 <div class="method-definition">
 163                                         <img src="../../media/images/Method.png" alt=" "/>
 164                                                                                         <span class="method-result">string</span>
 165                                                                                 <a href="#EndForm" title="details" class="method-name">EndForm</a>
 166                                                                                 ()
 167                                                                         </div>
 168
 169                                 <div class="method-definition">
 170                                         <img src="../../media/images/Method.png" alt=" "/>
 171                                                                                         <span class="method-result">void</span>
 172                                                                                 <a href="#HelpInCell" title="details" class="method-name">HelpInCell</a>
 173                                                                                 ()
 174                                                                         </div>
 175
 176                                 <div class="method-definition">
 177                                         <img src="../../media/images/Method.png" alt=" "/>
 178                                                                                         <span class="method-result">void</span>
 179                                                                                 <a href="#HelpInLine" title="details" class="method-name">HelpInLine</a>
 180                                                                                 ()
 181                                                                         </div>
 182
 183                                 <div class="method-definition">
 184                                         <img src="../../media/images/Method.png" alt=" "/>
 185                                                                                         <span class="method-result">string</span>
 186                                                                                 <a href="#HiddenField" title="details" class="method-name">HiddenField</a>
 187                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvaluei</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fid</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fvalue</span>)
 188                                                                         </div>
 189
 190                                 <div class="method-definition">
 191                                         <img src="../../media/images/Method.png" alt=" "/>
 192                                                                                         <span class="method-result">string</span>
 193                                                                                 <a href="#MultiEntryLine" title="details" class="method-name">MultiEntryLine</a>
 194                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt_options</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prompt_name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$default_prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span>)
 195                                                                         </div>
 196
 197                                 <div class="method-definition">
 198                                         <img src="../../media/images/Method.png" alt=" "/>
 199                                                                                         <span class="method-result">void</span>
 200                                                                                 <a href="#NoHelp" title="details" class="method-name">NoHelp</a>
 201                                                                                 ()
 202                                                                         </div>
 203
 204                                 <div class="method-definition">
 205                                         <img src="../../media/images/Method.png" alt=" "/>
 206                                                                                         <span class="method-result">void</span>
 207                                                                                 <a href="#PopulateForm" title="details" class="method-name">PopulateForm</a>
 208                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>)
 209                                                                         </div>
 210
 211                                 <div class="method-definition">
 212                                         <img src="../../media/images/Method.png" alt=" "/>
 213                                                                                         <span class="method-result">void</span>
 214                                                                                 <a href="#RevertLineFormat" title="details" class="method-name">RevertLineFormat</a>
 215                                                                                 ()
 216                                                                         </div>
 217
 218                                 <div class="method-definition">
 219                                         <img src="../../media/images/Method.png" alt=" "/>
 220                                                                                         <span class="method-result">void</span>
 221                                                                                 <a href="#SimpleForm" title="details" class="method-name">SimpleForm</a>
 222                                                                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 223                                                                         </div>
 224
 225                                 <div class="method-definition">
 226                                         <img src="../../media/images/Method.png" alt=" "/>
 227                                                                                         <span class="method-result">string</span>
 228                                                                                 <a href="#StartForm" title="details" class="method-name">StartForm</a>
 229                                                                                         ([<span class="var-type">array</span>&nbsp;<span class="var-name">$extra_attributes</span> = <span class="var-default">''</span>])
 230                                                                         </div>
 231
 232                                 <div class="method-definition">
 233                                         <img src="../../media/images/Method.png" alt=" "/>
 234                                                                                         <span class="method-result">string</span>
 235                                                                                 <a href="#SubmitButton" title="details" class="method-name">SubmitButton</a>
 236                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvalue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 237                                                                         </div>
 238
 239                                 <div class="method-definition">
 240                                         <img src="../../media/images/Method.png" alt=" "/>
 241                                                                                         <span class="method-result">void</span>
 242                                                                                 <a href="#TempLineFormat" title="details" class="method-name">TempLineFormat</a>
 243                                                                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 244                                                                         </div>
 245                                                                                                                                                         </div>
 246                 </div>
 247         </div>
 248
 249
 250         <a name="sec-methods"></a>
 251         <div class="info-box">
 252                 <div class="info-box-title">Methods</div>
 253                 <div class="nav-bar">
 254                         <a href="#sec-description">Description</a> |
 255                                                                                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 256
 257                 </div>
 258                 <div class="info-box-body">
 259                         <A NAME='method_detail'></A>
 260 <a name="method_ParseAttributes" id="_ParseAttributes"><!-- --></a>
 261 <div class="evenrow">
 262
 263         <div class="method-header">
 264                 <img src="../../media/images/StaticMethod.png" />
 265                 <span class="method-title">static _ParseAttributes</span> (line <span class="line-number">532</span>)
 266         </div>
 267
 268         <!-- ========== Info from phpDoc block ========= -->
 269 <p class="short-description">Internal function for parsing the type extra on a field.</p>
 270 <p class="description"><p>If the '_help' attribute is not set it will be assigned the value of  the 'title' attribute, if there is one.</p><p>If the 'class' attribute is not set it will be assigned to 'flookup',  'fselect', etc, according to the field type.</p></p>
 271         <ul class="tags">
 272                                 <li><span class="field">return:</span> The parsed type extra.</li>
 273                         </ul>
 274
 275         <div class="method-signature">
 276                 static <span class="method-result">string</span>
 277                 <span class="method-name">
 278                         _ParseAttributes
 279                 </span>
 280                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 281                         </div>
 282
 283                         <ul class="parameters">
 284                                         <li>
 285                                 <span class="var-type"></span>
 286                                 <span class="var-name">$ftype</span>                    </li>
 287                                         <li>
 288                                 <span class="var-type"></span>
 289                                 <span class="var-name">$attributes</span>                       </li>
 290                                 </ul>
 291
 292
 293         </div>
 294 <a name="methodEntryForm" id="EntryForm"><!-- --></a>
 295 <div class="oddrow">
 296
 297         <div class="method-header">
 298                 <img src="../../media/images/Constructor.png" />
 299                 <span class="method-title">Constructor EntryForm</span> (line <span class="line-number">394</span>)
 300         </div>
 301
 302         <!-- ========== Info from phpDoc block ========= -->
 303 <p class="short-description">Initialise a new data-entry form.</p>
 304
 305         <div class="method-signature">
 306                 <span class="method-result">EntryForm</span>
 307                 <span class="method-name">
 308                         EntryForm
 309                 </span>
 310                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$editing</span> = <span class="var-default">false</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$editmode</span>)
 311                         </div>
 312
 313                         <ul class="parameters">
 314                                         <li>
 315                                 <span class="var-type">string</span>
 316                                 <span class="var-name">$action</span><span class="var-description">: The action when the form is submitted.</span>                      </li>
 317                                         <li>
 318                                 <span class="var-type">objectref</span>
 319                                 <span class="var-name">$record</span><span class="var-description">: A reference to the database object we are displaying / editing.</span>                     </li>
 320                                         <li>
 321                                 <span class="var-type">boolean</span>
 322                                 <span class="var-name">$editmode</span><span class="var-description">: Whether we are editing.</span>                   </li>
 323                                         <li>
 324                                 <span class="var-type"></span>
 325                                 <span class="var-name">&$record</span>                  </li>
 326                                         <li>
 327                                 <span class="var-type"></span>
 328                                 <span class="var-name">$editing</span>                  </li>
 329                                 </ul>
 330
 331
 332         </div>
 333 <a name="methodBreakLine" id="BreakLine"><!-- --></a>
 334 <div class="evenrow">
 335
 336         <div class="method-header">
 337                 <img src="../../media/images/Method.png" />
 338                 <span class="method-title">BreakLine</span> (line <span class="line-number">504</span>)
 339         </div>
 340
 341         <!-- ========== Info from phpDoc block ========= -->
 342 <p class="short-description">A utility function for a heading line within a data entry table</p>
 343         <ul class="tags">
 344                                 <li><span class="field">return:</span> The HTML fragment to end the form.</li>
 345                         </ul>
 346
 347         <div class="method-signature">
 348                 <span class="method-result">string</span>
 349                 <span class="method-name">
 350                         BreakLine
 351                 </span>
 352                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">''</span>])
 353                         </div>
 354
 355                         <ul class="parameters">
 356                                         <li>
 357                                 <span class="var-type"></span>
 358                                 <span class="var-name">$text</span>                     </li>
 359                                 </ul>
 360
 361
 362         </div>
 363 <a name="methodDataEntryField" id="DataEntryField"><!-- --></a>
 364 <div class="oddrow">
 365
 366         <div class="method-header">
 367                 <img src="../../media/images/Method.png" />
 368                 <span class="method-title">DataEntryField</span> (line <span class="line-number">563</span>)
 369         </div>
 370
 371         <!-- ========== Info from phpDoc block ========= -->
 372 <p class="short-description">A utility function for a data entry line within a table</p>
 373         <ul class="tags">
 374                                 <li><span class="field">return:</span> The HTML fragment to display the data entry field</li>
 375                         </ul>
 376
 377         <div class="method-signature">
 378                 <span class="method-result">string</span>
 379                 <span class="method-name">
 380                         DataEntryField
 381                 </span>
 382                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$base_fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 383                         </div>
 384
 385                         <ul class="parameters">
 386                                         <li>
 387                                 <span class="var-type"></span>
 388                                 <span class="var-name">$format</span>                   </li>
 389                                         <li>
 390                                 <span class="var-type"></span>
 391                                 <span class="var-name">$ftype</span>                    </li>
 392                                         <li>
 393                                 <span class="var-type"></span>
 394                                 <span class="var-name">$base_fname</span>                       </li>
 395                                         <li>
 396                                 <span class="var-type"></span>
 397                                 <span class="var-name">$attributes</span>                       </li>
 398                                         <li>
 399                                 <span class="var-type"></span>
 400                                 <span class="var-name">$prefix</span>                   </li>
 401                                 </ul>
 402
 403
 404         </div>
 405 <a name="methodDataEntryLine" id="DataEntryLine"><!-- --></a>
 406 <div class="evenrow">
 407
 408         <div class="method-header">
 409                 <img src="../../media/images/Method.png" />
 410                 <span class="method-title">DataEntryLine</span> (line <span class="line-number">639</span>)
 411         </div>
 412
 413         <!-- ========== Info from phpDoc block ========= -->
 414 <p class="short-description">A utility function for a data entry line within a table</p>
 415         <ul class="tags">
 416                                 <li><span class="field">return:</span> The HTML fragment to display the prompt and field.</li>
 417                         </ul>
 418
 419         <div class="method-signature">
 420                 <span class="method-result">string</span>
 421                 <span class="method-name">
 422                         DataEntryLine
 423                 </span>
 424                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$field_format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">''</span>])
 425                         </div>
 426
 427                         <ul class="parameters">
 428                                         <li>
 429                                 <span class="var-type"></span>
 430                                 <span class="var-name">$prompt</span>                   </li>
 431                                         <li>
 432                                 <span class="var-type"></span>
 433                                 <span class="var-name">$field_format</span>                     </li>
 434                                         <li>
 435                                 <span class="var-type"></span>
 436                                 <span class="var-name">$ftype</span>                    </li>
 437                                         <li>
 438                                 <span class="var-type"></span>
 439                                 <span class="var-name">$fname</span>                    </li>
 440                                         <li>
 441                                 <span class="var-type"></span>
 442                                 <span class="var-name">$attributes</span>                       </li>
 443                                         <li>
 444                                 <span class="var-type"></span>
 445                                 <span class="var-name">$prefix</span>                   </li>
 446                                 </ul>
 447
 448
 449         </div>
 450 <a name="methodEndForm" id="EndForm"><!-- --></a>
 451 <div class="oddrow">
 452
 453         <div class="method-header">
 454                 <img src="../../media/images/Method.png" />
 455                 <span class="method-title">EndForm</span> (line <span class="line-number">496</span>)
 456         </div>
 457
 458         <!-- ========== Info from phpDoc block ========= -->
 459 <p class="short-description">Return the HTML fragment to end the form.</p>
 460         <ul class="tags">
 461                                 <li><span class="field">return:</span> The HTML fragment to end the form.</li>
 462                         </ul>
 463
 464         <div class="method-signature">
 465                 <span class="method-result">string</span>
 466                 <span class="method-name">
 467                         EndForm
 468                 </span>
 469                                 ()
 470                         </div>
 471
 472
 473
 474         </div>
 475 <a name="methodHelpInCell" id="HelpInCell"><!-- --></a>
 476 <div class="evenrow">
 477
 478         <div class="method-header">
 479                 <img src="../../media/images/Method.png" />
 480                 <span class="method-title">HelpInCell</span> (line <span class="line-number">434</span>)
 481         </div>
 482
 483         <!-- ========== Info from phpDoc block ========= -->
 484 <p class="short-description">Set the line format to have help displayed in it's own separate cell</p>
 485
 486         <div class="method-signature">
 487                 <span class="method-result">void</span>
 488                 <span class="method-name">
 489                         HelpInCell
 490                 </span>
 491                                 ()
 492                         </div>
 493
 494
 495
 496         </div>
 497 <a name="methodHelpInLine" id="HelpInLine"><!-- --></a>
 498 <div class="oddrow">
 499
 500         <div class="method-header">
 501                 <img src="../../media/images/Method.png" />
 502                 <span class="method-title">HelpInLine</span> (line <span class="line-number">426</span>)
 503         </div>
 504
 505         <!-- ========== Info from phpDoc block ========= -->
 506 <p class="short-description">Set the line format to have help displayed in the same cell as the entry field.</p>
 507
 508         <div class="method-signature">
 509                 <span class="method-result">void</span>
 510                 <span class="method-name">
 511                         HelpInLine
 512                 </span>
 513                                 ()
 514                         </div>
 515
 516
 517
 518         </div>
 519 <a name="methodHiddenField" id="HiddenField"><!-- --></a>
 520 <div class="evenrow">
 521
 522         <div class="method-header">
 523                 <img src="../../media/images/Method.png" />
 524                 <span class="method-title">HiddenField</span> (line <span class="line-number">516</span>)
 525         </div>
 526
 527         <!-- ========== Info from phpDoc block ========= -->
 528 <p class="short-description">A utility function for a hidden field within a data entry table</p>
 529         <ul class="tags">
 530                                 <li><span class="field">return:</span> The HTML fragment for the hidden field.</li>
 531                         </ul>
 532
 533         <div class="method-signature">
 534                 <span class="method-result">string</span>
 535                 <span class="method-name">
 536                         HiddenField
 537                 </span>
 538                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvaluei</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$fid</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$fvalue</span>)
 539                         </div>
 540
 541                         <ul class="parameters">
 542                                         <li>
 543                                 <span class="var-type">string</span>
 544                                 <span class="var-name">$fname</span><span class="var-description">: The name of the field.</span>                       </li>
 545                                         <li>
 546                                 <span class="var-type">string</span>
 547                                 <span class="var-name">$fvalue</span><span class="var-description">: The value of the field.</span>                     </li>
 548                                         <li>
 549                                 <span class="var-type"></span>
 550                                 <span class="var-name">$fvaluei</span>                  </li>
 551                                         <li>
 552                                 <span class="var-type"></span>
 553                                 <span class="var-name">$fid</span>                      </li>
 554                                 </ul>
 555
 556
 557         </div>
 558 <a name="methodMultiEntryLine" id="MultiEntryLine"><!-- --></a>
 559 <div class="oddrow">
 560
 561         <div class="method-header">
 562                 <img src="../../media/images/Method.png" />
 563                 <span class="method-title">MultiEntryLine</span> (line <span class="line-number">652</span>)
 564         </div>
 565
 566         <!-- ========== Info from phpDoc block ========= -->
 567 <p class="short-description">A utility function for a data entry line, where the prompt is a drop-down.</p>
 568         <ul class="tags">
 569                                 <li><span class="field">return:</span> The HTML fragment for the drop-down prompt and associated entry field.</li>
 570                         </ul>
 571
 572         <div class="method-signature">
 573                 <span class="method-result">string</span>
 574                 <span class="method-name">
 575                         MultiEntryLine
 576                 </span>
 577                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$prompt_options</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prompt_name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$default_prompt</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$format</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$ftype</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span>)
 578                         </div>
 579
 580                         <ul class="parameters">
 581                                         <li>
 582                                 <span class="var-type"></span>
 583                                 <span class="var-name">$prompt_options</span>                   </li>
 584                                         <li>
 585                                 <span class="var-type"></span>
 586                                 <span class="var-name">$prompt_name</span>                      </li>
 587                                         <li>
 588                                 <span class="var-type"></span>
 589                                 <span class="var-name">$default_prompt</span>                   </li>
 590                                         <li>
 591                                 <span class="var-type"></span>
 592                                 <span class="var-name">$format</span>                   </li>
 593                                         <li>
 594                                 <span class="var-type"></span>
 595                                 <span class="var-name">$ftype</span>                    </li>
 596                                         <li>
 597                                 <span class="var-type"></span>
 598                                 <span class="var-name">$fname</span>                    </li>
 599                                         <li>
 600                                 <span class="var-type"></span>
 601                                 <span class="var-name">$attributes</span>                       </li>
 602                                         <li>
 603                                 <span class="var-type"></span>
 604                                 <span class="var-name">$prefix</span>                   </li>
 605                                 </ul>
 606
 607
 608         </div>
 609 <a name="methodNoHelp" id="NoHelp"><!-- --></a>
 610 <div class="evenrow">
 611
 612         <div class="method-header">
 613                 <img src="../../media/images/Method.png" />
 614                 <span class="method-title">NoHelp</span> (line <span class="line-number">418</span>)
 615         </div>
 616
 617         <!-- ========== Info from phpDoc block ========= -->
 618 <p class="short-description">Set the line format to have no help display</p>
 619
 620         <div class="method-signature">
 621                 <span class="method-result">void</span>
 622                 <span class="method-name">
 623                         NoHelp
 624                 </span>
 625                                 ()
 626                         </div>
 627
 628
 629
 630         </div>
 631 <a name="methodPopulateForm" id="PopulateForm"><!-- --></a>
 632 <div class="oddrow">
 633
 634         <div class="method-header">
 635                 <img src="../../media/images/Method.png" />
 636                 <span class="method-title">PopulateForm</span> (line <span class="line-number">408</span>)
 637         </div>
 638
 639         <!-- ========== Info from phpDoc block ========= -->
 640 <p class="short-description">Initialise some more of the forms fields, possibly with a prefix</p>
 641
 642         <div class="method-signature">
 643                 <span class="method-result">void</span>
 644                 <span class="method-name">
 645                         PopulateForm
 646                 </span>
 647                                         (<span class="var-type"></span>&nbsp;<span class="var-name">&$record</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">&quot;&quot;</span>], <span class="var-type">objectref</span>&nbsp;<span class="var-name">$record</span>)
 648                         </div>
 649
 650                         <ul class="parameters">
 651                                         <li>
 652                                 <span class="var-type">objectref</span>
 653                                 <span class="var-name">$record</span><span class="var-description">: A reference to the database object we are displaying / editing.</span>                     </li>
 654                                         <li>
 655                                 <span class="var-type">string</span>
 656                                 <span class="var-name">$prefix</span><span class="var-description">: A prefix to prepend to the field name.</span>                      </li>
 657                                         <li>
 658                                 <span class="var-type"></span>
 659                                 <span class="var-name">&$record</span>                  </li>
 660                                 </ul>
 661
 662
 663         </div>
 664 <a name="methodRevertLineFormat" id="RevertLineFormat"><!-- --></a>
 665 <div class="evenrow">
 666
 667         <div class="method-header">
 668                 <img src="../../media/images/Method.png" />
 669                 <span class="method-title">RevertLineFormat</span> (line <span class="line-number">459</span>)
 670         </div>
 671
 672         <!-- ========== Info from phpDoc block ========= -->
 673 <p class="short-description">Revert the line format to what was in place before the last TempLineFormat call.</p>
 674
 675         <div class="method-signature">
 676                 <span class="method-result">void</span>
 677                 <span class="method-name">
 678                         RevertLineFormat
 679                 </span>
 680                                 ()
 681                         </div>
 682
 683
 684
 685         </div>
 686 <a name="methodSimpleForm" id="SimpleForm"><!-- --></a>
 687 <div class="oddrow">
 688
 689         <div class="method-header">
 690                 <img src="../../media/images/Method.png" />
 691                 <span class="method-title">SimpleForm</span> (line <span class="line-number">442</span>)
 692         </div>
 693
 694         <!-- ========== Info from phpDoc block ========= -->
 695 <p class="short-description">Set the line format to an extremely simple CSS based prompt / field layout.</p>
 696
 697         <div class="method-signature">
 698                 <span class="method-result">void</span>
 699                 <span class="method-name">
 700                         SimpleForm
 701                 </span>
 702                                         ([<span class="var-type"></span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 703                         </div>
 704
 705                         <ul class="parameters">
 706                                         <li>
 707                                 <span class="var-type"></span>
 708                                 <span class="var-name">$new_format</span>                       </li>
 709                                 </ul>
 710
 711
 712         </div>
 713 <a name="methodStartForm" id="StartForm"><!-- --></a>
 714 <div class="evenrow">
 715
 716         <div class="method-header">
 717                 <img src="../../media/images/Method.png" />
 718                 <span class="method-title">StartForm</span> (line <span class="line-number">470</span>)
 719         </div>
 720
 721         <!-- ========== Info from phpDoc block ========= -->
 722 <p class="short-description">Start the actual HTML form.  Return the fragment to do this.</p>
 723         <ul class="tags">
 724                                 <li><span class="field">return:</span> The HTML fragment for the start of the form.</li>
 725                         </ul>
 726
 727         <div class="method-signature">
 728                 <span class="method-result">string</span>
 729                 <span class="method-name">
 730                         StartForm
 731                 </span>
 732                                         ([<span class="var-type">array</span>&nbsp;<span class="var-name">$extra_attributes</span> = <span class="var-default">''</span>])
 733                         </div>
 734
 735                         <ul class="parameters">
 736                                         <li>
 737                                 <span class="var-type">array</span>
 738                                 <span class="var-name">$extra_attributes</span><span class="var-description">: Extra key/value pairs for the FORM tag.</span>                   </li>
 739                                 </ul>
 740
 741
 742         </div>
 743 <a name="methodSubmitButton" id="SubmitButton"><!-- --></a>
 744 <div class="oddrow">
 745
 746         <div class="method-header">
 747                 <img src="../../media/images/Method.png" />
 748                 <span class="method-title">SubmitButton</span> (line <span class="line-number">629</span>)
 749         </div>
 750
 751         <!-- ========== Info from phpDoc block ========= -->
 752 <p class="short-description">A utility function for a submit button within a data entry table</p>
 753         <ul class="tags">
 754                                 <li><span class="field">return:</span> The HTML fragment to display a submit button for the form.</li>
 755                         </ul>
 756
 757         <div class="method-signature">
 758                 <span class="method-result">string</span>
 759                 <span class="method-name">
 760                         SubmitButton
 761                 </span>
 762                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$fname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fvalue</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">''</span>])
 763                         </div>
 764
 765                         <ul class="parameters">
 766                                         <li>
 767                                 <span class="var-type"></span>
 768                                 <span class="var-name">$fname</span>                    </li>
 769                                         <li>
 770                                 <span class="var-type"></span>
 771                                 <span class="var-name">$fvalue</span>                   </li>
 772                                         <li>
 773                                 <span class="var-type"></span>
 774                                 <span class="var-name">$attributes</span>                       </li>
 775                                 </ul>
 776
 777
 778         </div>
 779 <a name="methodTempLineFormat" id="TempLineFormat"><!-- --></a>
 780 <div class="evenrow">
 781
 782         <div class="method-header">
 783                 <img src="../../media/images/Method.png" />
 784                 <span class="method-title">TempLineFormat</span> (line <span class="line-number">451</span>)
 785         </div>
 786
 787         <!-- ========== Info from phpDoc block ========= -->
 788 <p class="short-description">Set the line format to a temporary one that we can revert from.</p>
 789
 790         <div class="method-signature">
 791                 <span class="method-result">void</span>
 792                 <span class="method-name">
 793                         TempLineFormat
 794                 </span>
 795                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$new_format</span> = <span class="var-default">'&lt;span class=&quot;prompt&quot;&gt;%s:&lt;/span&gt;&amp;nbsp;&lt;span class=&quot;entry&quot;&gt;%s&lt;/span&gt;'</span>])
 796                         </div>
 797
 798                         <ul class="parameters">
 799                                         <li>
 800                                 <span class="var-type">string</span>
 801                                 <span class="var-name">$new_format</span><span class="var-description">: The (optional) new format we will temporarily use.</span>                      </li>
 802                                 </ul>
 803
 804
 805         </div>
 806
 807                 </div>
 808         </div>
 809
 810
 811         <p class="notes" id="credit">
 812                 Documentation generated on Tue, 28 Dec 2010 02:01:35 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 813         </p>
 814         </div></body>
 815 </html>