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",
36 "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>",
37 "memberOf" : "Roo.util.Observable",
43 "type" : "String/Object",
44 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
45 "memberOf" : "Roo.Button",
52 "desc" : "The button text",
53 "memberOf" : "Roo.Button",
59 "type" : "String/HTMLElement/Element",
60 "desc" : "The element to append the button to",
61 "memberOf" : "Roo.Button",
68 "desc" : "True to start hidden (defaults to false)",
69 "memberOf" : "Roo.Button",
74 "name" : "toggleGroup",
76 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
77 "memberOf" : "Roo.Button",
82 "name" : "handleMouseEvents",
84 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
85 "memberOf" : "Roo.Button",
92 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
93 "memberOf" : "Roo.Button",
98 "name" : "enableToggle",
100 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
101 "memberOf" : "Roo.Button",
106 "name" : "arrowHandler",
108 "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
109 "memberOf" : "Roo.SplitButton",
116 "desc" : "A function called when the button is clicked (can be used instead of click event)",
117 "memberOf" : "Roo.Button",
124 "desc" : "The scope of the handler",
125 "memberOf" : "Roo.Button",
132 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
133 "memberOf" : "Roo.Button",
140 "desc" : "True to start disabled (defaults to false)",
141 "memberOf" : "Roo.Button",
148 "desc" : "True to start pressed (only if enableToggle = true)",
149 "memberOf" : "Roo.Button",
155 "type" : "Roo.Template",
156 "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.",
157 "memberOf" : "Roo.Button",
164 "desc" : "A CSS class to apply to the button's main element.",
165 "memberOf" : "Roo.Button",
172 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
173 "memberOf" : "Roo.Button",
180 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
181 "memberOf" : "Roo.Button",
186 "name" : "menuAlign",
188 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
189 "memberOf" : "Roo.Button",
196 "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\")",
197 "memberOf" : "Roo.Button",
202 "name" : "tooltipType",
204 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
205 "memberOf" : "Roo.Button",
210 "name" : "arrowTooltip",
212 "desc" : "The title attribute of the arrow",
213 "memberOf" : "Roo.SplitButton",
218 "name" : "clickEvent",
220 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
221 "memberOf" : "Roo.Button",
227 "type" : "Boolean/Object",
228 "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).",
229 "memberOf" : "Roo.Button",
236 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
237 "memberOf" : "Roo.Button",
244 "name" : "setArrowHandler",
245 "desc" : "Sets this button's arrow click handler",
247 "isConstructor" : false,
249 "memberOf" : "Roo.SplitButton",
258 "desc" : "The function to call when the arrow is clicked",
264 "desc" : "(optional) Scope for the function passed above",
273 "desc" : "Focus the button",
275 "isConstructor" : false,
277 "memberOf" : "Roo.SplitButton",
288 "name" : "setHandler",
289 "desc" : "Sets this button's click handler",
291 "isConstructor" : false,
293 "memberOf" : "Roo.SplitButton",
302 "desc" : "The function to call when the button is clicked",
308 "desc" : "(optional) Scope for the function passed above",
317 "desc" : "Show this button",
319 "isConstructor" : false,
321 "memberOf" : "Roo.Button",
333 "desc" : "Disable this button",
335 "isConstructor" : false,
337 "memberOf" : "Roo.Button",
349 "desc" : "Enable this button",
351 "isConstructor" : false,
353 "memberOf" : "Roo.Button",
365 "desc" : "Returns the button's underlying element",
367 "isConstructor" : false,
369 "memberOf" : "Roo.Button",
379 "type" : "Roo.Element",
380 "desc" : "The element"
385 "name" : "setDisabled",
386 "desc" : "Convenience function for boolean enable/disable",
388 "isConstructor" : false,
390 "memberOf" : "Roo.Button",
399 "desc" : "True to enable, false to disable",
407 "name" : "setVisible",
408 "desc" : "Convenience function for boolean show/hide",
410 "isConstructor" : false,
412 "memberOf" : "Roo.Button",
421 "desc" : "True to show, false to hide",
430 "desc" : "Destroys this Button and removes any listeners.",
432 "isConstructor" : false,
434 "memberOf" : "Roo.Button",
446 "desc" : "Gets the text for this button",
448 "isConstructor" : false,
450 "memberOf" : "Roo.Button",
461 "desc" : "The button text"
467 "desc" : "Sets this button's text",
469 "isConstructor" : false,
471 "memberOf" : "Roo.Button",
480 "desc" : "The button text",
489 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
491 "isConstructor" : false,
493 "memberOf" : "Roo.Button",
502 "desc" : "(optional) Force a particular state",
511 "desc" : "Hide this button",
513 "isConstructor" : false,
515 "memberOf" : "Roo.Button",
526 "name" : "purgeListeners",
527 "desc" : "Removes all listeners for this object",
529 "isConstructor" : false,
531 "memberOf" : "Roo.util.Observable",
543 "desc" : "Appends an event handler to this element (shorthand for addListener)",
545 "isConstructor" : false,
547 "memberOf" : "Roo.util.Observable",
554 "name" : "eventName",
556 "desc" : "The type of event to listen for",
562 "desc" : "The method the event invokes",
568 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
574 "desc" : "(optional)",
583 "desc" : "Removes a listener (shorthand for removeListener)",
585 "isConstructor" : false,
587 "memberOf" : "Roo.util.Observable",
594 "name" : "eventName",
596 "desc" : "The type of event to listen for",
602 "desc" : "The handler to remove",
608 "desc" : "(optional) The scope (this object) for the handler",
616 "name" : "addEvents",
617 "desc" : "Used to define events on this Observable",
619 "isConstructor" : false,
621 "memberOf" : "Roo.util.Observable",
630 "desc" : "The object with the events defined",
638 "name" : "releaseCapture",
639 "desc" : "Removes <b>all</b> added captures from the Observable.",
641 "isConstructor" : false,
643 "memberOf" : "Roo.util.Observable",
651 "type" : "Observable",
652 "desc" : "The Observable to release",
660 "name" : "removeListener",
661 "desc" : "Removes a listener",
663 "isConstructor" : false,
665 "memberOf" : "Roo.util.Observable",
672 "name" : "eventName",
674 "desc" : "The type of event to listen for",
680 "desc" : "The handler to remove",
686 "desc" : "(optional) The scope (this object) for the handler",
694 "name" : "fireEvent",
695 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
697 "isConstructor" : false,
699 "memberOf" : "Roo.util.Observable",
706 "name" : "eventName",
713 "type" : "Object...",
714 "desc" : "Variable number of parameters are passed to handlers",
722 "desc" : "returns false if any of the handlers return false otherwise it returns true"
727 "name" : "hasListener",
728 "desc" : "Checks to see if this object has any listeners for a specified event",
730 "isConstructor" : false,
732 "memberOf" : "Roo.util.Observable",
739 "name" : "eventName",
741 "desc" : "The name of the event to check for",
749 "desc" : "True if the event is being listened for, else false"
755 "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.",
757 "isConstructor" : false,
759 "memberOf" : "Roo.util.Observable",
767 "type" : "Observable",
768 "desc" : "The Observable to capture",
774 "desc" : "The function to call",
780 "desc" : "(optional) The scope (this object) for the fn",
788 "name" : "addListener",
789 "desc" : "Appends an event handler to this component",
791 "isConstructor" : false,
793 "memberOf" : "Roo.util.Observable",
800 "name" : "eventName",
802 "desc" : "The type of event to listen for",
808 "desc" : "The method the event invokes",
814 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
820 "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>",
830 "name" : "arrowclick",
831 "desc" : "Fires when this button's arrow is clicked",
832 "memberOf" : "Roo.SplitButton",
840 "type" : "SplitButton",
846 "type" : "EventObject",
847 "desc" : "The click event",
856 "desc" : "Fires when the button is rendered",
857 "memberOf" : "Roo.Button",
875 "desc" : "Fires when this button is clicked",
876 "memberOf" : "Roo.Button",
890 "type" : "EventObject",
891 "desc" : "The click event",
899 "name" : "mouseover",
900 "desc" : "Fires when the mouse hovers over the button",
901 "memberOf" : "Roo.Button",
916 "desc" : "The event object",
925 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
926 "memberOf" : "Roo.Button",
950 "desc" : "Fires when the mouse exits the button",
951 "memberOf" : "Roo.Button",
966 "desc" : "The event object",