2 "name" : "Roo.menu.Menu",
10 "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).",
11 "isSingleton" : false,
23 "desc" : "Configuration options",
34 "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>",
35 "memberOf" : "Roo.util.Observable"
39 "type" : "Boolean/String",
40 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
44 "name" : "defaultAlign",
46 "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
50 "name" : "subMenuAlign",
52 "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
58 "desc" : "The minimum width of the menu in pixels (defaults to 120)",
62 "name" : "registerMenu",
64 "desc" : "True (default) - means that clicking on screen etc. hides it.",
68 "name" : "allowOtherMenus",
70 "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
76 "name" : "addMenuItem",
78 "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
83 "isConstructor" : false,
95 "desc" : "A MenuItem config object",
102 "type" : "Roo.menu.Item",
103 "desc" : "The menu item that was added"
108 "name" : "addElement",
110 "desc" : "Adds an {@link Roo.Element} object to the menu",
115 "isConstructor" : false,
126 "type" : "String/HTMLElement/Roo.Element",
127 "desc" : "The element or DOM node to add, or its id",
134 "type" : "Roo.menu.Item",
135 "desc" : "The menu item that was added"
140 "name" : "isVisible",
142 "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
143 "sig" : "()\n{\n\n}",
147 "isConstructor" : false,
161 "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>",
166 "isConstructor" : false,
178 "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
185 "type" : "Roo.menu.Item",
186 "desc" : "The menu item that was added, or the last one if multiple items were added"
191 "name" : "addSeparator",
193 "desc" : "Adds a separator bar to the menu",
194 "sig" : "()\n{\n\n}",
198 "isConstructor" : false,
210 "type" : "Roo.menu.Item",
211 "desc" : "The menu item that was added"
216 "name" : "removeAll",
218 "desc" : "Removes and destroys all items in the menu",
219 "sig" : "()\n{\n\n}",
223 "isConstructor" : false,
237 "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
242 "isConstructor" : false,
253 "type" : "Roo.menu.Item",
254 "desc" : "The menu item to remove",
263 "desc" : "Returns this menu's underlying {@link Roo.Element} object",
264 "sig" : "()\n{\n\n}",
268 "isConstructor" : false,
280 "type" : "Roo.Element",
281 "desc" : "The element"
288 "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
289 "sig" : "(index, item)",
293 "isConstructor" : false,
305 "desc" : "The index in the menu's list of current items where the new item should be inserted",
310 "type" : "Roo.menu.Item",
311 "desc" : "The menu item to add",
318 "type" : "Roo.menu.Item",
319 "desc" : "The menu item that was added"
326 "desc" : "Hides this menu and optionally all parent menus",
331 "isConstructor" : false,
343 "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
352 "desc" : "Displays this menu relative to another element",
353 "sig" : "(element, position, parentMenu)",
357 "isConstructor" : false,
368 "type" : "String/HTMLElement/Roo.Element",
369 "desc" : "The element to align to",
375 "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
379 "name" : "parentMenu",
380 "type" : "Roo.menu.Menu",
381 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
390 "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
395 "isConstructor" : false,
407 "desc" : "The text to display in the menu item",
414 "type" : "Roo.menu.Item",
415 "desc" : "The menu item that was added"
422 "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
427 "isConstructor" : false,
438 "type" : "Roo.menu.Item",
439 "desc" : "The menu item to add",
446 "type" : "Roo.menu.Item",
447 "desc" : "The menu item that was added"
454 "desc" : "Displays this menu at a specific xy position",
455 "sig" : "(xyPosition, parentMenu)",
459 "isConstructor" : false,
469 "name" : "xyPosition",
471 "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
475 "name" : "parentMenu",
476 "type" : "Roo.menu.Menu",
477 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
484 "name" : "purgeListeners",
486 "desc" : "Removes all listeners for this object",
487 "sig" : "()\n{\n\n}",
489 "memberOf" : "Roo.util.Observable",
491 "isConstructor" : false,
505 "desc" : "Appends an event handler to this element (shorthand for addListener)",
506 "sig" : "(eventName, handler, scope, options)",
508 "memberOf" : "Roo.util.Observable",
510 "isConstructor" : false,
520 "name" : "eventName",
522 "desc" : "The type of event to listen for",
528 "desc" : "The method the event invokes",
534 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
540 "desc" : "(optional)",
549 "desc" : "Removes a listener (shorthand for removeListener)",
550 "sig" : "(eventName, handler, scope)",
552 "memberOf" : "Roo.util.Observable",
554 "isConstructor" : false,
564 "name" : "eventName",
566 "desc" : "The type of event to listen for",
572 "desc" : "The handler to remove",
578 "desc" : "(optional) The scope (this object) for the handler",
585 "name" : "addEvents",
587 "desc" : "Used to define events on this Observable",
590 "memberOf" : "Roo.util.Observable",
592 "isConstructor" : false,
604 "desc" : "The object with the events defined",
611 "name" : "releaseCapture",
613 "desc" : "Removes <b>all</b> added captures from the Observable.",
616 "memberOf" : "Roo.util.Observable",
618 "isConstructor" : false,
629 "type" : "Observable",
630 "desc" : "The Observable to release",
637 "name" : "removeListener",
639 "desc" : "Removes a listener",
640 "sig" : "(eventName, handler, scope)",
642 "memberOf" : "Roo.util.Observable",
644 "isConstructor" : false,
654 "name" : "eventName",
656 "desc" : "The type of event to listen for",
662 "desc" : "The handler to remove",
668 "desc" : "(optional) The scope (this object) for the handler",
675 "name" : "fireEvent",
677 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
678 "sig" : "(eventName, args)",
680 "memberOf" : "Roo.util.Observable",
682 "isConstructor" : false,
692 "name" : "eventName",
699 "type" : "Object...",
700 "desc" : "Variable number of parameters are passed to handlers",
708 "desc" : "returns false if any of the handlers return false otherwise it returns true"
713 "name" : "hasListener",
715 "desc" : "Checks to see if this object has any listeners for a specified event",
716 "sig" : "(eventName)",
718 "memberOf" : "Roo.util.Observable",
720 "isConstructor" : false,
730 "name" : "eventName",
732 "desc" : "The name of the event to check for",
740 "desc" : "True if the event is being listened for, else false"
747 "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.",
748 "sig" : "(o, fn, scope)",
750 "memberOf" : "Roo.util.Observable",
752 "isConstructor" : false,
763 "type" : "Observable",
764 "desc" : "The Observable to capture",
770 "desc" : "The function to call",
776 "desc" : "(optional) The scope (this object) for the fn",
783 "name" : "addListener",
785 "desc" : "Appends an event handler to this component",
786 "sig" : "(eventName, handler, scope, options)",
788 "memberOf" : "Roo.util.Observable",
790 "isConstructor" : false,
800 "name" : "eventName",
802 "desc" : "The type of event to listen for",
808 "desc" : "The method the event invokes",
814 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
820 "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 "name" : "mouseover",
831 "desc" : "Fires when the mouse is hovering over this menu",
832 "sig" : "function (_self, e, menuItem)\n{\n\n}",
841 "type" : "Roo.menu.Menu",
847 "type" : "Roo.EventObject",
853 "type" : "Roo.menu.Item",
854 "desc" : "The menu item that was clicked",
863 "desc" : "Fires when the mouse exits this menu",
864 "sig" : "function (_self, e, menuItem)\n{\n\n}",
873 "type" : "Roo.menu.Menu",
879 "type" : "Roo.EventObject",
885 "type" : "Roo.menu.Item",
886 "desc" : "The menu item that was clicked",
893 "name" : "beforehide",
895 "desc" : "Fires before this menu is hidden",
896 "sig" : "function (_self)\n{\n\n}",
905 "type" : "Roo.menu.Menu",
913 "name" : "itemclick",
915 "desc" : "Fires when a menu item contained in this menu is clicked",
916 "sig" : "function (baseItem, e)\n{\n\n}",
925 "type" : "Roo.menu.BaseItem",
926 "desc" : "The BaseItem that was clicked",
931 "type" : "Roo.EventObject",
939 "name" : "beforeshow",
941 "desc" : "Fires before this menu is displayed",
942 "sig" : "function (_self)\n{\n\n}",
951 "type" : "Roo.menu.Menu",
961 "desc" : "Fires after this menu is hidden",
962 "sig" : "function (_self)\n{\n\n}",
971 "type" : "Roo.menu.Menu",
981 "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
982 "sig" : "function (_self, menuItem, e)\n{\n\n}",
991 "type" : "Roo.menu.Menu",
997 "type" : "Roo.menu.Item",
998 "desc" : "The menu item that was clicked",
1003 "type" : "Roo.EventObject",
1005 "isOptional" : false
1012 "type" : "function",
1013 "desc" : "Fires after this menu is displayed",
1014 "sig" : "function (_self)\n{\n\n}",
1023 "type" : "Roo.menu.Menu",
1025 "isOptional" : false