2 "name" : "Roo.menu.ColorMenu",
10 "desc" : "A menu containing a {@link Roo.menu.ColorItem} component (which provides a basic color picker).",
11 "isSingleton" : false,
15 "isBuilderTop" : false,
16 "memberOf" : "ColorMenu",
25 "desc" : "Configuration options",
36 "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>",
37 "memberOf" : "Roo.util.Observable",
43 "type" : "Boolean/String",
44 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
45 "memberOf" : "Roo.menu.Menu",
50 "name" : "subMenuAlign",
52 "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
53 "memberOf" : "Roo.menu.Menu",
58 "name" : "defaultAlign",
60 "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
61 "memberOf" : "Roo.menu.Menu",
68 "desc" : "The minimum width of the menu in pixels (defaults to 120)",
69 "memberOf" : "Roo.menu.Menu",
74 "name" : "registerMenu",
76 "desc" : "True (default) - means that clicking on screen etc. hides it.",
77 "memberOf" : "Roo.menu.Menu",
82 "name" : "allowOtherMenus",
84 "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
85 "memberOf" : "Roo.menu.Menu",
92 "name" : "addMenuItem",
94 "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
97 "memberOf" : "Roo.menu.Menu",
99 "isConstructor" : false,
111 "desc" : "A MenuItem config object",
118 "type" : "Roo.menu.Item",
119 "desc" : "The menu item that was added"
124 "name" : "addElement",
126 "desc" : "Adds an {@link Roo.Element} object to the menu",
129 "memberOf" : "Roo.menu.Menu",
131 "isConstructor" : false,
142 "type" : "String/HTMLElement/Roo.Element",
143 "desc" : "The element or DOM node to add, or its id",
150 "type" : "Roo.menu.Item",
151 "desc" : "The menu item that was added"
156 "name" : "isVisible",
158 "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
159 "sig" : "()\n{\n\n}",
161 "memberOf" : "Roo.menu.Menu",
163 "isConstructor" : false,
177 "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>",
180 "memberOf" : "Roo.menu.Menu",
182 "isConstructor" : false,
194 "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
201 "type" : "Roo.menu.Item",
202 "desc" : "The menu item that was added, or the last one if multiple items were added"
207 "name" : "addSeparator",
209 "desc" : "Adds a separator bar to the menu",
210 "sig" : "()\n{\n\n}",
212 "memberOf" : "Roo.menu.Menu",
214 "isConstructor" : false,
226 "type" : "Roo.menu.Item",
227 "desc" : "The menu item that was added"
232 "name" : "removeAll",
234 "desc" : "Removes and destroys all items in the menu",
235 "sig" : "()\n{\n\n}",
237 "memberOf" : "Roo.menu.Menu",
239 "isConstructor" : false,
253 "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
256 "memberOf" : "Roo.menu.Menu",
258 "isConstructor" : false,
269 "type" : "Roo.menu.Item",
270 "desc" : "The menu item to remove",
279 "desc" : "Returns this menu's underlying {@link Roo.Element} object",
280 "sig" : "()\n{\n\n}",
282 "memberOf" : "Roo.menu.Menu",
284 "isConstructor" : false,
296 "type" : "Roo.Element",
297 "desc" : "The element"
304 "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
305 "sig" : "(index, item)",
307 "memberOf" : "Roo.menu.Menu",
309 "isConstructor" : false,
321 "desc" : "The index in the menu's list of current items where the new item should be inserted",
326 "type" : "Roo.menu.Item",
327 "desc" : "The menu item to add",
334 "type" : "Roo.menu.Item",
335 "desc" : "The menu item that was added"
342 "desc" : "Hides this menu and optionally all parent menus",
345 "memberOf" : "Roo.menu.Menu",
347 "isConstructor" : false,
359 "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
368 "desc" : "Displays this menu relative to another element",
369 "sig" : "(element, position, parentMenu)",
371 "memberOf" : "Roo.menu.Menu",
373 "isConstructor" : false,
384 "type" : "String/HTMLElement/Roo.Element",
385 "desc" : "The element to align to",
391 "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
395 "name" : "parentMenu",
396 "type" : "Roo.menu.Menu",
397 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
406 "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
409 "memberOf" : "Roo.menu.Menu",
411 "isConstructor" : false,
423 "desc" : "The text to display in the menu item",
430 "type" : "Roo.menu.Item",
431 "desc" : "The menu item that was added"
438 "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
441 "memberOf" : "Roo.menu.Menu",
443 "isConstructor" : false,
454 "type" : "Roo.menu.Item",
455 "desc" : "The menu item to add",
462 "type" : "Roo.menu.Item",
463 "desc" : "The menu item that was added"
470 "desc" : "Displays this menu at a specific xy position",
471 "sig" : "(xyPosition, parentMenu)",
473 "memberOf" : "Roo.menu.Menu",
475 "isConstructor" : false,
485 "name" : "xyPosition",
487 "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
491 "name" : "parentMenu",
492 "type" : "Roo.menu.Menu",
493 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
500 "name" : "purgeListeners",
502 "desc" : "Removes all listeners for this object",
503 "sig" : "()\n{\n\n}",
505 "memberOf" : "Roo.util.Observable",
507 "isConstructor" : false,
521 "desc" : "Appends an event handler to this element (shorthand for addListener)",
522 "sig" : "(eventName, handler, scope, options)",
524 "memberOf" : "Roo.util.Observable",
526 "isConstructor" : false,
536 "name" : "eventName",
538 "desc" : "The type of event to listen for",
544 "desc" : "The method the event invokes",
550 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
556 "desc" : "(optional)",
565 "desc" : "Removes a listener (shorthand for removeListener)",
566 "sig" : "(eventName, handler, scope)",
568 "memberOf" : "Roo.util.Observable",
570 "isConstructor" : false,
580 "name" : "eventName",
582 "desc" : "The type of event to listen for",
588 "desc" : "The handler to remove",
594 "desc" : "(optional) The scope (this object) for the handler",
601 "name" : "addEvents",
603 "desc" : "Used to define events on this Observable",
606 "memberOf" : "Roo.util.Observable",
608 "isConstructor" : false,
620 "desc" : "The object with the events defined",
627 "name" : "releaseCapture",
629 "desc" : "Removes <b>all</b> added captures from the Observable.",
632 "memberOf" : "Roo.util.Observable",
634 "isConstructor" : false,
645 "type" : "Observable",
646 "desc" : "The Observable to release",
653 "name" : "removeListener",
655 "desc" : "Removes a listener",
656 "sig" : "(eventName, handler, scope)",
658 "memberOf" : "Roo.util.Observable",
660 "isConstructor" : false,
670 "name" : "eventName",
672 "desc" : "The type of event to listen for",
678 "desc" : "The handler to remove",
684 "desc" : "(optional) The scope (this object) for the handler",
691 "name" : "fireEvent",
693 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
694 "sig" : "(eventName, args)",
696 "memberOf" : "Roo.util.Observable",
698 "isConstructor" : false,
708 "name" : "eventName",
715 "type" : "Object...",
716 "desc" : "Variable number of parameters are passed to handlers",
724 "desc" : "returns false if any of the handlers return false otherwise it returns true"
729 "name" : "hasListener",
731 "desc" : "Checks to see if this object has any listeners for a specified event",
732 "sig" : "(eventName)",
734 "memberOf" : "Roo.util.Observable",
736 "isConstructor" : false,
746 "name" : "eventName",
748 "desc" : "The name of the event to check for",
756 "desc" : "True if the event is being listened for, else false"
763 "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.",
764 "sig" : "(o, fn, scope)",
766 "memberOf" : "Roo.util.Observable",
768 "isConstructor" : false,
779 "type" : "Observable",
780 "desc" : "The Observable to capture",
786 "desc" : "The function to call",
792 "desc" : "(optional) The scope (this object) for the fn",
799 "name" : "addListener",
801 "desc" : "Appends an event handler to this component",
802 "sig" : "(eventName, handler, scope, options)",
804 "memberOf" : "Roo.util.Observable",
806 "isConstructor" : false,
816 "name" : "eventName",
818 "desc" : "The type of event to listen for",
824 "desc" : "The method the event invokes",
830 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
836 "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>",
848 "sig" : "function (palette, color)\n{\n\n}",
857 "type" : "ColorPalette",
871 "name" : "mouseover",
873 "desc" : "Fires when the mouse is hovering over this menu",
874 "sig" : "function (_self, e, menuItem)\n{\n\n}",
875 "memberOf" : "Roo.menu.Menu",
883 "type" : "Roo.menu.Menu",
889 "type" : "Roo.EventObject",
895 "type" : "Roo.menu.Item",
896 "desc" : "The menu item that was clicked",
905 "desc" : "Fires when the mouse exits this menu",
906 "sig" : "function (_self, e, menuItem)\n{\n\n}",
907 "memberOf" : "Roo.menu.Menu",
915 "type" : "Roo.menu.Menu",
921 "type" : "Roo.EventObject",
927 "type" : "Roo.menu.Item",
928 "desc" : "The menu item that was clicked",
935 "name" : "beforehide",
937 "desc" : "Fires before this menu is hidden",
938 "sig" : "function (_self)\n{\n\n}",
939 "memberOf" : "Roo.menu.Menu",
947 "type" : "Roo.menu.Menu",
955 "name" : "itemclick",
957 "desc" : "Fires when a menu item contained in this menu is clicked",
958 "sig" : "function (baseItem, e)\n{\n\n}",
959 "memberOf" : "Roo.menu.Menu",
967 "type" : "Roo.menu.BaseItem",
968 "desc" : "The BaseItem that was clicked",
973 "type" : "Roo.EventObject",
981 "name" : "beforeshow",
983 "desc" : "Fires before this menu is displayed",
984 "sig" : "function (_self)\n{\n\n}",
985 "memberOf" : "Roo.menu.Menu",
993 "type" : "Roo.menu.Menu",
1002 "type" : "function",
1003 "desc" : "Fires after this menu is hidden",
1004 "sig" : "function (_self)\n{\n\n}",
1005 "memberOf" : "Roo.menu.Menu",
1013 "type" : "Roo.menu.Menu",
1015 "isOptional" : false
1022 "type" : "function",
1023 "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
1024 "sig" : "function (_self, menuItem, e)\n{\n\n}",
1025 "memberOf" : "Roo.menu.Menu",
1033 "type" : "Roo.menu.Menu",
1035 "isOptional" : false
1038 "name" : "menuItem",
1039 "type" : "Roo.menu.Item",
1040 "desc" : "The menu item that was clicked",
1041 "isOptional" : false
1045 "type" : "Roo.EventObject",
1047 "isOptional" : false
1054 "type" : "function",
1055 "desc" : "Fires after this menu is displayed",
1056 "sig" : "function (_self)\n{\n\n}",
1057 "memberOf" : "Roo.menu.Menu",
1065 "type" : "Roo.menu.Menu",
1067 "isOptional" : false