Location: PHPKode > projects > FOOWD > foowd/apidocs/Foowd/Input/input_dropdown.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_dropdown</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_dropdown.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_dropdown</h1>

<pre><strong>input_dropdown</strong><br /></pre>


<hr />

<p>
class <strong>input_dropdown</strong><br />
</p>

<p>Dropdown list class. </p><p>This class defines a dropdown listbox, it handles input validation, value persistancy, and displaying the object. </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 dropdown list. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$value">$value</a><br />The value of the dropdown list. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$caption">$caption</a><br />The dropdown lists caption. </td></tr><tr><td class="type">public int</td><td class="description"><a href="#$height">$height</a><br />The height of the dropdown list. </td></tr><tr><td class="type">public array</td><td class="description"><a href="#$items">$items</a><br />Array of list items. </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#$multiple">$multiple</a><br />Dropdown list allows multiple selection. </td></tr><tr><td class="type">public str</td><td class="description"><a href="#$class">$class</a><br />The dropdown lists CSS class. </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_dropdown">input_dropdown</a><br />Constructs a new dropdown list object. </td></tr><tr><td class="type">public bool</td><td class="description"><a href="#set">set</a><br />Sets the value of the dropdown list. </td></tr><tr><td class="type">public void</td><td class="description"><a href="#display">display</a><br />Display the dropdown list. </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 dropdown list. </p><p></p><hr /><a name="$value"></a><h2>value</h2> <code>public str <strong>$value</strong></code><br /><p>The value of the dropdown list. </p><p></p><hr /><a name="$caption"></a><h2>caption</h2> <code>public str <strong>$caption</strong></code><br /><p>The dropdown lists caption. </p><p></p><hr /><a name="$height"></a><h2>height</h2> <code>public int <strong>$height</strong></code><br /><p>The height of the dropdown list. </p><p></p><hr /><a name="$items"></a><h2>items</h2> <code>public array <strong>$items</strong></code><br /><p>Array of list items. </p><p></p><hr /><a name="$multiple"></a><h2>multiple</h2> <code>public bool <strong>$multiple</strong></code><br /><p>Dropdown list allows multiple selection. </p><p></p><hr /><a name="$class"></a><h2>class</h2> <code>public str <strong>$class</strong></code><br /><p>The dropdown lists CSS class. </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_dropdown"></a><h2>input_dropdown()</h2> <code>public void <strong>input_dropdown</strong>(str name, str value, var $items, str caption, int height, bool multiple, str class)</code><br /><p>Constructs a new dropdown list object. </p><p></p><dl><dt>Parameters:</dt><dd><code>name</code> - The name of the dropdown list. </dd><dd><code>value</code> - The initial selected item. </dd><dd><code>$items</code><dd><code>caption</code> - The caption to display by the dropdown list. </dd><dd><code>height</code> - The height of the dropdown list. </dd><dd><code>multiple</code> - Dropdown list allows multiple selection. </dd><dd><code>class</code> - The CSS class for this dropdown list. </dd></dl><hr /><a name="set"></a><h2>set()</h2> <code>public bool <strong>set</strong>(str value)</code><br /><p>Sets the value of the dropdown list. </p><p></p><dl><dt>Parameters:</dt><dd><code>value</code> - The item to select in the dropdown list. </dd></dl><dl><dt>Returns:</dt><dd>TRUE on success. </dd></dl><hr /><a name="display"></a><h2>display()</h2> <code>public void <strong>display</strong>()</code><br /><p>Display the dropdown list. </p><p></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_dropdown.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