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"
41 "type" : "Boolean/String",
42 "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
43 "memberOf" : "Roo.menu.Menu"
46 "name" : "subMenuAlign",
48 "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
49 "memberOf" : "Roo.menu.Menu"
52 "name" : "defaultAlign",
54 "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
55 "memberOf" : "Roo.menu.Menu"
60 "desc" : "The minimum width of the menu in pixels (defaults to 120)",
61 "memberOf" : "Roo.menu.Menu"
64 "name" : "registerMenu",
66 "desc" : "True (default) - means that clicking on screen etc. hides it.",
67 "memberOf" : "Roo.menu.Menu"
70 "name" : "allowOtherMenus",
72 "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
73 "memberOf" : "Roo.menu.Menu"
78 "name" : "addMenuItem",
80 "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
83 "memberOf" : "Roo.menu.Menu",
85 "isConstructor" : false,
97 "desc" : "A MenuItem config object",
104 "type" : "Roo.menu.Item",
105 "desc" : "The menu item that was added"
110 "name" : "addElement",
112 "desc" : "Adds an {@link Roo.Element} object to the menu",
115 "memberOf" : "Roo.menu.Menu",
117 "isConstructor" : false,
128 "type" : "String/HTMLElement/Roo.Element",
129 "desc" : "The element or DOM node to add, or its id",
136 "type" : "Roo.menu.Item",
137 "desc" : "The menu item that was added"
142 "name" : "isVisible",
144 "desc" : "Read-only. Returns true if the menu is currently displayed, else false.",
145 "sig" : "()\n{\n\n}",
147 "memberOf" : "Roo.menu.Menu",
149 "isConstructor" : false,
163 "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 "memberOf" : "Roo.menu.Menu",
168 "isConstructor" : false,
180 "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
187 "type" : "Roo.menu.Item",
188 "desc" : "The menu item that was added, or the last one if multiple items were added"
193 "name" : "addSeparator",
195 "desc" : "Adds a separator bar to the menu",
196 "sig" : "()\n{\n\n}",
198 "memberOf" : "Roo.menu.Menu",
200 "isConstructor" : false,
212 "type" : "Roo.menu.Item",
213 "desc" : "The menu item that was added"
218 "name" : "removeAll",
220 "desc" : "Removes and destroys all items in the menu",
221 "sig" : "()\n{\n\n}",
223 "memberOf" : "Roo.menu.Menu",
225 "isConstructor" : false,
239 "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
242 "memberOf" : "Roo.menu.Menu",
244 "isConstructor" : false,
255 "type" : "Roo.menu.Item",
256 "desc" : "The menu item to remove",
265 "desc" : "Returns this menu's underlying {@link Roo.Element} object",
266 "sig" : "()\n{\n\n}",
268 "memberOf" : "Roo.menu.Menu",
270 "isConstructor" : false,
282 "type" : "Roo.Element",
283 "desc" : "The element"
290 "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
291 "sig" : "(index, item)",
293 "memberOf" : "Roo.menu.Menu",
295 "isConstructor" : false,
307 "desc" : "The index in the menu's list of current items where the new item should be inserted",
312 "type" : "Roo.menu.Item",
313 "desc" : "The menu item to add",
320 "type" : "Roo.menu.Item",
321 "desc" : "The menu item that was added"
328 "desc" : "Hides this menu and optionally all parent menus",
331 "memberOf" : "Roo.menu.Menu",
333 "isConstructor" : false,
345 "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
354 "desc" : "Displays this menu relative to another element",
355 "sig" : "(element, position, parentMenu)",
357 "memberOf" : "Roo.menu.Menu",
359 "isConstructor" : false,
370 "type" : "String/HTMLElement/Roo.Element",
371 "desc" : "The element to align to",
377 "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
381 "name" : "parentMenu",
382 "type" : "Roo.menu.Menu",
383 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
392 "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
395 "memberOf" : "Roo.menu.Menu",
397 "isConstructor" : false,
409 "desc" : "The text to display in the menu item",
416 "type" : "Roo.menu.Item",
417 "desc" : "The menu item that was added"
424 "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
427 "memberOf" : "Roo.menu.Menu",
429 "isConstructor" : false,
440 "type" : "Roo.menu.Item",
441 "desc" : "The menu item to add",
448 "type" : "Roo.menu.Item",
449 "desc" : "The menu item that was added"
456 "desc" : "Displays this menu at a specific xy position",
457 "sig" : "(xyPosition, parentMenu)",
459 "memberOf" : "Roo.menu.Menu",
461 "isConstructor" : false,
471 "name" : "xyPosition",
473 "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
477 "name" : "parentMenu",
478 "type" : "Roo.menu.Menu",
479 "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
486 "name" : "purgeListeners",
488 "desc" : "Removes all listeners for this object",
489 "sig" : "()\n{\n\n}",
491 "memberOf" : "Roo.util.Observable",
493 "isConstructor" : false,
507 "desc" : "Appends an event handler to this element (shorthand for addListener)",
508 "sig" : "(eventName, handler, scope, options)",
510 "memberOf" : "Roo.util.Observable",
512 "isConstructor" : false,
522 "name" : "eventName",
524 "desc" : "The type of event to listen for",
530 "desc" : "The method the event invokes",
536 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
542 "desc" : "(optional)",
551 "desc" : "Removes a listener (shorthand for removeListener)",
552 "sig" : "(eventName, handler, scope)",
554 "memberOf" : "Roo.util.Observable",
556 "isConstructor" : false,
566 "name" : "eventName",
568 "desc" : "The type of event to listen for",
574 "desc" : "The handler to remove",
580 "desc" : "(optional) The scope (this object) for the handler",
587 "name" : "addEvents",
589 "desc" : "Used to define events on this Observable",
592 "memberOf" : "Roo.util.Observable",
594 "isConstructor" : false,
606 "desc" : "The object with the events defined",
613 "name" : "releaseCapture",
615 "desc" : "Removes <b>all</b> added captures from the Observable.",
618 "memberOf" : "Roo.util.Observable",
620 "isConstructor" : false,
631 "type" : "Observable",
632 "desc" : "The Observable to release",
639 "name" : "removeListener",
641 "desc" : "Removes a listener",
642 "sig" : "(eventName, handler, scope)",
644 "memberOf" : "Roo.util.Observable",
646 "isConstructor" : false,
656 "name" : "eventName",
658 "desc" : "The type of event to listen for",
664 "desc" : "The handler to remove",
670 "desc" : "(optional) The scope (this object) for the handler",
677 "name" : "fireEvent",
679 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
680 "sig" : "(eventName, args)",
682 "memberOf" : "Roo.util.Observable",
684 "isConstructor" : false,
694 "name" : "eventName",
701 "type" : "Object...",
702 "desc" : "Variable number of parameters are passed to handlers",
710 "desc" : "returns false if any of the handlers return false otherwise it returns true"
715 "name" : "hasListener",
717 "desc" : "Checks to see if this object has any listeners for a specified event",
718 "sig" : "(eventName)",
720 "memberOf" : "Roo.util.Observable",
722 "isConstructor" : false,
732 "name" : "eventName",
734 "desc" : "The name of the event to check for",
742 "desc" : "True if the event is being listened for, else false"
749 "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.",
750 "sig" : "(o, fn, scope)",
752 "memberOf" : "Roo.util.Observable",
754 "isConstructor" : false,
765 "type" : "Observable",
766 "desc" : "The Observable to capture",
772 "desc" : "The function to call",
778 "desc" : "(optional) The scope (this object) for the fn",
785 "name" : "addListener",
787 "desc" : "Appends an event handler to this component",
788 "sig" : "(eventName, handler, scope, options)",
790 "memberOf" : "Roo.util.Observable",
792 "isConstructor" : false,
802 "name" : "eventName",
804 "desc" : "The type of event to listen for",
810 "desc" : "The method the event invokes",
816 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
822 "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>",
834 "sig" : "function (palette, color)\n{\n\n}",
843 "type" : "ColorPalette",
857 "name" : "mouseover",
859 "desc" : "Fires when the mouse is hovering over this menu",
860 "sig" : "function (_self, e, menuItem)\n{\n\n}",
861 "memberOf" : "Roo.menu.Menu",
869 "type" : "Roo.menu.Menu",
875 "type" : "Roo.EventObject",
881 "type" : "Roo.menu.Item",
882 "desc" : "The menu item that was clicked",
891 "desc" : "Fires when the mouse exits this menu",
892 "sig" : "function (_self, e, menuItem)\n{\n\n}",
893 "memberOf" : "Roo.menu.Menu",
901 "type" : "Roo.menu.Menu",
907 "type" : "Roo.EventObject",
913 "type" : "Roo.menu.Item",
914 "desc" : "The menu item that was clicked",
921 "name" : "beforehide",
923 "desc" : "Fires before this menu is hidden",
924 "sig" : "function (_self)\n{\n\n}",
925 "memberOf" : "Roo.menu.Menu",
933 "type" : "Roo.menu.Menu",
941 "name" : "itemclick",
943 "desc" : "Fires when a menu item contained in this menu is clicked",
944 "sig" : "function (baseItem, e)\n{\n\n}",
945 "memberOf" : "Roo.menu.Menu",
953 "type" : "Roo.menu.BaseItem",
954 "desc" : "The BaseItem that was clicked",
959 "type" : "Roo.EventObject",
967 "name" : "beforeshow",
969 "desc" : "Fires before this menu is displayed",
970 "sig" : "function (_self)\n{\n\n}",
971 "memberOf" : "Roo.menu.Menu",
979 "type" : "Roo.menu.Menu",
989 "desc" : "Fires after this menu is hidden",
990 "sig" : "function (_self)\n{\n\n}",
991 "memberOf" : "Roo.menu.Menu",
999 "type" : "Roo.menu.Menu",
1001 "isOptional" : false
1008 "type" : "function",
1009 "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
1010 "sig" : "function (_self, menuItem, e)\n{\n\n}",
1011 "memberOf" : "Roo.menu.Menu",
1019 "type" : "Roo.menu.Menu",
1021 "isOptional" : false
1024 "name" : "menuItem",
1025 "type" : "Roo.menu.Item",
1026 "desc" : "The menu item that was clicked",
1027 "isOptional" : false
1031 "type" : "Roo.EventObject",
1033 "isOptional" : false
1040 "type" : "function",
1041 "desc" : "Fires after this menu is displayed",
1042 "sig" : "function (_self)\n{\n\n}",
1043 "memberOf" : "Roo.menu.Menu",
1051 "type" : "Roo.menu.Menu",
1053 "isOptional" : false