2 "name" : "Roo.menu.ColorMenu",
7 "desc" : "A menu containing a {@link Roo.menu.ColorItem} component (which provides a basic color picker).",
11 "memberOf" : "ColorMenu",
20 "desc" : "Configuration options",
29 "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>",
30 "memberOf" : "Roo.util.Observable",
35 "type" : "Boolean/String",
36 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
37 "memberOf" : "Roo.menu.Menu",
41 "name" : "subMenuAlign",
43 "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
44 "memberOf" : "Roo.menu.Menu",
48 "name" : "defaultAlign",
50 "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
51 "memberOf" : "Roo.menu.Menu",
57 "desc" : "The minimum width of the menu in pixels (defaults to 120)",
58 "memberOf" : "Roo.menu.Menu",
62 "name" : "registerMenu",
64 "desc" : "True (default) - means that clicking on screen etc. hides it.",
65 "memberOf" : "Roo.menu.Menu",
69 "name" : "allowOtherMenus",
71 "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
72 "memberOf" : "Roo.menu.Menu",
78 "name" : "addMenuItem",
79 "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
81 "isConstructor" : false,
83 "memberOf" : "Roo.menu.Menu",
92 "desc" : "A MenuItem config object",
99 "type" : "Roo.menu.Item",
100 "desc" : "The menu item that was added"
105 "name" : "addElement",
106 "desc" : "Adds an {@link Roo.Element} object to the menu",
108 "isConstructor" : false,
110 "memberOf" : "Roo.menu.Menu",
118 "type" : "String/HTMLElement/Roo.Element",
119 "desc" : "The element or DOM node to add, or its id",
126 "type" : "Roo.menu.Item",
127 "desc" : "The menu item that was added"
132 "name" : "isVisible",
133 "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
135 "isConstructor" : false,
137 "memberOf" : "Roo.menu.Menu",
147 "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n menuItem, // add existing item by ref\n 'Dynamic Item', // new TextItem\n '-', // new separator\n { text: 'Config Item' } // new item by config\n);\n</code></pre>",
149 "isConstructor" : false,
151 "memberOf" : "Roo.menu.Menu",
160 "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
167 "type" : "Roo.menu.Item",
168 "desc" : "The menu item that was added, or the last one if multiple items were added"
173 "name" : "addSeparator",
174 "desc" : "Adds a separator bar to the menu",
176 "isConstructor" : false,
178 "memberOf" : "Roo.menu.Menu",
187 "type" : "Roo.menu.Item",
188 "desc" : "The menu item that was added"
193 "name" : "removeAll",
194 "desc" : "Removes and destroys all items in the menu",
196 "isConstructor" : false,
198 "memberOf" : "Roo.menu.Menu",
208 "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
210 "isConstructor" : false,
212 "memberOf" : "Roo.menu.Menu",
220 "type" : "Roo.menu.Item",
221 "desc" : "The menu item to remove",
229 "desc" : "Returns this menu's underlying {@link Roo.Element} object",
231 "isConstructor" : false,
233 "memberOf" : "Roo.menu.Menu",
242 "type" : "Roo.Element",
243 "desc" : "The element"
249 "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
251 "isConstructor" : false,
253 "memberOf" : "Roo.menu.Menu",
262 "desc" : "The index in the menu's list of current items where the new item should be inserted",
267 "type" : "Roo.menu.Item",
268 "desc" : "The menu item to add",
275 "type" : "Roo.menu.Item",
276 "desc" : "The menu item that was added"
282 "desc" : "Hides this menu and optionally all parent menus",
284 "isConstructor" : false,
286 "memberOf" : "Roo.menu.Menu",
295 "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
303 "desc" : "Displays this menu relative to another element",
305 "isConstructor" : false,
307 "memberOf" : "Roo.menu.Menu",
315 "type" : "String/HTMLElement/Roo.Element",
316 "desc" : "The element to align to",
322 "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
326 "name" : "parentMenu",
327 "type" : "Roo.menu.Menu",
328 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
336 "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
338 "isConstructor" : false,
340 "memberOf" : "Roo.menu.Menu",
349 "desc" : "The text to display in the menu item",
356 "type" : "Roo.menu.Item",
357 "desc" : "The menu item that was added"
363 "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
365 "isConstructor" : false,
367 "memberOf" : "Roo.menu.Menu",
375 "type" : "Roo.menu.Item",
376 "desc" : "The menu item to add",
383 "type" : "Roo.menu.Item",
384 "desc" : "The menu item that was added"
390 "desc" : "Displays this menu at a specific xy position",
392 "isConstructor" : false,
394 "memberOf" : "Roo.menu.Menu",
401 "name" : "xyPosition",
403 "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
407 "name" : "parentMenu",
408 "type" : "Roo.menu.Menu",
409 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
416 "name" : "purgeListeners",
417 "desc" : "Removes all listeners for this object",
419 "isConstructor" : false,
421 "memberOf" : "Roo.util.Observable",
431 "desc" : "Appends an event handler to this element (shorthand for addListener)",
433 "isConstructor" : false,
435 "memberOf" : "Roo.util.Observable",
442 "name" : "eventName",
444 "desc" : "The type of event to listen for",
450 "desc" : "The method the event invokes",
456 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
462 "desc" : "(optional)",
470 "desc" : "Removes a listener (shorthand for removeListener)",
472 "isConstructor" : false,
474 "memberOf" : "Roo.util.Observable",
481 "name" : "eventName",
483 "desc" : "The type of event to listen for",
489 "desc" : "The handler to remove",
495 "desc" : "(optional) The scope (this object) for the handler",
502 "name" : "addEvents",
503 "desc" : "Used to define events on this Observable",
505 "isConstructor" : false,
507 "memberOf" : "Roo.util.Observable",
516 "desc" : "The object with the events defined",
523 "name" : "releaseCapture",
524 "desc" : "Removes <b>all</b> added captures from the Observable.",
526 "isConstructor" : false,
528 "memberOf" : "Roo.util.Observable",
536 "type" : "Observable",
537 "desc" : "The Observable to release",
544 "name" : "removeListener",
545 "desc" : "Removes a listener",
547 "isConstructor" : false,
549 "memberOf" : "Roo.util.Observable",
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" : "fireEvent",
578 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
580 "isConstructor" : false,
582 "memberOf" : "Roo.util.Observable",
589 "name" : "eventName",
596 "type" : "Object...",
597 "desc" : "Variable number of parameters are passed to handlers",
605 "desc" : "returns false if any of the handlers return false otherwise it returns true"
610 "name" : "hasListener",
611 "desc" : "Checks to see if this object has any listeners for a specified event",
613 "isConstructor" : false,
615 "memberOf" : "Roo.util.Observable",
622 "name" : "eventName",
624 "desc" : "The name of the event to check for",
632 "desc" : "True if the event is being listened for, else false"
638 "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.",
640 "isConstructor" : false,
642 "memberOf" : "Roo.util.Observable",
650 "type" : "Observable",
651 "desc" : "The Observable to capture",
657 "desc" : "The function to call",
663 "desc" : "(optional) The scope (this object) for the fn",
670 "name" : "addListener",
671 "desc" : "Appends an event handler to this component",
673 "isConstructor" : false,
675 "memberOf" : "Roo.util.Observable",
682 "name" : "eventName",
684 "desc" : "The type of event to listen for",
690 "desc" : "The method the event invokes",
696 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
702 "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>",
713 "memberOf" : "Roo.menu.ColorMenu",
721 "type" : "ColorPalette",
735 "name" : "mouseover",
736 "desc" : "Fires when the mouse is hovering over this menu",
737 "memberOf" : "Roo.menu.Menu",
745 "type" : "Roo.menu.Menu",
751 "type" : "Roo.EventObject",
757 "type" : "Roo.menu.Item",
758 "desc" : "The menu item that was clicked",
766 "desc" : "Fires when the mouse exits this menu",
767 "memberOf" : "Roo.menu.Menu",
775 "type" : "Roo.menu.Menu",
781 "type" : "Roo.EventObject",
787 "type" : "Roo.menu.Item",
788 "desc" : "The menu item that was clicked",
795 "name" : "beforehide",
796 "desc" : "Fires before this menu is hidden",
797 "memberOf" : "Roo.menu.Menu",
805 "type" : "Roo.menu.Menu",
813 "name" : "itemclick",
814 "desc" : "Fires when a menu item contained in this menu is clicked",
815 "memberOf" : "Roo.menu.Menu",
823 "type" : "Roo.menu.BaseItem",
824 "desc" : "The BaseItem that was clicked",
829 "type" : "Roo.EventObject",
837 "name" : "beforeshow",
838 "desc" : "Fires before this menu is displayed",
839 "memberOf" : "Roo.menu.Menu",
847 "type" : "Roo.menu.Menu",
856 "desc" : "Fires after this menu is hidden",
857 "memberOf" : "Roo.menu.Menu",
865 "type" : "Roo.menu.Menu",
874 "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
875 "memberOf" : "Roo.menu.Menu",
883 "type" : "Roo.menu.Menu",
889 "type" : "Roo.menu.Item",
890 "desc" : "The menu item that was clicked",
895 "type" : "Roo.EventObject",
904 "desc" : "Fires after this menu is displayed",
905 "memberOf" : "Roo.menu.Menu",
913 "type" : "Roo.menu.Menu",