2 "name" : "Roo.SplitButton",
8 "Roo.Toolbar.SplitButton"
10 "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 "isSingleton" : false,
14 "memberOf" : "SplitButton",
22 "type" : "String/HTMLElement/Element",
23 "desc" : "The element to append the button to",
29 "desc" : "The config object",
40 "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>",
41 "memberOf" : "Roo.util.Observable"
45 "type" : "String/Object",
46 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
47 "memberOf" : "Roo.Button"
52 "desc" : "The button text",
53 "memberOf" : "Roo.Button"
57 "type" : "String/HTMLElement/Element",
58 "desc" : "The element to append the button to",
59 "memberOf" : "Roo.Button"
64 "desc" : "True to start hidden (defaults to false)",
65 "memberOf" : "Roo.Button"
68 "name" : "toggleGroup",
70 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
71 "memberOf" : "Roo.Button"
74 "name" : "handleMouseEvents",
76 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
77 "memberOf" : "Roo.Button"
81 "type" : "Roo.menu.Menu",
82 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
83 "memberOf" : "Roo.Button"
86 "name" : "enableToggle",
88 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
89 "memberOf" : "Roo.Button"
92 "name" : "arrowHandler",
94 "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
100 "desc" : "A function called when the button is clicked (can be used instead of click event)",
101 "memberOf" : "Roo.Button"
106 "desc" : "The scope of the handler",
107 "memberOf" : "Roo.Button"
112 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
113 "memberOf" : "Roo.Button"
118 "desc" : "True to start disabled (defaults to false)",
119 "memberOf" : "Roo.Button"
124 "desc" : "True to start pressed (only if enableToggle = true)",
125 "memberOf" : "Roo.Button"
129 "type" : "Roo.Template",
130 "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.",
131 "memberOf" : "Roo.Button"
136 "desc" : "A CSS class to apply to the button's main element.",
137 "memberOf" : "Roo.Button"
142 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
143 "memberOf" : "Roo.Button"
148 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
149 "memberOf" : "Roo.Button"
152 "name" : "menuAlign",
154 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
155 "memberOf" : "Roo.Button"
160 "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\")",
161 "memberOf" : "Roo.Button"
164 "name" : "tooltipType",
166 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
167 "memberOf" : "Roo.Button"
170 "name" : "arrowTooltip",
172 "desc" : "The title attribute of the arrow",
176 "name" : "clickEvent",
178 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
179 "memberOf" : "Roo.Button"
183 "type" : "Boolean/Object",
184 "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).",
185 "memberOf" : "Roo.Button"
190 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
191 "memberOf" : "Roo.Button"
196 "name" : "setArrowHandler",
198 "desc" : "Sets this button's arrow click handler",
199 "sig" : "(handler, scope)",
203 "isConstructor" : false,
215 "desc" : "The function to call when the arrow is clicked",
221 "desc" : "(optional) Scope for the function passed above",
230 "desc" : "Focus the button",
231 "sig" : "()\n{\n\n}",
235 "isConstructor" : false,
247 "name" : "setHandler",
249 "desc" : "Sets this button's click handler",
250 "sig" : "(handler, scope)",
254 "isConstructor" : false,
266 "desc" : "The function to call when the button is clicked",
272 "desc" : "(optional) Scope for the function passed above",
281 "desc" : "Show this button",
282 "sig" : "()\n{\n\n}",
284 "memberOf" : "Roo.Button",
286 "isConstructor" : false,
300 "desc" : "Disable this button",
301 "sig" : "()\n{\n\n}",
303 "memberOf" : "Roo.Button",
305 "isConstructor" : false,
319 "desc" : "Enable this button",
320 "sig" : "()\n{\n\n}",
322 "memberOf" : "Roo.Button",
324 "isConstructor" : false,
338 "desc" : "Returns the button's underlying element",
339 "sig" : "()\n{\n\n}",
341 "memberOf" : "Roo.Button",
343 "isConstructor" : false,
355 "type" : "Roo.Element",
356 "desc" : "The element"
361 "name" : "setDisabled",
363 "desc" : "Convenience function for boolean enable/disable",
366 "memberOf" : "Roo.Button",
368 "isConstructor" : false,
380 "desc" : "True to enable, false to disable",
387 "name" : "setVisible",
389 "desc" : "Convenience function for boolean show/hide",
392 "memberOf" : "Roo.Button",
394 "isConstructor" : false,
406 "desc" : "True to show, false to hide",
415 "desc" : "Destroys this Button and removes any listeners.",
416 "sig" : "()\n{\n\n}",
418 "memberOf" : "Roo.Button",
420 "isConstructor" : false,
434 "desc" : "Gets the text for this button",
435 "sig" : "()\n{\n\n}",
437 "memberOf" : "Roo.Button",
439 "isConstructor" : false,
452 "desc" : "The button text"
459 "desc" : "Sets this button's text",
462 "memberOf" : "Roo.Button",
464 "isConstructor" : false,
476 "desc" : "The button text",
485 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
488 "memberOf" : "Roo.Button",
490 "isConstructor" : false,
502 "desc" : "(optional) Force a particular state",
511 "desc" : "Hide this button",
512 "sig" : "()\n{\n\n}",
514 "memberOf" : "Roo.Button",
516 "isConstructor" : false,
528 "name" : "purgeListeners",
530 "desc" : "Removes all listeners for this object",
531 "sig" : "()\n{\n\n}",
533 "memberOf" : "Roo.util.Observable",
535 "isConstructor" : false,
549 "desc" : "Appends an event handler to this element (shorthand for addListener)",
550 "sig" : "(eventName, handler, scope, options)",
552 "memberOf" : "Roo.util.Observable",
554 "isConstructor" : false,
564 "name" : "eventName",
566 "desc" : "The type of event to listen for",
572 "desc" : "The method the event invokes",
578 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
584 "desc" : "(optional)",
593 "desc" : "Removes a listener (shorthand for removeListener)",
594 "sig" : "(eventName, handler, scope)",
596 "memberOf" : "Roo.util.Observable",
598 "isConstructor" : false,
608 "name" : "eventName",
610 "desc" : "The type of event to listen for",
616 "desc" : "The handler to remove",
622 "desc" : "(optional) The scope (this object) for the handler",
629 "name" : "addEvents",
631 "desc" : "Used to define events on this Observable",
634 "memberOf" : "Roo.util.Observable",
636 "isConstructor" : false,
648 "desc" : "The object with the events defined",
655 "name" : "releaseCapture",
657 "desc" : "Removes <b>all</b> added captures from the Observable.",
660 "memberOf" : "Roo.util.Observable",
662 "isConstructor" : false,
673 "type" : "Observable",
674 "desc" : "The Observable to release",
681 "name" : "removeListener",
683 "desc" : "Removes a listener",
684 "sig" : "(eventName, handler, scope)",
686 "memberOf" : "Roo.util.Observable",
688 "isConstructor" : false,
698 "name" : "eventName",
700 "desc" : "The type of event to listen for",
706 "desc" : "The handler to remove",
712 "desc" : "(optional) The scope (this object) for the handler",
719 "name" : "fireEvent",
721 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
722 "sig" : "(eventName, args)",
724 "memberOf" : "Roo.util.Observable",
726 "isConstructor" : false,
736 "name" : "eventName",
743 "type" : "Object...",
744 "desc" : "Variable number of parameters are passed to handlers",
752 "desc" : "returns false if any of the handlers return false otherwise it returns true"
757 "name" : "hasListener",
759 "desc" : "Checks to see if this object has any listeners for a specified event",
760 "sig" : "(eventName)",
762 "memberOf" : "Roo.util.Observable",
764 "isConstructor" : false,
774 "name" : "eventName",
776 "desc" : "The name of the event to check for",
784 "desc" : "True if the event is being listened for, else false"
791 "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.",
792 "sig" : "(o, fn, scope)",
794 "memberOf" : "Roo.util.Observable",
796 "isConstructor" : false,
807 "type" : "Observable",
808 "desc" : "The Observable to capture",
814 "desc" : "The function to call",
820 "desc" : "(optional) The scope (this object) for the fn",
827 "name" : "addListener",
829 "desc" : "Appends an event handler to this component",
830 "sig" : "(eventName, handler, scope, options)",
832 "memberOf" : "Roo.util.Observable",
834 "isConstructor" : false,
844 "name" : "eventName",
846 "desc" : "The type of event to listen for",
852 "desc" : "The method the event invokes",
858 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
864 "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>",
873 "name" : "arrowclick",
875 "desc" : "Fires when this button's arrow is clicked",
876 "sig" : "function (_self, e)\n{\n\n}",
885 "type" : "SplitButton",
891 "type" : "EventObject",
892 "desc" : "The click event",
901 "desc" : "Fires when the button is rendered",
902 "sig" : "function (_self)\n{\n\n}",
903 "memberOf" : "Roo.Button",
921 "desc" : "Fires when this button is clicked",
922 "sig" : "function (_self, e)\n{\n\n}",
923 "memberOf" : "Roo.Button",
937 "type" : "EventObject",
938 "desc" : "The click event",
945 "name" : "mouseover",
947 "desc" : "Fires when the mouse hovers over the button",
948 "sig" : "function (_self, e)\n{\n\n}",
949 "memberOf" : "Roo.Button",
964 "desc" : "The event object",
973 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
974 "sig" : "function (_self, pressed)\n{\n\n}",
975 "memberOf" : "Roo.Button",
999 "desc" : "Fires when the mouse exits the button",
1000 "sig" : "function (_self, e)\n{\n\n}",
1001 "memberOf" : "Roo.Button",
1011 "isOptional" : false
1016 "desc" : "The event object",
1017 "isOptional" : false