X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.menu.ColorMenu.json;fp=docs%2Fsymbols%2FRoo.menu.ColorMenu.json;h=59e834fad8d7ad77266de80c9728715f7725201d;hp=4cfd8aed8adf206f0c693ae78d057e41fef3bf8a;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.menu.ColorMenu.json b/docs/symbols/Roo.menu.ColorMenu.json index 4cfd8aed8a..59e834fad8 100644 --- a/docs/symbols/Roo.menu.ColorMenu.json +++ b/docs/symbols/Roo.menu.ColorMenu.json @@ -4,10 +4,15 @@ "Roo.menu.Menu", "Roo.util.Observable" ], + "childClasses" : { }, + "tree_children" : [], + "tree_parent" : [], "desc" : "A menu containing a {@link Roo.menu.ColorItem} component (which provides a basic color picker).", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "ColorMenu", "example" : "", "deprecated" : "", @@ -22,69 +27,69 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "subMenuAlign", "type" : "String", "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "defaultAlign", "type" : "String", "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width of the menu in pixels (defaults to 120)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "registerMenu", "type" : "Boolean", "desc" : "True (default) - means that clicking on screen etc. hides it.", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "allowOtherMenus", "type" : "Boolean", "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" } ], "methods" : [ { "name" : "addMenuItem", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -103,15 +108,20 @@ }, { "name" : "addElement", + "type" : "function", "desc" : "Adds an {@link Roo.Element} object to the menu", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -130,29 +140,39 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "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\nUsage:\n
\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
", + "sig" : "(args)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "args", @@ -171,15 +191,20 @@ }, { "name" : "addSeparator", + "type" : "function", "desc" : "Adds a separator bar to the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -191,29 +216,39 @@ }, { "name" : "removeAll", + "type" : "function", "desc" : "Removes and destroys all items in the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "remove", + "type" : "function", "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -226,15 +261,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -246,15 +286,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -279,15 +324,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -300,15 +350,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -333,15 +388,20 @@ }, { "name" : "addText", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -360,15 +420,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -387,15 +452,20 @@ }, { "name" : "showAt", + "type" : "function", "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xyPosition", @@ -414,29 +484,39 @@ }, { "name" : "purgeListeners", + "type" : "function", "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "on", + "type" : "function", "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -467,15 +547,20 @@ }, { "name" : "un", + "type" : "function", "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -500,15 +585,20 @@ }, { "name" : "addEvents", + "type" : "function", "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -521,15 +611,20 @@ }, { "name" : "releaseCapture", + "type" : "function", "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -542,15 +637,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -575,15 +675,20 @@ }, { "name" : "fireEvent", + "type" : "function", "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -608,15 +713,20 @@ }, { "name" : "hasListener", + "type" : "function", "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +745,20 @@ }, { "name" : "capture", + "type" : "function", "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\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -668,15 +783,20 @@ }, { "name" : "addListener", + "type" : "function", "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,8 +829,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "", - "memberOf" : "Roo.menu.ColorMenu", + "sig" : "function (palette, color)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -733,7 +855,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -763,7 +887,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -793,7 +919,9 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -811,7 +939,9 @@ }, { "name" : "itemclick", + "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -835,7 +965,9 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -853,7 +985,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -871,7 +1005,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, menuItem, e)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -901,7 +1037,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "",