2 "name" : "Roo.SplitButton",
7 "desc" : "A split button that provides a built-in dropdown arrow that can fire an event separately from the default\nclick event of the button. Typically this would be used to display a dropdown menu that provides additional\noptions to the primary button action, but any custom handler can provide the arrowclick implementation.",
11 "memberOf" : "SplitButton",
19 "type" : "String/HTMLElement/Element",
20 "desc" : "The element to append the button to",
26 "desc" : "The config object",
35 "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>",
36 "memberOf" : "Roo.util.Observable",
41 "type" : "String/Object",
42 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
43 "memberOf" : "Roo.Button",
49 "desc" : "The button text",
50 "memberOf" : "Roo.Button",
55 "type" : "String/HTMLElement/Element",
56 "desc" : "The element to append the button to",
57 "memberOf" : "Roo.Button",
63 "desc" : "True to start hidden (defaults to false)",
64 "memberOf" : "Roo.Button",
68 "name" : "toggleGroup",
70 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
71 "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",
84 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
85 "memberOf" : "Roo.Button",
89 "name" : "enableToggle",
91 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
92 "memberOf" : "Roo.Button",
96 "name" : "arrowHandler",
98 "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
99 "memberOf" : "Roo.SplitButton",
105 "desc" : "A function called when the button is clicked (can be used instead of click event)",
106 "memberOf" : "Roo.Button",
112 "desc" : "The scope of the handler",
113 "memberOf" : "Roo.Button",
119 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
120 "memberOf" : "Roo.Button",
126 "desc" : "True to start disabled (defaults to false)",
127 "memberOf" : "Roo.Button",
133 "desc" : "True to start pressed (only if enableToggle = true)",
134 "memberOf" : "Roo.Button",
139 "type" : "Roo.Template",
140 "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.",
141 "memberOf" : "Roo.Button",
147 "desc" : "A CSS class to apply to the button's main element.",
148 "memberOf" : "Roo.Button",
154 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
155 "memberOf" : "Roo.Button",
161 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
162 "memberOf" : "Roo.Button",
166 "name" : "menuAlign",
168 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
169 "memberOf" : "Roo.Button",
175 "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\")",
176 "memberOf" : "Roo.Button",
180 "name" : "tooltipType",
182 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
183 "memberOf" : "Roo.Button",
187 "name" : "arrowTooltip",
189 "desc" : "The title attribute of the arrow",
190 "memberOf" : "Roo.SplitButton",
194 "name" : "clickEvent",
196 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
197 "memberOf" : "Roo.Button",
202 "type" : "Boolean/Object",
203 "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).",
204 "memberOf" : "Roo.Button",
210 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
211 "memberOf" : "Roo.Button",
217 "name" : "setArrowHandler",
218 "desc" : "Sets this button's arrow click handler",
220 "isConstructor" : false,
222 "memberOf" : "Roo.SplitButton",
231 "desc" : "The function to call when the arrow is clicked",
237 "desc" : "(optional) Scope for the function passed above",
245 "desc" : "Focus the button",
247 "isConstructor" : false,
249 "memberOf" : "Roo.SplitButton",
258 "name" : "setHandler",
259 "desc" : "Sets this button's click handler",
261 "isConstructor" : false,
263 "memberOf" : "Roo.SplitButton",
272 "desc" : "The function to call when the button is clicked",
278 "desc" : "(optional) Scope for the function passed above",
286 "desc" : "Show this button",
288 "isConstructor" : false,
290 "memberOf" : "Roo.Button",
300 "desc" : "Disable this button",
302 "isConstructor" : false,
304 "memberOf" : "Roo.Button",
314 "desc" : "Enable this button",
316 "isConstructor" : false,
318 "memberOf" : "Roo.Button",
328 "desc" : "Returns the button's underlying element",
330 "isConstructor" : false,
332 "memberOf" : "Roo.Button",
341 "type" : "Roo.Element",
342 "desc" : "The element"
347 "name" : "setDisabled",
348 "desc" : "Convenience function for boolean enable/disable",
350 "isConstructor" : false,
352 "memberOf" : "Roo.Button",
361 "desc" : "True to enable, false to disable",
368 "name" : "setVisible",
369 "desc" : "Convenience function for boolean show/hide",
371 "isConstructor" : false,
373 "memberOf" : "Roo.Button",
382 "desc" : "True to show, false to hide",
390 "desc" : "Destroys this Button and removes any listeners.",
392 "isConstructor" : false,
394 "memberOf" : "Roo.Button",
404 "desc" : "Gets the text for this button",
406 "isConstructor" : false,
408 "memberOf" : "Roo.Button",
418 "desc" : "The button text"
424 "desc" : "Sets this button's text",
426 "isConstructor" : false,
428 "memberOf" : "Roo.Button",
437 "desc" : "The button text",
445 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
447 "isConstructor" : false,
449 "memberOf" : "Roo.Button",
458 "desc" : "(optional) Force a particular state",
466 "desc" : "Hide this button",
468 "isConstructor" : false,
470 "memberOf" : "Roo.Button",
479 "name" : "purgeListeners",
480 "desc" : "Removes all listeners for this object",
482 "isConstructor" : false,
484 "memberOf" : "Roo.util.Observable",
494 "desc" : "Appends an event handler to this element (shorthand for addListener)",
496 "isConstructor" : false,
498 "memberOf" : "Roo.util.Observable",
505 "name" : "eventName",
507 "desc" : "The type of event to listen for",
513 "desc" : "The method the event invokes",
519 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
525 "desc" : "(optional)",
533 "desc" : "Removes a listener (shorthand for removeListener)",
535 "isConstructor" : false,
537 "memberOf" : "Roo.util.Observable",
544 "name" : "eventName",
546 "desc" : "The type of event to listen for",
552 "desc" : "The handler to remove",
558 "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",
586 "name" : "releaseCapture",
587 "desc" : "Removes <b>all</b> added captures from the Observable.",
589 "isConstructor" : false,
591 "memberOf" : "Roo.util.Observable",
599 "type" : "Observable",
600 "desc" : "The Observable to release",
607 "name" : "removeListener",
608 "desc" : "Removes a listener",
610 "isConstructor" : false,
612 "memberOf" : "Roo.util.Observable",
619 "name" : "eventName",
621 "desc" : "The type of event to listen for",
627 "desc" : "The handler to remove",
633 "desc" : "(optional) The scope (this object) for the handler",
640 "name" : "fireEvent",
641 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
643 "isConstructor" : false,
645 "memberOf" : "Roo.util.Observable",
652 "name" : "eventName",
659 "type" : "Object...",
660 "desc" : "Variable number of parameters are passed to handlers",
668 "desc" : "returns false if any of the handlers return false otherwise it returns true"
673 "name" : "hasListener",
674 "desc" : "Checks to see if this object has any listeners for a specified event",
676 "isConstructor" : false,
678 "memberOf" : "Roo.util.Observable",
685 "name" : "eventName",
687 "desc" : "The name of the event to check for",
695 "desc" : "True if the event is being listened for, else false"
701 "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.",
703 "isConstructor" : false,
705 "memberOf" : "Roo.util.Observable",
713 "type" : "Observable",
714 "desc" : "The Observable to capture",
720 "desc" : "The function to call",
726 "desc" : "(optional) The scope (this object) for the fn",
733 "name" : "addListener",
734 "desc" : "Appends an event handler to this component",
736 "isConstructor" : false,
738 "memberOf" : "Roo.util.Observable",
745 "name" : "eventName",
747 "desc" : "The type of event to listen for",
753 "desc" : "The method the event invokes",
759 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
765 "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>",
774 "name" : "arrowclick",
775 "desc" : "Fires when this button's arrow is clicked",
776 "memberOf" : "Roo.SplitButton",
784 "type" : "SplitButton",
790 "type" : "EventObject",
791 "desc" : "The click event",
799 "desc" : "Fires when the button is rendered",
800 "memberOf" : "Roo.Button",
817 "desc" : "Fires when this button is clicked",
818 "memberOf" : "Roo.Button",
832 "type" : "EventObject",
833 "desc" : "The click event",
840 "name" : "mouseover",
841 "desc" : "Fires when the mouse hovers over the button",
842 "memberOf" : "Roo.Button",
857 "desc" : "The event object",
865 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
866 "memberOf" : "Roo.Button",
889 "desc" : "Fires when the mouse exits the button",
890 "memberOf" : "Roo.Button",
905 "desc" : "The event object",