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",
31 "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>",
32 "memberOf" : "Roo.util.Observable"
36 "type" : "Boolean/String",
37 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
38 "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"
47 "name" : "defaultAlign",
49 "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
50 "memberOf" : "Roo.menu.Menu"
55 "desc" : "The minimum width of the menu in pixels (defaults to 120)",
56 "memberOf" : "Roo.menu.Menu"
59 "name" : "registerMenu",
61 "desc" : "True (default) - means that clicking on screen etc. hides it.",
62 "memberOf" : "Roo.menu.Menu"
65 "name" : "allowOtherMenus",
67 "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
68 "memberOf" : "Roo.menu.Menu"
73 "name" : "addMenuItem",
75 "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
78 "memberOf" : "Roo.menu.Menu",
80 "isConstructor" : false,
92 "desc" : "A MenuItem config object",
99 "type" : "Roo.menu.Item",
100 "desc" : "The menu item that was added"
105 "name" : "addElement",
107 "desc" : "Adds an {@link Roo.Element} object to the menu",
110 "memberOf" : "Roo.menu.Menu",
112 "isConstructor" : false,
123 "type" : "String/HTMLElement/Roo.Element",
124 "desc" : "The element or DOM node to add, or its id",
131 "type" : "Roo.menu.Item",
132 "desc" : "The menu item that was added"
137 "name" : "isVisible",
139 "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
140 "sig" : "()\n{\n\n}",
142 "memberOf" : "Roo.menu.Menu",
144 "isConstructor" : false,
158 "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>",
161 "memberOf" : "Roo.menu.Menu",
163 "isConstructor" : false,
175 "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
182 "type" : "Roo.menu.Item",
183 "desc" : "The menu item that was added, or the last one if multiple items were added"
188 "name" : "addSeparator",
190 "desc" : "Adds a separator bar to the menu",
191 "sig" : "()\n{\n\n}",
193 "memberOf" : "Roo.menu.Menu",
195 "isConstructor" : false,
207 "type" : "Roo.menu.Item",
208 "desc" : "The menu item that was added"
213 "name" : "removeAll",
215 "desc" : "Removes and destroys all items in the menu",
216 "sig" : "()\n{\n\n}",
218 "memberOf" : "Roo.menu.Menu",
220 "isConstructor" : false,
234 "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
237 "memberOf" : "Roo.menu.Menu",
239 "isConstructor" : false,
250 "type" : "Roo.menu.Item",
251 "desc" : "The menu item to remove",
260 "desc" : "Returns this menu's underlying {@link Roo.Element} object",
261 "sig" : "()\n{\n\n}",
263 "memberOf" : "Roo.menu.Menu",
265 "isConstructor" : false,
277 "type" : "Roo.Element",
278 "desc" : "The element"
285 "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
286 "sig" : "(index, item)",
288 "memberOf" : "Roo.menu.Menu",
290 "isConstructor" : false,
302 "desc" : "The index in the menu's list of current items where the new item should be inserted",
307 "type" : "Roo.menu.Item",
308 "desc" : "The menu item to add",
315 "type" : "Roo.menu.Item",
316 "desc" : "The menu item that was added"
323 "desc" : "Hides this menu and optionally all parent menus",
326 "memberOf" : "Roo.menu.Menu",
328 "isConstructor" : false,
340 "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
349 "desc" : "Displays this menu relative to another element",
350 "sig" : "(element, position, parentMenu)",
352 "memberOf" : "Roo.menu.Menu",
354 "isConstructor" : false,
365 "type" : "String/HTMLElement/Roo.Element",
366 "desc" : "The element to align to",
372 "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
376 "name" : "parentMenu",
377 "type" : "Roo.menu.Menu",
378 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
387 "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
390 "memberOf" : "Roo.menu.Menu",
392 "isConstructor" : false,
404 "desc" : "The text to display in the menu item",
411 "type" : "Roo.menu.Item",
412 "desc" : "The menu item that was added"
419 "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
422 "memberOf" : "Roo.menu.Menu",
424 "isConstructor" : false,
435 "type" : "Roo.menu.Item",
436 "desc" : "The menu item to add",
443 "type" : "Roo.menu.Item",
444 "desc" : "The menu item that was added"
451 "desc" : "Displays this menu at a specific xy position",
452 "sig" : "(xyPosition, parentMenu)",
454 "memberOf" : "Roo.menu.Menu",
456 "isConstructor" : false,
466 "name" : "xyPosition",
468 "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
472 "name" : "parentMenu",
473 "type" : "Roo.menu.Menu",
474 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
481 "name" : "purgeListeners",
483 "desc" : "Removes all listeners for this object",
484 "sig" : "()\n{\n\n}",
486 "memberOf" : "Roo.util.Observable",
488 "isConstructor" : false,
502 "desc" : "Appends an event handler to this element (shorthand for addListener)",
503 "sig" : "(eventName, handler, scope, options)",
505 "memberOf" : "Roo.util.Observable",
507 "isConstructor" : false,
517 "name" : "eventName",
519 "desc" : "The type of event to listen for",
525 "desc" : "The method the event invokes",
531 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
537 "desc" : "(optional)",
546 "desc" : "Removes a listener (shorthand for removeListener)",
547 "sig" : "(eventName, handler, scope)",
549 "memberOf" : "Roo.util.Observable",
551 "isConstructor" : false,
561 "name" : "eventName",
563 "desc" : "The type of event to listen for",
569 "desc" : "The handler to remove",
575 "desc" : "(optional) The scope (this object) for the handler",
582 "name" : "addEvents",
584 "desc" : "Used to define events on this Observable",
587 "memberOf" : "Roo.util.Observable",
589 "isConstructor" : false,
601 "desc" : "The object with the events defined",
608 "name" : "releaseCapture",
610 "desc" : "Removes <b>all</b> added captures from the Observable.",
613 "memberOf" : "Roo.util.Observable",
615 "isConstructor" : false,
626 "type" : "Observable",
627 "desc" : "The Observable to release",
634 "name" : "removeListener",
636 "desc" : "Removes a listener",
637 "sig" : "(eventName, handler, scope)",
639 "memberOf" : "Roo.util.Observable",
641 "isConstructor" : false,
651 "name" : "eventName",
653 "desc" : "The type of event to listen for",
659 "desc" : "The handler to remove",
665 "desc" : "(optional) The scope (this object) for the handler",
672 "name" : "fireEvent",
674 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
675 "sig" : "(eventName, args)",
677 "memberOf" : "Roo.util.Observable",
679 "isConstructor" : false,
689 "name" : "eventName",
696 "type" : "Object...",
697 "desc" : "Variable number of parameters are passed to handlers",
705 "desc" : "returns false if any of the handlers return false otherwise it returns true"
710 "name" : "hasListener",
712 "desc" : "Checks to see if this object has any listeners for a specified event",
713 "sig" : "(eventName)",
715 "memberOf" : "Roo.util.Observable",
717 "isConstructor" : false,
727 "name" : "eventName",
729 "desc" : "The name of the event to check for",
737 "desc" : "True if the event is being listened for, else false"
744 "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.",
745 "sig" : "(o, fn, scope)",
747 "memberOf" : "Roo.util.Observable",
749 "isConstructor" : false,
760 "type" : "Observable",
761 "desc" : "The Observable to capture",
767 "desc" : "The function to call",
773 "desc" : "(optional) The scope (this object) for the fn",
780 "name" : "addListener",
782 "desc" : "Appends an event handler to this component",
783 "sig" : "(eventName, handler, scope, options)",
785 "memberOf" : "Roo.util.Observable",
787 "isConstructor" : false,
797 "name" : "eventName",
799 "desc" : "The type of event to listen for",
805 "desc" : "The method the event invokes",
811 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
817 "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>",
829 "sig" : "function (palette, color)\n{\n\n}",
838 "type" : "ColorPalette",
852 "name" : "mouseover",
854 "desc" : "Fires when the mouse is hovering over this menu",
855 "sig" : "function (_self, e, menuItem)\n{\n\n}",
856 "memberOf" : "Roo.menu.Menu",
864 "type" : "Roo.menu.Menu",
870 "type" : "Roo.EventObject",
876 "type" : "Roo.menu.Item",
877 "desc" : "The menu item that was clicked",
886 "desc" : "Fires when the mouse exits this menu",
887 "sig" : "function (_self, e, menuItem)\n{\n\n}",
888 "memberOf" : "Roo.menu.Menu",
896 "type" : "Roo.menu.Menu",
902 "type" : "Roo.EventObject",
908 "type" : "Roo.menu.Item",
909 "desc" : "The menu item that was clicked",
916 "name" : "beforehide",
918 "desc" : "Fires before this menu is hidden",
919 "sig" : "function (_self)\n{\n\n}",
920 "memberOf" : "Roo.menu.Menu",
928 "type" : "Roo.menu.Menu",
936 "name" : "itemclick",
938 "desc" : "Fires when a menu item contained in this menu is clicked",
939 "sig" : "function (baseItem, e)\n{\n\n}",
940 "memberOf" : "Roo.menu.Menu",
948 "type" : "Roo.menu.BaseItem",
949 "desc" : "The BaseItem that was clicked",
954 "type" : "Roo.EventObject",
962 "name" : "beforeshow",
964 "desc" : "Fires before this menu is displayed",
965 "sig" : "function (_self)\n{\n\n}",
966 "memberOf" : "Roo.menu.Menu",
974 "type" : "Roo.menu.Menu",
984 "desc" : "Fires after this menu is hidden",
985 "sig" : "function (_self)\n{\n\n}",
986 "memberOf" : "Roo.menu.Menu",
994 "type" : "Roo.menu.Menu",
1003 "type" : "function",
1004 "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
1005 "sig" : "function (_self, menuItem, e)\n{\n\n}",
1006 "memberOf" : "Roo.menu.Menu",
1014 "type" : "Roo.menu.Menu",
1016 "isOptional" : false
1019 "name" : "menuItem",
1020 "type" : "Roo.menu.Item",
1021 "desc" : "The menu item that was clicked",
1022 "isOptional" : false
1026 "type" : "Roo.EventObject",
1028 "isOptional" : false
1035 "type" : "function",
1036 "desc" : "Fires after this menu is displayed",
1037 "sig" : "function (_self)\n{\n\n}",
1038 "memberOf" : "Roo.menu.Menu",
1046 "type" : "Roo.menu.Menu",
1048 "isOptional" : false