Location: PHPKode > projects > Aukyla Platform > aukyla/doc/html/a00089.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>Button Class Reference</h1><p>Inheritance diagram for Button:
<p><center><img src="a00089.png" usemap="#Button_map" border="0" alt=""></center>
<map name="Button_map">
<area href="a00114.html" alt="Input" shape="rect" coords="0,112,67,136">
<area href="a00096.html" alt="Container" shape="rect" coords="0,56,67,80">
<area href="a00166.html" alt="Widget" shape="rect" coords="0,0,67,24">
</map>
<a href="a00028.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A form button. 
<p>
A button used to submit a <a class="el" href="a00106.html">Form</a>.<p>
Buttons can be confirmation buttons (meaning the user wants to confirm the data filled in in the form) by calling the <a class="el" href="a00089.html#a1">setConfirm()</a> function. A confirmation generally triggers the processing of the form on the server. When the user clicks a confirmation button, the form is validated to make sure the user has filled in all required fields in the form.<p>
When the <a class="el" href="a00106.html">Form</a> is a single-shot form, confirmation buttons can only be clicked once.<p>
<dl compact><dt><b>Note:</b></dt><dd>There are two ways to set the contents of a button. You can add contents by adding child widgets or you can set no explicit contents in which case the value set with <a class="el" href="a00114.html#a2">setValue()</a> is used. Setting the text of a button has no effect.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00089.html#a1">setConfirm()</a>, <a class="el" href="a00114.html#a3">Input::setRequired()</a>, <a class="el" href="a00106.html#a11">Form::setSingleShot()</a> </dd></dl>

<p>

<p>
Definition at line <a class="el" href="a00215.html#l00883">883</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="a00089.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="a00089.html#a1">setConfirm</a> ($confirm)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html#a2">show</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="a00089.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="a00089.html#p1">$form</a></td></tr>

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

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

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

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

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="Button::__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">Button::__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#l00885">885</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="Button::setConfirm"></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">Button::setConfirm           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>confirm</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 button is used to confirm the form. This means when this button is pressed all required fields should be checked before they're submitted.<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>confirm</em>&nbsp;</td><td><code>true</code> if this button is used to confirm the form, <code>false</code> otherwise.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00215.html#l00900">900</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="Button::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">Button::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 this widget and all child widgets.
<p>
Reimplemented from <a class="el" href="a00096.html#a2">Container</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00905">905</a> of file <a class="el" href="a00215.html">Forms.php</a>.
<p>
References <a class="el" href="a00239.html#l00115">Widget::addJavaScript()</a>, <a class="el" href="a00239.html#l00271">Container::show()</a>, and <a class="el" href="a00229.html#l00168">Output::write()</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p0" doxytag="Button::$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">Button::$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#l00929">929</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p1" doxytag="Button::$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">Button::$form<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Parent form.
<p>
Reimplemented from <a class="el" href="a00114.html#p0">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00930">930</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p2" doxytag="Button::$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">Button::$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="a00114.html#p1">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00931">931</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p3" doxytag="Button::$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">Button::$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#l00932">932</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p4" doxytag="Button::$type"></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">Button::$type<code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The type of the widget, only used internally by subclasses.
<p>
Reimplemented from <a class="el" href="a00114.html#p6">Input</a>.
<p>
Definition at line <a class="el" href="a00215.html#l00933">933</a> of file <a class="el" href="a00215.html">Forms.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="p5" doxytag="Button::$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">Button::$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#l00934">934</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