Location: PHPKode > projects > FOOWD > foowd/apidocs/Foowd/Input/input_form.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>

<title>Input_form</title>

<link rel="stylesheet" type="text/css" href="../../stylesheet.css" />
<link rel="start" href="overview-summary.html" />

</head>

<body>

<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../../index.html" target="_top">FRAMES</a> <a href="input_form.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<h1>Class input_form</h1>

<pre><strong>input_form</strong><br /></pre>


<hr />

<p>
class <strong>input_form</strong><br />
</p>

<p>Input form class. </p><p>This class defines an input form and has methods for adding form objects to the form, displaying the form, and requesting the forms state. </p><dl><dt>Author:</dt><dd>Paul James </dd></dl>
<hr />
<br />

<a name="summary_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Field Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public str</td><td class="description"><a href="#$name">$name</a><br />The name of the form. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$location">$location</a><br />URI for form to submit to. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$method">$method</a><br />The submit method to use. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$submit">$submit</a><br />Caption of the submit button. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$reset">$reset</a><br />Caption of the reset button. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$preview">$preview</a><br />Caption of the preview button. </td></tr><tr><td class="type">public array</td><td class="description"><a href="#$objects">$objects</a><br />Form objects in this form. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$class">$class</a><br />The CSS class for this form. </td></tr></table>
<br />
<a name="summary_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th colspan="2" class="title">Method Summary</th></tr>
</table>

<table width="100%" cellspacing="0" class="body"><tr><td class="type">public void</td><td class="description"><a href="#input_form">input_form</a><br />Constructs a new form object. </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#addObject">addObject</a><br />Add a form object to the form. </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#submitted">submitted</a><br />Has the form been submitted? </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#previewed">previewed</a><br />Has the form been previewed? </td></tr><tr><td class="type">public void</td><td class="description"><a href="#display">display</a><br />Display the form. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#display_start">display_start</a><br />Display the form header. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#display_end">display_end</a><br />Display the form footer. </td></tr></table>
<br />
<hr />
<br />


<a name="detail_field"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Field Detail</th></tr>
</table>

<a name="$name"></a><h2>name</h2> <code>public str <strong>$name</strong></code><br /><p>The name of the form. </p><p></p><hr /><a name="$location"></a><h2>location</h2> <code>public str <strong>$location</strong></code><br /><p>URI for form to submit to. </p><p></p><hr /><a name="$method"></a><h2>method</h2> <code>public str <strong>$method</strong></code><br /><p>The submit method to use. </p><p></p><hr /><a name="$submit"></a><h2>submit</h2> <code>public str <strong>$submit</strong></code><br /><p>Caption of the submit button. </p><p></p><hr /><a name="$reset"></a><h2>reset</h2> <code>public str <strong>$reset</strong></code><br /><p>Caption of the reset button. </p><p></p><hr /><a name="$preview"></a><h2>preview</h2> <code>public str <strong>$preview</strong></code><br /><p>Caption of the preview button. </p><p></p><hr /><a name="$objects"></a><h2>objects</h2> <code>public array <strong>$objects</strong></code><br /><p>Form objects in this form. </p><p></p><hr /><a name="$class"></a><h2>class</h2> <code>public str <strong>$class</strong></code><br /><p>The CSS class for this form. </p><p></p><hr />
<a name="detail_method"></a>
<table width="100%" cellspacing="0" class="title">
<tr><th class="title">Method Detail</th></tr>
</table>

<a name="input_form"></a><h2>input_form()</h2> <code>public void <strong>input_form</strong>(str name, str location, str method, str submit, str reset, str preview, str class)</code><br /><p>Constructs a new form object. </p><p></p><dl><dt>Parameters:</dt><dd><code>name</code> - The name of the form. </dd><dd><code>location</code> - URI for form to submit to. </dd><dd><code>method</code> - The submit method to use. </dd><dd><code>submit</code> - Caption of the submit button. </dd><dd><code>reset</code> - Caption of the reset button. </dd><dd><code>preview</code> - Caption of the preview button. </dd><dd><code>class</code> - The CSS class for this form. </dd></dl><hr /><a name="addObject"></a><h2>addObject()</h2> <code>public bool <strong>addObject</strong>(object object)</code><br /><p>Add a form object to the form. </p><p></p><dl><dt>Parameters:</dt><dd><code>object</code> - The form object to add. </dd></dl><dl><dt>Returns:</dt><dd>TRUE on success. </dd></dl><hr /><a name="submitted"></a><h2>submitted()</h2> <code>public bool <strong>submitted</strong>()</code><br /><p>Has the form been submitted? </p><dl><dt>Returns:</dt><dd>TRUE if the form has been submitted. </dd></dl><hr /><a name="previewed"></a><h2>previewed()</h2> <code>public bool <strong>previewed</strong>()</code><br /><p>Has the form been previewed? </p><dl><dt>Returns:</dt><dd>TRUE if the form has been previewed. </dd></dl><hr /><a name="display"></a><h2>display()</h2> <code>public void <strong>display</strong>()</code><br /><p>Display the form. </p><p></p><hr /><a name="display_start"></a><h2>display_start()</h2> <code>public void <strong>display_start</strong>()</code><br /><p>Display the form header. </p><p>This method should be used in conjunction with <code><a href="../Foowd/Input/input_form.html#display_end">input_form::display_end</a></code> and requires the form objects within the form to be manually told to display themselves. This can be useful if you need finer granularity over the forms look without having to sub-class. </p><hr /><a name="display_end"></a><h2>display_end()</h2> <code>public void <strong>display_end</strong>()</code><br /><p>Display the form footer. </p><p>See <code><a href="../Foowd/Input/input_form.html#display_start">input_form::display_start</a></code> for more. </p><hr />
<table width="100%" cellpadding="0" class="header">
<tr><td class="header">
<a href="../../overview-summary.html">Overview</a>
<a href="package-summary.html">Package</a>
<a href="package-tree.html">Tree</a></td><td class="short_title">
FOOWD</td></tr>
</table>

<table width="100%" cellpadding="0" class="small_links">
<tr>
<td><a href="../../index.html" target="_top">FRAMES</a> <a href="input_form.html" target="_top">NO FRAMES</a></td>
</tr>
<tr>
<td>SUMMARY: <a href="#summary_field">FIELD</a> <a href="#summary_method">METHOD</a></td>
<td>DETAIL: <a href="#detail_field">FIELD</a> <a href="#detail_method">METHOD</a></td>
</tr>
</table>

<hr />

<p class="footer">This document was generated by <a href="http://phpdoctor.sourceforge.net/">PHPDoctor: The PHP Documentation Creator</a>.</p>
</body>
</html>
Return current item: FOOWD