2 "name" : "Roo.Toolbar.Button",
7 "desc" : "A button that renders into a toolbar.",
11 "memberOf" : "Button",
20 "desc" : "A standard {@link Roo.Button} config object",
31 "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>",
32 "memberOf" : "Roo.util.Observable"
36 "type" : "String/Object",
37 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
38 "memberOf" : "Roo.Button"
43 "desc" : "The button text",
44 "memberOf" : "Roo.Button"
48 "type" : "String/HTMLElement/Element",
49 "desc" : "The element to append the button to",
50 "memberOf" : "Roo.Button"
55 "desc" : "True to start hidden (defaults to false)",
56 "memberOf" : "Roo.Button"
59 "name" : "toggleGroup",
61 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
62 "memberOf" : "Roo.Button"
65 "name" : "handleMouseEvents",
67 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
68 "memberOf" : "Roo.Button"
72 "type" : "Roo.menu.Menu",
73 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
74 "memberOf" : "Roo.Button"
77 "name" : "enableToggle",
79 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
80 "memberOf" : "Roo.Button"
85 "desc" : "A function called when the button is clicked (can be used instead of click event)",
86 "memberOf" : "Roo.Button"
91 "desc" : "The scope of the handler",
92 "memberOf" : "Roo.Button"
97 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
98 "memberOf" : "Roo.Button"
103 "desc" : "True to start disabled (defaults to false)",
104 "memberOf" : "Roo.Button"
109 "desc" : "True to start pressed (only if enableToggle = true)",
110 "memberOf" : "Roo.Button"
114 "type" : "Roo.Template",
115 "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.",
116 "memberOf" : "Roo.Button"
121 "desc" : "A CSS class to apply to the button's main element.",
122 "memberOf" : "Roo.Button"
127 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
128 "memberOf" : "Roo.Button"
133 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
134 "memberOf" : "Roo.Button"
137 "name" : "menuAlign",
139 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
140 "memberOf" : "Roo.Button"
145 "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\")",
146 "memberOf" : "Roo.Button"
149 "name" : "tooltipType",
151 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
152 "memberOf" : "Roo.Button"
155 "name" : "clickEvent",
157 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
158 "memberOf" : "Roo.Button"
162 "type" : "Boolean/Object",
163 "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).",
164 "memberOf" : "Roo.Button"
169 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
170 "memberOf" : "Roo.Button"
177 "desc" : "Disables this item",
178 "sig" : "()\n{\n\n}",
182 "isConstructor" : false,
196 "desc" : "Enables this item",
197 "sig" : "()\n{\n\n}",
201 "isConstructor" : false,
215 "desc" : "Removes and destroys this button",
216 "sig" : "()\n{\n\n}",
220 "isConstructor" : false,
234 "desc" : "Hides this button",
235 "sig" : "()\n{\n\n}",
239 "isConstructor" : false,
253 "desc" : "Shows this button",
254 "sig" : "()\n{\n\n}",
258 "isConstructor" : false,
272 "desc" : "Focus the button",
273 "sig" : "()\n{\n\n}",
275 "memberOf" : "Roo.Button",
277 "isConstructor" : false,
289 "name" : "setHandler",
291 "desc" : "Assigns this button's click handler",
292 "sig" : "(handler, scope)",
294 "memberOf" : "Roo.Button",
296 "isConstructor" : false,
308 "desc" : "The function to call when the button is clicked",
314 "desc" : "(optional) Scope for the function passed in",
323 "desc" : "Returns the button's underlying element",
324 "sig" : "()\n{\n\n}",
326 "memberOf" : "Roo.Button",
328 "isConstructor" : false,
340 "type" : "Roo.Element",
341 "desc" : "The element"
346 "name" : "setDisabled",
348 "desc" : "Convenience function for boolean enable/disable",
351 "memberOf" : "Roo.Button",
353 "isConstructor" : false,
365 "desc" : "True to enable, false to disable",
372 "name" : "setVisible",
374 "desc" : "Convenience function for boolean show/hide",
377 "memberOf" : "Roo.Button",
379 "isConstructor" : false,
391 "desc" : "True to show, false to hide",
400 "desc" : "Gets the text for this button",
401 "sig" : "()\n{\n\n}",
403 "memberOf" : "Roo.Button",
405 "isConstructor" : false,
418 "desc" : "The button text"
425 "desc" : "Sets this button's text",
428 "memberOf" : "Roo.Button",
430 "isConstructor" : false,
442 "desc" : "The button text",
451 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
454 "memberOf" : "Roo.Button",
456 "isConstructor" : false,
468 "desc" : "(optional) Force a particular state",
475 "name" : "purgeListeners",
477 "desc" : "Removes all listeners for this object",
478 "sig" : "()\n{\n\n}",
480 "memberOf" : "Roo.util.Observable",
482 "isConstructor" : false,
496 "desc" : "Appends an event handler to this element (shorthand for addListener)",
497 "sig" : "(eventName, handler, scope, options)",
499 "memberOf" : "Roo.util.Observable",
501 "isConstructor" : false,
511 "name" : "eventName",
513 "desc" : "The type of event to listen for",
519 "desc" : "The method the event invokes",
525 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
531 "desc" : "(optional)",
540 "desc" : "Removes a listener (shorthand for removeListener)",
541 "sig" : "(eventName, handler, scope)",
543 "memberOf" : "Roo.util.Observable",
545 "isConstructor" : false,
555 "name" : "eventName",
557 "desc" : "The type of event to listen for",
563 "desc" : "The handler to remove",
569 "desc" : "(optional) The scope (this object) for the handler",
576 "name" : "addEvents",
578 "desc" : "Used to define events on this Observable",
581 "memberOf" : "Roo.util.Observable",
583 "isConstructor" : false,
595 "desc" : "The object with the events defined",
602 "name" : "releaseCapture",
604 "desc" : "Removes <b>all</b> added captures from the Observable.",
607 "memberOf" : "Roo.util.Observable",
609 "isConstructor" : false,
620 "type" : "Observable",
621 "desc" : "The Observable to release",
628 "name" : "removeListener",
630 "desc" : "Removes a listener",
631 "sig" : "(eventName, handler, scope)",
633 "memberOf" : "Roo.util.Observable",
635 "isConstructor" : false,
645 "name" : "eventName",
647 "desc" : "The type of event to listen for",
653 "desc" : "The handler to remove",
659 "desc" : "(optional) The scope (this object) for the handler",
666 "name" : "fireEvent",
668 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
669 "sig" : "(eventName, args)",
671 "memberOf" : "Roo.util.Observable",
673 "isConstructor" : false,
683 "name" : "eventName",
690 "type" : "Object...",
691 "desc" : "Variable number of parameters are passed to handlers",
699 "desc" : "returns false if any of the handlers return false otherwise it returns true"
704 "name" : "hasListener",
706 "desc" : "Checks to see if this object has any listeners for a specified event",
707 "sig" : "(eventName)",
709 "memberOf" : "Roo.util.Observable",
711 "isConstructor" : false,
721 "name" : "eventName",
723 "desc" : "The name of the event to check for",
731 "desc" : "True if the event is being listened for, else false"
738 "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.",
739 "sig" : "(o, fn, scope)",
741 "memberOf" : "Roo.util.Observable",
743 "isConstructor" : false,
754 "type" : "Observable",
755 "desc" : "The Observable to capture",
761 "desc" : "The function to call",
767 "desc" : "(optional) The scope (this object) for the fn",
774 "name" : "addListener",
776 "desc" : "Appends an event handler to this component",
777 "sig" : "(eventName, handler, scope, options)",
779 "memberOf" : "Roo.util.Observable",
781 "isConstructor" : false,
791 "name" : "eventName",
793 "desc" : "The type of event to listen for",
799 "desc" : "The method the event invokes",
805 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
811 "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>",
822 "desc" : "Fires when the button is rendered",
823 "sig" : "function (_self)\n{\n\n}",
824 "memberOf" : "Roo.Button",
842 "desc" : "Fires when this button is clicked",
843 "sig" : "function (_self, e)\n{\n\n}",
844 "memberOf" : "Roo.Button",
858 "type" : "EventObject",
859 "desc" : "The click event",
866 "name" : "mouseover",
868 "desc" : "Fires when the mouse hovers over the button",
869 "sig" : "function (_self, e)\n{\n\n}",
870 "memberOf" : "Roo.Button",
885 "desc" : "The event object",
894 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
895 "sig" : "function (_self, pressed)\n{\n\n}",
896 "memberOf" : "Roo.Button",
920 "desc" : "Fires when the mouse exits the button",
921 "sig" : "function (_self, e)\n{\n\n}",
922 "memberOf" : "Roo.Button",
937 "desc" : "The event object",