2 "name" : "Roo.menu.Menu",
19 "desc" : "A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class\nwhen you want a specialzed menu based off of another component (like {@link Roo.menu.DateMenu} for example).",
20 "isSingleton" : false,
24 "isBuilderTop" : false,
34 "desc" : "Configuration options",
45 "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>",
46 "memberOf" : "Roo.util.Observable",
52 "type" : "Boolean/String",
53 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
59 "name" : "defaultAlign",
61 "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
67 "name" : "subMenuAlign",
69 "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
77 "desc" : "The minimum width of the menu in pixels (defaults to 120)",
83 "name" : "registerMenu",
85 "desc" : "True (default) - means that clicking on screen etc. hides it.",
91 "name" : "allowOtherMenus",
93 "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
101 "name" : "addMenuItem",
103 "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
108 "isConstructor" : false,
120 "desc" : "A MenuItem config object",
127 "type" : "Roo.menu.Item",
128 "desc" : "The menu item that was added"
133 "name" : "addElement",
135 "desc" : "Adds an {@link Roo.Element} object to the menu",
140 "isConstructor" : false,
151 "type" : "String/HTMLElement/Roo.Element",
152 "desc" : "The element or DOM node to add, or its id",
159 "type" : "Roo.menu.Item",
160 "desc" : "The menu item that was added"
165 "name" : "isVisible",
167 "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
168 "sig" : "()\n{\n\n}",
172 "isConstructor" : false,
186 "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>",
191 "isConstructor" : false,
203 "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
210 "type" : "Roo.menu.Item",
211 "desc" : "The menu item that was added, or the last one if multiple items were added"
216 "name" : "addSeparator",
218 "desc" : "Adds a separator bar to the menu",
219 "sig" : "()\n{\n\n}",
223 "isConstructor" : false,
235 "type" : "Roo.menu.Item",
236 "desc" : "The menu item that was added"
241 "name" : "removeAll",
243 "desc" : "Removes and destroys all items in the menu",
244 "sig" : "()\n{\n\n}",
248 "isConstructor" : false,
262 "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
267 "isConstructor" : false,
278 "type" : "Roo.menu.Item",
279 "desc" : "The menu item to remove",
288 "desc" : "Returns this menu's underlying {@link Roo.Element} object",
289 "sig" : "()\n{\n\n}",
293 "isConstructor" : false,
305 "type" : "Roo.Element",
306 "desc" : "The element"
313 "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
314 "sig" : "(index, item)",
318 "isConstructor" : false,
330 "desc" : "The index in the menu's list of current items where the new item should be inserted",
335 "type" : "Roo.menu.Item",
336 "desc" : "The menu item to add",
343 "type" : "Roo.menu.Item",
344 "desc" : "The menu item that was added"
351 "desc" : "Hides this menu and optionally all parent menus",
356 "isConstructor" : false,
368 "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
377 "desc" : "Displays this menu relative to another element",
378 "sig" : "(element, position, parentMenu)",
382 "isConstructor" : false,
393 "type" : "String/HTMLElement/Roo.Element",
394 "desc" : "The element to align to",
400 "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
404 "name" : "parentMenu",
405 "type" : "Roo.menu.Menu",
406 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
415 "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
420 "isConstructor" : false,
432 "desc" : "The text to display in the menu item",
439 "type" : "Roo.menu.Item",
440 "desc" : "The menu item that was added"
447 "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
452 "isConstructor" : false,
463 "type" : "Roo.menu.Item",
464 "desc" : "The menu item to add",
471 "type" : "Roo.menu.Item",
472 "desc" : "The menu item that was added"
479 "desc" : "Displays this menu at a specific xy position",
480 "sig" : "(xyPosition, parentMenu)",
484 "isConstructor" : false,
494 "name" : "xyPosition",
496 "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
500 "name" : "parentMenu",
501 "type" : "Roo.menu.Menu",
502 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
509 "name" : "purgeListeners",
511 "desc" : "Removes all listeners for this object",
512 "sig" : "()\n{\n\n}",
514 "memberOf" : "Roo.util.Observable",
516 "isConstructor" : false,
530 "desc" : "Appends an event handler to this element (shorthand for addListener)",
531 "sig" : "(eventName, handler, scope, options)",
533 "memberOf" : "Roo.util.Observable",
535 "isConstructor" : false,
545 "name" : "eventName",
547 "desc" : "The type of event to listen for",
553 "desc" : "The method the event invokes",
559 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
565 "desc" : "(optional)",
574 "desc" : "Removes a listener (shorthand for removeListener)",
575 "sig" : "(eventName, handler, scope)",
577 "memberOf" : "Roo.util.Observable",
579 "isConstructor" : false,
589 "name" : "eventName",
591 "desc" : "The type of event to listen for",
597 "desc" : "The handler to remove",
603 "desc" : "(optional) The scope (this object) for the handler",
610 "name" : "addEvents",
612 "desc" : "Used to define events on this Observable",
615 "memberOf" : "Roo.util.Observable",
617 "isConstructor" : false,
629 "desc" : "The object with the events defined",
636 "name" : "releaseCapture",
638 "desc" : "Removes <b>all</b> added captures from the Observable.",
641 "memberOf" : "Roo.util.Observable",
643 "isConstructor" : false,
654 "type" : "Observable",
655 "desc" : "The Observable to release",
662 "name" : "removeListener",
664 "desc" : "Removes a listener",
665 "sig" : "(eventName, handler, scope)",
667 "memberOf" : "Roo.util.Observable",
669 "isConstructor" : false,
679 "name" : "eventName",
681 "desc" : "The type of event to listen for",
687 "desc" : "The handler to remove",
693 "desc" : "(optional) The scope (this object) for the handler",
700 "name" : "fireEvent",
702 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
703 "sig" : "(eventName, args)",
705 "memberOf" : "Roo.util.Observable",
707 "isConstructor" : false,
717 "name" : "eventName",
724 "type" : "Object...",
725 "desc" : "Variable number of parameters are passed to handlers",
733 "desc" : "returns false if any of the handlers return false otherwise it returns true"
738 "name" : "hasListener",
740 "desc" : "Checks to see if this object has any listeners for a specified event",
741 "sig" : "(eventName)",
743 "memberOf" : "Roo.util.Observable",
745 "isConstructor" : false,
755 "name" : "eventName",
757 "desc" : "The name of the event to check for",
765 "desc" : "True if the event is being listened for, else false"
772 "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.",
773 "sig" : "(o, fn, scope)",
775 "memberOf" : "Roo.util.Observable",
777 "isConstructor" : false,
788 "type" : "Observable",
789 "desc" : "The Observable to capture",
795 "desc" : "The function to call",
801 "desc" : "(optional) The scope (this object) for the fn",
808 "name" : "addListener",
810 "desc" : "Appends an event handler to this component",
811 "sig" : "(eventName, handler, scope, options)",
813 "memberOf" : "Roo.util.Observable",
815 "isConstructor" : false,
825 "name" : "eventName",
827 "desc" : "The type of event to listen for",
833 "desc" : "The method the event invokes",
839 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
845 "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>",
854 "name" : "mouseover",
856 "desc" : "Fires when the mouse is hovering over this menu",
857 "sig" : "function (_self, e, menuItem)\n{\n\n}",
866 "type" : "Roo.menu.Menu",
872 "type" : "Roo.EventObject",
878 "type" : "Roo.menu.Item",
879 "desc" : "The menu item that was clicked",
888 "desc" : "Fires when the mouse exits this menu",
889 "sig" : "function (_self, e, menuItem)\n{\n\n}",
898 "type" : "Roo.menu.Menu",
904 "type" : "Roo.EventObject",
910 "type" : "Roo.menu.Item",
911 "desc" : "The menu item that was clicked",
918 "name" : "beforehide",
920 "desc" : "Fires before this menu is hidden",
921 "sig" : "function (_self)\n{\n\n}",
930 "type" : "Roo.menu.Menu",
938 "name" : "itemclick",
940 "desc" : "Fires when a menu item contained in this menu is clicked",
941 "sig" : "function (baseItem, e)\n{\n\n}",
950 "type" : "Roo.menu.BaseItem",
951 "desc" : "The BaseItem that was clicked",
956 "type" : "Roo.EventObject",
964 "name" : "beforeshow",
966 "desc" : "Fires before this menu is displayed",
967 "sig" : "function (_self)\n{\n\n}",
976 "type" : "Roo.menu.Menu",
986 "desc" : "Fires after this menu is hidden",
987 "sig" : "function (_self)\n{\n\n}",
996 "type" : "Roo.menu.Menu",
1005 "type" : "function",
1006 "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
1007 "sig" : "function (_self, menuItem, e)\n{\n\n}",
1016 "type" : "Roo.menu.Menu",
1018 "isOptional" : false
1021 "name" : "menuItem",
1022 "type" : "Roo.menu.Item",
1023 "desc" : "The menu item that was clicked",
1024 "isOptional" : false
1028 "type" : "Roo.EventObject",
1030 "isOptional" : false
1037 "type" : "function",
1038 "desc" : "Fires after this menu is displayed",
1039 "sig" : "function (_self)\n{\n\n}",
1048 "type" : "Roo.menu.Menu",
1050 "isOptional" : false