2 "name" : "Roo.menu.Menu",
21 "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).",
22 "isSingleton" : false,
26 "isBuilderTop" : false,
36 "desc" : "Configuration options",
47 "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>",
48 "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\")",
54 "memberOf" : "Roo.menu.Menu"
57 "name" : "defaultAlign",
59 "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
60 "memberOf" : "Roo.menu.Menu"
63 "name" : "subMenuAlign",
65 "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
66 "memberOf" : "Roo.menu.Menu"
71 "desc" : "The minimum width of the menu in pixels (defaults to 120)",
72 "memberOf" : "Roo.menu.Menu"
75 "name" : "registerMenu",
77 "desc" : "True (default) - means that clicking on screen etc. hides it.",
78 "memberOf" : "Roo.menu.Menu"
81 "name" : "allowOtherMenus",
83 "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
84 "memberOf" : "Roo.menu.Menu"
89 "name" : "addMenuItem",
91 "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
96 "isConstructor" : false,
108 "desc" : "A MenuItem config object",
115 "type" : "Roo.menu.Item",
116 "desc" : "The menu item that was added"
121 "name" : "addElement",
123 "desc" : "Adds an {@link Roo.Element} object to the menu",
128 "isConstructor" : false,
139 "type" : "String/HTMLElement/Roo.Element",
140 "desc" : "The element or DOM node to add, or its id",
147 "type" : "Roo.menu.Item",
148 "desc" : "The menu item that was added"
153 "name" : "isVisible",
155 "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
156 "sig" : "()\n{\n\n}",
160 "isConstructor" : false,
174 "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>",
179 "isConstructor" : false,
191 "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
198 "type" : "Roo.menu.Item",
199 "desc" : "The menu item that was added, or the last one if multiple items were added"
204 "name" : "addSeparator",
206 "desc" : "Adds a separator bar to the menu",
207 "sig" : "()\n{\n\n}",
211 "isConstructor" : false,
223 "type" : "Roo.menu.Item",
224 "desc" : "The menu item that was added"
229 "name" : "removeAll",
231 "desc" : "Removes and destroys all items in the menu",
232 "sig" : "()\n{\n\n}",
236 "isConstructor" : false,
250 "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
255 "isConstructor" : false,
266 "type" : "Roo.menu.Item",
267 "desc" : "The menu item to remove",
276 "desc" : "Returns this menu's underlying {@link Roo.Element} object",
277 "sig" : "()\n{\n\n}",
281 "isConstructor" : false,
293 "type" : "Roo.Element",
294 "desc" : "The element"
301 "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
302 "sig" : "(index, item)",
306 "isConstructor" : false,
318 "desc" : "The index in the menu's list of current items where the new item should be inserted",
323 "type" : "Roo.menu.Item",
324 "desc" : "The menu item to add",
331 "type" : "Roo.menu.Item",
332 "desc" : "The menu item that was added"
339 "desc" : "Hides this menu and optionally all parent menus",
344 "isConstructor" : false,
356 "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
365 "desc" : "Displays this menu relative to another element",
366 "sig" : "(element, position, parentMenu)",
370 "isConstructor" : false,
381 "type" : "String/HTMLElement/Roo.Element",
382 "desc" : "The element to align to",
388 "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
392 "name" : "parentMenu",
393 "type" : "Roo.menu.Menu",
394 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
403 "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
408 "isConstructor" : false,
420 "desc" : "The text to display in the menu item",
427 "type" : "Roo.menu.Item",
428 "desc" : "The menu item that was added"
435 "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
440 "isConstructor" : false,
451 "type" : "Roo.menu.Item",
452 "desc" : "The menu item to add",
459 "type" : "Roo.menu.Item",
460 "desc" : "The menu item that was added"
467 "desc" : "Displays this menu at a specific xy position",
468 "sig" : "(xyPosition, parentMenu)",
472 "isConstructor" : false,
482 "name" : "xyPosition",
484 "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
488 "name" : "parentMenu",
489 "type" : "Roo.menu.Menu",
490 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
497 "name" : "purgeListeners",
499 "desc" : "Removes all listeners for this object",
500 "sig" : "()\n{\n\n}",
502 "memberOf" : "Roo.util.Observable",
504 "isConstructor" : false,
518 "desc" : "Appends an event handler to this element (shorthand for addListener)",
519 "sig" : "(eventName, handler, scope, options)",
521 "memberOf" : "Roo.util.Observable",
523 "isConstructor" : false,
533 "name" : "eventName",
535 "desc" : "The type of event to listen for",
541 "desc" : "The method the event invokes",
547 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
553 "desc" : "(optional)",
562 "desc" : "Removes a listener (shorthand for removeListener)",
563 "sig" : "(eventName, handler, scope)",
565 "memberOf" : "Roo.util.Observable",
567 "isConstructor" : false,
577 "name" : "eventName",
579 "desc" : "The type of event to listen for",
585 "desc" : "The handler to remove",
591 "desc" : "(optional) The scope (this object) for the handler",
598 "name" : "addEvents",
600 "desc" : "Used to define events on this Observable",
603 "memberOf" : "Roo.util.Observable",
605 "isConstructor" : false,
617 "desc" : "The object with the events defined",
624 "name" : "releaseCapture",
626 "desc" : "Removes <b>all</b> added captures from the Observable.",
629 "memberOf" : "Roo.util.Observable",
631 "isConstructor" : false,
642 "type" : "Observable",
643 "desc" : "The Observable to release",
650 "name" : "removeListener",
652 "desc" : "Removes a listener",
653 "sig" : "(eventName, handler, scope)",
655 "memberOf" : "Roo.util.Observable",
657 "isConstructor" : false,
667 "name" : "eventName",
669 "desc" : "The type of event to listen for",
675 "desc" : "The handler to remove",
681 "desc" : "(optional) The scope (this object) for the handler",
688 "name" : "fireEvent",
690 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
691 "sig" : "(eventName, args)",
693 "memberOf" : "Roo.util.Observable",
695 "isConstructor" : false,
705 "name" : "eventName",
712 "type" : "Object...",
713 "desc" : "Variable number of parameters are passed to handlers",
721 "desc" : "returns false if any of the handlers return false otherwise it returns true"
726 "name" : "hasListener",
728 "desc" : "Checks to see if this object has any listeners for a specified event",
729 "sig" : "(eventName)",
731 "memberOf" : "Roo.util.Observable",
733 "isConstructor" : false,
743 "name" : "eventName",
745 "desc" : "The name of the event to check for",
753 "desc" : "True if the event is being listened for, else false"
760 "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.",
761 "sig" : "(o, fn, scope)",
763 "memberOf" : "Roo.util.Observable",
765 "isConstructor" : false,
776 "type" : "Observable",
777 "desc" : "The Observable to capture",
783 "desc" : "The function to call",
789 "desc" : "(optional) The scope (this object) for the fn",
796 "name" : "addListener",
798 "desc" : "Appends an event handler to this component",
799 "sig" : "(eventName, handler, scope, options)",
801 "memberOf" : "Roo.util.Observable",
803 "isConstructor" : false,
813 "name" : "eventName",
815 "desc" : "The type of event to listen for",
821 "desc" : "The method the event invokes",
827 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
833 "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>",
842 "name" : "mouseover",
844 "desc" : "Fires when the mouse is hovering over this menu",
845 "sig" : "function (_self, e, menuItem)\n{\n\n}",
854 "type" : "Roo.menu.Menu",
860 "type" : "Roo.EventObject",
866 "type" : "Roo.menu.Item",
867 "desc" : "The menu item that was clicked",
876 "desc" : "Fires when the mouse exits this menu",
877 "sig" : "function (_self, e, menuItem)\n{\n\n}",
886 "type" : "Roo.menu.Menu",
892 "type" : "Roo.EventObject",
898 "type" : "Roo.menu.Item",
899 "desc" : "The menu item that was clicked",
906 "name" : "beforehide",
908 "desc" : "Fires before this menu is hidden",
909 "sig" : "function (_self)\n{\n\n}",
918 "type" : "Roo.menu.Menu",
926 "name" : "itemclick",
928 "desc" : "Fires when a menu item contained in this menu is clicked",
929 "sig" : "function (baseItem, e)\n{\n\n}",
938 "type" : "Roo.menu.BaseItem",
939 "desc" : "The BaseItem that was clicked",
944 "type" : "Roo.EventObject",
952 "name" : "beforeshow",
954 "desc" : "Fires before this menu is displayed",
955 "sig" : "function (_self)\n{\n\n}",
964 "type" : "Roo.menu.Menu",
974 "desc" : "Fires after this menu is hidden",
975 "sig" : "function (_self)\n{\n\n}",
984 "type" : "Roo.menu.Menu",
994 "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
995 "sig" : "function (_self, menuItem, e)\n{\n\n}",
1004 "type" : "Roo.menu.Menu",
1006 "isOptional" : false
1009 "name" : "menuItem",
1010 "type" : "Roo.menu.Item",
1011 "desc" : "The menu item that was clicked",
1012 "isOptional" : false
1016 "type" : "Roo.EventObject",
1018 "isOptional" : false
1025 "type" : "function",
1026 "desc" : "Fires after this menu is displayed",
1027 "sig" : "function (_self)\n{\n\n}",
1036 "type" : "Roo.menu.Menu",
1038 "isOptional" : false