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>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.SplitButton.html#constructor" roo:cls="Roo.SplitButton.html#constructor">Roo.SplitButton</a>, <a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>, <a href="./Roo.Toolbar.SplitButton.html#constructor" roo:cls="Roo.Toolbar.SplitButton.html#constructor">Roo.Toolbar.SplitButton</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Button';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.Button.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.Button-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0 notInherited">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.Button-cfg-clickEvent" name=".clickEvent"></a>
139 <div class="fixedFont">
140 <b class="itemname">clickEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
146 <div class="short">The type of event to map to the button's event handler (defaults to 'click')</div>
150 <div class="long">The type of event to map to the button's event handler (defaults to 'click')</div>
164 <tr class="config-row expandable config-row-alt1 notInherited">
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
168 <a id="Roo.Button-cfg-cls" name=".cls"></a>
169 <div class="fixedFont">
170 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
176 <div class="short">A CSS class to apply to the button's main element.</div>
180 <div class="long">A CSS class to apply to the button's main element.</div>
194 <tr class="config-row expandable config-row-alt0 notInherited">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.Button-cfg-disabled" name=".disabled"></a>
199 <div class="fixedFont">
200 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
206 <div class="short">True to start disabled (defaults to false)</div>
210 <div class="long">True to start disabled (defaults to false)</div>
224 <tr class="config-row expandable config-row-alt1 notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.Button-cfg-enableToggle" name=".enableToggle"></a>
229 <div class="fixedFont">
230 <b class="itemname">enableToggle</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
236 <div class="short">True to enable pressed/not pressed toggling (defaults to false)</div>
240 <div class="long">True to enable pressed/not pressed toggling (defaults to false)</div>
254 <tr class="config-row expandable config-row-alt0 notInherited">
255 <td class="micon"><a class="exi" href="#expand"> </a></td>
258 <a id="Roo.Button-cfg-handleMouseEvents" name=".handleMouseEvents"></a>
259 <div class="fixedFont">
260 <b class="itemname">handleMouseEvents</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
266 <div class="short">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div>
270 <div class="long">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div>
284 <tr class="config-row expandable config-row-alt1 notInherited">
285 <td class="micon"><a class="exi" href="#expand"> </a></td>
288 <a id="Roo.Button-cfg-handler" name=".handler"></a>
289 <div class="fixedFont">
290 <b class="itemname">handler</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
296 <div class="short">A function called when the button is clicked (can be used instead of click event)</div>
300 <div class="long">A function called when the button is clicked (can be used instead of click event)</div>
314 <tr class="config-row expandable config-row-alt0 notInherited">
315 <td class="micon"><a class="exi" href="#expand"> </a></td>
318 <a id="Roo.Button-cfg-hidden" name=".hidden"></a>
319 <div class="fixedFont">
320 <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
326 <div class="short">True to start hidden (defaults to false)</div>
330 <div class="long">True to start hidden (defaults to false)</div>
344 <tr class="config-row expandable config-row-alt1 notInherited">
345 <td class="micon"><a class="exi" href="#expand"> </a></td>
348 <a id="Roo.Button-cfg-icon" name=".icon"></a>
349 <div class="fixedFont">
350 <b class="itemname">icon</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
356 <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>
360 <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>
374 <tr class="config-row expandable config-row-alt0 notInherited">
375 <td class="micon"><a class="exi" href="#expand"> </a></td>
378 <a id="Roo.Button-cfg-iconCls" name=".iconCls"></a>
379 <div class="fixedFont">
380 <b class="itemname">iconCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
386 <div class="short">A css class which sets a background image to be used as the icon for this button (defaults to undefined).</div>
390 <div class="long">A css class which sets a background image to be used as the icon for this button (defaults to undefined).</div>
404 <tr class="config-row expandable config-row-alt1">
405 <td class="micon"><a class="exi" href="#expand"> </a></td>
408 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
409 <div class="fixedFont">
410 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
416 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
420 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
428 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
434 <tr class="config-row expandable config-row-alt0 notInherited">
435 <td class="micon"><a class="exi" href="#expand"> </a></td>
438 <a id="Roo.Button-cfg-menu" name=".menu"></a>
439 <div class="fixedFont">
440 <b class="itemname">menu</b> : Mixed
446 <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>
450 <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>
464 <tr class="config-row expandable config-row-alt1 notInherited">
465 <td class="micon"><a class="exi" href="#expand"> </a></td>
468 <a id="Roo.Button-cfg-menuAlign" name=".menuAlign"></a>
469 <div class="fixedFont">
470 <b class="itemname">menuAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
476 <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>
480 <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>
494 <tr class="config-row expandable config-row-alt0 notInherited">
495 <td class="micon"><a class="exi" href="#expand"> </a></td>
498 <a id="Roo.Button-cfg-minWidth" name=".minWidth"></a>
499 <div class="fixedFont">
500 <b class="itemname">minWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
506 <div class="short">The minimum width for this button (used to give a set of buttons a common width)</div>
510 <div class="long">The minimum width for this button (used to give a set of buttons a common width)</div>
524 <tr class="config-row expandable config-row-alt1 notInherited">
525 <td class="micon"><a class="exi" href="#expand"> </a></td>
528 <a id="Roo.Button-cfg-pressed" name=".pressed"></a>
529 <div class="fixedFont">
530 <b class="itemname">pressed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
536 <div class="short">True to start pressed (only if enableToggle = true)</div>
540 <div class="long">True to start pressed (only if enableToggle = true)</div>
554 <tr class="config-row expandable config-row-alt0 notInherited">
555 <td class="micon"><a class="exi" href="#expand"> </a></td>
558 <a id="Roo.Button-cfg-renderTo" name=".renderTo"></a>
559 <div class="fixedFont">
560 <b class="itemname">renderTo</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
566 <div class="short">The element to append the button to</div>
570 <div class="long">The element to append the button to</div>
584 <tr class="config-row expandable config-row-alt1 notInherited">
585 <td class="micon"><a class="exi" href="#expand"> </a></td>
588 <a id="Roo.Button-cfg-repeat" name=".repeat"></a>
589 <div class="fixedFont">
590 <b class="itemname">repeat</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Object
596 <div class="short">True to repeat fire the click event while the mouse is down.</div>
600 <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>
614 <tr class="config-row expandable config-row-alt0 notInherited">
615 <td class="micon"><a class="exi" href="#expand"> </a></td>
618 <a id="Roo.Button-cfg-scope" name=".scope"></a>
619 <div class="fixedFont">
620 <b class="itemname">scope</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
626 <div class="short">The scope of the handler</div>
630 <div class="long">The scope of the handler</div>
644 <tr class="config-row expandable config-row-alt1 notInherited">
645 <td class="micon"><a class="exi" href="#expand"> </a></td>
648 <a id="Roo.Button-cfg-tabIndex" name=".tabIndex"></a>
649 <div class="fixedFont">
650 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
656 <div class="short">The DOM tabIndex for this button (defaults to undefined)</div>
660 <div class="long">The DOM tabIndex for this button (defaults to undefined)</div>
674 <tr class="config-row expandable config-row-alt0 notInherited">
675 <td class="micon"><a class="exi" href="#expand"> </a></td>
678 <a id="Roo.Button-cfg-template" name=".template"></a>
679 <div class="fixedFont">
680 <b class="itemname">template</b> : <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
686 <div class="short">(Optional)<br/>An {<b>link</b> Roo.Template} with which to create the Button's main element.</div>
690 <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>
704 <tr class="config-row expandable config-row-alt1 notInherited">
705 <td class="micon"><a class="exi" href="#expand"> </a></td>
708 <a id="Roo.Button-cfg-text" name=".text"></a>
709 <div class="fixedFont">
710 <b class="itemname">text</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
716 <div class="short">The button text</div>
720 <div class="long">The button text</div>
734 <tr class="config-row expandable config-row-alt0 notInherited">
735 <td class="micon"><a class="exi" href="#expand"> </a></td>
738 <a id="Roo.Button-cfg-toggleGroup" name=".toggleGroup"></a>
739 <div class="fixedFont">
740 <b class="itemname">toggleGroup</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
746 <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>
750 <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>
764 <tr class="config-row expandable config-row-alt1 notInherited">
765 <td class="micon"><a class="exi" href="#expand"> </a></td>
768 <a id="Roo.Button-cfg-tooltip" name=".tooltip"></a>
769 <div class="fixedFont">
770 <b class="itemname">tooltip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
776 <div class="short">The tooltip for the button - can be a string or QuickTips config object</div>
780 <div class="long">The tooltip for the button - can be a string or QuickTips config object</div>
794 <tr class="config-row expandable config-row-alt0 notInherited">
795 <td class="micon"><a class="exi" href="#expand"> </a></td>
798 <a id="Roo.Button-cfg-tooltipType" name=".tooltipType"></a>
799 <div class="fixedFont">
800 <b class="itemname">tooltipType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
806 <div class="short">The type of tooltip to use.</div>
810 <div class="long">The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.</div>
824 <tr class="config-row expandable config-row-alt1 notInherited">
825 <td class="micon"><a class="exi" href="#expand"> </a></td>
828 <a id="Roo.Button-cfg-type" name=".type"></a>
829 <div class="fixedFont">
830 <b class="itemname">type</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
836 <div class="short">The button's type, corresponding to the DOM input element type attribute.</div>
840 <div class="long">The button's type, corresponding to the DOM input element type attribute. Either "submit," "reset" or "button" (default).</div>
864 <!-- ============================== public properties ==================== -->
868 <a id="Roo.Button-props"></a>
874 <table cellspacing="0" class="member-table">
875 <caption class="Empty">Public Properties - Has None</caption>
881 <!-- ============================== methods summary / details ======================== -->
884 <a id="Roo.Button-methods"></a>
885 <!-- constructor?? -->
892 <!-- then dynamics first -->
899 <table cellspacing="0" class="member-table">
900 <caption>Public Methods</caption>
902 <th class="sig-header" colspan="2">Method</th>
903 <th class="msource-header">Defined By</th>
913 <tr class="method-row config-row-alt0 expandable notInherited">
914 <td class="micon"><a class="exi" href="#expand"> </a></td>
918 <a id="Roo-method-Button" name=".Button"></a>
919 <div class="fixedFont">
920 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Button</b>
922 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
930 <div class="short">Create a new Roo.Button</div>
937 Create a new Roo.Button
940 <dl class="detailList">
941 <dt class="heading">Parameters:</dt>
944 <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>
947 <dd>The config object</dd>
971 <tr class="method-row config-row-alt1 expandable">
972 <td class="micon"><a class="exi" href="#expand"> </a></td>
976 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
977 <div class="fixedFont">
978 <span class="attributes"></span><b class="itemname">addEvents</b>
980 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
987 <div class="short">Used to define events on this Observable</div>
993 Used to define events on this Observable
1000 <dl class="detailList">
1001 <dt class="heading">Parameters:</dt>
1004 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
1007 <dd>The object with the events defined</dd>
1025 <td class="msource">
1027 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1033 <tr class="method-row config-row-alt0 expandable">
1034 <td class="micon"><a class="exi" href="#expand"> </a></td>
1038 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1039 <div class="fixedFont">
1040 <span class="attributes"></span><b class="itemname">addListener</b>
1042 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></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>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1049 <div class="short">Appends an event handler to this component</div>
1055 Appends an event handler to this component
1062 <dl class="detailList">
1063 <dt class="heading">Parameters:</dt>
1066 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1069 <dd>The type of event to listen for</dd>
1072 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1075 <dd>The method the event invokes</dd>
1078 <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>
1081 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1084 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1087 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
1105 <td class="msource">
1107 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1113 <tr class="method-row config-row-alt1 expandable notInherited">
1114 <td class="micon"><a class="exi" href="#expand"> </a></td>
1118 <a id="Roo.Button-method-destroy" name=".destroy"></a>
1119 <div class="fixedFont">
1120 <span class="attributes"></span><b class="itemname">destroy</b>
1129 <div class="short">Destroys this Button and removes any listeners.</div>
1135 Destroys this Button and removes any listeners.
1156 <td class="msource">
1164 <tr class="method-row config-row-alt0 expandable notInherited">
1165 <td class="micon"><a class="exi" href="#expand"> </a></td>
1169 <a id="Roo.Button-method-disable" name=".disable"></a>
1170 <div class="fixedFont">
1171 <span class="attributes"></span><b class="itemname">disable</b>
1180 <div class="short">Disable this button</div>
1207 <td class="msource">
1215 <tr class="method-row config-row-alt1 expandable notInherited">
1216 <td class="micon"><a class="exi" href="#expand"> </a></td>
1220 <a id="Roo.Button-method-enable" name=".enable"></a>
1221 <div class="fixedFont">
1222 <span class="attributes"></span><b class="itemname">enable</b>
1231 <div class="short">Enable this button</div>
1258 <td class="msource">
1266 <tr class="method-row config-row-alt0 expandable">
1267 <td class="micon"><a class="exi" href="#expand"> </a></td>
1271 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1272 <div class="fixedFont">
1273 <span class="attributes"></span><b class="itemname">fireEvent</b>
1275 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1281 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1290 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1296 Fires the specified event with the passed parameters (minus the event name).
1303 <dl class="detailList">
1304 <dt class="heading">Parameters:</dt>
1307 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1313 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
1316 <dd>Variable number of parameters are passed to handlers</dd>
1324 <dl class="detailList">
1325 <dt class="heading">Returns:</dt>
1327 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
1341 <td class="msource">
1343 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1349 <tr class="method-row config-row-alt1 expandable notInherited">
1350 <td class="micon"><a class="exi" href="#expand"> </a></td>
1354 <a id="Roo.Button-method-focus" name=".focus"></a>
1355 <div class="fixedFont">
1356 <span class="attributes"></span><b class="itemname">focus</b>
1365 <div class="short">Focus the button</div>
1392 <td class="msource">
1400 <tr class="method-row config-row-alt0 expandable notInherited">
1401 <td class="micon"><a class="exi" href="#expand"> </a></td>
1405 <a id="Roo.Button-method-getEl" name=".getEl"></a>
1406 <div class="fixedFont">
1407 <span class="attributes"></span><b class="itemname">getEl</b>
1415 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1424 <div class="short">Returns the button's underlying element</div>
1430 Returns the button's underlying element
1441 <dl class="detailList">
1442 <dt class="heading">Returns:</dt>
1444 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1458 <td class="msource">
1466 <tr class="method-row config-row-alt1 expandable notInherited">
1467 <td class="micon"><a class="exi" href="#expand"> </a></td>
1471 <a id="Roo.Button-method-getText" name=".getText"></a>
1472 <div class="fixedFont">
1473 <span class="attributes"></span><b class="itemname">getText</b>
1481 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1490 <div class="short">Gets the text for this button</div>
1496 Gets the text for this button
1507 <dl class="detailList">
1508 <dt class="heading">Returns:</dt>
1510 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The button text</dd>
1524 <td class="msource">
1532 <tr class="method-row config-row-alt0 expandable">
1533 <td class="micon"><a class="exi" href="#expand"> </a></td>
1537 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1538 <div class="fixedFont">
1539 <span class="attributes"></span><b class="itemname">hasListener</b>
1541 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1547 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1556 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1562 Checks to see if this object has any listeners for a specified event
1569 <dl class="detailList">
1570 <dt class="heading">Parameters:</dt>
1573 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1576 <dd>The name of the event to check for</dd>
1584 <dl class="detailList">
1585 <dt class="heading">Returns:</dt>
1587 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1601 <td class="msource">
1603 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1609 <tr class="method-row config-row-alt1 expandable notInherited">
1610 <td class="micon"><a class="exi" href="#expand"> </a></td>
1614 <a id="Roo.Button-method-hide" name=".hide"></a>
1615 <div class="fixedFont">
1616 <span class="attributes"></span><b class="itemname">hide</b>
1625 <div class="short">Hide this button</div>
1652 <td class="msource">
1660 <tr class="method-row config-row-alt0 expandable">
1661 <td class="micon"><a class="exi" href="#expand"> </a></td>
1665 <a id="Roo.util.Observable-method-on" name=".on"></a>
1666 <div class="fixedFont">
1667 <span class="attributes"></span><b class="itemname">on</b>
1669 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></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>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1676 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1682 Appends an event handler to this element (shorthand for addListener)
1689 <dl class="detailList">
1690 <dt class="heading">Parameters:</dt>
1693 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1696 <dd>The type of event to listen for</dd>
1699 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1702 <dd>The method the event invokes</dd>
1705 <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>
1708 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1711 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1732 <td class="msource">
1734 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1740 <tr class="method-row config-row-alt1 expandable">
1741 <td class="micon"><a class="exi" href="#expand"> </a></td>
1745 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1746 <div class="fixedFont">
1747 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1756 <div class="short">Removes all listeners for this object</div>
1762 Removes all listeners for this object
1783 <td class="msource">
1785 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1791 <tr class="method-row config-row-alt0 expandable">
1792 <td class="micon"><a class="exi" href="#expand"> </a></td>
1796 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1797 <div class="fixedFont">
1798 <span class="attributes"></span><b class="itemname">removeListener</b>
1800 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></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>)
1807 <div class="short">Removes a listener</div>
1820 <dl class="detailList">
1821 <dt class="heading">Parameters:</dt>
1824 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1827 <dd>The type of event to listen for</dd>
1830 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1833 <dd>The handler to remove</dd>
1836 <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>
1839 <dd>(optional) The scope (this object) for the handler</dd>
1857 <td class="msource">
1859 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1865 <tr class="method-row config-row-alt1 expandable notInherited">
1866 <td class="micon"><a class="exi" href="#expand"> </a></td>
1870 <a id="Roo.Button-method-setDisabled" name=".setDisabled"></a>
1871 <div class="fixedFont">
1872 <span class="attributes"></span><b class="itemname">setDisabled</b>
1874 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>enabled</i></B>)
1881 <div class="short">Convenience function for boolean enable/disable</div>
1887 Convenience function for boolean enable/disable
1894 <dl class="detailList">
1895 <dt class="heading">Parameters:</dt>
1898 <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>
1901 <dd>True to enable, false to disable</dd>
1919 <td class="msource">
1927 <tr class="method-row config-row-alt0 expandable notInherited">
1928 <td class="micon"><a class="exi" href="#expand"> </a></td>
1932 <a id="Roo.Button-method-setHandler" name=".setHandler"></a>
1933 <div class="fixedFont">
1934 <span class="attributes"></span><b class="itemname">setHandler</b>
1936 (<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>)
1943 <div class="short">Assigns this button's click handler</div>
1949 Assigns this button's click handler
1956 <dl class="detailList">
1957 <dt class="heading">Parameters:</dt>
1960 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1963 <dd>The function to call when the button is clicked</dd>
1966 <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>
1969 <dd>(optional) Scope for the function passed in</dd>
1987 <td class="msource">
1995 <tr class="method-row config-row-alt1 expandable notInherited">
1996 <td class="micon"><a class="exi" href="#expand"> </a></td>
2000 <a id="Roo.Button-method-setText" name=".setText"></a>
2001 <div class="fixedFont">
2002 <span class="attributes"></span><b class="itemname">setText</b>
2004 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
2011 <div class="short">Sets this button's text</div>
2017 Sets this button's text
2024 <dl class="detailList">
2025 <dt class="heading">Parameters:</dt>
2028 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
2031 <dd>The button text</dd>
2049 <td class="msource">
2057 <tr class="method-row config-row-alt0 expandable notInherited">
2058 <td class="micon"><a class="exi" href="#expand"> </a></td>
2062 <a id="Roo.Button-method-setVisible" name=".setVisible"></a>
2063 <div class="fixedFont">
2064 <span class="attributes"></span><b class="itemname">setVisible</b>
2066 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2073 <div class="short">Convenience function for boolean show/hide</div>
2079 Convenience function for boolean show/hide
2086 <dl class="detailList">
2087 <dt class="heading">Parameters:</dt>
2090 <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>
2093 <dd>True to show, false to hide</dd>
2111 <td class="msource">
2119 <tr class="method-row config-row-alt1 expandable notInherited">
2120 <td class="micon"><a class="exi" href="#expand"> </a></td>
2124 <a id="Roo.Button-method-show" name=".show"></a>
2125 <div class="fixedFont">
2126 <span class="attributes"></span><b class="itemname">show</b>
2135 <div class="short">Show this button</div>
2162 <td class="msource">
2170 <tr class="method-row config-row-alt0 expandable notInherited">
2171 <td class="micon"><a class="exi" href="#expand"> </a></td>
2175 <a id="Roo.Button-method-toggle" name=".toggle"></a>
2176 <div class="fixedFont">
2177 <span class="attributes"></span><b class="itemname">toggle</b>
2179 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>state</i></B>)
2186 <div class="short">If a state it passed, it becomes the pressed state otherwise the current state is toggled.</div>
2192 If a state it passed, it becomes the pressed state otherwise the current state is toggled.
2199 <dl class="detailList">
2200 <dt class="heading">Parameters:</dt>
2203 <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>
2206 <dd>(optional) Force a particular state</dd>
2224 <td class="msource">
2232 <tr class="method-row config-row-alt1 expandable">
2233 <td class="micon"><a class="exi" href="#expand"> </a></td>
2237 <a id="Roo.util.Observable-method-un" name=".un"></a>
2238 <div class="fixedFont">
2239 <span class="attributes"></span><b class="itemname">un</b>
2241 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></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>)
2248 <div class="short">Removes a listener (shorthand for removeListener)</div>
2254 Removes a listener (shorthand for removeListener)
2261 <dl class="detailList">
2262 <dt class="heading">Parameters:</dt>
2265 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2268 <dd>The type of event to listen for</dd>
2271 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2274 <dd>The handler to remove</dd>
2277 <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>
2280 <dd>(optional) The scope (this object) for the handler</dd>
2298 <td class="msource">
2300 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2309 <!-- ============================== events summary / details ======================== -->
2312 <a id="Roo.Button-events"></a>
2321 <table cellspacing="0" class="member-table">
2322 <caption>Events</caption>
2325 <th class="sig-header" colspan="2">Event</th>
2326 <th class="msource-header">Defined By</th>
2335 <tr class="method-row expandable config-row-alt0 notInherited">
2336 <td class="micon"><a class="exi" href="#expand"> </a></td>
2339 <a id="Roo.Button-event-*click"></a>
2341 <div class="fixedFont">
2342 <b class="itemname">click</b> (Button <B><i>this</i></B>, EventObject <B><i>e</i></B>)
2348 <div class="short">Fires when this button is clicked
2354 Fires when this button is clicked
2360 <dl class="detailList">
2361 <dt class="heading">Parameters:</dt>
2364 <span class="fixedFont">Button</span> <b>this</b>
2370 <span class="fixedFont">EventObject</span> <b>e</b>
2373 <dd>The click event</dd>
2391 <td class="msource">
2396 <tr class="method-row expandable config-row-alt1 notInherited">
2397 <td class="micon"><a class="exi" href="#expand"> </a></td>
2400 <a id="Roo.Button-event-*mouseout"></a>
2402 <div class="fixedFont">
2403 <b class="itemname">mouseout</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
2409 <div class="short">Fires when the mouse exits the button
2415 Fires when the mouse exits the button
2421 <dl class="detailList">
2422 <dt class="heading">Parameters:</dt>
2425 <span class="fixedFont">Button</span> <b>this</b>
2431 <span class="fixedFont">Event</span> <b>e</b>
2434 <dd>The event object</dd>
2452 <td class="msource">
2457 <tr class="method-row expandable config-row-alt0 notInherited">
2458 <td class="micon"><a class="exi" href="#expand"> </a></td>
2461 <a id="Roo.Button-event-*mouseover"></a>
2463 <div class="fixedFont">
2464 <b class="itemname">mouseover</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
2470 <div class="short">Fires when the mouse hovers over the button
2476 Fires when the mouse hovers over the button
2482 <dl class="detailList">
2483 <dt class="heading">Parameters:</dt>
2486 <span class="fixedFont">Button</span> <b>this</b>
2492 <span class="fixedFont">Event</span> <b>e</b>
2495 <dd>The event object</dd>
2513 <td class="msource">
2518 <tr class="method-row expandable config-row-alt1 notInherited">
2519 <td class="micon"><a class="exi" href="#expand"> </a></td>
2522 <a id="Roo.Button-event-*render"></a>
2524 <div class="fixedFont">
2525 <b class="itemname">render</b> (Button <B><i>this</i></B>)
2531 <div class="short">Fires when the button is rendered
2537 Fires when the button is rendered
2543 <dl class="detailList">
2544 <dt class="heading">Parameters:</dt>
2547 <span class="fixedFont">Button</span> <b>this</b>
2568 <td class="msource">
2573 <tr class="method-row expandable config-row-alt0 notInherited">
2574 <td class="micon"><a class="exi" href="#expand"> </a></td>
2577 <a id="Roo.Button-event-*toggle"></a>
2579 <div class="fixedFont">
2580 <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>)
2586 <div class="short">Fires when the "pressed" state of this button changes (only if enableToggle = true)
2592 Fires when the "pressed" state of this button changes (only if enableToggle = true)
2598 <dl class="detailList">
2599 <dt class="heading">Parameters:</dt>
2602 <span class="fixedFont">Button</span> <b>this</b>
2608 <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>
2629 <td class="msource">
2641 <!-- ============================== footer ================================= -->
2642 <div class="fineprint" style="clear:both">
2644 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Dec 06 2011 15:43:32 GMT+0800 (HKT)
2646 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>