12 "Roo.Toolbar.SplitButton"
17 "desc" : "Simple Button class",
18 "isSingleton" : false,
22 "isBuilderTop" : false,
23 "memberOf" : "Button",
32 "desc" : "The config object",
43 "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>",
44 "memberOf" : "Roo.util.Observable"
48 "type" : "String/Object",
49 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
55 "desc" : "The button text",
60 "type" : "String/HTMLElement/Element",
61 "desc" : "The element to append the button to",
67 "desc" : "True to start hidden (defaults to false)",
71 "name" : "toggleGroup",
73 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
77 "name" : "handleMouseEvents",
79 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
84 "type" : "Roo.menu.Menu",
85 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
89 "name" : "enableToggle",
91 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
97 "desc" : "A function called when the button is clicked (can be used instead of click event)",
103 "desc" : "The scope of the handler",
109 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
115 "desc" : "True to start disabled (defaults to false)",
121 "desc" : "True to start pressed (only if enableToggle = true)",
126 "type" : "Roo.Template",
127 "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.",
133 "desc" : "A CSS class to apply to the button's main element.",
139 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
145 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
149 "name" : "menuAlign",
151 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
157 "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\")",
161 "name" : "tooltipType",
163 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
167 "name" : "clickEvent",
169 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
174 "type" : "Boolean/Object",
175 "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).",
181 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
189 "desc" : "Show this button",
190 "sig" : "()\n{\n\n}",
194 "isConstructor" : false,
208 "desc" : "Focus the button",
209 "sig" : "()\n{\n\n}",
213 "isConstructor" : false,
225 "name" : "setHandler",
227 "desc" : "Assigns this button's click handler",
228 "sig" : "(handler, scope)",
232 "isConstructor" : false,
244 "desc" : "The function to call when the button is clicked",
250 "desc" : "(optional) Scope for the function passed in",
259 "desc" : "Disable this button",
260 "sig" : "()\n{\n\n}",
264 "isConstructor" : false,
278 "desc" : "Enable this button",
279 "sig" : "()\n{\n\n}",
283 "isConstructor" : false,
297 "desc" : "Returns the button's underlying element",
298 "sig" : "()\n{\n\n}",
302 "isConstructor" : false,
314 "type" : "Roo.Element",
315 "desc" : "The element"
320 "name" : "setDisabled",
322 "desc" : "Convenience function for boolean enable/disable",
327 "isConstructor" : false,
339 "desc" : "True to enable, false to disable",
346 "name" : "setVisible",
348 "desc" : "Convenience function for boolean show/hide",
353 "isConstructor" : false,
365 "desc" : "True to show, false to hide",
374 "desc" : "Destroys this Button and removes any listeners.",
375 "sig" : "()\n{\n\n}",
379 "isConstructor" : false,
393 "desc" : "Gets the text for this button",
394 "sig" : "()\n{\n\n}",
398 "isConstructor" : false,
411 "desc" : "The button text"
418 "desc" : "Sets this button's text",
423 "isConstructor" : false,
435 "desc" : "The button text",
444 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
449 "isConstructor" : false,
461 "desc" : "(optional) Force a particular state",
470 "desc" : "Hide this button",
471 "sig" : "()\n{\n\n}",
475 "isConstructor" : false,
487 "name" : "purgeListeners",
489 "desc" : "Removes all listeners for this object",
490 "sig" : "()\n{\n\n}",
492 "memberOf" : "Roo.util.Observable",
494 "isConstructor" : false,
508 "desc" : "Appends an event handler to this element (shorthand for addListener)",
509 "sig" : "(eventName, handler, scope, options)",
511 "memberOf" : "Roo.util.Observable",
513 "isConstructor" : false,
523 "name" : "eventName",
525 "desc" : "The type of event to listen for",
531 "desc" : "The method the event invokes",
537 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
543 "desc" : "(optional)",
552 "desc" : "Removes a listener (shorthand for removeListener)",
553 "sig" : "(eventName, handler, scope)",
555 "memberOf" : "Roo.util.Observable",
557 "isConstructor" : false,
567 "name" : "eventName",
569 "desc" : "The type of event to listen for",
575 "desc" : "The handler to remove",
581 "desc" : "(optional) The scope (this object) for the handler",
588 "name" : "addEvents",
590 "desc" : "Used to define events on this Observable",
593 "memberOf" : "Roo.util.Observable",
595 "isConstructor" : false,
607 "desc" : "The object with the events defined",
614 "name" : "releaseCapture",
616 "desc" : "Removes <b>all</b> added captures from the Observable.",
619 "memberOf" : "Roo.util.Observable",
621 "isConstructor" : false,
632 "type" : "Observable",
633 "desc" : "The Observable to release",
640 "name" : "removeListener",
642 "desc" : "Removes a listener",
643 "sig" : "(eventName, handler, scope)",
645 "memberOf" : "Roo.util.Observable",
647 "isConstructor" : false,
657 "name" : "eventName",
659 "desc" : "The type of event to listen for",
665 "desc" : "The handler to remove",
671 "desc" : "(optional) The scope (this object) for the handler",
678 "name" : "fireEvent",
680 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
681 "sig" : "(eventName, args)",
683 "memberOf" : "Roo.util.Observable",
685 "isConstructor" : false,
695 "name" : "eventName",
702 "type" : "Object...",
703 "desc" : "Variable number of parameters are passed to handlers",
711 "desc" : "returns false if any of the handlers return false otherwise it returns true"
716 "name" : "hasListener",
718 "desc" : "Checks to see if this object has any listeners for a specified event",
719 "sig" : "(eventName)",
721 "memberOf" : "Roo.util.Observable",
723 "isConstructor" : false,
733 "name" : "eventName",
735 "desc" : "The name of the event to check for",
743 "desc" : "True if the event is being listened for, else false"
750 "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.",
751 "sig" : "(o, fn, scope)",
753 "memberOf" : "Roo.util.Observable",
755 "isConstructor" : false,
766 "type" : "Observable",
767 "desc" : "The Observable to capture",
773 "desc" : "The function to call",
779 "desc" : "(optional) The scope (this object) for the fn",
786 "name" : "addListener",
788 "desc" : "Appends an event handler to this component",
789 "sig" : "(eventName, handler, scope, options)",
791 "memberOf" : "Roo.util.Observable",
793 "isConstructor" : false,
803 "name" : "eventName",
805 "desc" : "The type of event to listen for",
811 "desc" : "The method the event invokes",
817 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
823 "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>",
834 "desc" : "Fires when the button is rendered",
835 "sig" : "function (_self)\n{\n\n}",
854 "desc" : "Fires when this button is clicked",
855 "sig" : "function (_self, e)\n{\n\n}",
870 "type" : "EventObject",
871 "desc" : "The click event",
878 "name" : "mouseover",
880 "desc" : "Fires when the mouse hovers over the button",
881 "sig" : "function (_self, e)\n{\n\n}",
897 "desc" : "The event object",
906 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
907 "sig" : "function (_self, pressed)\n{\n\n}",
932 "desc" : "Fires when the mouse exits the button",
933 "sig" : "function (_self, e)\n{\n\n}",
949 "desc" : "The event object",