Location: PHPKode > projects > Aukyla Platform > aukyla/doc/html/a00106.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <title>Aukyla PHP Framework</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <link rel="StyleSheet" href="auton.css" type="text/css" media="screen">
  </head>

  <body>
    <div id="mainmenu">
      <a href="http://www.auton.nl/" class="home">Home</a>
    </div>
    <div id="submenu">
      <a class="logo" href="http://www.auton.nl/"></a>

      <div class="head">Ads</div>
      <a href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=116358&amp;type=1" alt="SourceForge.net Logo" style="padding: 2px 4px; width: 88px; height: 31px; border: 0px"></a>
      <a href="http://getfirefox.com/" title="Get Firefox - The Browser, Reloaded."><img src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox" style="width: 110px; height: 32px; border: 0px"></a>
    </div>
    <div id="main">
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>Form Class Reference</h1><p>Inheritance diagram for Form:
<p><center><img src="a00106.png" usemap="#Form_map" border="0" alt=""></center>
<map name="Form_map">
<area href="a00096.html" alt="Container" shape="rect" coords="0,56,82,80">
<area href="a00166.html" alt="Widget" shape="rect" coords="0,0,82,24">
<area href="a00093.html" alt="ConfigEditor" shape="rect" coords="0,168,82,192">
</map>
<a href="a00017.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Provides functions for building and displaying forms. 
<p>
Forms allow the user to enter data through <a class="el" href="a00114.html">Input</a> widgets which is then send to the server when the form is submitted. A form is submitted when the user clicks on a <a class="el" href="a00089.html">Button</a> which has the confirmation property set. 
<p>

<p>
Definition at line <a class="el" href="a00215.html#l00037">37</a> of file <a class="el" href="a00215.html">Forms.php</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a0">__construct</a> (<a class="el" href="a00096.html">Container</a> $parent, $actionURL)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a1">show</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a2">form</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a3">setRequired</a> ($id, $required)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a4">hasChecks</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a5">addJavaScriptCheck</a> ($expression, $error= '')</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a6">setMultiPart</a> ($multiPart)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a7">setErrorMessage</a> ($errorMessage)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a8">errorMessage</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a9">useGridLayout</a> ($useGridLayout)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a10">gridLayout</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a11">setSingleShot</a> ($singleShot)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a12">singleShot</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a13">addWidget</a> (<a class="el" href="a00166.html">Widget</a> $widget)</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#e0">highlightLabel</a> ($label, $attribute=false)</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#p0">$children</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#p1">$id</a></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="Form::__construct"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::__construct           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a00096.html">Container</a> $&nbsp;</td>
          <td class="mdname" nowrap> <em>parent</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>actionURL</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor.<p>
Creates an empty form.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td><a class="el" href="a00096.html">Container</a> to add this form to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>actionURL</em>&nbsp;</td><td>The URL to request when submitting the form.</td></tr>
  </table>
</dl>

<p>
Reimplemented from <a class="el" href="a00096.html#a0">Container</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00047">47</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
References <a class="el" href="a00215.html#l00206">errorMessage()</a>, <a class="el" href="a00207.html#l00205">Config::globals()</a>, <a class="el" href="a00215.html#l00258">singleShot()</a>, and <a class="el" href="a00215.html#l00218">useGridLayout()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a5" doxytag="Form::addJavaScriptCheck"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::addJavaScriptCheck           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>expression</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>error</em> = <code>''</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Adds an (extra) <a class="el" href="a00115.html">JavaScript</a> check.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>expression</em>&nbsp;</td><td>The expression to be checked when the form is submitted. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>error</em>&nbsp;</td><td>The error message to show if the expression failes. If empty, the form's error message is used.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00170">170</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a13" doxytag="Form::addWidget"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::addWidget           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a00166.html">Widget</a> $&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>widget</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Adds a widget to the children list.<p>
<dl compact><dt><b>Note:</b></dt><dd>You shouldn't have to call this function directly as the constructor of child widgets will already call this function for you.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>widget</em>&nbsp;</td><td>The widget to add to the children list.</td></tr>
  </table>
</dl>

<p>
Reimplemented from <a class="el" href="a00096.html#a1">Container</a>.
<p>
Reimplemented in <a class="el" href="a00093.html#a1">ConfigEditor</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00263">263</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a8" doxytag="Form::errorMessage"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::errorMessage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the error message set for this form.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The error message to show when not all required input fields have been filled in.</dd></dl>

<p>
Definition at line <a class="el" href="a00215.html#l00206">206</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
Referenced by <a class="el" href="a00215.html#l00047">__construct()</a>, and <a class="el" href="a00215.html#l00195">setErrorMessage()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="Form::form"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::form           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the current form.
<p>
Reimplemented from <a class="el" href="a00166.html#a5">Widget</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00123">123</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
Referenced by <a class="el" href="a00215.html#l00066">show()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a10" doxytag="Form::gridLayout"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::gridLayout           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether this form uses a <a class="el" href="a00108.html">GridLayout</a> for aligning its elements.<p>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if the form uses a grid layout, <code>false</code> otherwise.</dd></dl>

