X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.menu.Menu.json;fp=docs%2Fsymbols%2FRoo.menu.Menu.json;h=8a844a7c00c608cbb1d6468859f45bd249641e8e;hb=c1c0168c0e693c4262f3f744a82419f9d9b1807f;hp=0000000000000000000000000000000000000000;hpb=b282409b66344f6d0ff1999b55639cfd80097128;p=roojs1 diff --git a/docs/symbols/Roo.menu.Menu.json b/docs/symbols/Roo.menu.Menu.json new file mode 100644 index 0000000000..8a844a7c00 --- /dev/null +++ b/docs/symbols/Roo.menu.Menu.json @@ -0,0 +1,931 @@ +{ + "name" : "Roo.menu.Menu", + "augments" : [ + "Roo.util.Observable" + ], + "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).", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "Configuration options", + "isOptional" : false + } + ], + "returns" : [ + ], + "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", + "values" : [ + ] + }, + { + "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", + "values" : [ + ] + }, + { + "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", + "values" : [ + ] + }, + { + "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", + "values" : [ + ] + }, + { + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum width of the menu in pixels (defaults to 120)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + }, + { + "name" : "allowOtherMenus", + "type" : "Boolean", + "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", + "memberOf" : "Roo.menu.Menu", + "values" : [ + ] + } + ], + "methods" : [ + { + "name" : "addMenuItem", + "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "A MenuItem config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addElement", + "desc" : "Adds an {@link Roo.Element} object to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element or DOM node to add, or its id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "isVisible", + "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "add", + "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
", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "args", + "type" : "Mixed", + "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added, or the last one if multiple items were added" + } + ] + }, + { + "name" : "addSeparator", + "desc" : "Adds a separator bar to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "removeAll", + "desc" : "Removes and destroys all items in the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "remove", + "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to remove", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getEl", + "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "insert", + "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index in the menu's list of current items where the new item should be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "hide", + "desc" : "Hides this menu and optionally all parent menus", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Displays this menu relative to another element", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addText", + "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display in the menu item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "addItem", + "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] + }, + { + "name" : "showAt", + "desc" : "Displays this menu at a specific xy position", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "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.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\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
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\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
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\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
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "mouseover", + "desc" : "Fires when the mouse is hovering over this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "mouseout", + "desc" : "Fires when the mouse exits this menu", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforehide", + "desc" : "Fires before this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "itemclick", + "desc" : "Fires when a menu item contained in this menu is clicked", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "beforeshow", + "desc" : "Fires before this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "hide", + "desc" : "Fires after this menu is hidden", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "click", + "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "show", + "desc" : "Fires after this menu is displayed", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file