--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.Button</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.Button-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.Button-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.Button-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.Button-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+ <div class="inheritance res-block">
+ <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Button
+
+ </pre>
+ </div>
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.Button
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_Button.js.html">Roo/Button.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">Button</td></tr>
+
+
+
+
+ <tr><td class="label">Extends:</td><td class="hd-info">
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td></tr>
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ Simple Button class
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.Button';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.Button.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.Button-configs"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Config Options (Usually are also Properties)</caption>
+
+
+ <tr>
+ <th class="sig-header" colspan="2">Options</th>
+
+ <th class="msource-header">Defined By</th>
+ </tr>
+
+
+
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-clickEvent" name=".clickEvent"></a>
+ <div class="fixedFont">
+ <b class="itemname">clickEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The type of event to map to the button's event handler (defaults to 'click')</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The type of event to map to the button's event handler (defaults to 'click')</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-cls" name=".cls"></a>
+ <div class="fixedFont">
+ <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">A CSS class to apply to the button's main element.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">A CSS class to apply to the button's main element.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-disabled" name=".disabled"></a>
+ <div class="fixedFont">
+ <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to start disabled (defaults to false)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to start disabled (defaults to false)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-enableToggle" name=".enableToggle"></a>
+ <div class="fixedFont">
+ <b class="itemname">enableToggle</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to enable pressed/not pressed toggling (defaults to false)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to enable pressed/not pressed toggling (defaults to false)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-handleMouseEvents" name=".handleMouseEvents"></a>
+ <div class="fixedFont">
+ <b class="itemname">handleMouseEvents</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-handler" name=".handler"></a>
+ <div class="fixedFont">
+ <b class="itemname">handler</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">A function called when the button is clicked (can be used instead of click event)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">A function called when the button is clicked (can be used instead of click event)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-hidden" name=".hidden"></a>
+ <div class="fixedFont">
+ <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to start hidden (defaults to false)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to start hidden (defaults to false)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-icon" name=".icon"></a>
+ <div class="fixedFont">
+ <b class="itemname">icon</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The path to an image to display in the button (the image will be set as the background-image<br/>CSS property of the button by default, so if you want a mixed icon/text button, set cls:"x-btn-text-icon")</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The path to an image to display in the button (the image will be set as the background-image<br/>CSS property of the button by default, so if you want a mixed icon/text button, set cls:"x-btn-text-icon")</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-iconCls" name=".iconCls"></a>
+ <div class="fixedFont">
+ <b class="itemname">iconCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">A css class which sets a background image to be used as the icon for this button (defaults to undefined).</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">A css class which sets a background image to be used as the icon for this button (defaults to undefined).</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-menu" name=".menu"></a>
+ <div class="fixedFont">
+ <b class="itemname">menu</b> : Mixed
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-menuAlign" name=".menuAlign"></a>
+ <div class="fixedFont">
+ <b class="itemname">menuAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The position to align the menu to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to 'tl-bl?').</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The position to align the menu to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to 'tl-bl?').</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-minWidth" name=".minWidth"></a>
+ <div class="fixedFont">
+ <b class="itemname">minWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The minimum width for this button (used to give a set of buttons a common width)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The minimum width for this button (used to give a set of buttons a common width)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-pressed" name=".pressed"></a>
+ <div class="fixedFont">
+ <b class="itemname">pressed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to start pressed (only if enableToggle = true)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to start pressed (only if enableToggle = true)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-renderTo" name=".renderTo"></a>
+ <div class="fixedFont">
+ <b class="itemname">renderTo</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The element to append the button to</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The element to append the button to</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-repeat" name=".repeat"></a>
+ <div class="fixedFont">
+ <b class="itemname">repeat</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Object
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to repeat fire the click event while the mouse is down.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to repeat fire the click event while the mouse is down. This can also be<br/> an {<b>link</b> Roo.util.ClickRepeater} config object (defaults to false).</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-scope" name=".scope"></a>
+ <div class="fixedFont">
+ <b class="itemname">scope</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The scope of the handler</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The scope of the handler</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-tabIndex" name=".tabIndex"></a>
+ <div class="fixedFont">
+ <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The DOM tabIndex for this button (defaults to undefined)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The DOM tabIndex for this button (defaults to undefined)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-template" name=".template"></a>
+ <div class="fixedFont">
+ <b class="itemname">template</b> : <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">(Optional)<br/>An {<b>link</b> Roo.Template} with which to create the Button's main element.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">(Optional)<br/>An {<b>link</b> Roo.Template} with which to create the Button's main element. This Template must<br/>contain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could<br/>require code modifications if required elements (e.g. a button) aren't present.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-text" name=".text"></a>
+ <div class="fixedFont">
+ <b class="itemname">text</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The button text</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The button text</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-toggleGroup" name=".toggleGroup"></a>
+ <div class="fixedFont">
+ <b class="itemname">toggleGroup</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The group this toggle button is a member of (only 1 per group can be pressed, only<br/> applies if enableToggle = true)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The group this toggle button is a member of (only 1 per group can be pressed, only<br/> applies if enableToggle = true)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-tooltip" name=".tooltip"></a>
+ <div class="fixedFont">
+ <b class="itemname">tooltip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The tooltip for the button - can be a string or QuickTips config object</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The tooltip for the button - can be a string or QuickTips config object</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-tooltipType" name=".tooltipType"></a>
+ <div class="fixedFont">
+ <b class="itemname">tooltipType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The type of tooltip to use.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Button-cfg-type" name=".type"></a>
+ <div class="fixedFont">
+ <b class="itemname">type</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The button's type, corresponding to the DOM input element type attribute.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The button's type, corresponding to the DOM input element type attribute. Either "submit," "reset" or "button" (default).</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.Button-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.Button-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo-method-Button" name=".Button"></a>
+ <div class="fixedFont">
+ <span class="attributes">new <B>Roo.</B></span><b class="itemname">Button</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+
+ <div class="short">Create a new Roo.Button</div>
+
+
+ <div class="long">
+
+
+
+ Create a new Roo.Button
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
+
+ </dt>
+ <dd>The config object</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-destroy" name=".destroy"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">destroy</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Destroys this Button and removes any listeners.</div>
+
+
+
+ <div class="long">
+
+ Destroys this Button and removes any listeners.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-disable" name=".disable"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">disable</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Disable this button</div>
+
+
+
+ <div class="long">
+
+ Disable this button
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-enable" name=".enable"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">enable</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Enable this button</div>
+
+
+
+ <div class="long">
+
+ Enable this button
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-focus" name=".focus"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">focus</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Focus the button</div>
+
+
+
+ <div class="long">
+
+ Focus the button
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-getEl" name=".getEl"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getEl</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns the button's underlying element</div>
+
+
+
+ <div class="long">
+
+ Returns the button's underlying element
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-getText" name=".getText"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getText</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the text for this button</div>
+
+
+
+ <div class="long">
+
+ Gets the text for this button
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The button text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-hide" name=".hide"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">hide</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Hide this button</div>
+
+
+
+ <div class="long">
+
+ Hide this button
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-setDisabled" name=".setDisabled"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setDisabled</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>enabled</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Convenience function for boolean enable/disable</div>
+
+
+
+ <div class="long">
+
+ Convenience function for boolean enable/disable
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>enabled</b>
+
+ </dt>
+ <dd>True to enable, false to disable</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-setHandler" name=".setHandler"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setHandler</b>
+
+ (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Assigns this button's click handler</div>
+
+
+
+ <div class="long">
+
+ Assigns this button's click handler
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The function to call when the button is clicked</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
+
+ </dt>
+ <dd>(optional) Scope for the function passed in</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-setText" name=".setText"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setText</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Sets this button's text</div>
+
+
+
+ <div class="long">
+
+ Sets this button's text
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
+
+ </dt>
+ <dd>The button text</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-setVisible" name=".setVisible"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setVisible</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Convenience function for boolean show/hide</div>
+
+
+
+ <div class="long">
+
+ Convenience function for boolean show/hide
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visible</b>
+
+ </dt>
+ <dd>True to show, false to hide</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-show" name=".show"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">show</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Show this button</div>
+
+
+
+ <div class="long">
+
+ Show this button
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Button-method-toggle" name=".toggle"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">toggle</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>state</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">If a state it passed, it becomes the pressed state otherwise the current state is toggled.</div>
+
+
+
+ <div class="long">
+
+ If a state it passed, it becomes the pressed state otherwise the current state is toggled.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>state</b>
+
+ </dt>
+ <dd>(optional) Force a particular state</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Button
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.Button-events"></a>
+
+
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Events</caption>
+ <thead>
+ <tr>
+ <th class="sig-header" colspan="2">Event</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+ </thead>
+
+
+
+
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Button-event-*click"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">click</b> (Button <B><i>this</i></B>, EventObject <B><i>e</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when this button is clicked
+
+ </div>
+
+ <div class="long">
+
+ Fires when this button is clicked
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Button</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont">EventObject</span> <b>e</b>
+
+ </dt>
+ <dd>The click event</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Button
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Button-event-*mouseout"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">mouseout</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when the mouse exits the button
+
+ </div>
+
+ <div class="long">
+
+ Fires when the mouse exits the button
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Button</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont">Event</span> <b>e</b>
+
+ </dt>
+ <dd>The event object</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Button
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Button-event-*mouseover"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">mouseover</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when the mouse hovers over the button
+
+ </div>
+
+ <div class="long">
+
+ Fires when the mouse hovers over the button
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Button</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont">Event</span> <b>e</b>
+
+ </dt>
+ <dd>The event object</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Button
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Button-event-*render"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">render</b> (Button <B><i>this</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when the button is rendered
+
+ </div>
+
+ <div class="long">
+
+ Fires when the button is rendered
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Button</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Button
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Button-event-*toggle"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">toggle</b> (Button <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>pressed</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when the "pressed" state of this button changes (only if enableToggle = true)
+
+ </div>
+
+ <div class="long">
+
+ Fires when the "pressed" state of this button changes (only if enableToggle = true)
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Button</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>pressed</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Button
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 15:55:21 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>