2 "name" : "Roo.Toolbar.SplitButton",
9 "desc" : "A menu button that renders into a toolbar.",
10 "isSingleton" : false,
13 "memberOf" : "SplitButton",
22 "desc" : "A standard {@link Roo.SplitButton} config object",
33 "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>",
34 "memberOf" : "Roo.util.Observable"
38 "type" : "String/Object",
39 "desc" : "The tooltip for the button - can be a string or QuickTips config object",
40 "memberOf" : "Roo.Button"
45 "desc" : "The button text",
46 "memberOf" : "Roo.Button"
50 "type" : "String/HTMLElement/Element",
51 "desc" : "The element to append the button to",
52 "memberOf" : "Roo.Button"
57 "desc" : "True to start hidden (defaults to false)",
58 "memberOf" : "Roo.Button"
61 "name" : "toggleGroup",
63 "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
64 "memberOf" : "Roo.Button"
67 "name" : "handleMouseEvents",
69 "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
70 "memberOf" : "Roo.Button"
74 "type" : "Roo.menu.Menu",
75 "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
76 "memberOf" : "Roo.Button"
79 "name" : "enableToggle",
81 "desc" : "True to enable pressed/not pressed toggling (defaults to false)",
82 "memberOf" : "Roo.Button"
85 "name" : "arrowHandler",
87 "desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
88 "memberOf" : "Roo.SplitButton"
93 "desc" : "A function called when the button is clicked (can be used instead of click event)",
94 "memberOf" : "Roo.Button"
99 "desc" : "The scope of the handler",
100 "memberOf" : "Roo.Button"
105 "desc" : "The minimum width for this button (used to give a set of buttons a common width)",
106 "memberOf" : "Roo.Button"
111 "desc" : "True to start disabled (defaults to false)",
112 "memberOf" : "Roo.Button"
117 "desc" : "True to start pressed (only if enableToggle = true)",
118 "memberOf" : "Roo.Button"
122 "type" : "Roo.Template",
123 "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.",
124 "memberOf" : "Roo.Button"
129 "desc" : "A CSS class to apply to the button's main element.",
130 "memberOf" : "Roo.Button"
135 "desc" : "The DOM tabIndex for this button (defaults to undefined)",
136 "memberOf" : "Roo.Button"
141 "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
142 "memberOf" : "Roo.Button"
145 "name" : "menuAlign",
147 "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
148 "memberOf" : "Roo.Button"
153 "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\")",
154 "memberOf" : "Roo.Button"
157 "name" : "tooltipType",
159 "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
160 "memberOf" : "Roo.Button"
163 "name" : "arrowTooltip",
165 "desc" : "The title attribute of the arrow",
166 "memberOf" : "Roo.SplitButton"
169 "name" : "clickEvent",
171 "desc" : "The type of event to map to the button's event handler (defaults to 'click')",
172 "memberOf" : "Roo.Button"
176 "type" : "Boolean/Object",
177 "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).",
178 "memberOf" : "Roo.Button"
183 "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
184 "memberOf" : "Roo.Button"
191 "desc" : "Removes and destroys this button",
192 "sig" : "()\n{\n\n}",
196 "isConstructor" : false,
210 "desc" : "Hides this button",
211 "sig" : "()\n{\n\n}",
215 "isConstructor" : false,
229 "desc" : "Shows this button",
230 "sig" : "()\n{\n\n}",
234 "isConstructor" : false,
246 "name" : "setArrowHandler",
248 "desc" : "Sets this button's arrow click handler",
249 "sig" : "(handler, scope)",
251 "memberOf" : "Roo.SplitButton",
253 "isConstructor" : false,
265 "desc" : "The function to call when the arrow is clicked",
271 "desc" : "(optional) Scope for the function passed above",
280 "desc" : "Focus the button",
281 "sig" : "()\n{\n\n}",
283 "memberOf" : "Roo.SplitButton",
285 "isConstructor" : false,
297 "name" : "setHandler",
299 "desc" : "Sets this button's click handler",
300 "sig" : "(handler, scope)",
302 "memberOf" : "Roo.SplitButton",
304 "isConstructor" : false,
316 "desc" : "The function to call when the button is clicked",
322 "desc" : "(optional) Scope for the function passed above",
331 "desc" : "Disable this button",
332 "sig" : "()\n{\n\n}",
334 "memberOf" : "Roo.Button",
336 "isConstructor" : false,
350 "desc" : "Enable this button",
351 "sig" : "()\n{\n\n}",
353 "memberOf" : "Roo.Button",
355 "isConstructor" : false,
369 "desc" : "Returns the button's underlying element",
370 "sig" : "()\n{\n\n}",
372 "memberOf" : "Roo.Button",
374 "isConstructor" : false,
386 "type" : "Roo.Element",
387 "desc" : "The element"
392 "name" : "setDisabled",
394 "desc" : "Convenience function for boolean enable/disable",
397 "memberOf" : "Roo.Button",
399 "isConstructor" : false,
411 "desc" : "True to enable, false to disable",
418 "name" : "setVisible",
420 "desc" : "Convenience function for boolean show/hide",
423 "memberOf" : "Roo.Button",
425 "isConstructor" : false,
437 "desc" : "True to show, false to hide",
446 "desc" : "Gets the text for this button",
447 "sig" : "()\n{\n\n}",
449 "memberOf" : "Roo.Button",
451 "isConstructor" : false,
464 "desc" : "The button text"
471 "desc" : "Sets this button's text",
474 "memberOf" : "Roo.Button",
476 "isConstructor" : false,
488 "desc" : "The button text",
497 "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.",
500 "memberOf" : "Roo.Button",
502 "isConstructor" : false,
514 "desc" : "(optional) Force a particular state",
521 "name" : "purgeListeners",
523 "desc" : "Removes all listeners for this object",
524 "sig" : "()\n{\n\n}",
526 "memberOf" : "Roo.util.Observable",
528 "isConstructor" : false,
542 "desc" : "Appends an event handler to this element (shorthand for addListener)",
543 "sig" : "(eventName, handler, scope, options)",
545 "memberOf" : "Roo.util.Observable",
547 "isConstructor" : false,
557 "name" : "eventName",
559 "desc" : "The type of event to listen for",
565 "desc" : "The method the event invokes",
571 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
577 "desc" : "(optional)",
586 "desc" : "Removes a listener (shorthand for removeListener)",
587 "sig" : "(eventName, handler, scope)",
589 "memberOf" : "Roo.util.Observable",
591 "isConstructor" : false,
601 "name" : "eventName",
603 "desc" : "The type of event to listen for",
609 "desc" : "The handler to remove",
615 "desc" : "(optional) The scope (this object) for the handler",
622 "name" : "addEvents",
624 "desc" : "Used to define events on this Observable",
627 "memberOf" : "Roo.util.Observable",
629 "isConstructor" : false,
641 "desc" : "The object with the events defined",
648 "name" : "releaseCapture",
650 "desc" : "Removes <b>all</b> added captures from the Observable.",
653 "memberOf" : "Roo.util.Observable",
655 "isConstructor" : false,
666 "type" : "Observable",
667 "desc" : "The Observable to release",
674 "name" : "removeListener",
676 "desc" : "Removes a listener",
677 "sig" : "(eventName, handler, scope)",
679 "memberOf" : "Roo.util.Observable",
681 "isConstructor" : false,
691 "name" : "eventName",
693 "desc" : "The type of event to listen for",
699 "desc" : "The handler to remove",
705 "desc" : "(optional) The scope (this object) for the handler",
712 "name" : "fireEvent",
714 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
715 "sig" : "(eventName, args)",
717 "memberOf" : "Roo.util.Observable",
719 "isConstructor" : false,
729 "name" : "eventName",
736 "type" : "Object...",
737 "desc" : "Variable number of parameters are passed to handlers",
745 "desc" : "returns false if any of the handlers return false otherwise it returns true"
750 "name" : "hasListener",
752 "desc" : "Checks to see if this object has any listeners for a specified event",
753 "sig" : "(eventName)",
755 "memberOf" : "Roo.util.Observable",
757 "isConstructor" : false,
767 "name" : "eventName",
769 "desc" : "The name of the event to check for",
777 "desc" : "True if the event is being listened for, else false"
784 "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.",
785 "sig" : "(o, fn, scope)",
787 "memberOf" : "Roo.util.Observable",
789 "isConstructor" : false,
800 "type" : "Observable",
801 "desc" : "The Observable to capture",
807 "desc" : "The function to call",
813 "desc" : "(optional) The scope (this object) for the fn",
820 "name" : "addListener",
822 "desc" : "Appends an event handler to this component",
823 "sig" : "(eventName, handler, scope, options)",
825 "memberOf" : "Roo.util.Observable",
827 "isConstructor" : false,
837 "name" : "eventName",
839 "desc" : "The type of event to listen for",
845 "desc" : "The method the event invokes",
851 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
857 "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>",
866 "name" : "arrowclick",
868 "desc" : "Fires when this button's arrow is clicked",
869 "sig" : "function (_self, e)\n{\n\n}",
870 "memberOf" : "Roo.SplitButton",
878 "type" : "SplitButton",
884 "type" : "EventObject",
885 "desc" : "The click event",
894 "desc" : "Fires when the button is rendered",
895 "sig" : "function (_self)\n{\n\n}",
896 "memberOf" : "Roo.Button",
914 "desc" : "Fires when this button is clicked",
915 "sig" : "function (_self, e)\n{\n\n}",
916 "memberOf" : "Roo.Button",
930 "type" : "EventObject",
931 "desc" : "The click event",
938 "name" : "mouseover",
940 "desc" : "Fires when the mouse hovers over the button",
941 "sig" : "function (_self, e)\n{\n\n}",
942 "memberOf" : "Roo.Button",
957 "desc" : "The event object",
966 "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)",
967 "sig" : "function (_self, pressed)\n{\n\n}",
968 "memberOf" : "Roo.Button",
992 "desc" : "Fires when the mouse exits the button",
993 "sig" : "function (_self, e)\n{\n\n}",
994 "memberOf" : "Roo.Button",
1004 "isOptional" : false
1009 "desc" : "The event object",
1010 "isOptional" : false