6 "desc" : "Simple Button class",
10 "memberOf" : "Button",
19 "desc" : "The config object",
28 "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
29 "memberOf" : "Roo.util.Observable",
34 "type" : "String/Object",
35 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
36 "memberOf" : "Roo.Button",
42 "desc" : "The button text",
43 "memberOf" : "Roo.Button",
48 "type" : "String/HTMLElement/Element",
49 "desc" : "The element to append the button to",
50 "memberOf" : "Roo.Button",
56 "desc" : "True to start hidden (defaults to false)",
57 "memberOf" : "Roo.Button",
61 "name" : "toggleGroup",
63 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
64 "memberOf" : "Roo.Button",
68 "name" : "handleMouseEvents",
70 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
71 "memberOf" : "Roo.Button",
77 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
78 "memberOf" : "Roo.Button",
82 "name" : "enableToggle",
84 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
85 "memberOf" : "Roo.Button",
91 "desc" : "A function called when the button is clicked (can be used instead of click event)",
92 "memberOf" : "Roo.Button",
98 "desc" : "The scope of the handler",
99 "memberOf" : "Roo.Button",
105 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
106 "memberOf" : "Roo.Button",
112 "desc" : "True to start disabled (defaults to false)",
113 "memberOf" : "Roo.Button",
119 "desc" : "True to start pressed (only if enableToggle = true)",
120 "memberOf" : "Roo.Button",
125 "type" : "Roo.Template",
126 "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
127 "memberOf" : "Roo.Button",
133 "desc" : "A CSS class to apply to the button's main element.",
134 "memberOf" : "Roo.Button",
140 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
141 "memberOf" : "Roo.Button",
147 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
148 "memberOf" : "Roo.Button",
152 "name" : "menuAlign",
154 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
155 "memberOf" : "Roo.Button",
161 "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
162 "memberOf" : "Roo.Button",
166 "name" : "tooltipType",
168 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
169 "memberOf" : "Roo.Button",
173 "name" : "clickEvent",
175 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
176 "memberOf" : "Roo.Button",
181 "type" : "Boolean/Object",
182 "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
183 "memberOf" : "Roo.Button",
189 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
190 "memberOf" : "Roo.Button",
197 "desc" : "Show this button",
199 "isConstructor" : false,
201 "memberOf" : "Roo.Button",
211 "desc" : "Focus the button",
213 "isConstructor" : false,
215 "memberOf" : "Roo.Button",
224 "name" : "setHandler",
225 "desc" : "Assigns this button's click handler",
227 "isConstructor" : false,
229 "memberOf" : "Roo.Button",
238 "desc" : "The function to call when the button is clicked",
244 "desc" : "(optional) Scope for the function passed in",
252 "desc" : "Disable this button",
254 "isConstructor" : false,
256 "memberOf" : "Roo.Button",
266 "desc" : "Enable this button",
268 "isConstructor" : false,
270 "memberOf" : "Roo.Button",
280 "desc" : "Returns the button's underlying element",
282 "isConstructor" : false,
284 "memberOf" : "Roo.Button",
293 "type" : "Roo.Element",
294 "desc" : "The element"
299 "name" : "setDisabled",
300 "desc" : "Convenience function for boolean enable/disable",
302 "isConstructor" : false,
304 "memberOf" : "Roo.Button",
313 "desc" : "True to enable, false to disable",
320 "name" : "setVisible",
321 "desc" : "Convenience function for boolean show/hide",
323 "isConstructor" : false,
325 "memberOf" : "Roo.Button",
334 "desc" : "True to show, false to hide",
342 "desc" : "Destroys this Button and removes any listeners.",
344 "isConstructor" : false,
346 "memberOf" : "Roo.Button",
356 "desc" : "Gets the text for this button",
358 "isConstructor" : false,
360 "memberOf" : "Roo.Button",
370 "desc" : "The button text"
376 "desc" : "Sets this button's text",
378 "isConstructor" : false,
380 "memberOf" : "Roo.Button",
389 "desc" : "The button text",
397 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
399 "isConstructor" : false,
401 "memberOf" : "Roo.Button",
410 "desc" : "(optional) Force a particular state",
418 "desc" : "Hide this button",
420 "isConstructor" : false,
422 "memberOf" : "Roo.Button",
431 "name" : "purgeListeners",
432 "desc" : "Removes all listeners for this object",
434 "isConstructor" : false,
436 "memberOf" : "Roo.util.Observable",
446 "desc" : "Appends an event handler to this element (shorthand for addListener)",
448 "isConstructor" : false,
450 "memberOf" : "Roo.util.Observable",
457 "name" : "eventName",
459 "desc" : "The type of event to listen for",
465 "desc" : "The method the event invokes",
471 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
477 "desc" : "(optional)",
485 "desc" : "Removes a listener (shorthand for removeListener)",
487 "isConstructor" : false,
489 "memberOf" : "Roo.util.Observable",
496 "name" : "eventName",
498 "desc" : "The type of event to listen for",
504 "desc" : "The handler to remove",
510 "desc" : "(optional) The scope (this object) for the handler",
517 "name" : "addEvents",
518 "desc" : "Used to define events on this Observable",
520 "isConstructor" : false,
522 "memberOf" : "Roo.util.Observable",
531 "desc" : "The object with the events defined",
538 "name" : "releaseCapture",
539 "desc" : "Removes <b>all</b> added captures from the Observable.",
541 "isConstructor" : false,
543 "memberOf" : "Roo.util.Observable",
551 "type" : "Observable",
552 "desc" : "The Observable to release",
559 "name" : "removeListener",
560 "desc" : "Removes a listener",
562 "isConstructor" : false,
564 "memberOf" : "Roo.util.Observable",
571 "name" : "eventName",
573 "desc" : "The type of event to listen for",
579 "desc" : "The handler to remove",
585 "desc" : "(optional) The scope (this object) for the handler",
592 "name" : "fireEvent",
593 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
595 "isConstructor" : false,
597 "memberOf" : "Roo.util.Observable",
604 "name" : "eventName",
611 "type" : "Object...",
612 "desc" : "Variable number of parameters are passed to handlers",
620 "desc" : "returns false if any of the handlers return false otherwise it returns true"
625 "name" : "hasListener",
626 "desc" : "Checks to see if this object has any listeners for a specified event",
628 "isConstructor" : false,
630 "memberOf" : "Roo.util.Observable",
637 "name" : "eventName",
639 "desc" : "The name of the event to check for",
647 "desc" : "True if the event is being listened for, else false"
653 "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
655 "isConstructor" : false,
657 "memberOf" : "Roo.util.Observable",
665 "type" : "Observable",
666 "desc" : "The Observable to capture",
672 "desc" : "The function to call",
678 "desc" : "(optional) The scope (this object) for the fn",
685 "name" : "addListener",
686 "desc" : "Appends an event handler to this component",
688 "isConstructor" : false,
690 "memberOf" : "Roo.util.Observable",
697 "name" : "eventName",
699 "desc" : "The type of event to listen for",
705 "desc" : "The method the event invokes",
711 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
717 "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
727 "desc" : "Fires when the button is rendered",
728 "memberOf" : "Roo.Button",
745 "desc" : "Fires when this button is clicked",
746 "memberOf" : "Roo.Button",
760 "type" : "EventObject",
761 "desc" : "The click event",
768 "name" : "mouseover",
769 "desc" : "Fires when the mouse hovers over the button",
770 "memberOf" : "Roo.Button",
785 "desc" : "The event object",
793 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
794 "memberOf" : "Roo.Button",
817 "desc" : "Fires when the mouse exits the button",
818 "memberOf" : "Roo.Button",
833 "desc" : "The event object",