2 "name" : "Roo.SplitButton",
9 "Roo.Toolbar.SplitButton"
14 "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.",
15 "isSingleton" : false,
19 "isBuilderTop" : false,
20 "memberOf" : "SplitButton",
28 "type" : "String/HTMLElement/Element",
29 "desc" : "The element to append the button to",
35 "desc" : "The config object",
46 "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>",
47 "memberOf" : "Roo.util.Observable"
51 "type" : "String/Object",
52 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
53 "memberOf" : "Roo.Button"
58 "desc" : "The button text",
59 "memberOf" : "Roo.Button"
63 "type" : "String/HTMLElement/Element",
64 "desc" : "The element to append the button to",
65 "memberOf" : "Roo.Button"
70 "desc" : "True to start hidden (defaults to false)",
71 "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"
80 "name" : "handleMouseEvents",
82 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
83 "memberOf" : "Roo.Button"
87 "type" : "Roo.menu.Menu",
88 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
89 "memberOf" : "Roo.Button"
92 "name" : "enableToggle",
94 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
95 "memberOf" : "Roo.Button"
98 "name" : "arrowHandler",
100 "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
101 "memberOf" : "Roo.SplitButton"
106 "desc" : "A function called when the button is clicked (can be used instead of click event)",
107 "memberOf" : "Roo.Button"
112 "desc" : "The scope of the handler",
113 "memberOf" : "Roo.Button"
118 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
119 "memberOf" : "Roo.Button"
124 "desc" : "True to start disabled (defaults to false)",
125 "memberOf" : "Roo.Button"
130 "desc" : "True to start pressed (only if enableToggle = true)",
131 "memberOf" : "Roo.Button"
135 "type" : "Roo.Template",
136 "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.",
137 "memberOf" : "Roo.Button"
142 "desc" : "A CSS class to apply to the button's main element.",
143 "memberOf" : "Roo.Button"
148 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
149 "memberOf" : "Roo.Button"
154 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
155 "memberOf" : "Roo.Button"
158 "name" : "menuAlign",
160 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
161 "memberOf" : "Roo.Button"
166 "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\")",
167 "memberOf" : "Roo.Button"
170 "name" : "tooltipType",
172 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
173 "memberOf" : "Roo.Button"
176 "name" : "arrowTooltip",
178 "desc" : "The title attribute of the arrow",
179 "memberOf" : "Roo.SplitButton"
182 "name" : "clickEvent",
184 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
185 "memberOf" : "Roo.Button"
189 "type" : "Boolean/Object",
190 "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).",
191 "memberOf" : "Roo.Button"
196 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
197 "memberOf" : "Roo.Button"
202 "name" : "setArrowHandler",
204 "desc" : "Sets this button's arrow click handler",
205 "sig" : "(handler, scope)",
209 "isConstructor" : false,
221 "desc" : "The function to call when the arrow is clicked",
227 "desc" : "(optional) Scope for the function passed above",
236 "desc" : "Focus the button",
237 "sig" : "()\n{\n\n}",
241 "isConstructor" : false,
253 "name" : "setHandler",
255 "desc" : "Sets this button's click handler",
256 "sig" : "(handler, scope)",
260 "isConstructor" : false,
272 "desc" : "The function to call when the button is clicked",
278 "desc" : "(optional) Scope for the function passed above",
287 "desc" : "Show this button",
288 "sig" : "()\n{\n\n}",
290 "memberOf" : "Roo.Button",
292 "isConstructor" : false,
306 "desc" : "Disable this button",
307 "sig" : "()\n{\n\n}",
309 "memberOf" : "Roo.Button",
311 "isConstructor" : false,
325 "desc" : "Enable this button",
326 "sig" : "()\n{\n\n}",
328 "memberOf" : "Roo.Button",
330 "isConstructor" : false,
344 "desc" : "Returns the button's underlying element",
345 "sig" : "()\n{\n\n}",
347 "memberOf" : "Roo.Button",
349 "isConstructor" : false,
361 "type" : "Roo.Element",
362 "desc" : "The element"
367 "name" : "setDisabled",
369 "desc" : "Convenience function for boolean enable/disable",
372 "memberOf" : "Roo.Button",
374 "isConstructor" : false,
386 "desc" : "True to enable, false to disable",
393 "name" : "setVisible",
395 "desc" : "Convenience function for boolean show/hide",
398 "memberOf" : "Roo.Button",
400 "isConstructor" : false,
412 "desc" : "True to show, false to hide",
421 "desc" : "Destroys this Button and removes any listeners.",
422 "sig" : "()\n{\n\n}",
424 "memberOf" : "Roo.Button",
426 "isConstructor" : false,
440 "desc" : "Gets the text for this button",
441 "sig" : "()\n{\n\n}",
443 "memberOf" : "Roo.Button",
445 "isConstructor" : false,
458 "desc" : "The button text"
465 "desc" : "Sets this button's text",
468 "memberOf" : "Roo.Button",
470 "isConstructor" : false,
482 "desc" : "The button text",
491 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
494 "memberOf" : "Roo.Button",
496 "isConstructor" : false,
508 "desc" : "(optional) Force a particular state",
517 "desc" : "Hide this button",
518 "sig" : "()\n{\n\n}",
520 "memberOf" : "Roo.Button",
522 "isConstructor" : false,
534 "name" : "purgeListeners",
536 "desc" : "Removes all listeners for this object",
537 "sig" : "()\n{\n\n}",
539 "memberOf" : "Roo.util.Observable",
541 "isConstructor" : false,
555 "desc" : "Appends an event handler to this element (shorthand for addListener)",
556 "sig" : "(eventName, handler, scope, options)",
558 "memberOf" : "Roo.util.Observable",
560 "isConstructor" : false,
570 "name" : "eventName",
572 "desc" : "The type of event to listen for",
578 "desc" : "The method the event invokes",
584 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
590 "desc" : "(optional)",
599 "desc" : "Removes a listener (shorthand for removeListener)",
600 "sig" : "(eventName, handler, scope)",
602 "memberOf" : "Roo.util.Observable",
604 "isConstructor" : false,
614 "name" : "eventName",
616 "desc" : "The type of event to listen for",
622 "desc" : "The handler to remove",
628 "desc" : "(optional) The scope (this object) for the handler",
635 "name" : "addEvents",
637 "desc" : "Used to define events on this Observable",
640 "memberOf" : "Roo.util.Observable",
642 "isConstructor" : false,
654 "desc" : "The object with the events defined",
661 "name" : "releaseCapture",
663 "desc" : "Removes <b>all</b> added captures from the Observable.",
666 "memberOf" : "Roo.util.Observable",
668 "isConstructor" : false,
679 "type" : "Observable",
680 "desc" : "The Observable to release",
687 "name" : "removeListener",
689 "desc" : "Removes a listener",
690 "sig" : "(eventName, handler, scope)",
692 "memberOf" : "Roo.util.Observable",
694 "isConstructor" : false,
704 "name" : "eventName",
706 "desc" : "The type of event to listen for",
712 "desc" : "The handler to remove",
718 "desc" : "(optional) The scope (this object) for the handler",
725 "name" : "fireEvent",
727 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
728 "sig" : "(eventName, args)",
730 "memberOf" : "Roo.util.Observable",
732 "isConstructor" : false,
742 "name" : "eventName",
749 "type" : "Object...",
750 "desc" : "Variable number of parameters are passed to handlers",
758 "desc" : "returns false if any of the handlers return false otherwise it returns true"
763 "name" : "hasListener",
765 "desc" : "Checks to see if this object has any listeners for a specified event",
766 "sig" : "(eventName)",
768 "memberOf" : "Roo.util.Observable",
770 "isConstructor" : false,
780 "name" : "eventName",
782 "desc" : "The name of the event to check for",
790 "desc" : "True if the event is being listened for, else false"
797 "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.",
798 "sig" : "(o, fn, scope)",
800 "memberOf" : "Roo.util.Observable",
802 "isConstructor" : false,
813 "type" : "Observable",
814 "desc" : "The Observable to capture",
820 "desc" : "The function to call",
826 "desc" : "(optional) The scope (this object) for the fn",
833 "name" : "addListener",
835 "desc" : "Appends an event handler to this component",
836 "sig" : "(eventName, handler, scope, options)",
838 "memberOf" : "Roo.util.Observable",
840 "isConstructor" : false,
850 "name" : "eventName",
852 "desc" : "The type of event to listen for",
858 "desc" : "The method the event invokes",
864 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
870 "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>",
879 "name" : "arrowclick",
881 "desc" : "Fires when this button's arrow is clicked",
882 "sig" : "function (_self, e)\n{\n\n}",
891 "type" : "SplitButton",
897 "type" : "EventObject",
898 "desc" : "The click event",
907 "desc" : "Fires when the button is rendered",
908 "sig" : "function (_self)\n{\n\n}",
909 "memberOf" : "Roo.Button",
927 "desc" : "Fires when this button is clicked",
928 "sig" : "function (_self, e)\n{\n\n}",
929 "memberOf" : "Roo.Button",
943 "type" : "EventObject",
944 "desc" : "The click event",
951 "name" : "mouseover",
953 "desc" : "Fires when the mouse hovers over the button",
954 "sig" : "function (_self, e)\n{\n\n}",
955 "memberOf" : "Roo.Button",
970 "desc" : "The event object",
979 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
980 "sig" : "function (_self, pressed)\n{\n\n}",
981 "memberOf" : "Roo.Button",
1003 "name" : "mouseout",
1004 "type" : "function",
1005 "desc" : "Fires when the mouse exits the button",
1006 "sig" : "function (_self, e)\n{\n\n}",
1007 "memberOf" : "Roo.Button",
1017 "isOptional" : false
1022 "desc" : "The event object",
1023 "isOptional" : false