<p>
Definition at line <a class="el" href="a00215.html#l00228">228</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
Referenced by <a class="el" href="a00215.html#l00066">show()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4" doxytag="Form::hasChecks"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::hasChecks           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether the form has any <a class="el" href="a00115.html">JavaScript</a> checks, because of required widgets or custom checks.
<p>
Definition at line <a class="el" href="a00215.html#l00155">155</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
Referenced by <a class="el" href="a00215.html#l00066">show()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e0" doxytag="Form::highlightLabel"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::highlightLabel           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>attribute</em> = <code>false</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Highlights a required <code>label</code>. This can be done by either making it bold or by putting a star behind it.
<p>
Definition at line <a class="el" href="a00215.html#l00275">275</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
References <a class="el" href="a00235.html#l00078">String::endsWith()</a>, and <a class="el" href="a00235.html#l00038">String::substringBefore()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a7" doxytag="Form::setErrorMessage"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::setErrorMessage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>errorMessage</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets an error message which is shown when required input fields haven't been filled in.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>errorMessage</em>&nbsp;</td><td>The new error message.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00195">195</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
References <a class="el" href="a00215.html#l00206">errorMessage()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a6" doxytag="Form::setMultiPart"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::setMultiPart           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>multiPart</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets whether the form is multi-part encoded.<p>
Usually you don't need to worry about this. If you add a <a class="el" href="a00105.html">FileInput</a> to the form, this will be set automatically.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>multiPart</em>&nbsp;</td><td>The new multi-part value, <code>true</code> enables multi-part encoding, <code>false</code> disables it.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00184">184</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="Form::setRequired"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::setRequired           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>required</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets an input as being required to be filled in.<p>
Usually you don't need to call this function yourself, as most constructors of input widgets already contain a <code>required</code> argument, and they will call this function for you if it's <code>true</code>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>ID of the widget. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>required</em>&nbsp;</td><td><code>true</code> if the widget is required, <code>false</code> otherwise.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00139">139</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a11" doxytag="Form::setSingleShot"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::setSingleShot           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>singleShot</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets whether this form is a single shot form. A single shot form is a form which may be submitted only once, and which will protect the user from submitting it more than once.<p>
<dl compact><dt><b>Note:</b></dt><dd>Even though the form will protect the user to not submit the form more than once, no guarantee is offered that the form is really only submitted once. This is purely a convenience function!</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>singleShot</em>&nbsp;</td><td>Boolean determining whether this form should be a single shot form.</td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00106.html#a12">singleShot()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00215.html#l00248">248</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
References <a class="el" href="a00215.html#l00258">singleShot()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="Form::show"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::show           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Shows the form.
<p>
Reimplemented from <a class="el" href="a00096.html#a2">Container</a>.
<p>
Reimplemented in <a class="el" href="a00093.html#a2">ConfigEditor</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00066">66</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
References <a class="el" href="a00218.html#l00066">JavaScript::checkVariables()</a>, <a class="el" href="a00215.html#l00123">form()</a>, <a class="el" href="a00215.html#l00228">gridLayout()</a>, <a class="el" href="a00215.html#l00155">hasChecks()</a>, <a class="el" href="a00215.html#l00218">useGridLayout()</a>, and <a class="el" href="a00229.html#l00168">Output::write()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a12" doxytag="Form::singleShot"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::singleShot           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns whether this form is a single shot form.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00106.html#a11">setSingleShot()</a></dd></dl>

<p>
Definition at line <a class="el" href="a00215.html#l00258">258</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
Referenced by <a class="el" href="a00215.html#l00047">__construct()</a>, and <a class="el" href="a00215.html#l00248">setSingleShot()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a9" doxytag="Form::useGridLayout"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::useGridLayout           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>useGridLayout</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets whether this form should use a <a class="el" href="a00108.html">GridLayout</a> to align the form elements in it. By default this is off.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>useGridLayout</em>&nbsp;</td><td><code>true</code> if the form should use a <a class="el" href="a00108.html">GridLayout</a> for layout, <code>false</code> otherwise.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00218">218</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
References <a class="el" href="a00215.html#l00218">useGridLayout()</a>.
<p>
Referenced by <a class="el" href="a00215.html#l00047">__construct()</a>, <a class="el" href="a00215.html#l00066">show()</a>, and <a class="el" href="a00215.html#l00218">useGridLayout()</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p0" doxytag="Form::$children"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::$children<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Registered children of the class.
<p>
Reimplemented from <a class="el" href="a00096.html#p0">Container</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00298">298</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p1" doxytag="Form::$id"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">Form::$id<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Widget's ID.
<p>
Reimplemented from <a class="el" href="a00166.html#p1">Widget</a>.
<p>
Reimplemented in <a class="el" href="a00093.html#p0">ConfigEditor</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00299">299</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00215.html">Forms.php</a></ul>
    </div>
  </body>
</html>
Return current item: Aukyla Platform