"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" : "",
}
],
"returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "listeners",
"type" : "Object",
"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>",
- "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",
},
{
"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",
},
{
"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<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>",
+ "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",
},
{
"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" : [
{
},
{
"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",
},
{
"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" : [
{
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"name" : "releaseCapture",
+ "type" : "function",
"desc" : "Removes <b>all</b> 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",
},
{
"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",
},
{
"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",
},
{
"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",
},
{
"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\n<b>before</b> 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",
},
{
"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",
"events" : [
{
"name" : "select",
+ "type" : "function",
"desc" : "",
- "memberOf" : "Roo.menu.ColorMenu",
+ "sig" : "function (palette, color)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
},
{
"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" : "",
},
{
"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" : "",
},
{
"name" : "beforehide",
+ "type" : "function",
"desc" : "Fires before this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
},
{
"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" : "",
},
{
"name" : "beforeshow",
+ "type" : "function",
"desc" : "Fires before this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Fires after this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
},
{
"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" : "",
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Fires after this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.menu.Menu",
"example" : "",
"deprecated" : "",
projects / roojs1 / blobdiff