6 "desc" : "Simple Button class",
10 "memberOf" : "Button",
19 "desc" : "The config object",
29 "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>",
30 "memberOf" : "Roo.util.Observable",
36 "type" : "String/Object",
37 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
38 "memberOf" : "Roo.Button",
45 "desc" : "The button text",
46 "memberOf" : "Roo.Button",
52 "type" : "String/HTMLElement/Element",
53 "desc" : "The element to append the button to",
54 "memberOf" : "Roo.Button",
61 "desc" : "True to start hidden (defaults to false)",
62 "memberOf" : "Roo.Button",
67 "name" : "toggleGroup",
69 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
70 "memberOf" : "Roo.Button",
75 "name" : "handleMouseEvents",
77 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
78 "memberOf" : "Roo.Button",
85 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
86 "memberOf" : "Roo.Button",
91 "name" : "enableToggle",
93 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
94 "memberOf" : "Roo.Button",
101 "desc" : "A function called when the button is clicked (can be used instead of click event)",
102 "memberOf" : "Roo.Button",
109 "desc" : "The scope of the handler",
110 "memberOf" : "Roo.Button",
117 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
118 "memberOf" : "Roo.Button",
125 "desc" : "True to start disabled (defaults to false)",
126 "memberOf" : "Roo.Button",
133 "desc" : "True to start pressed (only if enableToggle = true)",
134 "memberOf" : "Roo.Button",
140 "type" : "Roo.Template",
141 "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.",
142 "memberOf" : "Roo.Button",
149 "desc" : "A CSS class to apply to the button's main element.",
150 "memberOf" : "Roo.Button",
157 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
158 "memberOf" : "Roo.Button",
165 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
166 "memberOf" : "Roo.Button",
171 "name" : "menuAlign",
173 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
174 "memberOf" : "Roo.Button",
181 "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\")",
182 "memberOf" : "Roo.Button",
187 "name" : "tooltipType",
189 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
190 "memberOf" : "Roo.Button",
195 "name" : "clickEvent",
197 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
198 "memberOf" : "Roo.Button",
204 "type" : "Boolean/Object",
205 "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).",
206 "memberOf" : "Roo.Button",
213 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
214 "memberOf" : "Roo.Button",
222 "desc" : "Show this button",
224 "isConstructor" : false,
226 "memberOf" : "Roo.Button",
238 "desc" : "Focus the button",
240 "isConstructor" : false,
242 "memberOf" : "Roo.Button",
253 "name" : "setHandler",
254 "desc" : "Assigns this button's click handler",
256 "isConstructor" : false,
258 "memberOf" : "Roo.Button",
267 "desc" : "The function to call when the button is clicked",
273 "desc" : "(optional) Scope for the function passed in",
282 "desc" : "Disable this button",
284 "isConstructor" : false,
286 "memberOf" : "Roo.Button",
298 "desc" : "Enable this button",
300 "isConstructor" : false,
302 "memberOf" : "Roo.Button",
314 "desc" : "Returns the button's underlying element",
316 "isConstructor" : false,
318 "memberOf" : "Roo.Button",
328 "type" : "Roo.Element",
329 "desc" : "The element"
334 "name" : "setDisabled",
335 "desc" : "Convenience function for boolean enable/disable",
337 "isConstructor" : false,
339 "memberOf" : "Roo.Button",
348 "desc" : "True to enable, false to disable",
356 "name" : "setVisible",
357 "desc" : "Convenience function for boolean show/hide",
359 "isConstructor" : false,
361 "memberOf" : "Roo.Button",
370 "desc" : "True to show, false to hide",
379 "desc" : "Destroys this Button and removes any listeners.",
381 "isConstructor" : false,
383 "memberOf" : "Roo.Button",
395 "desc" : "Gets the text for this button",
397 "isConstructor" : false,
399 "memberOf" : "Roo.Button",
410 "desc" : "The button text"
416 "desc" : "Sets this button's text",
418 "isConstructor" : false,
420 "memberOf" : "Roo.Button",
429 "desc" : "The button text",
438 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
440 "isConstructor" : false,
442 "memberOf" : "Roo.Button",
451 "desc" : "(optional) Force a particular state",
460 "desc" : "Hide this button",
462 "isConstructor" : false,
464 "memberOf" : "Roo.Button",
475 "name" : "purgeListeners",
476 "desc" : "Removes all listeners for this object",
478 "isConstructor" : false,
480 "memberOf" : "Roo.util.Observable",
492 "desc" : "Appends an event handler to this element (shorthand for addListener)",
494 "isConstructor" : false,
496 "memberOf" : "Roo.util.Observable",
503 "name" : "eventName",
505 "desc" : "The type of event to listen for",
511 "desc" : "The method the event invokes",
517 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
523 "desc" : "(optional)",
532 "desc" : "Removes a listener (shorthand for removeListener)",
534 "isConstructor" : false,
536 "memberOf" : "Roo.util.Observable",
543 "name" : "eventName",
545 "desc" : "The type of event to listen for",
551 "desc" : "The handler to remove",
557 "desc" : "(optional) The scope (this object) for the handler",
565 "name" : "addEvents",
566 "desc" : "Used to define events on this Observable",
568 "isConstructor" : false,
570 "memberOf" : "Roo.util.Observable",
579 "desc" : "The object with the events defined",
587 "name" : "releaseCapture",
588 "desc" : "Removes <b>all</b> added captures from the Observable.",
590 "isConstructor" : false,
592 "memberOf" : "Roo.util.Observable",
600 "type" : "Observable",
601 "desc" : "The Observable to release",
609 "name" : "removeListener",
610 "desc" : "Removes a listener",
612 "isConstructor" : false,
614 "memberOf" : "Roo.util.Observable",
621 "name" : "eventName",
623 "desc" : "The type of event to listen for",
629 "desc" : "The handler to remove",
635 "desc" : "(optional) The scope (this object) for the handler",
643 "name" : "fireEvent",
644 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
646 "isConstructor" : false,
648 "memberOf" : "Roo.util.Observable",
655 "name" : "eventName",
662 "type" : "Object...",
663 "desc" : "Variable number of parameters are passed to handlers",
671 "desc" : "returns false if any of the handlers return false otherwise it returns true"
676 "name" : "hasListener",
677 "desc" : "Checks to see if this object has any listeners for a specified event",
679 "isConstructor" : false,
681 "memberOf" : "Roo.util.Observable",
688 "name" : "eventName",
690 "desc" : "The name of the event to check for",
698 "desc" : "True if the event is being listened for, else false"
704 "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.",
706 "isConstructor" : false,
708 "memberOf" : "Roo.util.Observable",
716 "type" : "Observable",
717 "desc" : "The Observable to capture",
723 "desc" : "The function to call",
729 "desc" : "(optional) The scope (this object) for the fn",
737 "name" : "addListener",
738 "desc" : "Appends an event handler to this component",
740 "isConstructor" : false,
742 "memberOf" : "Roo.util.Observable",
749 "name" : "eventName",
751 "desc" : "The type of event to listen for",
757 "desc" : "The method the event invokes",
763 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
769 "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>",
780 "desc" : "Fires when the button is rendered",
781 "memberOf" : "Roo.Button",
799 "desc" : "Fires when this button is clicked",
800 "memberOf" : "Roo.Button",
814 "type" : "EventObject",
815 "desc" : "The click event",
823 "name" : "mouseover",
824 "desc" : "Fires when the mouse hovers over the button",
825 "memberOf" : "Roo.Button",
840 "desc" : "The event object",
849 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
850 "memberOf" : "Roo.Button",
874 "desc" : "Fires when the mouse exits the button",
875 "memberOf" : "Roo.Button",
890 "desc" : "The event object",