1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.Button</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.Button-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Button-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Button-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Button-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Button
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_Button.js.html">Roo/Button.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Button</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Button';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.Button.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.Button-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.Button-cfg-clickEvent" name=".clickEvent"></a>
132 <div class="fixedFont">
133 <b class="itemname">clickEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">The type of event to map to the button's event handler (defaults to 'click')</div>
143 <div class="long">The type of event to map to the button's event handler (defaults to 'click')</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.Button-cfg-cls" name=".cls"></a>
162 <div class="fixedFont">
163 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
169 <div class="short">A CSS class to apply to the button's main element.</div>
173 <div class="long">A CSS class to apply to the button's main element.</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.Button-cfg-disabled" name=".disabled"></a>
192 <div class="fixedFont">
193 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
199 <div class="short">True to start disabled (defaults to false)</div>
203 <div class="long">True to start disabled (defaults to false)</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.Button-cfg-enableToggle" name=".enableToggle"></a>
222 <div class="fixedFont">
223 <b class="itemname">enableToggle</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
229 <div class="short">True to enable pressed/not pressed toggling (defaults to false)</div>
233 <div class="long">True to enable pressed/not pressed toggling (defaults to false)</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.Button-cfg-handleMouseEvents" name=".handleMouseEvents"></a>
252 <div class="fixedFont">
253 <b class="itemname">handleMouseEvents</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
259 <div class="short">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div>
263 <div class="long">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.Button-cfg-handler" name=".handler"></a>
282 <div class="fixedFont">
283 <b class="itemname">handler</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
289 <div class="short">A function called when the button is clicked (can be used instead of click event)</div>
293 <div class="long">A function called when the button is clicked (can be used instead of click event)</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.Button-cfg-hidden" name=".hidden"></a>
312 <div class="fixedFont">
313 <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
319 <div class="short">True to start hidden (defaults to false)</div>
323 <div class="long">True to start hidden (defaults to false)</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.Button-cfg-icon" name=".icon"></a>
342 <div class="fixedFont">
343 <b class="itemname">icon</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
349 <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>
353 <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>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.Button-cfg-iconCls" name=".iconCls"></a>
372 <div class="fixedFont">
373 <b class="itemname">iconCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
379 <div class="short">A css class which sets a background image to be used as the icon for this button (defaults to undefined).</div>
383 <div class="long">A css class which sets a background image to be used as the icon for this button (defaults to undefined).</div>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.Button-cfg-menu" name=".menu"></a>
402 <div class="fixedFont">
403 <b class="itemname">menu</b> : Mixed
409 <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>
413 <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>
427 <tr class="config-row expandable config-row-alt0 notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.Button-cfg-menuAlign" name=".menuAlign"></a>
432 <div class="fixedFont">
433 <b class="itemname">menuAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
439 <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>
443 <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>
457 <tr class="config-row expandable config-row-alt1 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.Button-cfg-minWidth" name=".minWidth"></a>
462 <div class="fixedFont">
463 <b class="itemname">minWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
469 <div class="short">The minimum width for this button (used to give a set of buttons a common width)</div>
473 <div class="long">The minimum width for this button (used to give a set of buttons a common width)</div>
487 <tr class="config-row expandable config-row-alt0 notInherited">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.Button-cfg-pressed" name=".pressed"></a>
492 <div class="fixedFont">
493 <b class="itemname">pressed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
499 <div class="short">True to start pressed (only if enableToggle = true)</div>
503 <div class="long">True to start pressed (only if enableToggle = true)</div>
517 <tr class="config-row expandable config-row-alt1 notInherited">
518 <td class="micon"><a class="exi" href="#expand"> </a></td>
521 <a id="Roo.Button-cfg-renderTo" name=".renderTo"></a>
522 <div class="fixedFont">
523 <b class="itemname">renderTo</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
529 <div class="short">The element to append the button to</div>
533 <div class="long">The element to append the button to</div>
547 <tr class="config-row expandable config-row-alt0 notInherited">
548 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.Button-cfg-repeat" name=".repeat"></a>
552 <div class="fixedFont">
553 <b class="itemname">repeat</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Object
559 <div class="short">True to repeat fire the click event while the mouse is down.</div>
563 <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>
577 <tr class="config-row expandable config-row-alt1 notInherited">
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
581 <a id="Roo.Button-cfg-scope" name=".scope"></a>
582 <div class="fixedFont">
583 <b class="itemname">scope</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
589 <div class="short">The scope of the handler</div>
593 <div class="long">The scope of the handler</div>
607 <tr class="config-row expandable config-row-alt0 notInherited">
608 <td class="micon"><a class="exi" href="#expand"> </a></td>
611 <a id="Roo.Button-cfg-tabIndex" name=".tabIndex"></a>
612 <div class="fixedFont">
613 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
619 <div class="short">The DOM tabIndex for this button (defaults to undefined)</div>
623 <div class="long">The DOM tabIndex for this button (defaults to undefined)</div>
637 <tr class="config-row expandable config-row-alt1 notInherited">
638 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.Button-cfg-template" name=".template"></a>
642 <div class="fixedFont">
643 <b class="itemname">template</b> : <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
649 <div class="short">(Optional)<br/>An {<b>link</b> Roo.Template} with which to create the Button's main element.</div>
653 <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>
667 <tr class="config-row expandable config-row-alt0 notInherited">
668 <td class="micon"><a class="exi" href="#expand"> </a></td>
671 <a id="Roo.Button-cfg-text" name=".text"></a>
672 <div class="fixedFont">
673 <b class="itemname">text</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
679 <div class="short">The button text</div>
683 <div class="long">The button text</div>
697 <tr class="config-row expandable config-row-alt1 notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
701 <a id="Roo.Button-cfg-toggleGroup" name=".toggleGroup"></a>
702 <div class="fixedFont">
703 <b class="itemname">toggleGroup</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
709 <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>
713 <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>
727 <tr class="config-row expandable config-row-alt0 notInherited">
728 <td class="micon"><a class="exi" href="#expand"> </a></td>
731 <a id="Roo.Button-cfg-tooltip" name=".tooltip"></a>
732 <div class="fixedFont">
733 <b class="itemname">tooltip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
739 <div class="short">The tooltip for the button - can be a string or QuickTips config object</div>
743 <div class="long">The tooltip for the button - can be a string or QuickTips config object</div>
757 <tr class="config-row expandable config-row-alt1 notInherited">
758 <td class="micon"><a class="exi" href="#expand"> </a></td>
761 <a id="Roo.Button-cfg-tooltipType" name=".tooltipType"></a>
762 <div class="fixedFont">
763 <b class="itemname">tooltipType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
769 <div class="short">The type of tooltip to use.</div>
773 <div class="long">The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.</div>
787 <tr class="config-row expandable config-row-alt0 notInherited">
788 <td class="micon"><a class="exi" href="#expand"> </a></td>
791 <a id="Roo.Button-cfg-type" name=".type"></a>
792 <div class="fixedFont">
793 <b class="itemname">type</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
799 <div class="short">The button's type, corresponding to the DOM input element type attribute.</div>
803 <div class="long">The button's type, corresponding to the DOM input element type attribute. Either "submit," "reset" or "button" (default).</div>
827 <!-- ============================== public properties ==================== -->
831 <a id="Roo.Button-props"></a>
837 <table cellspacing="0" class="member-table">
838 <caption class="Empty">Public Properties - Has None</caption>
844 <!-- ============================== methods summary / details ======================== -->
847 <a id="Roo.Button-methods"></a>
848 <!-- constructor?? -->
855 <!-- then dynamics first -->
862 <table cellspacing="0" class="member-table">
863 <caption>Public Methods</caption>
865 <th class="sig-header" colspan="2">Method</th>
866 <th class="msource-header">Defined By</th>
876 <tr class="method-row config-row-alt0 expandable notInherited">
877 <td class="micon"><a class="exi" href="#expand"> </a></td>
881 <a id="Roo-method-Button" name=".Button"></a>
882 <div class="fixedFont">
883 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Button</b>
885 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
893 <div class="short">Create a new Roo.Button</div>
900 Create a new Roo.Button
903 <dl class="detailList">
904 <dt class="heading">Parameters:</dt>
907 <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>
910 <dd>The config object</dd>
934 <tr class="method-row config-row-alt1 expandable notInherited">
935 <td class="micon"><a class="exi" href="#expand"> </a></td>
939 <a id="Roo.Button-method-destroy" name=".destroy"></a>
940 <div class="fixedFont">
941 <span class="attributes"></span><b class="itemname">destroy</b>
950 <div class="short">Destroys this Button and removes any listeners.</div>
956 Destroys this Button and removes any listeners.
985 <tr class="method-row config-row-alt0 expandable notInherited">
986 <td class="micon"><a class="exi" href="#expand"> </a></td>
990 <a id="Roo.Button-method-disable" name=".disable"></a>
991 <div class="fixedFont">
992 <span class="attributes"></span><b class="itemname">disable</b>
1001 <div class="short">Disable this button</div>
1028 <td class="msource">
1036 <tr class="method-row config-row-alt1 expandable notInherited">
1037 <td class="micon"><a class="exi" href="#expand"> </a></td>
1041 <a id="Roo.Button-method-enable" name=".enable"></a>
1042 <div class="fixedFont">
1043 <span class="attributes"></span><b class="itemname">enable</b>
1052 <div class="short">Enable this button</div>
1079 <td class="msource">
1087 <tr class="method-row config-row-alt0 expandable notInherited">
1088 <td class="micon"><a class="exi" href="#expand"> </a></td>
1092 <a id="Roo.Button-method-focus" name=".focus"></a>
1093 <div class="fixedFont">
1094 <span class="attributes"></span><b class="itemname">focus</b>
1103 <div class="short">Focus the button</div>
1130 <td class="msource">
1138 <tr class="method-row config-row-alt1 expandable notInherited">
1139 <td class="micon"><a class="exi" href="#expand"> </a></td>
1143 <a id="Roo.Button-method-getEl" name=".getEl"></a>
1144 <div class="fixedFont">
1145 <span class="attributes"></span><b class="itemname">getEl</b>
1153 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1162 <div class="short">Returns the button's underlying element</div>
1168 Returns the button's underlying element
1179 <dl class="detailList">
1180 <dt class="heading">Returns:</dt>
1182 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1196 <td class="msource">
1204 <tr class="method-row config-row-alt0 expandable notInherited">
1205 <td class="micon"><a class="exi" href="#expand"> </a></td>
1209 <a id="Roo.Button-method-getText" name=".getText"></a>
1210 <div class="fixedFont">
1211 <span class="attributes"></span><b class="itemname">getText</b>
1219 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1228 <div class="short">Gets the text for this button</div>
1234 Gets the text for this button
1245 <dl class="detailList">
1246 <dt class="heading">Returns:</dt>
1248 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The button text</dd>
1262 <td class="msource">
1270 <tr class="method-row config-row-alt1 expandable notInherited">
1271 <td class="micon"><a class="exi" href="#expand"> </a></td>
1275 <a id="Roo.Button-method-hide" name=".hide"></a>
1276 <div class="fixedFont">
1277 <span class="attributes"></span><b class="itemname">hide</b>
1286 <div class="short">Hide this button</div>
1313 <td class="msource">
1321 <tr class="method-row config-row-alt0 expandable notInherited">
1322 <td class="micon"><a class="exi" href="#expand"> </a></td>
1326 <a id="Roo.Button-method-setDisabled" name=".setDisabled"></a>
1327 <div class="fixedFont">
1328 <span class="attributes"></span><b class="itemname">setDisabled</b>
1330 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>enabled</i></B>)
1337 <div class="short">Convenience function for boolean enable/disable</div>
1343 Convenience function for boolean enable/disable
1350 <dl class="detailList">
1351 <dt class="heading">Parameters:</dt>
1354 <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>
1357 <dd>True to enable, false to disable</dd>
1375 <td class="msource">
1383 <tr class="method-row config-row-alt1 expandable notInherited">
1384 <td class="micon"><a class="exi" href="#expand"> </a></td>
1388 <a id="Roo.Button-method-setHandler" name=".setHandler"></a>
1389 <div class="fixedFont">
1390 <span class="attributes"></span><b class="itemname">setHandler</b>
1392 (<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>)
1399 <div class="short">Assigns this button's click handler</div>
1405 Assigns this button's click handler
1412 <dl class="detailList">
1413 <dt class="heading">Parameters:</dt>
1416 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1419 <dd>The function to call when the button is clicked</dd>
1422 <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>
1425 <dd>(optional) Scope for the function passed in</dd>
1443 <td class="msource">
1451 <tr class="method-row config-row-alt0 expandable notInherited">
1452 <td class="micon"><a class="exi" href="#expand"> </a></td>
1456 <a id="Roo.Button-method-setText" name=".setText"></a>
1457 <div class="fixedFont">
1458 <span class="attributes"></span><b class="itemname">setText</b>
1460 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
1467 <div class="short">Sets this button's text</div>
1473 Sets this button's text
1480 <dl class="detailList">
1481 <dt class="heading">Parameters:</dt>
1484 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
1487 <dd>The button text</dd>
1505 <td class="msource">
1513 <tr class="method-row config-row-alt1 expandable notInherited">
1514 <td class="micon"><a class="exi" href="#expand"> </a></td>
1518 <a id="Roo.Button-method-setVisible" name=".setVisible"></a>
1519 <div class="fixedFont">
1520 <span class="attributes"></span><b class="itemname">setVisible</b>
1522 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1529 <div class="short">Convenience function for boolean show/hide</div>
1535 Convenience function for boolean show/hide
1542 <dl class="detailList">
1543 <dt class="heading">Parameters:</dt>
1546 <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>
1549 <dd>True to show, false to hide</dd>
1567 <td class="msource">
1575 <tr class="method-row config-row-alt0 expandable notInherited">
1576 <td class="micon"><a class="exi" href="#expand"> </a></td>
1580 <a id="Roo.Button-method-show" name=".show"></a>
1581 <div class="fixedFont">
1582 <span class="attributes"></span><b class="itemname">show</b>
1591 <div class="short">Show this button</div>
1618 <td class="msource">
1626 <tr class="method-row config-row-alt1 expandable notInherited">
1627 <td class="micon"><a class="exi" href="#expand"> </a></td>
1631 <a id="Roo.Button-method-toggle" name=".toggle"></a>
1632 <div class="fixedFont">
1633 <span class="attributes"></span><b class="itemname">toggle</b>
1635 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>state</i></B>)
1642 <div class="short">If a state it passed, it becomes the pressed state otherwise the current state is toggled.</div>
1648 If a state it passed, it becomes the pressed state otherwise the current state is toggled.
1655 <dl class="detailList">
1656 <dt class="heading">Parameters:</dt>
1659 <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>
1662 <dd>(optional) Force a particular state</dd>
1680 <td class="msource">
1691 <!-- ============================== events summary / details ======================== -->
1694 <a id="Roo.Button-events"></a>
1703 <table cellspacing="0" class="member-table">
1704 <caption>Events</caption>
1707 <th class="sig-header" colspan="2">Event</th>
1708 <th class="msource-header">Defined By</th>
1717 <tr class="method-row expandable config-row-alt0 notInherited">
1718 <td class="micon"><a class="exi" href="#expand"> </a></td>
1721 <a id="Roo.Button-event-*click"></a>
1723 <div class="fixedFont">
1724 <b class="itemname">click</b> (Button <B><i>this</i></B>, EventObject <B><i>e</i></B>)
1730 <div class="short">Fires when this button is clicked
1736 Fires when this button is clicked
1742 <dl class="detailList">
1743 <dt class="heading">Parameters:</dt>
1746 <span class="fixedFont">Button</span> <b>this</b>
1752 <span class="fixedFont">EventObject</span> <b>e</b>
1755 <dd>The click event</dd>
1773 <td class="msource">
1778 <tr class="method-row expandable config-row-alt1 notInherited">
1779 <td class="micon"><a class="exi" href="#expand"> </a></td>
1782 <a id="Roo.Button-event-*mouseout"></a>
1784 <div class="fixedFont">
1785 <b class="itemname">mouseout</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
1791 <div class="short">Fires when the mouse exits the button
1797 Fires when the mouse exits the button
1803 <dl class="detailList">
1804 <dt class="heading">Parameters:</dt>
1807 <span class="fixedFont">Button</span> <b>this</b>
1813 <span class="fixedFont">Event</span> <b>e</b>
1816 <dd>The event object</dd>
1834 <td class="msource">
1839 <tr class="method-row expandable config-row-alt0 notInherited">
1840 <td class="micon"><a class="exi" href="#expand"> </a></td>
1843 <a id="Roo.Button-event-*mouseover"></a>
1845 <div class="fixedFont">
1846 <b class="itemname">mouseover</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
1852 <div class="short">Fires when the mouse hovers over the button
1858 Fires when the mouse hovers over the button
1864 <dl class="detailList">
1865 <dt class="heading">Parameters:</dt>
1868 <span class="fixedFont">Button</span> <b>this</b>
1874 <span class="fixedFont">Event</span> <b>e</b>
1877 <dd>The event object</dd>
1895 <td class="msource">
1900 <tr class="method-row expandable config-row-alt1 notInherited">
1901 <td class="micon"><a class="exi" href="#expand"> </a></td>
1904 <a id="Roo.Button-event-*render"></a>
1906 <div class="fixedFont">
1907 <b class="itemname">render</b> (Button <B><i>this</i></B>)
1913 <div class="short">Fires when the button is rendered
1919 Fires when the button is rendered
1925 <dl class="detailList">
1926 <dt class="heading">Parameters:</dt>
1929 <span class="fixedFont">Button</span> <b>this</b>
1950 <td class="msource">
1955 <tr class="method-row expandable config-row-alt0 notInherited">
1956 <td class="micon"><a class="exi" href="#expand"> </a></td>
1959 <a id="Roo.Button-event-*toggle"></a>
1961 <div class="fixedFont">
1962 <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>)
1968 <div class="short">Fires when the "pressed" state of this button changes (only if enableToggle = true)
1974 Fires when the "pressed" state of this button changes (only if enableToggle = true)
1980 <dl class="detailList">
1981 <dt class="heading">Parameters:</dt>
1984 <span class="fixedFont">Button</span> <b>this</b>
1990 <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>
2011 <td class="msource">
2023 <!-- ============================== footer ================================= -->
2024 <div class="fineprint" style="clear:both">
2026 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:05:42 GMT+0800 (HKT)
2028 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>