Location: PHPKode > projects > Aukyla Platform > doc/html/a00151.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>SelectInput Class Reference</h1><p>Inheritance diagram for SelectInput:
<p><center><img src="a00151.png" usemap="#SelectInput_map" border="0" alt=""></center>
<map name="SelectInput_map">
<area href="a00114.html" alt="Input" shape="rect" coords="0,112,121,136">
<area href="a00096.html" alt="Container" shape="rect" coords="0,56,121,80">
<area href="a00166.html" alt="Widget" shape="rect" coords="0,0,121,24">
<area href="a00150.html" alt="SelectConfigOption" shape="rect" coords="0,224,121,248">
</map>
<a href="a00025.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A select input widget. 
<p>
Select inputs provide a rollout list of options from which the user can choose one.<p>
Using the function <a class="el" href="a00151.html#a3">setMultiple()</a>, you can allow the user to select more than one option. 
<p>

<p>
Definition at line <a class="el" href="a00215.html#l00671">671</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="a00151.html#a0">__construct</a> (<a class="el" href="a00096.html">Container</a> $parent, $id)</td></tr>

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

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a2">addOption</a> ($key, $text, $selected=false)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a3">setMultiple</a> ($multiple, $size=1)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a4">supportsGridLayout</a> ()</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="a00151.html#p0">$name</a></td></tr>

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

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

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

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="SelectInput::__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">SelectInput::__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>id</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>
<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 input to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The input's ID.</td></tr>
  </table>
</dl>

<p>
Reimplemented from <a class="el" href="a00114.html#a0">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00673">673</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="SelectInput::addOption"></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">SelectInput::addOption           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>key</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>text</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>selected</em> = <code>false</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 option to the options list.<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>key</em>&nbsp;</td><td>The key of this option. This is the key you will see when the form has been submitted. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>The visible text of the option. This is the option as it's seen by the user. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>selected</em>&nbsp;</td><td><code>true</code> if this option is currently option, <code>false</code> otherwise.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00704">704</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="SelectInput::setMultiple"></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">SelectInput::setMultiple           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>multiple</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>size</em> = <code>1</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>
With this function you can allow the user to select more than one option from the list. When multiple selection is enabled, the input is no longer a rollout widget, but rather provides a plain scrollable list of options.<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>multiple</em>&nbsp;</td><td>Boolean determining whether this select input should allow multiple selections. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The amount of options visible at once. This is <b>not</b> the number of options that may be selected.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00731">731</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="SelectInput::setOptions"></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">SelectInput::setOptions           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>options</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 all options through an array.<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>options</em>&nbsp;</td><td>The array of options. The array should consist of <code>key</code> =&gt; <code>text</code> pairs. For documentation of the <code>key</code> and <code>text</code> attributes, see <a class="el" href="a00151.html#a2">addOption()</a>.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00689">689</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
Referenced by <a class="el" href="a00208.html#l00297">SelectConfigOption::__construct()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4" doxytag="SelectInput::supportsGridLayout"></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">SelectInput::supportsGridLayout           </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 input widget can line out its contents in a <a class="el" href="a00108.html">GridLayout</a>.
<p>
Reimplemented from <a class="el" href="a00114.html#a5">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00737">737</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p0" doxytag="SelectInput::$name"></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">SelectInput::$name<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Name of the widget. By default this equals the id of the widget, but it can be overwritten by subclasses.
<p>
Reimplemented from <a class="el" href="a00114.html#p2">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00775">775</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p1" doxytag="SelectInput::$required"></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">SelectInput::$required<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Boolean determining whether the input widget is required to be filled in.
<p>
Reimplemented from <a class="el" href="a00114.html#p3">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00776">776</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p2" doxytag="SelectInput::$text"></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">SelectInput::$text<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Text shown on the widget.
<p>
Reimplemented from <a class="el" href="a00114.html#p5">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00777">777</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p3" doxytag="SelectInput::$value"></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">SelectInput::$value<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The value of the widget. Subclasses can decide to interpret the value as a boolean or as a string.
<p>
Reimplemented from <a class="el" href="a00114.html#p7">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00778">778</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