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>
151 The type of event to map to the button's event handler (defaults to 'click')
167 <tr class="config-row expandable config-row-alt1 notInherited">
168 <td class="micon"><a class="exi" href="#expand"> </a></td>
171 <a id="Roo.Button-cfg-cls" name=".cls"></a>
172 <div class="fixedFont">
173 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
179 <div class="short">A CSS class to apply to the button's main element.</div>
184 A CSS class to apply to the button's main element.
200 <tr class="config-row expandable config-row-alt0 notInherited">
201 <td class="micon"><a class="exi" href="#expand"> </a></td>
204 <a id="Roo.Button-cfg-disabled" name=".disabled"></a>
205 <div class="fixedFont">
206 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
212 <div class="short">True to start disabled (defaults to false)</div>
217 True to start disabled (defaults to false)
233 <tr class="config-row expandable config-row-alt1 notInherited">
234 <td class="micon"><a class="exi" href="#expand"> </a></td>
237 <a id="Roo.Button-cfg-enableToggle" name=".enableToggle"></a>
238 <div class="fixedFont">
239 <b class="itemname">enableToggle</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
245 <div class="short">True to enable pressed/not pressed toggling (defaults to false)</div>
250 True to enable pressed/not pressed toggling (defaults to false)
266 <tr class="config-row expandable config-row-alt0 notInherited">
267 <td class="micon"><a class="exi" href="#expand"> </a></td>
270 <a id="Roo.Button-cfg-handleMouseEvents" name=".handleMouseEvents"></a>
271 <div class="fixedFont">
272 <b class="itemname">handleMouseEvents</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
278 <div class="short">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div>
283 False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
299 <tr class="config-row expandable config-row-alt1 notInherited">
300 <td class="micon"><a class="exi" href="#expand"> </a></td>
303 <a id="Roo.Button-cfg-handler" name=".handler"></a>
304 <div class="fixedFont">
305 <b class="itemname">handler</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
311 <div class="short">A function called when the button is clicked (can be used instead of click event)</div>
316 A function called when the button is clicked (can be used instead of click event)
332 <tr class="config-row expandable config-row-alt0 notInherited">
333 <td class="micon"><a class="exi" href="#expand"> </a></td>
336 <a id="Roo.Button-cfg-hidden" name=".hidden"></a>
337 <div class="fixedFont">
338 <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
344 <div class="short">True to start hidden (defaults to false)</div>
349 True to start hidden (defaults to false)
365 <tr class="config-row expandable config-row-alt1 notInherited">
366 <td class="micon"><a class="exi" href="#expand"> </a></td>
369 <a id="Roo.Button-cfg-icon" name=".icon"></a>
370 <div class="fixedFont">
371 <b class="itemname">icon</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
377 <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>
382 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")
398 <tr class="config-row expandable config-row-alt0 notInherited">
399 <td class="micon"><a class="exi" href="#expand"> </a></td>
402 <a id="Roo.Button-cfg-iconCls" name=".iconCls"></a>
403 <div class="fixedFont">
404 <b class="itemname">iconCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
410 <div class="short">A css class which sets a background image to be used as the icon for this button (defaults to undefined).</div>
415 A css class which sets a background image to be used as the icon for this button (defaults to undefined).
431 <tr class="config-row expandable config-row-alt1">
432 <td class="micon"><a class="exi" href="#expand"> </a></td>
435 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
436 <div class="fixedFont">
437 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
443 <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>
448 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>
458 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
464 <tr class="config-row expandable config-row-alt0 notInherited">
465 <td class="micon"><a class="exi" href="#expand"> </a></td>
468 <a id="Roo.Button-cfg-menu" name=".menu"></a>
469 <div class="fixedFont">
470 <b class="itemname">menu</b> : Mixed
476 <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>
481 Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
497 <tr class="config-row expandable config-row-alt1 notInherited">
498 <td class="micon"><a class="exi" href="#expand"> </a></td>
501 <a id="Roo.Button-cfg-menuAlign" name=".menuAlign"></a>
502 <div class="fixedFont">
503 <b class="itemname">menuAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
509 <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>
514 The position to align the menu to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to 'tl-bl?').
530 <tr class="config-row expandable config-row-alt0 notInherited">
531 <td class="micon"><a class="exi" href="#expand"> </a></td>
534 <a id="Roo.Button-cfg-minWidth" name=".minWidth"></a>
535 <div class="fixedFont">
536 <b class="itemname">minWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
542 <div class="short">The minimum width for this button (used to give a set of buttons a common width)</div>
547 The minimum width for this button (used to give a set of buttons a common width)
563 <tr class="config-row expandable config-row-alt1 notInherited">
564 <td class="micon"><a class="exi" href="#expand"> </a></td>
567 <a id="Roo.Button-cfg-pressed" name=".pressed"></a>
568 <div class="fixedFont">
569 <b class="itemname">pressed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
575 <div class="short">True to start pressed (only if enableToggle = true)</div>
580 True to start pressed (only if enableToggle = true)
596 <tr class="config-row expandable config-row-alt0 notInherited">
597 <td class="micon"><a class="exi" href="#expand"> </a></td>
600 <a id="Roo.Button-cfg-renderTo" name=".renderTo"></a>
601 <div class="fixedFont">
602 <b class="itemname">renderTo</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
608 <div class="short">The element to append the button to</div>
613 The element to append the button to
629 <tr class="config-row expandable config-row-alt1 notInherited">
630 <td class="micon"><a class="exi" href="#expand"> </a></td>
633 <a id="Roo.Button-cfg-repeat" name=".repeat"></a>
634 <div class="fixedFont">
635 <b class="itemname">repeat</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Object
641 <div class="short">True to repeat fire the click event while the mouse is down.</div>
646 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).
662 <tr class="config-row expandable config-row-alt0 notInherited">
663 <td class="micon"><a class="exi" href="#expand"> </a></td>
666 <a id="Roo.Button-cfg-scope" name=".scope"></a>
667 <div class="fixedFont">
668 <b class="itemname">scope</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
674 <div class="short">The scope of the handler</div>
679 The scope of the handler
695 <tr class="config-row expandable config-row-alt1 notInherited">
696 <td class="micon"><a class="exi" href="#expand"> </a></td>
699 <a id="Roo.Button-cfg-tabIndex" name=".tabIndex"></a>
700 <div class="fixedFont">
701 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
707 <div class="short">The DOM tabIndex for this button (defaults to undefined)</div>
712 The DOM tabIndex for this button (defaults to undefined)
728 <tr class="config-row expandable config-row-alt0 notInherited">
729 <td class="micon"><a class="exi" href="#expand"> </a></td>
732 <a id="Roo.Button-cfg-template" name=".template"></a>
733 <div class="fixedFont">
734 <b class="itemname">template</b> : <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
740 <div class="short">(Optional)<br/>An {<b>link</b> Roo.Template} with which to create the Button's main element.</div>
745 (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.
761 <tr class="config-row expandable config-row-alt1 notInherited">
762 <td class="micon"><a class="exi" href="#expand"> </a></td>
765 <a id="Roo.Button-cfg-text" name=".text"></a>
766 <div class="fixedFont">
767 <b class="itemname">text</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
773 <div class="short">The button text</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-toggleGroup" name=".toggleGroup"></a>
799 <div class="fixedFont">
800 <b class="itemname">toggleGroup</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
806 <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>
811 The group this toggle button is a member of (only 1 per group can be pressed, only<br/> applies if enableToggle = true)
827 <tr class="config-row expandable config-row-alt1 notInherited">
828 <td class="micon"><a class="exi" href="#expand"> </a></td>
831 <a id="Roo.Button-cfg-tooltip" name=".tooltip"></a>
832 <div class="fixedFont">
833 <b class="itemname">tooltip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
839 <div class="short">The tooltip for the button - can be a string or QuickTips config object</div>
844 The tooltip for the button - can be a string or QuickTips config object
860 <tr class="config-row expandable config-row-alt0 notInherited">
861 <td class="micon"><a class="exi" href="#expand"> </a></td>
864 <a id="Roo.Button-cfg-tooltipType" name=".tooltipType"></a>
865 <div class="fixedFont">
866 <b class="itemname">tooltipType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
872 <div class="short">The type of tooltip to use.</div>
877 The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.
893 <tr class="config-row expandable config-row-alt1 notInherited">
894 <td class="micon"><a class="exi" href="#expand"> </a></td>
897 <a id="Roo.Button-cfg-type" name=".type"></a>
898 <div class="fixedFont">
899 <b class="itemname">type</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
905 <div class="short">The button's type, corresponding to the DOM input element type attribute.</div>
910 The button's type, corresponding to the DOM input element type attribute. Either "submit," "reset" or "button" (default).
936 <!-- ============================== public properties ==================== -->
940 <a id="Roo.Button-props"></a>
946 <table cellspacing="0" class="member-table">
947 <caption class="Empty">Public Properties - Has None</caption>
953 <!-- ============================== methods summary / details ======================== -->
956 <a id="Roo.Button-methods"></a>
957 <!-- constructor?? -->
964 <!-- then dynamics first -->
971 <table cellspacing="0" class="member-table">
972 <caption>Public Methods</caption>
974 <th class="sig-header" colspan="2">Method</th>
975 <th class="msource-header">Defined By</th>
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-method-Button" name=".Button"></a>
991 <div class="fixedFont">
992 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Button</b>
994 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1002 <div class="short">Create a new Roo.Button</div>
1009 Create a new Roo.Button
1012 <dl class="detailList">
1013 <dt class="heading">Parameters:</dt>
1016 <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>
1019 <dd>The config object</dd>
1037 <td class="msource">
1043 <tr class="method-row config-row-alt1 expandable">
1044 <td class="micon"><a class="exi" href="#expand"> </a></td>
1048 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1049 <div class="fixedFont">
1050 <span class="attributes"></span><b class="itemname">addEvents</b>
1052 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1059 <div class="short">Used to define events on this Observable</div>
1065 Used to define events on this Observable
1072 <dl class="detailList">
1073 <dt class="heading">Parameters:</dt>
1076 <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>
1079 <dd>The object with the events defined</dd>
1097 <td class="msource">
1099 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1105 <tr class="method-row config-row-alt0 expandable">
1106 <td class="micon"><a class="exi" href="#expand"> </a></td>
1110 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1111 <div class="fixedFont">
1112 <span class="attributes"></span><b class="itemname">addListener</b>
1114 (<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>)
1121 <div class="short">Appends an event handler to this component</div>
1127 Appends an event handler to this component
1134 <dl class="detailList">
1135 <dt class="heading">Parameters:</dt>
1138 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1141 <dd>The type of event to listen for</dd>
1144 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1147 <dd>The method the event invokes</dd>
1150 <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>
1153 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1156 <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>
1159 <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>
1177 <td class="msource">
1179 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1185 <tr class="method-row config-row-alt1 expandable notInherited">
1186 <td class="micon"><a class="exi" href="#expand"> </a></td>
1190 <a id="Roo.Button-method-destroy" name=".destroy"></a>
1191 <div class="fixedFont">
1192 <span class="attributes"></span><b class="itemname">destroy</b>
1201 <div class="short">Destroys this Button and removes any listeners.</div>
1207 Destroys this Button and removes any listeners.
1228 <td class="msource">
1236 <tr class="method-row config-row-alt0 expandable notInherited">
1237 <td class="micon"><a class="exi" href="#expand"> </a></td>
1241 <a id="Roo.Button-method-disable" name=".disable"></a>
1242 <div class="fixedFont">
1243 <span class="attributes"></span><b class="itemname">disable</b>
1252 <div class="short">Disable this button</div>
1279 <td class="msource">
1287 <tr class="method-row config-row-alt1 expandable notInherited">
1288 <td class="micon"><a class="exi" href="#expand"> </a></td>
1292 <a id="Roo.Button-method-enable" name=".enable"></a>
1293 <div class="fixedFont">
1294 <span class="attributes"></span><b class="itemname">enable</b>
1303 <div class="short">Enable this button</div>
1330 <td class="msource">
1338 <tr class="method-row config-row-alt0 expandable">
1339 <td class="micon"><a class="exi" href="#expand"> </a></td>
1343 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1344 <div class="fixedFont">
1345 <span class="attributes"></span><b class="itemname">fireEvent</b>
1347 (<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>)
1353 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1362 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1368 Fires the specified event with the passed parameters (minus the event name).
1375 <dl class="detailList">
1376 <dt class="heading">Parameters:</dt>
1379 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1385 <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>
1388 <dd>Variable number of parameters are passed to handlers</dd>
1396 <dl class="detailList">
1397 <dt class="heading">Returns:</dt>
1399 <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>
1413 <td class="msource">
1415 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1421 <tr class="method-row config-row-alt1 expandable notInherited">
1422 <td class="micon"><a class="exi" href="#expand"> </a></td>
1426 <a id="Roo.Button-method-focus" name=".focus"></a>
1427 <div class="fixedFont">
1428 <span class="attributes"></span><b class="itemname">focus</b>
1437 <div class="short">Focus the button</div>
1464 <td class="msource">
1472 <tr class="method-row config-row-alt0 expandable notInherited">
1473 <td class="micon"><a class="exi" href="#expand"> </a></td>
1477 <a id="Roo.Button-method-getEl" name=".getEl"></a>
1478 <div class="fixedFont">
1479 <span class="attributes"></span><b class="itemname">getEl</b>
1487 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1496 <div class="short">Returns the button's underlying element</div>
1502 Returns the button's underlying element
1513 <dl class="detailList">
1514 <dt class="heading">Returns:</dt>
1516 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1530 <td class="msource">
1538 <tr class="method-row config-row-alt1 expandable notInherited">
1539 <td class="micon"><a class="exi" href="#expand"> </a></td>
1543 <a id="Roo.Button-method-getText" name=".getText"></a>
1544 <div class="fixedFont">
1545 <span class="attributes"></span><b class="itemname">getText</b>
1553 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1562 <div class="short">Gets the text for this button</div>
1568 Gets the text for this button
1579 <dl class="detailList">
1580 <dt class="heading">Returns:</dt>
1582 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> The button text</dd>
1596 <td class="msource">
1604 <tr class="method-row config-row-alt0 expandable">
1605 <td class="micon"><a class="exi" href="#expand"> </a></td>
1609 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1610 <div class="fixedFont">
1611 <span class="attributes"></span><b class="itemname">hasListener</b>
1613 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1619 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1628 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1634 Checks to see if this object has any listeners for a specified event
1641 <dl class="detailList">
1642 <dt class="heading">Parameters:</dt>
1645 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1648 <dd>The name of the event to check for</dd>
1656 <dl class="detailList">
1657 <dt class="heading">Returns:</dt>
1659 <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>
1673 <td class="msource">
1675 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1681 <tr class="method-row config-row-alt1 expandable notInherited">
1682 <td class="micon"><a class="exi" href="#expand"> </a></td>
1686 <a id="Roo.Button-method-hide" name=".hide"></a>
1687 <div class="fixedFont">
1688 <span class="attributes"></span><b class="itemname">hide</b>
1697 <div class="short">Hide this button</div>
1724 <td class="msource">
1732 <tr class="method-row config-row-alt0 expandable">
1733 <td class="micon"><a class="exi" href="#expand"> </a></td>
1737 <a id="Roo.util.Observable-method-on" name=".on"></a>
1738 <div class="fixedFont">
1739 <span class="attributes"></span><b class="itemname">on</b>
1741 (<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>)
1748 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1754 Appends an event handler to this element (shorthand for addListener)
1761 <dl class="detailList">
1762 <dt class="heading">Parameters:</dt>
1765 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1768 <dd>The type of event to listen for</dd>
1771 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1774 <dd>The method the event invokes</dd>
1777 <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>
1780 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1783 <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>
1804 <td class="msource">
1806 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1812 <tr class="method-row config-row-alt1 expandable">
1813 <td class="micon"><a class="exi" href="#expand"> </a></td>
1817 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1818 <div class="fixedFont">
1819 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1828 <div class="short">Removes all listeners for this object</div>
1834 Removes all listeners for this object
1855 <td class="msource">
1857 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1863 <tr class="method-row config-row-alt0 expandable">
1864 <td class="micon"><a class="exi" href="#expand"> </a></td>
1868 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1869 <div class="fixedFont">
1870 <span class="attributes"></span><b class="itemname">removeListener</b>
1872 (<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>)
1879 <div class="short">Removes a listener</div>
1892 <dl class="detailList">
1893 <dt class="heading">Parameters:</dt>
1896 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1899 <dd>The type of event to listen for</dd>
1902 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1905 <dd>The handler to remove</dd>
1908 <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>
1911 <dd>(optional) The scope (this object) for the handler</dd>
1929 <td class="msource">
1931 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1937 <tr class="method-row config-row-alt1 expandable notInherited">
1938 <td class="micon"><a class="exi" href="#expand"> </a></td>
1942 <a id="Roo.Button-method-setDisabled" name=".setDisabled"></a>
1943 <div class="fixedFont">
1944 <span class="attributes"></span><b class="itemname">setDisabled</b>
1946 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>enabled</i></B>)
1953 <div class="short">Convenience function for boolean enable/disable</div>
1959 Convenience function for boolean enable/disable
1966 <dl class="detailList">
1967 <dt class="heading">Parameters:</dt>
1970 <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>
1973 <dd>True to enable, false to disable</dd>
1991 <td class="msource">
1999 <tr class="method-row config-row-alt0 expandable notInherited">
2000 <td class="micon"><a class="exi" href="#expand"> </a></td>
2004 <a id="Roo.Button-method-setHandler" name=".setHandler"></a>
2005 <div class="fixedFont">
2006 <span class="attributes"></span><b class="itemname">setHandler</b>
2008 (<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>)
2015 <div class="short">Assigns this button's click handler</div>
2021 Assigns this button's click handler
2028 <dl class="detailList">
2029 <dt class="heading">Parameters:</dt>
2032 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2035 <dd>The function to call when the button is clicked</dd>
2038 <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>
2041 <dd>(optional) Scope for the function passed in</dd>
2059 <td class="msource">
2067 <tr class="method-row config-row-alt1 expandable notInherited">
2068 <td class="micon"><a class="exi" href="#expand"> </a></td>
2072 <a id="Roo.Button-method-setText" name=".setText"></a>
2073 <div class="fixedFont">
2074 <span class="attributes"></span><b class="itemname">setText</b>
2076 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
2083 <div class="short">Sets this button's text</div>
2089 Sets this button's text
2096 <dl class="detailList">
2097 <dt class="heading">Parameters:</dt>
2100 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
2103 <dd>The button text</dd>
2121 <td class="msource">
2129 <tr class="method-row config-row-alt0 expandable notInherited">
2130 <td class="micon"><a class="exi" href="#expand"> </a></td>
2134 <a id="Roo.Button-method-setVisible" name=".setVisible"></a>
2135 <div class="fixedFont">
2136 <span class="attributes"></span><b class="itemname">setVisible</b>
2138 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2145 <div class="short">Convenience function for boolean show/hide</div>
2151 Convenience function for boolean show/hide
2158 <dl class="detailList">
2159 <dt class="heading">Parameters:</dt>
2162 <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>
2165 <dd>True to show, false to hide</dd>
2183 <td class="msource">
2191 <tr class="method-row config-row-alt1 expandable notInherited">
2192 <td class="micon"><a class="exi" href="#expand"> </a></td>
2196 <a id="Roo.Button-method-show" name=".show"></a>
2197 <div class="fixedFont">
2198 <span class="attributes"></span><b class="itemname">show</b>
2207 <div class="short">Show this button</div>
2234 <td class="msource">
2242 <tr class="method-row config-row-alt0 expandable notInherited">
2243 <td class="micon"><a class="exi" href="#expand"> </a></td>
2247 <a id="Roo.Button-method-toggle" name=".toggle"></a>
2248 <div class="fixedFont">
2249 <span class="attributes"></span><b class="itemname">toggle</b>
2251 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>state</i></B>)
2258 <div class="short">If a state it passed, it becomes the pressed state otherwise the current state is toggled.</div>
2264 If a state it passed, it becomes the pressed state otherwise the current state is toggled.
2271 <dl class="detailList">
2272 <dt class="heading">Parameters:</dt>
2275 <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>
2278 <dd>(optional) Force a particular state</dd>
2296 <td class="msource">
2304 <tr class="method-row config-row-alt1 expandable">
2305 <td class="micon"><a class="exi" href="#expand"> </a></td>
2309 <a id="Roo.util.Observable-method-un" name=".un"></a>
2310 <div class="fixedFont">
2311 <span class="attributes"></span><b class="itemname">un</b>
2313 (<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>)
2320 <div class="short">Removes a listener (shorthand for removeListener)</div>
2326 Removes a listener (shorthand for removeListener)
2333 <dl class="detailList">
2334 <dt class="heading">Parameters:</dt>
2337 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2340 <dd>The type of event to listen for</dd>
2343 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2346 <dd>The handler to remove</dd>
2349 <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>
2352 <dd>(optional) The scope (this object) for the handler</dd>
2370 <td class="msource">
2372 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2381 <!-- ============================== events summary / details ======================== -->
2384 <a id="Roo.Button-events"></a>
2393 <table cellspacing="0" class="member-table">
2394 <caption>Events</caption>
2397 <th class="sig-header" colspan="2">Event</th>
2398 <th class="msource-header">Defined By</th>
2407 <tr class="method-row expandable config-row-alt0 notInherited">
2408 <td class="micon"><a class="exi" href="#expand"> </a></td>
2411 <a id="Roo.Button-event-*click"></a>
2413 <div class="fixedFont">
2414 <b class="itemname">click</b> (Button <B><i>this</i></B>, EventObject <B><i>e</i></B>)
2420 <div class="short">Fires when this button is clicked
2426 Fires when this button is clicked
2432 <dl class="detailList">
2433 <dt class="heading">Parameters:</dt>
2436 <span class="fixedFont">Button</span> <b>this</b>
2442 <span class="fixedFont">EventObject</span> <b>e</b>
2445 <dd>The click event</dd>
2463 <td class="msource">
2468 <tr class="method-row expandable config-row-alt1 notInherited">
2469 <td class="micon"><a class="exi" href="#expand"> </a></td>
2472 <a id="Roo.Button-event-*mouseout"></a>
2474 <div class="fixedFont">
2475 <b class="itemname">mouseout</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
2481 <div class="short">Fires when the mouse exits the button
2487 Fires when the mouse exits the button
2493 <dl class="detailList">
2494 <dt class="heading">Parameters:</dt>
2497 <span class="fixedFont">Button</span> <b>this</b>
2503 <span class="fixedFont">Event</span> <b>e</b>
2506 <dd>The event object</dd>
2524 <td class="msource">
2529 <tr class="method-row expandable config-row-alt0 notInherited">
2530 <td class="micon"><a class="exi" href="#expand"> </a></td>
2533 <a id="Roo.Button-event-*mouseover"></a>
2535 <div class="fixedFont">
2536 <b class="itemname">mouseover</b> (Button <B><i>this</i></B>, Event <B><i>e</i></B>)
2542 <div class="short">Fires when the mouse hovers over the button
2548 Fires when the mouse hovers over the button
2554 <dl class="detailList">
2555 <dt class="heading">Parameters:</dt>
2558 <span class="fixedFont">Button</span> <b>this</b>
2564 <span class="fixedFont">Event</span> <b>e</b>
2567 <dd>The event object</dd>
2585 <td class="msource">
2590 <tr class="method-row expandable config-row-alt1 notInherited">
2591 <td class="micon"><a class="exi" href="#expand"> </a></td>
2594 <a id="Roo.Button-event-*render"></a>
2596 <div class="fixedFont">
2597 <b class="itemname">render</b> (Button <B><i>this</i></B>)
2603 <div class="short">Fires when the button is rendered
2609 Fires when the button is rendered
2615 <dl class="detailList">
2616 <dt class="heading">Parameters:</dt>
2619 <span class="fixedFont">Button</span> <b>this</b>
2640 <td class="msource">
2645 <tr class="method-row expandable config-row-alt0 notInherited">
2646 <td class="micon"><a class="exi" href="#expand"> </a></td>
2649 <a id="Roo.Button-event-*toggle"></a>
2651 <div class="fixedFont">
2652 <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>)
2658 <div class="short">Fires when the "pressed" state of this button changes (only if enableToggle = true)
2664 Fires when the "pressed" state of this button changes (only if enableToggle = true)
2670 <dl class="detailList">
2671 <dt class="heading">Parameters:</dt>
2674 <span class="fixedFont">Button</span> <b>this</b>
2680 <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>
2701 <td class="msource">
2713 <!-- ============================== footer ================================= -->
2714 <div class="fineprint" style="clear:both">
2716 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed Apr 06 2016 11:58:56 GMT+0800 (HKT)
2718 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>