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",
50 "type" : "String/Object",
51 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
59 "desc" : "The button text",
66 "type" : "String/HTMLElement/Element",
67 "desc" : "The element to append the button to",
75 "desc" : "True to start hidden (defaults to false)",
81 "name" : "toggleGroup",
83 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
89 "name" : "handleMouseEvents",
91 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
98 "type" : "Roo.menu.Menu",
99 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
101 "isOptional" : false,
105 "name" : "enableToggle",
107 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
109 "isOptional" : false,
115 "desc" : "A function called when the button is clicked (can be used instead of click event)",
117 "isOptional" : false,
123 "desc" : "The scope of the handler",
125 "isOptional" : false,
131 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
133 "isOptional" : false,
139 "desc" : "True to start disabled (defaults to false)",
141 "isOptional" : false,
147 "desc" : "True to start pressed (only if enableToggle = true)",
149 "isOptional" : false,
154 "type" : "Roo.Template",
155 "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.",
157 "isOptional" : false,
163 "desc" : "A CSS class to apply to the button's main element.",
165 "isOptional" : false,
171 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
173 "isOptional" : false,
179 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
181 "isOptional" : false,
185 "name" : "menuAlign",
187 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
189 "isOptional" : false,
195 "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 "isOptional" : false,
201 "name" : "tooltipType",
203 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
205 "isOptional" : false,
209 "name" : "clickEvent",
211 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
213 "isOptional" : false,
218 "type" : "Boolean/Object",
219 "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).",
221 "isOptional" : false,
227 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
229 "isOptional" : false,
237 "desc" : "Show this button",
238 "sig" : "()\n{\n\n}",
242 "isConstructor" : false,
256 "desc" : "Focus the button",
257 "sig" : "()\n{\n\n}",
261 "isConstructor" : false,
273 "name" : "setHandler",
275 "desc" : "Assigns this button's click handler",
276 "sig" : "(handler, scope)",
280 "isConstructor" : false,
292 "desc" : "The function to call when the button is clicked",
298 "desc" : "(optional) Scope for the function passed in",
307 "desc" : "Disable this button",
308 "sig" : "()\n{\n\n}",
312 "isConstructor" : false,
326 "desc" : "Enable this button",
327 "sig" : "()\n{\n\n}",
331 "isConstructor" : false,
345 "desc" : "Returns the button's underlying element",
346 "sig" : "()\n{\n\n}",
350 "isConstructor" : false,
362 "type" : "Roo.Element",
363 "desc" : "The element"
368 "name" : "setDisabled",
370 "desc" : "Convenience function for boolean enable/disable",
375 "isConstructor" : false,
387 "desc" : "True to enable, false to disable",
394 "name" : "setVisible",
396 "desc" : "Convenience function for boolean show/hide",
401 "isConstructor" : false,
413 "desc" : "True to show, false to hide",
422 "desc" : "Destroys this Button and removes any listeners.",
423 "sig" : "()\n{\n\n}",
427 "isConstructor" : false,
441 "desc" : "Gets the text for this button",
442 "sig" : "()\n{\n\n}",
446 "isConstructor" : false,
459 "desc" : "The button text"
466 "desc" : "Sets this button's text",
471 "isConstructor" : false,
483 "desc" : "The button text",
492 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
497 "isConstructor" : false,
509 "desc" : "(optional) Force a particular state",
518 "desc" : "Hide this button",
519 "sig" : "()\n{\n\n}",
523 "isConstructor" : false,
535 "name" : "purgeListeners",
537 "desc" : "Removes all listeners for this object",
538 "sig" : "()\n{\n\n}",
540 "memberOf" : "Roo.util.Observable",
542 "isConstructor" : false,
556 "desc" : "Appends an event handler to this element (shorthand for addListener)",
557 "sig" : "(eventName, handler, scope, options)",
559 "memberOf" : "Roo.util.Observable",
561 "isConstructor" : false,
571 "name" : "eventName",
573 "desc" : "The type of event to listen for",
579 "desc" : "The method the event invokes",
585 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
591 "desc" : "(optional)",
600 "desc" : "Removes a listener (shorthand for removeListener)",
601 "sig" : "(eventName, handler, scope)",
603 "memberOf" : "Roo.util.Observable",
605 "isConstructor" : false,
615 "name" : "eventName",
617 "desc" : "The type of event to listen for",
623 "desc" : "The handler to remove",
629 "desc" : "(optional) The scope (this object) for the handler",
636 "name" : "addEvents",
638 "desc" : "Used to define events on this Observable",
641 "memberOf" : "Roo.util.Observable",
643 "isConstructor" : false,
655 "desc" : "The object with the events defined",
662 "name" : "releaseCapture",
664 "desc" : "Removes <b>all</b> added captures from the Observable.",
667 "memberOf" : "Roo.util.Observable",
669 "isConstructor" : false,
680 "type" : "Observable",
681 "desc" : "The Observable to release",
688 "name" : "removeListener",
690 "desc" : "Removes a listener",
691 "sig" : "(eventName, handler, scope)",
693 "memberOf" : "Roo.util.Observable",
695 "isConstructor" : false,
705 "name" : "eventName",
707 "desc" : "The type of event to listen for",
713 "desc" : "The handler to remove",
719 "desc" : "(optional) The scope (this object) for the handler",
726 "name" : "fireEvent",
728 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
729 "sig" : "(eventName, args)",
731 "memberOf" : "Roo.util.Observable",
733 "isConstructor" : false,
743 "name" : "eventName",
750 "type" : "Object...",
751 "desc" : "Variable number of parameters are passed to handlers",
759 "desc" : "returns false if any of the handlers return false otherwise it returns true"
764 "name" : "hasListener",
766 "desc" : "Checks to see if this object has any listeners for a specified event",
767 "sig" : "(eventName)",
769 "memberOf" : "Roo.util.Observable",
771 "isConstructor" : false,
781 "name" : "eventName",
783 "desc" : "The name of the event to check for",
791 "desc" : "True if the event is being listened for, else false"
798 "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.",
799 "sig" : "(o, fn, scope)",
801 "memberOf" : "Roo.util.Observable",
803 "isConstructor" : false,
814 "type" : "Observable",
815 "desc" : "The Observable to capture",
821 "desc" : "The function to call",
827 "desc" : "(optional) The scope (this object) for the fn",
834 "name" : "addListener",
836 "desc" : "Appends an event handler to this component",
837 "sig" : "(eventName, handler, scope, options)",
839 "memberOf" : "Roo.util.Observable",
841 "isConstructor" : false,
851 "name" : "eventName",
853 "desc" : "The type of event to listen for",
859 "desc" : "The method the event invokes",
865 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
871 "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>",
882 "desc" : "Fires when the button is rendered",
883 "sig" : "function (_self)\n{\n\n}",
902 "desc" : "Fires when this button is clicked",
903 "sig" : "function (_self, e)\n{\n\n}",
918 "type" : "EventObject",
919 "desc" : "The click event",
926 "name" : "mouseover",
928 "desc" : "Fires when the mouse hovers over the button",
929 "sig" : "function (_self, e)\n{\n\n}",
945 "desc" : "The event object",
954 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
955 "sig" : "function (_self, pressed)\n{\n\n}",
980 "desc" : "Fires when the mouse exits the button",
981 "sig" : "function (_self, e)\n{\n\n}",
997 "desc" : "The event object",