2 "name" : "Roo.SplitButton",
7 "desc" : "A split button that provides a built-in dropdown arrow that can fire an event separately from the default\nclick event of the button. Typically this would be used to display a dropdown menu that provides additional\noptions to the primary button action, but any custom handler can provide the arrowclick implementation.",
11 "memberOf" : "SplitButton",
19 "type" : "String/HTMLElement/Element",
20 "desc" : "The element to append the button to",
26 "desc" : "The config object",
37 "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>",
38 "memberOf" : "Roo.util.Observable"
42 "type" : "String/Object",
43 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
44 "memberOf" : "Roo.Button"
49 "desc" : "The button text",
50 "memberOf" : "Roo.Button"
54 "type" : "String/HTMLElement/Element",
55 "desc" : "The element to append the button to",
56 "memberOf" : "Roo.Button"
61 "desc" : "True to start hidden (defaults to false)",
62 "memberOf" : "Roo.Button"
65 "name" : "toggleGroup",
67 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
68 "memberOf" : "Roo.Button"
71 "name" : "handleMouseEvents",
73 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
74 "memberOf" : "Roo.Button"
78 "type" : "Roo.menu.Menu",
79 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
80 "memberOf" : "Roo.Button"
83 "name" : "enableToggle",
85 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
86 "memberOf" : "Roo.Button"
89 "name" : "arrowHandler",
91 "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
97 "desc" : "A function called when the button is clicked (can be used instead of click event)",
98 "memberOf" : "Roo.Button"
103 "desc" : "The scope of the handler",
104 "memberOf" : "Roo.Button"
109 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
110 "memberOf" : "Roo.Button"
115 "desc" : "True to start disabled (defaults to false)",
116 "memberOf" : "Roo.Button"
121 "desc" : "True to start pressed (only if enableToggle = true)",
122 "memberOf" : "Roo.Button"
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.",
128 "memberOf" : "Roo.Button"
133 "desc" : "A CSS class to apply to the button's main element.",
134 "memberOf" : "Roo.Button"
139 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
140 "memberOf" : "Roo.Button"
145 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
146 "memberOf" : "Roo.Button"
149 "name" : "menuAlign",
151 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
152 "memberOf" : "Roo.Button"
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\")",
158 "memberOf" : "Roo.Button"
161 "name" : "tooltipType",
163 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
164 "memberOf" : "Roo.Button"
167 "name" : "arrowTooltip",
169 "desc" : "The title attribute of the arrow",
173 "name" : "clickEvent",
175 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
176 "memberOf" : "Roo.Button"
180 "type" : "Boolean/Object",
181 "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).",
182 "memberOf" : "Roo.Button"
187 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
188 "memberOf" : "Roo.Button"
193 "name" : "setArrowHandler",
195 "desc" : "Sets this button's arrow click handler",
196 "sig" : "(handler, scope)",
200 "isConstructor" : false,
212 "desc" : "The function to call when the arrow is clicked",
218 "desc" : "(optional) Scope for the function passed above",
227 "desc" : "Focus the button",
228 "sig" : "()\n{\n\n}",
232 "isConstructor" : false,
244 "name" : "setHandler",
246 "desc" : "Sets this button's click handler",
247 "sig" : "(handler, scope)",
251 "isConstructor" : false,
263 "desc" : "The function to call when the button is clicked",
269 "desc" : "(optional) Scope for the function passed above",
278 "desc" : "Show this button",
279 "sig" : "()\n{\n\n}",
281 "memberOf" : "Roo.Button",
283 "isConstructor" : false,
297 "desc" : "Disable this button",
298 "sig" : "()\n{\n\n}",
300 "memberOf" : "Roo.Button",
302 "isConstructor" : false,
316 "desc" : "Enable this button",
317 "sig" : "()\n{\n\n}",
319 "memberOf" : "Roo.Button",
321 "isConstructor" : false,
335 "desc" : "Returns the button's underlying element",
336 "sig" : "()\n{\n\n}",
338 "memberOf" : "Roo.Button",
340 "isConstructor" : false,
352 "type" : "Roo.Element",
353 "desc" : "The element"
358 "name" : "setDisabled",
360 "desc" : "Convenience function for boolean enable/disable",
363 "memberOf" : "Roo.Button",
365 "isConstructor" : false,
377 "desc" : "True to enable, false to disable",
384 "name" : "setVisible",
386 "desc" : "Convenience function for boolean show/hide",
389 "memberOf" : "Roo.Button",
391 "isConstructor" : false,
403 "desc" : "True to show, false to hide",
412 "desc" : "Destroys this Button and removes any listeners.",
413 "sig" : "()\n{\n\n}",
415 "memberOf" : "Roo.Button",
417 "isConstructor" : false,
431 "desc" : "Gets the text for this button",
432 "sig" : "()\n{\n\n}",
434 "memberOf" : "Roo.Button",
436 "isConstructor" : false,
449 "desc" : "The button text"
456 "desc" : "Sets this button's text",
459 "memberOf" : "Roo.Button",
461 "isConstructor" : false,
473 "desc" : "The button text",
482 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
485 "memberOf" : "Roo.Button",
487 "isConstructor" : false,
499 "desc" : "(optional) Force a particular state",
508 "desc" : "Hide this button",
509 "sig" : "()\n{\n\n}",
511 "memberOf" : "Roo.Button",
513 "isConstructor" : false,
525 "name" : "purgeListeners",
527 "desc" : "Removes all listeners for this object",
528 "sig" : "()\n{\n\n}",
530 "memberOf" : "Roo.util.Observable",
532 "isConstructor" : false,
546 "desc" : "Appends an event handler to this element (shorthand for addListener)",
547 "sig" : "(eventName, handler, scope, options)",
549 "memberOf" : "Roo.util.Observable",
551 "isConstructor" : false,
561 "name" : "eventName",
563 "desc" : "The type of event to listen for",
569 "desc" : "The method the event invokes",
575 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
581 "desc" : "(optional)",
590 "desc" : "Removes a listener (shorthand for removeListener)",
591 "sig" : "(eventName, handler, scope)",
593 "memberOf" : "Roo.util.Observable",
595 "isConstructor" : false,
605 "name" : "eventName",
607 "desc" : "The type of event to listen for",
613 "desc" : "The handler to remove",
619 "desc" : "(optional) The scope (this object) for the handler",
626 "name" : "addEvents",
628 "desc" : "Used to define events on this Observable",
631 "memberOf" : "Roo.util.Observable",
633 "isConstructor" : false,
645 "desc" : "The object with the events defined",
652 "name" : "releaseCapture",
654 "desc" : "Removes <b>all</b> added captures from the Observable.",
657 "memberOf" : "Roo.util.Observable",
659 "isConstructor" : false,
670 "type" : "Observable",
671 "desc" : "The Observable to release",
678 "name" : "removeListener",
680 "desc" : "Removes a listener",
681 "sig" : "(eventName, handler, scope)",
683 "memberOf" : "Roo.util.Observable",
685 "isConstructor" : false,
695 "name" : "eventName",
697 "desc" : "The type of event to listen for",
703 "desc" : "The handler to remove",
709 "desc" : "(optional) The scope (this object) for the handler",
716 "name" : "fireEvent",
718 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
719 "sig" : "(eventName, args)",
721 "memberOf" : "Roo.util.Observable",
723 "isConstructor" : false,
733 "name" : "eventName",
740 "type" : "Object...",
741 "desc" : "Variable number of parameters are passed to handlers",
749 "desc" : "returns false if any of the handlers return false otherwise it returns true"
754 "name" : "hasListener",
756 "desc" : "Checks to see if this object has any listeners for a specified event",
757 "sig" : "(eventName)",
759 "memberOf" : "Roo.util.Observable",
761 "isConstructor" : false,
771 "name" : "eventName",
773 "desc" : "The name of the event to check for",
781 "desc" : "True if the event is being listened for, else false"
788 "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.",
789 "sig" : "(o, fn, scope)",
791 "memberOf" : "Roo.util.Observable",
793 "isConstructor" : false,
804 "type" : "Observable",
805 "desc" : "The Observable to capture",
811 "desc" : "The function to call",
817 "desc" : "(optional) The scope (this object) for the fn",
824 "name" : "addListener",
826 "desc" : "Appends an event handler to this component",
827 "sig" : "(eventName, handler, scope, options)",
829 "memberOf" : "Roo.util.Observable",
831 "isConstructor" : false,
841 "name" : "eventName",
843 "desc" : "The type of event to listen for",
849 "desc" : "The method the event invokes",
855 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
861 "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>",
870 "name" : "arrowclick",
872 "desc" : "Fires when this button's arrow is clicked",
873 "sig" : "function (_self, e)\n{\n\n}",
882 "type" : "SplitButton",
888 "type" : "EventObject",
889 "desc" : "The click event",
898 "desc" : "Fires when the button is rendered",
899 "sig" : "function (_self)\n{\n\n}",
900 "memberOf" : "Roo.Button",
918 "desc" : "Fires when this button is clicked",
919 "sig" : "function (_self, e)\n{\n\n}",
920 "memberOf" : "Roo.Button",
934 "type" : "EventObject",
935 "desc" : "The click event",
942 "name" : "mouseover",
944 "desc" : "Fires when the mouse hovers over the button",
945 "sig" : "function (_self, e)\n{\n\n}",
946 "memberOf" : "Roo.Button",
961 "desc" : "The event object",
970 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
971 "sig" : "function (_self, pressed)\n{\n\n}",
972 "memberOf" : "Roo.Button",
996 "desc" : "Fires when the mouse exits the button",
997 "sig" : "function (_self, e)\n{\n\n}",
998 "memberOf" : "Roo.Button",
1008 "isOptional" : false
1013 "desc" : "The event object",
1014 "isOptional" : false