2 "name" : "Roo.Toolbar.Button",
8 "desc" : "A button that renders into a toolbar.",
12 "memberOf" : "Button",
21 "desc" : "A standard {@link Roo.Button} config object",
32 "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>",
33 "memberOf" : "Roo.util.Observable"
37 "type" : "String/Object",
38 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
39 "memberOf" : "Roo.Button"
44 "desc" : "The button text",
45 "memberOf" : "Roo.Button"
49 "type" : "String/HTMLElement/Element",
50 "desc" : "The element to append the button to",
51 "memberOf" : "Roo.Button"
56 "desc" : "True to start hidden (defaults to false)",
57 "memberOf" : "Roo.Button"
60 "name" : "toggleGroup",
62 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
63 "memberOf" : "Roo.Button"
66 "name" : "handleMouseEvents",
68 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
69 "memberOf" : "Roo.Button"
73 "type" : "Roo.menu.Menu",
74 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
75 "memberOf" : "Roo.Button"
78 "name" : "enableToggle",
80 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
81 "memberOf" : "Roo.Button"
86 "desc" : "A function called when the button is clicked (can be used instead of click event)",
87 "memberOf" : "Roo.Button"
92 "desc" : "The scope of the handler",
93 "memberOf" : "Roo.Button"
98 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
99 "memberOf" : "Roo.Button"
104 "desc" : "True to start disabled (defaults to false)",
105 "memberOf" : "Roo.Button"
110 "desc" : "True to start pressed (only if enableToggle = true)",
111 "memberOf" : "Roo.Button"
115 "type" : "Roo.Template",
116 "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.",
117 "memberOf" : "Roo.Button"
122 "desc" : "A CSS class to apply to the button's main element.",
123 "memberOf" : "Roo.Button"
128 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
129 "memberOf" : "Roo.Button"
134 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
135 "memberOf" : "Roo.Button"
138 "name" : "menuAlign",
140 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
141 "memberOf" : "Roo.Button"
146 "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\")",
147 "memberOf" : "Roo.Button"
150 "name" : "tooltipType",
152 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
153 "memberOf" : "Roo.Button"
156 "name" : "clickEvent",
158 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
159 "memberOf" : "Roo.Button"
163 "type" : "Boolean/Object",
164 "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).",
165 "memberOf" : "Roo.Button"
170 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
171 "memberOf" : "Roo.Button"
178 "desc" : "Disables this item",
179 "sig" : "()\n{\n\n}",
183 "isConstructor" : false,
197 "desc" : "Enables this item",
198 "sig" : "()\n{\n\n}",
202 "isConstructor" : false,
216 "desc" : "Removes and destroys this button",
217 "sig" : "()\n{\n\n}",
221 "isConstructor" : false,
235 "desc" : "Hides this button",
236 "sig" : "()\n{\n\n}",
240 "isConstructor" : false,
254 "desc" : "Shows this button",
255 "sig" : "()\n{\n\n}",
259 "isConstructor" : false,
273 "desc" : "Focus the button",
274 "sig" : "()\n{\n\n}",
276 "memberOf" : "Roo.Button",
278 "isConstructor" : false,
290 "name" : "setHandler",
292 "desc" : "Assigns this button's click handler",
293 "sig" : "(handler, scope)",
295 "memberOf" : "Roo.Button",
297 "isConstructor" : false,
309 "desc" : "The function to call when the button is clicked",
315 "desc" : "(optional) Scope for the function passed in",
324 "desc" : "Returns the button's underlying element",
325 "sig" : "()\n{\n\n}",
327 "memberOf" : "Roo.Button",
329 "isConstructor" : false,
341 "type" : "Roo.Element",
342 "desc" : "The element"
347 "name" : "setDisabled",
349 "desc" : "Convenience function for boolean enable/disable",
352 "memberOf" : "Roo.Button",
354 "isConstructor" : false,
366 "desc" : "True to enable, false to disable",
373 "name" : "setVisible",
375 "desc" : "Convenience function for boolean show/hide",
378 "memberOf" : "Roo.Button",
380 "isConstructor" : false,
392 "desc" : "True to show, false to hide",
401 "desc" : "Gets the text for this button",
402 "sig" : "()\n{\n\n}",
404 "memberOf" : "Roo.Button",
406 "isConstructor" : false,
419 "desc" : "The button text"
426 "desc" : "Sets this button's text",
429 "memberOf" : "Roo.Button",
431 "isConstructor" : false,
443 "desc" : "The button text",
452 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
455 "memberOf" : "Roo.Button",
457 "isConstructor" : false,
469 "desc" : "(optional) Force a particular state",
476 "name" : "purgeListeners",
478 "desc" : "Removes all listeners for this object",
479 "sig" : "()\n{\n\n}",
481 "memberOf" : "Roo.util.Observable",
483 "isConstructor" : false,
497 "desc" : "Appends an event handler to this element (shorthand for addListener)",
498 "sig" : "(eventName, handler, scope, options)",
500 "memberOf" : "Roo.util.Observable",
502 "isConstructor" : false,
512 "name" : "eventName",
514 "desc" : "The type of event to listen for",
520 "desc" : "The method the event invokes",
526 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
532 "desc" : "(optional)",
541 "desc" : "Removes a listener (shorthand for removeListener)",
542 "sig" : "(eventName, handler, scope)",
544 "memberOf" : "Roo.util.Observable",
546 "isConstructor" : false,
556 "name" : "eventName",
558 "desc" : "The type of event to listen for",
564 "desc" : "The handler to remove",
570 "desc" : "(optional) The scope (this object) for the handler",
577 "name" : "addEvents",
579 "desc" : "Used to define events on this Observable",
582 "memberOf" : "Roo.util.Observable",
584 "isConstructor" : false,
596 "desc" : "The object with the events defined",
603 "name" : "releaseCapture",
605 "desc" : "Removes <b>all</b> added captures from the Observable.",
608 "memberOf" : "Roo.util.Observable",
610 "isConstructor" : false,
621 "type" : "Observable",
622 "desc" : "The Observable to release",
629 "name" : "removeListener",
631 "desc" : "Removes a listener",
632 "sig" : "(eventName, handler, scope)",
634 "memberOf" : "Roo.util.Observable",
636 "isConstructor" : false,
646 "name" : "eventName",
648 "desc" : "The type of event to listen for",
654 "desc" : "The handler to remove",
660 "desc" : "(optional) The scope (this object) for the handler",
667 "name" : "fireEvent",
669 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
670 "sig" : "(eventName, args)",
672 "memberOf" : "Roo.util.Observable",
674 "isConstructor" : false,
684 "name" : "eventName",
691 "type" : "Object...",
692 "desc" : "Variable number of parameters are passed to handlers",
700 "desc" : "returns false if any of the handlers return false otherwise it returns true"
705 "name" : "hasListener",
707 "desc" : "Checks to see if this object has any listeners for a specified event",
708 "sig" : "(eventName)",
710 "memberOf" : "Roo.util.Observable",
712 "isConstructor" : false,
722 "name" : "eventName",
724 "desc" : "The name of the event to check for",
732 "desc" : "True if the event is being listened for, else false"
739 "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.",
740 "sig" : "(o, fn, scope)",
742 "memberOf" : "Roo.util.Observable",
744 "isConstructor" : false,
755 "type" : "Observable",
756 "desc" : "The Observable to capture",
762 "desc" : "The function to call",
768 "desc" : "(optional) The scope (this object) for the fn",
775 "name" : "addListener",
777 "desc" : "Appends an event handler to this component",
778 "sig" : "(eventName, handler, scope, options)",
780 "memberOf" : "Roo.util.Observable",
782 "isConstructor" : false,
792 "name" : "eventName",
794 "desc" : "The type of event to listen for",
800 "desc" : "The method the event invokes",
806 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
812 "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>",
823 "desc" : "Fires when the button is rendered",
824 "sig" : "function (_self)\n{\n\n}",
825 "memberOf" : "Roo.Button",
843 "desc" : "Fires when this button is clicked",
844 "sig" : "function (_self, e)\n{\n\n}",
845 "memberOf" : "Roo.Button",
859 "type" : "EventObject",
860 "desc" : "The click event",
867 "name" : "mouseover",
869 "desc" : "Fires when the mouse hovers over the button",
870 "sig" : "function (_self, e)\n{\n\n}",
871 "memberOf" : "Roo.Button",
886 "desc" : "The event object",
895 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
896 "sig" : "function (_self, pressed)\n{\n\n}",
897 "memberOf" : "Roo.Button",
921 "desc" : "Fires when the mouse exits the button",
922 "sig" : "function (_self, e)\n{\n\n}",
923 "memberOf" : "Roo.Button",
938 "desc" : "The event object",