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",
53 "type" : "String/Object",
54 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
55 "memberOf" : "Roo.Button",
62 "desc" : "The button text",
63 "memberOf" : "Roo.Button",
69 "type" : "String/HTMLElement/Element",
70 "desc" : "The element to append the button to",
71 "memberOf" : "Roo.Button",
78 "desc" : "True to start hidden (defaults to false)",
79 "memberOf" : "Roo.Button",
84 "name" : "toggleGroup",
86 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
87 "memberOf" : "Roo.Button",
92 "name" : "handleMouseEvents",
94 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
95 "memberOf" : "Roo.Button",
101 "type" : "Roo.menu.Menu",
102 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
103 "memberOf" : "Roo.Button",
104 "isOptional" : false,
108 "name" : "enableToggle",
110 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
111 "memberOf" : "Roo.Button",
112 "isOptional" : false,
116 "name" : "arrowHandler",
118 "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
120 "isOptional" : false,
126 "desc" : "A function called when the button is clicked (can be used instead of click event)",
127 "memberOf" : "Roo.Button",
128 "isOptional" : false,
134 "desc" : "The scope of the handler",
135 "memberOf" : "Roo.Button",
136 "isOptional" : false,
142 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
143 "memberOf" : "Roo.Button",
144 "isOptional" : false,
150 "desc" : "True to start disabled (defaults to false)",
151 "memberOf" : "Roo.Button",
152 "isOptional" : false,
158 "desc" : "True to start pressed (only if enableToggle = true)",
159 "memberOf" : "Roo.Button",
160 "isOptional" : false,
165 "type" : "Roo.Template",
166 "desc" : "An {@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.",
167 "memberOf" : "Roo.Button",
168 "isOptional" : false,
174 "desc" : "A CSS class to apply to the button's main element.",
175 "memberOf" : "Roo.Button",
176 "isOptional" : false,
182 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
183 "memberOf" : "Roo.Button",
184 "isOptional" : false,
190 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
191 "memberOf" : "Roo.Button",
192 "isOptional" : false,
196 "name" : "menuAlign",
198 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
199 "memberOf" : "Roo.Button",
200 "isOptional" : false,
206 "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\")",
207 "memberOf" : "Roo.Button",
208 "isOptional" : false,
212 "name" : "tooltipType",
214 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
215 "memberOf" : "Roo.Button",
216 "isOptional" : false,
220 "name" : "arrowTooltip",
222 "desc" : "The title attribute of the arrow",
224 "isOptional" : false,
228 "name" : "clickEvent",
230 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
231 "memberOf" : "Roo.Button",
232 "isOptional" : false,
237 "type" : "Boolean/Object",
238 "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).",
239 "memberOf" : "Roo.Button",
240 "isOptional" : false,
246 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
247 "memberOf" : "Roo.Button",
248 "isOptional" : false,
254 "name" : "setArrowHandler",
256 "desc" : "Sets this button's arrow click handler",
257 "sig" : "(handler, scope)",
261 "isConstructor" : false,
273 "desc" : "The function to call when the arrow is clicked",
279 "desc" : "(optional) Scope for the function passed above",
288 "desc" : "Focus the button",
289 "sig" : "()\n{\n\n}",
293 "isConstructor" : false,
305 "name" : "setHandler",
307 "desc" : "Sets this button's click handler",
308 "sig" : "(handler, scope)",
312 "isConstructor" : false,
324 "desc" : "The function to call when the button is clicked",
330 "desc" : "(optional) Scope for the function passed above",
339 "desc" : "Show this button",
340 "sig" : "()\n{\n\n}",
342 "memberOf" : "Roo.Button",
344 "isConstructor" : false,
358 "desc" : "Disable this button",
359 "sig" : "()\n{\n\n}",
361 "memberOf" : "Roo.Button",
363 "isConstructor" : false,
377 "desc" : "Enable this button",
378 "sig" : "()\n{\n\n}",
380 "memberOf" : "Roo.Button",
382 "isConstructor" : false,
396 "desc" : "Returns the button's underlying element",
397 "sig" : "()\n{\n\n}",
399 "memberOf" : "Roo.Button",
401 "isConstructor" : false,
413 "type" : "Roo.Element",
414 "desc" : "The element"
419 "name" : "setDisabled",
421 "desc" : "Convenience function for boolean enable/disable",
424 "memberOf" : "Roo.Button",
426 "isConstructor" : false,
438 "desc" : "True to enable, false to disable",
445 "name" : "setPressed",
447 "desc" : "Similar to toggle, but does not trigger event.",
450 "memberOf" : "Roo.Button",
452 "isConstructor" : false,
464 "desc" : "[required] Force a particular state",
471 "name" : "setVisible",
473 "desc" : "Convenience function for boolean show/hide",
476 "memberOf" : "Roo.Button",
478 "isConstructor" : false,
490 "desc" : "True to show, false to hide",
499 "desc" : "Destroys this Button and removes any listeners.",
500 "sig" : "()\n{\n\n}",
502 "memberOf" : "Roo.Button",
504 "isConstructor" : false,
518 "desc" : "Gets the text for this button",
519 "sig" : "()\n{\n\n}",
521 "memberOf" : "Roo.Button",
523 "isConstructor" : false,
536 "desc" : "The button text"
543 "desc" : "Sets this button's text",
546 "memberOf" : "Roo.Button",
548 "isConstructor" : false,
560 "desc" : "The button text",
569 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
572 "memberOf" : "Roo.Button",
574 "isConstructor" : false,
586 "desc" : "(optional) Force a particular state",
595 "desc" : "Hide this button",
596 "sig" : "()\n{\n\n}",
598 "memberOf" : "Roo.Button",
600 "isConstructor" : false,
612 "name" : "purgeListeners",
614 "desc" : "Removes all listeners for this object",
615 "sig" : "()\n{\n\n}",
617 "memberOf" : "Roo.util.Observable",
619 "isConstructor" : false,
633 "desc" : "Appends an event handler to this element (shorthand for addListener)",
634 "sig" : "(eventName, handler, scope, options)",
636 "memberOf" : "Roo.util.Observable",
638 "isConstructor" : false,
648 "name" : "eventName",
650 "desc" : "The type of event to listen for",
656 "desc" : "The method the event invokes",
662 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
668 "desc" : "(optional)",
677 "desc" : "Removes a listener (shorthand for removeListener)",
678 "sig" : "(eventName, handler, scope)",
680 "memberOf" : "Roo.util.Observable",
682 "isConstructor" : false,
692 "name" : "eventName",
694 "desc" : "The type of event to listen for",
700 "desc" : "The handler to remove",
706 "desc" : "(optional) The scope (this object) for the handler",
713 "name" : "addEvents",
715 "desc" : "Used to define events on this Observable",
718 "memberOf" : "Roo.util.Observable",
720 "isConstructor" : false,
732 "desc" : "The object with the events defined",
739 "name" : "releaseCapture",
741 "desc" : "Removes <b>all</b> added captures from the Observable.",
744 "memberOf" : "Roo.util.Observable",
746 "isConstructor" : false,
757 "type" : "Observable",
758 "desc" : "The Observable to release",
765 "name" : "removeListener",
767 "desc" : "Removes a listener",
768 "sig" : "(eventName, handler, scope)",
770 "memberOf" : "Roo.util.Observable",
772 "isConstructor" : false,
782 "name" : "eventName",
784 "desc" : "The type of event to listen for",
790 "desc" : "The handler to remove",
796 "desc" : "(optional) The scope (this object) for the handler",
803 "name" : "fireEvent",
805 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
806 "sig" : "(eventName, args)",
808 "memberOf" : "Roo.util.Observable",
810 "isConstructor" : false,
820 "name" : "eventName",
827 "type" : "Object...",
828 "desc" : "Variable number of parameters are passed to handlers",
836 "desc" : "returns false if any of the handlers return false otherwise it returns true"
841 "name" : "hasListener",
843 "desc" : "Checks to see if this object has any listeners for a specified event",
844 "sig" : "(eventName)",
846 "memberOf" : "Roo.util.Observable",
848 "isConstructor" : false,
858 "name" : "eventName",
860 "desc" : "The name of the event to check for",
868 "desc" : "True if the event is being listened for, else false"
875 "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.",
876 "sig" : "(o, fn, scope)",
878 "memberOf" : "Roo.util.Observable",
880 "isConstructor" : false,
891 "type" : "Observable",
892 "desc" : "The Observable to capture",
898 "desc" : "The function to call",
904 "desc" : "(optional) The scope (this object) for the fn",
911 "name" : "addListener",
913 "desc" : "Appends an event handler to this component",
914 "sig" : "(eventName, handler, scope, options)",
916 "memberOf" : "Roo.util.Observable",
918 "isConstructor" : false,
928 "name" : "eventName",
930 "desc" : "The type of event to listen for",
936 "desc" : "The method the event invokes",
942 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
948 "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>",
957 "name" : "arrowclick",
959 "desc" : "Fires when this button's arrow is clicked",
960 "sig" : "function (_self, e)\n{\n\n}",
969 "type" : "SplitButton",
975 "type" : "EventObject",
976 "desc" : "The click event",
985 "desc" : "Fires when the button is rendered",
986 "sig" : "function (_self)\n{\n\n}",
987 "memberOf" : "Roo.Button",
1004 "type" : "function",
1005 "desc" : "Fires when this button is clicked",
1006 "sig" : "function (_self, e)\n{\n\n}",
1007 "memberOf" : "Roo.Button",
1017 "isOptional" : false
1021 "type" : "EventObject",
1022 "desc" : "The click event",
1023 "isOptional" : false
1029 "name" : "mouseover",
1030 "type" : "function",
1031 "desc" : "Fires when the mouse hovers over the button",
1032 "sig" : "function (_self, e)\n{\n\n}",
1033 "memberOf" : "Roo.Button",
1043 "isOptional" : false
1048 "desc" : "The event object",
1049 "isOptional" : false
1056 "type" : "function",
1057 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
1058 "sig" : "function (_self, pressed)\n{\n\n}",
1059 "memberOf" : "Roo.Button",
1069 "isOptional" : false
1075 "isOptional" : false
1081 "name" : "mouseout",
1082 "type" : "function",
1083 "desc" : "Fires when the mouse exits the button",
1084 "sig" : "function (_self, e)\n{\n\n}",
1085 "memberOf" : "Roo.Button",
1095 "isOptional" : false
1100 "desc" : "The event object",
1101 "isOptional" : false