2 "name" : "Roo.Toolbar.Button",
10 "desc" : "A button that renders into a toolbar.",
11 "isSingleton" : false,
15 "isBuilderTop" : false,
16 "memberOf" : "Button",
25 "desc" : "A standard {@link Roo.Button} config object",
36 "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>",
37 "memberOf" : "Roo.util.Observable"
41 "type" : "String/Object",
42 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
43 "memberOf" : "Roo.Button"
48 "desc" : "The button text",
49 "memberOf" : "Roo.Button"
53 "type" : "String/HTMLElement/Element",
54 "desc" : "The element to append the button to",
55 "memberOf" : "Roo.Button"
60 "desc" : "True to start hidden (defaults to false)",
61 "memberOf" : "Roo.Button"
64 "name" : "toggleGroup",
66 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
67 "memberOf" : "Roo.Button"
70 "name" : "handleMouseEvents",
72 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
73 "memberOf" : "Roo.Button"
77 "type" : "Roo.menu.Menu",
78 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
79 "memberOf" : "Roo.Button"
82 "name" : "enableToggle",
84 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
85 "memberOf" : "Roo.Button"
90 "desc" : "A function called when the button is clicked (can be used instead of click event)",
91 "memberOf" : "Roo.Button"
96 "desc" : "The scope of the handler",
97 "memberOf" : "Roo.Button"
102 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
103 "memberOf" : "Roo.Button"
108 "desc" : "True to start disabled (defaults to false)",
109 "memberOf" : "Roo.Button"
114 "desc" : "True to start pressed (only if enableToggle = true)",
115 "memberOf" : "Roo.Button"
119 "type" : "Roo.Template",
120 "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.",
121 "memberOf" : "Roo.Button"
126 "desc" : "A CSS class to apply to the button's main element.",
127 "memberOf" : "Roo.Button"
132 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
133 "memberOf" : "Roo.Button"
138 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
139 "memberOf" : "Roo.Button"
142 "name" : "menuAlign",
144 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
145 "memberOf" : "Roo.Button"
150 "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\")",
151 "memberOf" : "Roo.Button"
154 "name" : "tooltipType",
156 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
157 "memberOf" : "Roo.Button"
160 "name" : "clickEvent",
162 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
163 "memberOf" : "Roo.Button"
167 "type" : "Boolean/Object",
168 "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).",
169 "memberOf" : "Roo.Button"
174 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
175 "memberOf" : "Roo.Button"
182 "desc" : "Disables this item",
183 "sig" : "()\n{\n\n}",
187 "isConstructor" : false,
201 "desc" : "Enables this item",
202 "sig" : "()\n{\n\n}",
206 "isConstructor" : false,
220 "desc" : "Removes and destroys this button",
221 "sig" : "()\n{\n\n}",
225 "isConstructor" : false,
239 "desc" : "Hides this button",
240 "sig" : "()\n{\n\n}",
244 "isConstructor" : false,
258 "desc" : "Shows this button",
259 "sig" : "()\n{\n\n}",
263 "isConstructor" : false,
277 "desc" : "Focus the button",
278 "sig" : "()\n{\n\n}",
280 "memberOf" : "Roo.Button",
282 "isConstructor" : false,
294 "name" : "setHandler",
296 "desc" : "Assigns this button's click handler",
297 "sig" : "(handler, scope)",
299 "memberOf" : "Roo.Button",
301 "isConstructor" : false,
313 "desc" : "The function to call when the button is clicked",
319 "desc" : "(optional) Scope for the function passed in",
328 "desc" : "Returns the button's underlying element",
329 "sig" : "()\n{\n\n}",
331 "memberOf" : "Roo.Button",
333 "isConstructor" : false,
345 "type" : "Roo.Element",
346 "desc" : "The element"
351 "name" : "setDisabled",
353 "desc" : "Convenience function for boolean enable/disable",
356 "memberOf" : "Roo.Button",
358 "isConstructor" : false,
370 "desc" : "True to enable, false to disable",
377 "name" : "setVisible",
379 "desc" : "Convenience function for boolean show/hide",
382 "memberOf" : "Roo.Button",
384 "isConstructor" : false,
396 "desc" : "True to show, false to hide",
405 "desc" : "Gets the text for this button",
406 "sig" : "()\n{\n\n}",
408 "memberOf" : "Roo.Button",
410 "isConstructor" : false,
423 "desc" : "The button text"
430 "desc" : "Sets this button's text",
433 "memberOf" : "Roo.Button",
435 "isConstructor" : false,
447 "desc" : "The button text",
456 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
459 "memberOf" : "Roo.Button",
461 "isConstructor" : false,
473 "desc" : "(optional) Force a particular state",
480 "name" : "purgeListeners",
482 "desc" : "Removes all listeners for this object",
483 "sig" : "()\n{\n\n}",
485 "memberOf" : "Roo.util.Observable",
487 "isConstructor" : false,
501 "desc" : "Appends an event handler to this element (shorthand for addListener)",
502 "sig" : "(eventName, handler, scope, options)",
504 "memberOf" : "Roo.util.Observable",
506 "isConstructor" : false,
516 "name" : "eventName",
518 "desc" : "The type of event to listen for",
524 "desc" : "The method the event invokes",
530 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
536 "desc" : "(optional)",
545 "desc" : "Removes a listener (shorthand for removeListener)",
546 "sig" : "(eventName, handler, scope)",
548 "memberOf" : "Roo.util.Observable",
550 "isConstructor" : false,
560 "name" : "eventName",
562 "desc" : "The type of event to listen for",
568 "desc" : "The handler to remove",
574 "desc" : "(optional) The scope (this object) for the handler",
581 "name" : "addEvents",
583 "desc" : "Used to define events on this Observable",
586 "memberOf" : "Roo.util.Observable",
588 "isConstructor" : false,
600 "desc" : "The object with the events defined",
607 "name" : "releaseCapture",
609 "desc" : "Removes <b>all</b> added captures from the Observable.",
612 "memberOf" : "Roo.util.Observable",
614 "isConstructor" : false,
625 "type" : "Observable",
626 "desc" : "The Observable to release",
633 "name" : "removeListener",
635 "desc" : "Removes a listener",
636 "sig" : "(eventName, handler, scope)",
638 "memberOf" : "Roo.util.Observable",
640 "isConstructor" : false,
650 "name" : "eventName",
652 "desc" : "The type of event to listen for",
658 "desc" : "The handler to remove",
664 "desc" : "(optional) The scope (this object) for the handler",
671 "name" : "fireEvent",
673 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
674 "sig" : "(eventName, args)",
676 "memberOf" : "Roo.util.Observable",
678 "isConstructor" : false,
688 "name" : "eventName",
695 "type" : "Object...",
696 "desc" : "Variable number of parameters are passed to handlers",
704 "desc" : "returns false if any of the handlers return false otherwise it returns true"
709 "name" : "hasListener",
711 "desc" : "Checks to see if this object has any listeners for a specified event",
712 "sig" : "(eventName)",
714 "memberOf" : "Roo.util.Observable",
716 "isConstructor" : false,
726 "name" : "eventName",
728 "desc" : "The name of the event to check for",
736 "desc" : "True if the event is being listened for, else false"
743 "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.",
744 "sig" : "(o, fn, scope)",
746 "memberOf" : "Roo.util.Observable",
748 "isConstructor" : false,
759 "type" : "Observable",
760 "desc" : "The Observable to capture",
766 "desc" : "The function to call",
772 "desc" : "(optional) The scope (this object) for the fn",
779 "name" : "addListener",
781 "desc" : "Appends an event handler to this component",
782 "sig" : "(eventName, handler, scope, options)",
784 "memberOf" : "Roo.util.Observable",
786 "isConstructor" : false,
796 "name" : "eventName",
798 "desc" : "The type of event to listen for",
804 "desc" : "The method the event invokes",
810 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
816 "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>",
827 "desc" : "Fires when the button is rendered",
828 "sig" : "function (_self)\n{\n\n}",
829 "memberOf" : "Roo.Button",
847 "desc" : "Fires when this button is clicked",
848 "sig" : "function (_self, e)\n{\n\n}",
849 "memberOf" : "Roo.Button",
863 "type" : "EventObject",
864 "desc" : "The click event",
871 "name" : "mouseover",
873 "desc" : "Fires when the mouse hovers over the button",
874 "sig" : "function (_self, e)\n{\n\n}",
875 "memberOf" : "Roo.Button",
890 "desc" : "The event object",
899 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
900 "sig" : "function (_self, pressed)\n{\n\n}",
901 "memberOf" : "Roo.Button",
925 "desc" : "Fires when the mouse exits the button",
926 "sig" : "function (_self, e)\n{\n\n}",
927 "memberOf" : "Roo.Button",
942 "desc" : "The event object",