From: Alan Knowles Date: Thu, 29 Jul 2021 07:19:19 +0000 (+0800) Subject: sync X-Git-Url: http://git.roojs.org/?p=roojs1;a=commitdiff_plain;h=a5c010ae8950880b8957d4e8d2c8279a0451f7ee sync --- diff --git a/docs/json/roodata.json b/docs/json/roodata.json index ff660f4974..904fcc6197 100644 --- a/docs/json/roodata.json +++ b/docs/json/roodata.json @@ -56153,7 +56153,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "" }, @@ -58640,7 +58640,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "Roo.bootstrap.Button" }, @@ -66015,7 +66015,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "Roo.bootstrap.Button" }, @@ -102866,7 +102866,7 @@ } ] }, - "Roo.bootstrap.Menu" : { + "Roo.bootstrap.MessageBar" : { "props" : [ { "name" : "actionMode", @@ -102874,24 +102874,30 @@ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", "memberOf" : "Roo.Component" }, - { - "name" : "align", - "type" : "String", - "desc" : "default tl-bl? == below - how the menu should be aligned.", - "memberOf" : "" - }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", "memberOf" : "Roo.Component" }, + { + "name" : "beforeClass", + "type" : "String", + "desc" : "insert the bar before the given class", + "memberOf" : "" + }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", "memberOf" : "Roo.bootstrap.Component" }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "e) default false", + "memberOf" : "" + }, { "name" : "cls", "type" : "String", @@ -102917,9 +102923,9 @@ "memberOf" : "Roo.Component" }, { - "name" : "hidden", - "type" : "bool", - "desc" : "if the menu should be hidden when rendered.", + "name" : "fixed", + "type" : "Boolean", + "desc" : "e) default false, fix the bar at the top", "memberOf" : "" }, { @@ -102929,15 +102935,9 @@ "memberOf" : "Roo.Component" }, { - "name" : "hideTrigger", - "type" : "bool", - "desc" : "e) default false - hide the carret for trigger.", - "memberOf" : "" - }, - { - "name" : "isLink", - "type" : "bool", - "desc" : "e) the menu has link disable auto expand and collaspe (default false)", + "name" : "html", + "type" : "String", + "desc" : "contents of the MessageBar", "memberOf" : "" }, { @@ -102952,18 +102952,6 @@ "desc" : "Specifies name attribute", "memberOf" : "Roo.bootstrap.Component" }, - { - "name" : "registerMenu", - "type" : "Boolean", - "desc" : "True (default) - means that clicking on screen etc. hides it.", - "memberOf" : "" - }, - { - "name" : "stopEvent", - "type" : "bool", - "desc" : "e) Stop event after trigger press (default true)", - "memberOf" : "" - }, { "name" : "style", "type" : "String", @@ -102976,18 +102964,18 @@ "desc" : "Text for the tooltip", "memberOf" : "Roo.bootstrap.Component" }, - { - "name" : "type", - "type" : "String", - "desc" : "u) type of menu", - "memberOf" : "" - }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", "memberOf" : "Roo.bootstrap.Component" }, + { + "name" : "weight", + "type" : "String", + "desc" : "r) default info", + "memberOf" : "" + }, { "name" : "xattr", "type" : "Object", @@ -103019,9 +103007,9 @@ { "name" : "beforehide", "type" : "function", - "desc" : "Fires before this menu is hidden (return false to block)", + "desc" : "Fires before the component is hidden. Return false to stop the hide.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "", + "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", @@ -103029,7 +103017,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.menu.Menu", + "type" : "Roo.Component", "desc" : "", "isOptional" : false } @@ -103059,9 +103047,9 @@ { "name" : "beforeshow", "type" : "function", - "desc" : "Fires before this menu is displayed (return false to block)", + "desc" : "Fires before the component is shown. Return false to stop the show.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "", + "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", @@ -103069,7 +103057,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.menu.Menu", + "type" : "Roo.Component", "desc" : "", "isOptional" : false } @@ -103096,38 +103084,6 @@ ], "returns" : [] }, - { - "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" : "", - "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" : "destroy", "type" : "function", @@ -103191,87 +103147,9 @@ { "name" : "hide", "type" : "function", - "desc" : "Fires after this menu is hidden", + "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.menu.Menu", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "itemclick", - "type" : "function", - "desc" : "Fires when a menu item contained in this menu is clicked", - "sig" : "function (baseItem, e)\n{\n\n}", - "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" : "mouseout", - "type" : "function", - "desc" : "Fires when the mouse exits this menu", - "sig" : "function (_self, e, menuItem)\n{\n\n}", - "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" : "mouseover", - "type" : "function", - "desc" : "Fires when the mouse is hovering over this menu", - "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "", + "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", @@ -103279,21 +103157,9 @@ "params" : [ { "name" : "this", - "type" : "Roo.menu.Menu", - "desc" : "", - "isOptional" : false - }, - { - "name" : "e", - "type" : "Roo.EventObject", + "type" : "Roo.Component", "desc" : "", "isOptional" : false - }, - { - "name" : "menuItem", - "type" : "Roo.menu.Item", - "desc" : "The menu item that was clicked", - "isOptional" : false } ], "returns" : [] @@ -103321,9 +103187,9 @@ { "name" : "show", "type" : "function", - "desc" : "Fires after this menu is displayed", + "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "", + "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", @@ -103331,7 +103197,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.menu.Menu", + "type" : "Roo.Component", "desc" : "", "isOptional" : false } @@ -103716,10 +103582,10 @@ { "name" : "hide", "type" : "function", - "desc" : "Hides this menu and optionally all parent menus", - "sig" : "(deep)", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "", + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, @@ -103729,14 +103595,7 @@ "see" : "", "exceptions" : "", "requires" : "", - "params" : [ - { - "name" : "deep", - "type" : "Boolean", - "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", - "isOptional" : false - } - ], + "params" : [], "returns" : [] }, { @@ -104010,48 +103869,10 @@ { "name" : "show", "type" : "function", - "desc" : "Displays this menu relative to another element", - "sig" : "(element, position, parentMenu)", - "static" : false, - "memberOf" : "", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "showAt", - "type" : "function", - "desc" : "Displays this menu at a specific xy position", - "sig" : "(xyPosition, parentMenu)", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "", + "memberOf" : "Roo.bootstrap.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, @@ -104061,3331 +103882,7 @@ "see" : "", "exceptions" : "", "requires" : "", - "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" : "tooltipEl", - "type" : "function", - "desc" : "Fetch the element to display the tooltip on.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : [] - } - ] - }, - "Roo.bootstrap.MenuItem" : { - "props" : [ - { - "name" : "actionMode", - "type" : "String", - "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", - "memberOf" : "Roo.Component" - }, - { - "name" : "active", - "type" : "Boolean", - "desc" : "used on sidebars to highlight active itesm", - "memberOf" : "" - }, - { - "name" : "allowDomMove", - "type" : "Boolean", - "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component" - }, - { - "name" : "can_build_overlaid", - "type" : "Boolean", - "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "cls", - "type" : "String", - "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "container_method", - "type" : "string", - "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "dataId", - "type" : "string", - "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "disableClass", - "type" : "String", - "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component" - }, - { - "name" : "fa", - "type" : "String", - "desc" : "favicon to show on left of menu item.", - "memberOf" : "" - }, - { - "name" : "hideMode", - "type" : "String", - "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", - "memberOf" : "Roo.Component" - }, - { - "name" : "href", - "type" : "String", - "desc" : "the link", - "memberOf" : "" - }, - { - "name" : "html", - "type" : "String", - "desc" : "the menu label", - "memberOf" : "" - }, - { - "name" : "isContainer", - "type" : "Boolean", - "desc" : "is it a container - just returns a drop down item..", - "memberOf" : "" - }, - { - "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" - }, - { - "name" : "menu", - "type" : "Roo.bootsrap.Menu", - "desc" : "the child menu.", - "memberOf" : "" - }, - { - "name" : "name", - "type" : "string", - "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "preventDefault", - "type" : "Boolean", - "desc" : "do not trigger A href on clicks (default false).", - "memberOf" : "" - }, - { - "name" : "style", - "type" : "String", - "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "tooltip", - "type" : "string", - "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "visibilityEl", - "type" : "string|object", - "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "xattr", - "type" : "Object", - "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component" - } - ], - "events" : [ - { - "name" : "beforedestroy", - "type" : "function", - "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforehide", - "type" : "function", - "desc" : "Fires before the component is hidden. Return false to stop the hide.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforerender", - "type" : "function", - "desc" : "Fires before the component is rendered. Return false to stop the render.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforeshow", - "type" : "function", - "desc" : "Fires before the component is shown. Return false to stop the show.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "childrenrendered", - "type" : "function", - "desc" : "Fires when the children have been rendered..", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.bootstrap.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "click", - "type" : "function", - "desc" : "The raw click event for the entire grid.", - "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.bootstrap.MenuItem", - "desc" : "", - "isOptional" : false - }, - { - "name" : "e", - "type" : "Roo.EventObject", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "destroy", - "type" : "function", - "desc" : "Fires after the component is destroyed.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "disable", - "type" : "function", - "desc" : "Fires after the component is disabled.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "enable", - "type" : "function", - "desc" : "Fires after the component is enabled.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "hide", - "type" : "function", - "desc" : "Fires after the component is hidden.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "render", - "type" : "function", - "desc" : "Fires after the component is rendered.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "show", - "type" : "function", - "desc" : "Fires after the component is shown.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - } - ], - "methods" : [ - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "object", - "type" : "Object", - "desc" : "The object with the events defined", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "destroy", - "type" : "function", - "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "disable", - "type" : "function", - "desc" : "Disable this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "enable", - "type" : "function", - "desc" : "Enable this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "focus", - "type" : "function", - "desc" : "Try to focus this component.", - "sig" : "(selectText)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "selectText", - "type" : "Boolean", - "desc" : "True to also select the text in this component (if applicable)", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "getChildContainer", - "type" : "function", - "desc" : "Fetch the element to add children to", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "name" : "getEl", - "type" : "function", - "desc" : "Returns the underlying {@link Roo.Element}.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "The element" - } - ] - }, - { - "name" : "getId", - "type" : "function", - "desc" : "Returns the id of this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "String", - "desc" : "" - } - ] - }, - { - "name" : "getVisibilityEl", - "type" : "function", - "desc" : "Get the element that will be used to show or hide", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "hide", - "type" : "function", - "desc" : "Hide a component - adds 'hidden' class", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "initEvents", - "type" : "function", - "desc" : "Initialize Events for the element", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "isVisible", - "type" : "function", - "desc" : "Returns true if this component is visible.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "o", - "type" : "Observable", - "desc" : "The Observable to release", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "removeListener", - "type" : "function", - "desc" : "Removes a listener", - "sig" : "(eventName, handler, scope)", - "static" : false, - "memberOf" : "Roo.util.Observable", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "render", - "type" : "function", - "desc" : "If this is a lazy rendering component, render it to its container element.", - "sig" : "(container)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "container", - "type" : "String/HTMLElement/Element", - "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "setDisabled", - "type" : "function", - "desc" : "Convenience function for setting disabled/enabled by boolean.", - "sig" : "(disabled)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "disabled", - "type" : "Boolean", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "setVisibilityEl", - "type" : "function", - "desc" : "Set the element that will be used to show or hide", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "setVisible", - "type" : "function", - "desc" : "Convenience function to hide or show this component by boolean.", - "sig" : "(visible)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "visible", - "type" : "Boolean", - "desc" : "True to show, false to hide", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "show", - "type" : "function", - "desc" : "Show a component - removes 'hidden' class", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "tooltipEl", - "type" : "function", - "desc" : "Fetch the element to display the tooltip on.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : [] - } - ] - }, - "Roo.bootstrap.MenuMgr" : { - "props" : [], - "events" : [], - "methods" : [ - { - "name" : "get", - "type" : "function", - "desc" : "Returns a {@link Roo.menu.Menu} object", - "sig" : "(menu)", - "static" : false, - "memberOf" : "", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "menu", - "type" : "String/Object", - "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "hideAll", - "type" : "function", - "desc" : "Hides all menus that are currently visible", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - } - ] - }, - "Roo.bootstrap.MenuSeparator" : { - "props" : [ - { - "name" : "actionMode", - "type" : "String", - "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", - "memberOf" : "Roo.Component" - }, - { - "name" : "allowDomMove", - "type" : "Boolean", - "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component" - }, - { - "name" : "can_build_overlaid", - "type" : "Boolean", - "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "cls", - "type" : "String", - "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "container_method", - "type" : "string", - "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "dataId", - "type" : "string", - "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "disableClass", - "type" : "String", - "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component" - }, - { - "name" : "hideMode", - "type" : "String", - "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", - "memberOf" : "Roo.Component" - }, - { - "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" - }, - { - "name" : "name", - "type" : "string", - "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "style", - "type" : "String", - "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "tooltip", - "type" : "string", - "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "visibilityEl", - "type" : "string|object", - "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "xattr", - "type" : "Object", - "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component" - } - ], - "events" : [ - { - "name" : "beforedestroy", - "type" : "function", - "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforehide", - "type" : "function", - "desc" : "Fires before the component is hidden. Return false to stop the hide.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforerender", - "type" : "function", - "desc" : "Fires before the component is rendered. Return false to stop the render.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforeshow", - "type" : "function", - "desc" : "Fires before the component is shown. Return false to stop the show.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "childrenrendered", - "type" : "function", - "desc" : "Fires when the children have been rendered..", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.bootstrap.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "destroy", - "type" : "function", - "desc" : "Fires after the component is destroyed.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "disable", - "type" : "function", - "desc" : "Fires after the component is disabled.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "enable", - "type" : "function", - "desc" : "Fires after the component is enabled.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "hide", - "type" : "function", - "desc" : "Fires after the component is hidden.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "render", - "type" : "function", - "desc" : "Fires after the component is rendered.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "show", - "type" : "function", - "desc" : "Fires after the component is shown.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - } - ], - "methods" : [ - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "object", - "type" : "Object", - "desc" : "The object with the events defined", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "destroy", - "type" : "function", - "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "disable", - "type" : "function", - "desc" : "Disable this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "enable", - "type" : "function", - "desc" : "Enable this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "focus", - "type" : "function", - "desc" : "Try to focus this component.", - "sig" : "(selectText)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "selectText", - "type" : "Boolean", - "desc" : "True to also select the text in this component (if applicable)", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "getChildContainer", - "type" : "function", - "desc" : "Fetch the element to add children to", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "name" : "getEl", - "type" : "function", - "desc" : "Returns the underlying {@link Roo.Element}.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "The element" - } - ] - }, - { - "name" : "getId", - "type" : "function", - "desc" : "Returns the id of this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "String", - "desc" : "" - } - ] - }, - { - "name" : "getVisibilityEl", - "type" : "function", - "desc" : "Get the element that will be used to show or hide", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "hide", - "type" : "function", - "desc" : "Hide a component - adds 'hidden' class", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "initEvents", - "type" : "function", - "desc" : "Initialize Events for the element", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "isVisible", - "type" : "function", - "desc" : "Returns true if this component is visible.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "o", - "type" : "Observable", - "desc" : "The Observable to release", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "removeListener", - "type" : "function", - "desc" : "Removes a listener", - "sig" : "(eventName, handler, scope)", - "static" : false, - "memberOf" : "Roo.util.Observable", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "render", - "type" : "function", - "desc" : "If this is a lazy rendering component, render it to its container element.", - "sig" : "(container)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "container", - "type" : "String/HTMLElement/Element", - "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "setDisabled", - "type" : "function", - "desc" : "Convenience function for setting disabled/enabled by boolean.", - "sig" : "(disabled)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "disabled", - "type" : "Boolean", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "setVisibilityEl", - "type" : "function", - "desc" : "Set the element that will be used to show or hide", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "setVisible", - "type" : "function", - "desc" : "Convenience function to hide or show this component by boolean.", - "sig" : "(visible)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "visible", - "type" : "Boolean", - "desc" : "True to show, false to hide", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "show", - "type" : "function", - "desc" : "Show a component - removes 'hidden' class", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "tooltipEl", - "type" : "function", - "desc" : "Fetch the element to display the tooltip on.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : [] - } - ] - }, - "Roo.bootstrap.MessageBar" : { - "props" : [ - { - "name" : "actionMode", - "type" : "String", - "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", - "memberOf" : "Roo.Component" - }, - { - "name" : "allowDomMove", - "type" : "Boolean", - "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component" - }, - { - "name" : "beforeClass", - "type" : "String", - "desc" : "insert the bar before the given class", - "memberOf" : "" - }, - { - "name" : "can_build_overlaid", - "type" : "Boolean", - "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "closable", - "type" : "Boolean", - "desc" : "e) default false", - "memberOf" : "" - }, - { - "name" : "cls", - "type" : "String", - "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "container_method", - "type" : "string", - "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "dataId", - "type" : "string", - "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "disableClass", - "type" : "String", - "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component" - }, - { - "name" : "fixed", - "type" : "Boolean", - "desc" : "e) default false, fix the bar at the top", - "memberOf" : "" - }, - { - "name" : "hideMode", - "type" : "String", - "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", - "memberOf" : "Roo.Component" - }, - { - "name" : "html", - "type" : "String", - "desc" : "contents of the MessageBar", - "memberOf" : "" - }, - { - "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" - }, - { - "name" : "name", - "type" : "string", - "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "style", - "type" : "String", - "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "tooltip", - "type" : "string", - "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "visibilityEl", - "type" : "string|object", - "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component" - }, - { - "name" : "weight", - "type" : "String", - "desc" : "r) default info", - "memberOf" : "" - }, - { - "name" : "xattr", - "type" : "Object", - "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component" - } - ], - "events" : [ - { - "name" : "beforedestroy", - "type" : "function", - "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforehide", - "type" : "function", - "desc" : "Fires before the component is hidden. Return false to stop the hide.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforerender", - "type" : "function", - "desc" : "Fires before the component is rendered. Return false to stop the render.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "beforeshow", - "type" : "function", - "desc" : "Fires before the component is shown. Return false to stop the show.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "childrenrendered", - "type" : "function", - "desc" : "Fires when the children have been rendered..", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.bootstrap.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "destroy", - "type" : "function", - "desc" : "Fires after the component is destroyed.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "disable", - "type" : "function", - "desc" : "Fires after the component is disabled.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "enable", - "type" : "function", - "desc" : "Fires after the component is enabled.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "hide", - "type" : "function", - "desc" : "Fires after the component is hidden.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "render", - "type" : "function", - "desc" : "Fires after the component is rendered.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "show", - "type" : "function", - "desc" : "Fires after the component is shown.", - "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component", - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "params" : [ - { - "name" : "this", - "type" : "Roo.Component", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - } - ], - "methods" : [ - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "object", - "type" : "Object", - "desc" : "The object with the events defined", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "destroy", - "type" : "function", - "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "disable", - "type" : "function", - "desc" : "Disable this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "enable", - "type" : "function", - "desc" : "Enable this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "focus", - "type" : "function", - "desc" : "Try to focus this component.", - "sig" : "(selectText)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "selectText", - "type" : "Boolean", - "desc" : "True to also select the text in this component (if applicable)", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "getChildContainer", - "type" : "function", - "desc" : "Fetch the element to add children to", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" - } - ] - }, - { - "name" : "getEl", - "type" : "function", - "desc" : "Returns the underlying {@link Roo.Element}.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "Roo.Element", - "desc" : "The element" - } - ] - }, - { - "name" : "getId", - "type" : "function", - "desc" : "Returns the id of this component.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [ - { - "name" : "", - "type" : "String", - "desc" : "" - } - ] - }, - { - "name" : "getVisibilityEl", - "type" : "function", - "desc" : "Get the element that will be used to show or hide", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "hide", - "type" : "function", - "desc" : "Hide a component - adds 'hidden' class", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "initEvents", - "type" : "function", - "desc" : "Initialize Events for the element", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "isVisible", - "type" : "function", - "desc" : "Returns true if this component is visible.", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "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, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "o", - "type" : "Observable", - "desc" : "The Observable to release", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "removeListener", - "type" : "function", - "desc" : "Removes a listener", - "sig" : "(eventName, handler, scope)", - "static" : false, - "memberOf" : "Roo.util.Observable", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "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" : "render", - "type" : "function", - "desc" : "If this is a lazy rendering component, render it to its container element.", - "sig" : "(container)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "container", - "type" : "String/HTMLElement/Element", - "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "setDisabled", - "type" : "function", - "desc" : "Convenience function for setting disabled/enabled by boolean.", - "sig" : "(disabled)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "disabled", - "type" : "Boolean", - "desc" : "", - "isOptional" : false - } - ], - "returns" : [] - }, - { - "name" : "setVisibilityEl", - "type" : "function", - "desc" : "Set the element that will be used to show or hide", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], - "returns" : [] - }, - { - "name" : "setVisible", - "type" : "function", - "desc" : "Convenience function to hide or show this component by boolean.", - "sig" : "(visible)", - "static" : false, - "memberOf" : "Roo.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [ - { - "name" : "visible", - "type" : "Boolean", - "desc" : "True to show, false to hide", - "isOptional" : false - } - ], - "returns" : [ - { - "name" : "", - "type" : "Roo.Component", - "desc" : "this" - } - ] - }, - { - "name" : "show", - "type" : "function", - "desc" : "Show a component - removes 'hidden' class", - "sig" : "()\n{\n\n}", - "static" : false, - "memberOf" : "Roo.bootstrap.Component", - "isStatic" : false, - "isConstructor" : false, - "isPrivate" : false, - "example" : "", - "deprecated" : "", - "since" : "", - "see" : "", - "exceptions" : "", - "requires" : "", - "params" : [], + "params" : [], "returns" : [] }, { @@ -116489,7 +112986,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "" }, @@ -121069,7 +117566,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "Roo.bootstrap.NavItem" }, @@ -170087,16 +166584,22 @@ "memberOf" : "Roo.bootstrap.Component" }, { - "name" : "disable", + "name" : "disableClass", + "type" : "String", + "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", + "memberOf" : "Roo.Component" + }, + { + "name" : "disabled", "type" : "Boolean", - "desc" : "e) default false", + "desc" : "is the item disabled - default false", "memberOf" : "" }, { - "name" : "disableClass", + "name" : "fa", "type" : "String", - "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component" + "desc" : "Font awesome icon", + "memberOf" : "" }, { "name" : "hideMode", @@ -170116,18 +166619,18 @@ "desc" : "text of the item", "memberOf" : "" }, - { - "name" : "icon", - "type" : "String", - "desc" : "Font awesome icon", - "memberOf" : "" - }, { "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" }, + { + "name" : "menu", + "type" : "Roo.bootsrap.Menu", + "desc" : "the child menu.", + "memberOf" : "" + }, { "name" : "name", "type" : "string", @@ -170137,13 +166640,13 @@ { "name" : "pos", "type" : "String", - "desc" : "Submenu align to (left | right) default right", + "desc" : "t) Submenu align to default right", "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", - "desc" : "e) default true", + "desc" : "stop trigger click event to parent elements - default true", "memberOf" : "" }, { @@ -170155,7 +166658,7 @@ { "name" : "submenu", "type" : "Boolean", - "desc" : "e) default false", + "desc" : "default false -", "memberOf" : "" }, { @@ -171216,6 +167719,57 @@ } ] }, + "Roo.bootstrap.menu.Manager" : { + "props" : [], + "events" : [], + "methods" : [ + { + "name" : "get", + "type" : "function", + "desc" : "Returns a {@link Roo.menu.Menu} object", + "sig" : "(menu)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "menu", + "type" : "String/Object", + "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hideAll", + "type" : "function", + "desc" : "Hides all menus that are currently visible", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + } + ] + }, "Roo.bootstrap.menu.Menu" : { "props" : [ { @@ -171224,6 +167778,12 @@ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", "memberOf" : "Roo.Component" }, + { + "name" : "align", + "type" : "String", + "desc" : "default tl-bl? == below - how the menu should be aligned.", + "memberOf" : "" + }, { "name" : "allowDomMove", "type" : "Boolean", @@ -171260,6 +167820,12 @@ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", "memberOf" : "Roo.Component" }, + { + "name" : "hidden", + "type" : "bool", + "desc" : "if the menu should be hidden when rendered.", + "memberOf" : "" + }, { "name" : "hideMode", "type" : "String", @@ -171267,15 +167833,15 @@ "memberOf" : "Roo.Component" }, { - "name" : "html", - "type" : "String", - "desc" : "Text of the menu", + "name" : "hideTrigger", + "type" : "bool", + "desc" : "e) default false - hide the carret for trigger.", "memberOf" : "" }, { - "name" : "icon", - "type" : "String", - "desc" : "Font awesome icon", + "name" : "isLink", + "type" : "bool", + "desc" : "e) the menu has link disable auto expand and collaspe (default false)", "memberOf" : "" }, { @@ -171291,9 +167857,15 @@ "memberOf" : "Roo.bootstrap.Component" }, { - "name" : "pos", - "type" : "String", - "desc" : "Menu align to (top | bottom) default bottom", + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", + "memberOf" : "" + }, + { + "name" : "stopEvent", + "type" : "bool", + "desc" : "e) Stop event after trigger press (default true)", "memberOf" : "" }, { @@ -171308,18 +167880,18 @@ "desc" : "Text for the tooltip", "memberOf" : "Roo.bootstrap.Component" }, + { + "name" : "type", + "type" : "String", + "desc" : "u) type of menu", + "memberOf" : "" + }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", "memberOf" : "Roo.bootstrap.Component" }, - { - "name" : "weight", - "type" : "String", - "desc" : "e)", - "memberOf" : "" - }, { "name" : "xattr", "type" : "Object", @@ -171351,7 +167923,7 @@ { "name" : "beforehide", "type" : "function", - "desc" : "Fires before this menu is hidden", + "desc" : "Fires before this menu is hidden (return false to block)", "sig" : "function (_self)\n{\n\n}", "memberOf" : "", "example" : "", @@ -171361,7 +167933,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", "desc" : "", "isOptional" : false } @@ -171391,7 +167963,7 @@ { "name" : "beforeshow", "type" : "function", - "desc" : "Fires before this menu is displayed", + "desc" : "Fires before this menu is displayed (return false to block)", "sig" : "function (_self)\n{\n\n}", "memberOf" : "", "example" : "", @@ -171401,7 +167973,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", "desc" : "", "isOptional" : false } @@ -171432,7 +168004,7 @@ "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, e)\n{\n\n}", + "sig" : "function (_self, menuItem, e)\n{\n\n}", "memberOf" : "", "example" : "", "deprecated" : "", @@ -171441,10 +168013,16 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "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", @@ -171527,13 +168105,103 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "itemclick", + "type" : "function", + "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", + "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" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "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" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "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" : "render", "type" : "function", @@ -171567,7 +168235,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", "desc" : "", "isOptional" : false } @@ -171952,10 +168620,10 @@ { "name" : "hide", "type" : "function", - "desc" : "Hide a component - adds 'hidden' class", - "sig" : "()\n{\n\n}", + "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", "static" : false, - "memberOf" : "Roo.bootstrap.Component", + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, @@ -171965,7 +168633,14 @@ "see" : "", "exceptions" : "", "requires" : "", - "params" : [], + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], "returns" : [] }, { @@ -172239,10 +168914,10 @@ { "name" : "show", "type" : "function", - "desc" : "Show a component - removes 'hidden' class", - "sig" : "()\n{\n\n}", + "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", "static" : false, - "memberOf" : "Roo.bootstrap.Component", + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, @@ -172252,7 +168927,58 @@ "see" : "", "exceptions" : "", "requires" : "", - "params" : [], + "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" : "showAt", + "type" : "function", + "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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" : [] }, { diff --git a/docs/src/Roo_bootstrap_Button.js.html b/docs/src/Roo_bootstrap_Button.js.html index 9e45fc939c..108bbaf7f8 100644 --- a/docs/src/Roo_bootstrap_Button.js.html +++ b/docs/src/Roo_bootstrap_Button.js.html @@ -31,7 +31,7 @@ * @cfg {Boolean} removeClass remove the standard class.. * @cfg {String} target (_self|_blank|_parent|_top|other) target for a href. * @cfg {Boolean} grpup if parent is a btn group - then it turns it into a toogleGroup. - * @cfg {Roo.bootstrap.Menu} menu a Menu + * @cfg {Roo.bootstrap.menu.Menu} menu a Menu * @constructor * Create a new button diff --git a/docs/src/Roo_bootstrap_NavItem.js.html b/docs/src/Roo_bootstrap_NavItem.js.html index 44360335ee..6bac955ca4 100644 --- a/docs/src/Roo_bootstrap_NavItem.js.html +++ b/docs/src/Roo_bootstrap_NavItem.js.html @@ -1,14 +1,9 @@ -Roo/bootstrap/NavItem.js/* - * - LGPL - * - * row - * - */ - -/** +Roo/bootstrap/NavItem.js/** * @class Roo.bootstrap.NavItem * @extends Roo.bootstrap.Component + * @licence LGPL * Bootstrap Navbar.NavItem class + * * @cfg {String} href link to * @cfg {String} button_weight (default|primary|secondary|success|info|warning|danger|link|light|dark) default none * @cfg {Boolean} button_outline show and outlined button @@ -25,7 +20,7 @@ * @cfg {String} tabId the tab that this item activates. * @cfg {String} tagtype (a|span) render as a href or span? * @cfg {Boolean} animateRef (true|false) link to element default false - * @cfg {Roo.bootstrap.Menu} menu a Menu + * @cfg {Roo.bootstrap.menu.Menu} menu a Menu * @constructor * Create a new Navbar Item diff --git a/docs/src/Roo_bootstrap_htmleditor_ToolbarStandard.js.html b/docs/src/Roo_bootstrap_htmleditor_ToolbarStandard.js.html index d60c6e38e5..113dccf291 100644 --- a/docs/src/Roo_bootstrap_htmleditor_ToolbarStandard.js.html +++ b/docs/src/Roo_bootstrap_htmleditor_ToolbarStandard.js.html @@ -246,7 +246,7 @@ // hides menus... - so this cant be on a menu... Roo.bootstrap.MenuMgr.hideAll(); */ - Roo.bootstrap.MenuMgr.hideAll(); + Roo.bootstrap.menu.Manager.hideAll(); //this.editorsyncValue(); }, onFirstFocus: function() { diff --git a/docs/src/Roo_bootstrap_menu_Item.js.html b/docs/src/Roo_bootstrap_menu_Item.js.html index 6186557efd..d0f1d110fb 100644 --- a/docs/src/Roo_bootstrap_menu_Item.js.html +++ b/docs/src/Roo_bootstrap_menu_Item.js.html @@ -1,26 +1,20 @@ -Roo/bootstrap/menu/Item.js/* - * - LGPL - * - * menu item - * - */ -Roo.bootstrap.menu = Roo.bootstrap.menu || {}; - -/** +Roo/bootstrap/menu/Item.js /** * @class Roo.bootstrap.menu.Item * @extends Roo.bootstrap.Component + * @licence LGPL * Bootstrap MenuItem class - * @cfg {Boolean} submenu (true | false) default false + * @cfg {Boolean} submenu default false - * @cfg {String} html text of the item * @cfg {String} href the link - * @cfg {Boolean} disable (true | false) default false - * @cfg {Boolean} preventDefault (true | false) default true - * @cfg {String} icon Font awesome icon - * @cfg {String} pos Submenu align to (left | right) default right - * + * @cfg {Boolean} disabled is the item disabled - default false + * @cfg {Boolean} preventDefault stop trigger click event to parent elements - default true + * @cfg {String} fa Font awesome icon + * @cfg {String} pos (left|right) Submenu align to default right + * @cfg {Roo.bootsrap.Menu} menu the child menu. + * * @constructor - * Create a new Item + * Create a new Menu Item * @param {Object} config The config object */ @@ -59,54 +53,85 @@ html : '', preventDefault: true, disable : false, - icon : false, + active : false, + fa : false, pos : 'right', + isContainer : false, // ?? only a <li drowdonw-menu-item"> + getAutoCreate : function() { - var text = [ - { - tag : 'span', - cls : 'roo-menu-item-text', - html : this.html - } - ]; - - if(this.icon){ - text.unshift({ - tag : 'i', - cls : 'fa ' + this.icon - }) + + if(this.isContainer){ + return { + tag: 'li', + cls: 'dropdown-menu-item ' + }; } - var cfg = { - tag : 'li', - cn : [ - { - tag : 'a', - href : this.href || '#', - cn : text - } - ] + var ctag = { + tag: 'span', + cls : 'roo-menu-item-text', + html : this.html + }; + + var anc = { + tag : 'a', + cls : 'dropdown-item', + href : this.href || '#', + cn : [ ] }; - if(this.disable){ - cfg.cls = (typeof(cfg.cls) == 'undefined') ? 'disabled' : (cfg.cls + ' disabled'); + if (this.fa !== false) { + anc.cn.push({ + tag : 'i', + cls : 'fa fa-' + this.fa + }); + } + + anc.cn.push(ctag); + + + var cfg= { + tag: 'li', + cls: 'dropdown-menu-item', + cn: [ anc ] + }; + if (this.parent().type == 'treeview') { + cfg.cls = 'treeview-menu'; } + if (this.active) { + cfg.cls += ' active'; + } + + if(this.disabled){ + cfg.cls += ' disabled' + } if(this.submenu){ - cfg.cls = (typeof(cfg.cls) == 'undefined') ? 'dropdown-submenu' : (cfg.cls + ' dropdown-submenu'); + cfg.cls += 'dropdown-submenu'; if(this.pos == 'left'){ - cfg.cls = (typeof(cfg.cls) == 'undefined') ? 'pull-left' : (cfg.cls + ' pull-left'); + cfg.cls += ' pull-left'; } } - + anc.href = this.href || cfg.cn[0].href ; + ctag.html = this.html || cfg.cn[0].html ; return cfg; + + }, initEvents : function() { + if (this.parent().type == 'treeview') { + this.el.select('a').on('click', this.onClick, this); + } + if (this.menu) { + this.menu.parentType = this.xtype; + this.menu.triggerEl = this.el; + this.menu = this.addxtype(Roo.apply({}, this.menu)); + } this.el.on('mouseover', this.onMouseOver, this); this.el.on('mouseout', this.onMouseOut, this); diff --git a/docs/src/Roo_bootstrap_menu_Menu.js.html b/docs/src/Roo_bootstrap_menu_Menu.js.html index 36e4762f64..31ac804a66 100644 --- a/docs/src/Roo_bootstrap_menu_Menu.js.html +++ b/docs/src/Roo_bootstrap_menu_Menu.js.html @@ -1,223 +1,476 @@ -Roo/bootstrap/menu/Menu.js/* - * - LGPL - * - * menu - * - */ -Roo.bootstrap.menu = Roo.bootstrap.menu || {}; - -/** +Roo/bootstrap/menu/Menu.js +/** * @class Roo.bootstrap.menu.Menu * @extends Roo.bootstrap.Component - * Bootstrap Menu class - container for Menu - * @cfg {String} html Text of the menu - * @cfg {String} weight (default | primary | success | info | warning | danger | inverse) - * @cfg {String} icon Font awesome icon - * @cfg {String} pos Menu align to (top | bottom) default bottom - * + * @licence LGPL + * @children Roo.bootstrap.menu.Item + * Bootstrap Menu class - container for MenuItems * + * @cfg {String} type (dropdown|treeview|submenu) type of menu + * @cfg {bool} hidden if the menu should be hidden when rendered. + * @cfg {bool} stopEvent (true|false) Stop event after trigger press (default true) + * @cfg {bool} isLink (true|false) the menu has link disable auto expand and collaspe (default false) + * @cfg {bool} hideTrigger (true|false) default false - hide the carret for trigger. + * @cfg {String} align default tl-bl? == below - how the menu should be aligned. + * @constructor * Create a new Menu - * @param {Object} config The config object + * @param {Object} config The config objectQ */ Roo.bootstrap.menu.Menu = function(config){ + + if (config.type == 'treeview') { + // normally menu's are drawn attached to the document to handle layering etc.. + // however treeview (used by the docs menu is drawn into the parent element) + this.container_method = 'getChildContainer'; + } + Roo.bootstrap.menu.Menu.superclass.constructor.call(this, config); + if (this.registerMenu && this.type != 'treeview') { + Roo.bootstrap.menu.Manager.register(this); + } + this.addEvents({ /** * @event beforeshow - * Fires before this menu is displayed - * @param {Roo.bootstrap.menu.Menu} this + * Fires before this menu is displayed (return false to block) + * @param {Roo.menu.Menu} this */ beforeshow : true, /** * @event beforehide - * Fires before this menu is hidden - * @param {Roo.bootstrap.menu.Menu} this + * Fires before this menu is hidden (return false to block) + * @param {Roo.menu.Menu} this */ beforehide : true, /** * @event show * Fires after this menu is displayed - * @param {Roo.bootstrap.menu.Menu} this + * @param {Roo.menu.Menu} this */ show : true, /** * @event hide * Fires after this menu is hidden - * @param {Roo.bootstrap.menu.Menu} this + * @param {Roo.menu.Menu} this */ hide : true, /** * @event click * Fires when this menu is clicked (or when the enter key is pressed while it is active) - * @param {Roo.bootstrap.menu.Menu} this + * @param {Roo.menu.Menu} this + * @param {Roo.menu.Item} menuItem The menu item that was clicked + * @param {Roo.EventObject} e + */ + click : true, + /** + * @event mouseover + * Fires when the mouse is hovering over this menu + * @param {Roo.menu.Menu} this + * @param {Roo.EventObject} e + * @param {Roo.menu.Item} menuItem The menu item that was clicked + */ + mouseover : true, + /** + * @event mouseout + * Fires when the mouse exits this menu + * @param {Roo.menu.Menu} this + * @param {Roo.EventObject} e + * @param {Roo.menu.Item} menuItem The menu item that was clicked + */ + mouseout : true, + /** + * @event itemclick + * Fires when a menu item contained in this menu is clicked + * @param {Roo.menu.BaseItem} baseItem The BaseItem that was clicked * @param {Roo.EventObject} e */ - click : true + itemclick: true }); - + this.menuitems = new Roo.util.MixedCollection(false, function(o) { return o.el.id; }); }; Roo.extend(Roo.bootstrap.menu.Menu, Roo.bootstrap.Component, { - submenu : false, - html : '', - weight : 'default', - icon : false, - pos : 'bottom', + /// html : false, + + triggerEl : false, // is this set by component builder? -- it should really be fetched from parent()??? + type: false, + /** + * @cfg {Boolean} registerMenu True (default) - means that clicking on screen etc. hides it. + */ + registerMenu : true, + + menuItems :false, // stores the menu items.. + + hidden:true, + + parentMenu : false, + + stopEvent : true, + + isLink : false, + + container_method : 'getDocumentBody', // so the menu is rendered on the body and zIndex works. + + hideTrigger : false, + + align : 'tl-bl?', getChildContainer : function() { - if(this.isSubMenu){ - return this.el; + return this.el; + }, + + getAutoCreate : function(){ + + //if (['right'].indexOf(this.align)!==-1) { + // cfg.cn[1].cls += ' pull-right' + //} + + var cfg = { + tag : 'ul', + cls : 'dropdown-menu shadow' , + style : 'z-index:1000' + + }; + + if (this.type === 'submenu') { + cfg.cls = 'submenu active'; + } + if (this.type === 'treeview') { + cfg.cls = 'treeview-menu'; } - return this.el.select('ul.dropdown-menu', true).first(); + return cfg; }, + initEvents : function() { - getAutoCreate : function() - { - var text = [ - { - tag : 'span', - cls : 'roo-menu-text', - html : this.html - } - ]; + // Roo.log("ADD event"); + // Roo.log(this.triggerEl.dom); + if (this.triggerEl) { - if(this.icon){ - text.unshift({ - tag : 'i', - cls : 'fa ' + this.icon - }) - } + this.triggerEl.on('click', this.onTriggerClick, this); + this.triggerEl.on(Roo.isTouch ? 'touchstart' : 'mouseup', this.onTriggerPress, this); - var cfg = { - tag : 'div', - cls : 'btn-group', - cn : [ - { - tag : 'button', - cls : 'dropdown-button btn btn-' + this.weight, - cn : text - }, - { - tag : 'button', - cls : 'dropdown-toggle btn btn-' + this.weight, - cn : [ - { - tag : 'span', - cls : 'caret' - } - ] - }, - { - tag : 'ul', - cls : 'dropdown-menu' - } - ] - - }; - - if(this.pos == 'top'){ - cfg.cls += ' dropup'; - } - - if(this.isSubMenu){ - cfg = { - tag : 'ul', - cls : 'dropdown-menu' - } + if (!this.hideTrigger) { + if (this.triggerEl.hasClass('nav-item') && this.triggerEl.select('.nav-link',true).length) { + // dropdown toggle on the 'a' in BS4? + this.triggerEl.select('.nav-link',true).first().addClass('dropdown-toggle'); + } else { + this.triggerEl.addClass('dropdown-toggle'); + } + } } - return cfg; + if (Roo.isTouch) { + this.el.on('touchstart' , this.onTouch, this); + } + this.el.on('click' , this.onClick, this); + + this.el.on("mouseover", this.onMouseOver, this); + this.el.on("mouseout", this.onMouseOut, this); + }, - onRender : function(ct, position) + findTargetItem : function(e) { - this.isSubMenu = ct.hasClass('dropdown-submenu'); + var t = e.getTarget(".dropdown-menu-item", this.el, true); + if(!t){ + return false; + } + //Roo.log(t); Roo.log(t.id); + if(t && t.id){ + //Roo.log(this.menuitems); + return this.menuitems.get(t.id); + + //return this.items.get(t.menuItemId); + } + + return false; + }, - Roo.bootstrap.menu.Menu.superclass.onRender.call(this, ct, position); + onTouch : function(e) + { + Roo.log("menu.onTouch"); + //e.stopEvent(); this make the user popdown broken + this.onClick(e); }, - initEvents : function() + onClick : function(e) { - if(this.isSubMenu){ + Roo.log("menu.onClick"); + + var t = this.findTargetItem(e); + if(!t || t.isContainer){ return; } + Roo.log(e); + /* + if (Roo.isTouch && e.type == 'touchstart' && t.menu && !t.disabled) { + if(t == this.activeItem && t.shouldDeactivate(e)){ + this.activeItem.deactivate(); + delete this.activeItem; + return; + } + if(t.canActivate){ + this.setActiveItem(t, true); + } + return; + + + } + */ + + Roo.log('pass click event'); + + t.onClick(e); + + this.fireEvent("click", this, t, e); + + var _this = this; - this.hidden = true; + if(!t.href.length || t.href == '#'){ + (function() { _this.hide(); }).defer(100); + } - this.triggerEl = this.el.select('button.dropdown-toggle', true).first(); - this.triggerEl.on('click', this.onTriggerPress, this); + }, - this.buttonEl = this.el.select('button.dropdown-button', true).first(); - this.buttonEl.on('click', this.onClick, this); + onMouseOver : function(e){ + var t = this.findTargetItem(e); + //Roo.log(t); + //if(t){ + // if(t.canActivate && !t.disabled){ + // this.setActiveItem(t, true); + // } + //} + this.fireEvent("mouseover", this, e, t); + }, + isVisible : function(){ + return !this.hidden; + }, + onMouseOut : function(e){ + var t = this.findTargetItem(e); + + //if(t ){ + // if(t == this.activeItem && t.shouldDeactivate(e)){ + // this.activeItem.deactivate(); + // delete this.activeItem; + // } + //} + this.fireEvent("mouseout", this, e, t); }, - list : function() + + /** + * Displays this menu relative to another element + * @param {String/HTMLElement/Roo.Element} element The element to align to + * @param {String} position (optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to + * the element (defaults to this.defaultAlign) + * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined) + */ + show : function(el, pos, parentMenu) { - if(this.isSubMenu){ - return this.el; + if (false === this.fireEvent("beforeshow", this)) { + Roo.log("show canceled"); + return; + } + this.parentMenu = parentMenu; + if(!this.el){ + this.render(); } + this.el.addClass('show'); // show otherwise we do not know how big we are.. + + var xy = this.el.getAlignToXY(el, pos); - return this.el.select('ul.dropdown-menu', true).first(); + // bl-tl << left align below + // tl-bl << left align + + if(this.el.getWidth() + xy[0] >= Roo.lib.Dom.getViewWidth()){ + // if it goes to far to the right.. -> align left. + xy = this.el.getAlignToXY(el, this.align.replace('/l/g', 'r')) + } + if(xy[0] < 0){ + // was left align - go right? + xy = this.el.getAlignToXY(el, this.align.replace('/r/g', 'l')) + } + + // goes down the bottom + if(this.el.getHeight() + xy[1] >= Roo.lib.Dom.getViewHeight() || + xy[1] < 0 ){ + var a = this.align.replace('?', '').split('-'); + xy = this.el.getAlignToXY(el, a[1] + '-' + a[0] + '?') + + } + + this.showAt( xy , parentMenu, false); }, + /** + * Displays this menu at a specific xy position + * @param {Array} xyPosition Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based) + * @param {Roo.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined) + */ + showAt : function(xy, parentMenu, /* private: */_e){ + this.parentMenu = parentMenu; + if(!this.el){ + this.render(); + } + if(_e !== false){ + this.fireEvent("beforeshow", this); + //xy = this.el.adjustForConstraints(xy); + } - onClick : function(e) - { - this.fireEvent("click", this, e); + //this.el.show(); + this.hideMenuItems(); + this.hidden = false; + if (this.triggerEl) { + this.triggerEl.addClass('open'); + } + + this.el.addClass('show'); + + + + // reassign x when hitting right + + // reassign y when hitting bottom + + // but the list may align on trigger left or trigger top... should it be a properity? + + if(this.el.getStyle('top') != 'auto' && this.el.getStyle('top').slice(-1) != "%"){ + this.el.setXY(xy); + } + + this.focus(); + this.fireEvent("show", this); }, - onTriggerPress : function(e) + focus : function(){ + return; + if(!this.hidden){ + this.doFocus.defer(50, this); + } + }, + + doFocus : function(){ + if(!this.hidden){ + this.focusEl.focus(); + } + }, + + /** + * Hides this menu and optionally all parent menus + * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false) + */ + hide : function(deep) { - if (this.isVisible()) { - this.hide(); - } else { - this.show(); + if (false === this.fireEvent("beforehide", this)) { + Roo.log("hide canceled"); + return; + } + this.hideMenuItems(); + if(this.el && this.isVisible()){ + + if(this.activeItem){ + this.activeItem.deactivate(); + this.activeItem = null; + } + if (this.triggerEl) { + this.triggerEl.removeClass('open'); + } + + this.el.removeClass('show'); + this.hidden = true; + this.fireEvent("hide", this); + } + if(deep === true && this.parentMenu){ + this.parentMenu.hide(true); } }, - isVisible : function(){ - return !this.hidden; + onTriggerClick : function(e) + { + Roo.log('trigger click'); + + var target = e.getTarget(); + + Roo.log(target.nodeName.toLowerCase()); + + if(target.nodeName.toLowerCase() === 'i'){ + e.preventDefault(); + } + }, - show : function() + onTriggerPress : function(e) { - this.fireEvent("beforeshow", this); + Roo.log('trigger press'); + //Roo.log(e.getTarget()); + // Roo.log(this.triggerEl.dom); + + // trigger only occurs on normal menu's -- if it's a treeview or dropdown... do not hide/show.. + var pel = Roo.get(e.getTarget()); + if (pel.findParent('.dropdown-menu') || pel.findParent('.treeview-menu') ) { + Roo.log('is treeview or dropdown?'); + return; + } - this.hidden = false; - this.el.addClass('open'); + if(e.getTarget().nodeName.toLowerCase() !== 'i' && this.isLink){ + return; + } - Roo.get(document).on("mouseup", this.onMouseUp, this); + if (this.isVisible()) { + Roo.log('hide'); + this.hide(); + } else { + Roo.log('show'); - this.fireEvent("show", this); + this.show(this.triggerEl, this.align, false); + } + if(this.stopEvent || e.getTarget().nodeName.toLowerCase() === 'i'){ + e.stopEvent(); + } }, - hide : function() + + hideMenuItems : function() { - this.fireEvent("beforehide", this); + Roo.log("hide Menu Items"); + if (!this.el) { + return; + } - this.hidden = true; - this.el.removeClass('open'); + this.el.select('.open',true).each(function(aa) { - Roo.get(document).un("mouseup", this.onMouseUp); + aa.removeClass('open'); - this.fireEvent("hide", this); + }); }, + addxtypeChild : function (tree, cntr) { + var comp= Roo.bootstrap.menu.Menu.superclass.addxtypeChild.call(this, tree, cntr); + + this.menuitems.add(comp); + return comp; - onMouseUp : function() + }, + getEl : function() { - this.hide(); - } + Roo.log(this.el); + return this.el; + }, + clear : function() + { + this.getEl().dom.innerHTML = ''; + this.menuitems.clear(); + } }); diff --git a/docs/src/Roo_bootstrap_menu_Separator.js.html b/docs/src/Roo_bootstrap_menu_Separator.js.html index 050934a055..4e8d030846 100644 --- a/docs/src/Roo_bootstrap_menu_Separator.js.html +++ b/docs/src/Roo_bootstrap_menu_Separator.js.html @@ -1,14 +1,8 @@ -Roo/bootstrap/menu/Separator.js/* - * - LGPL - * - * menu separator - * - */ -Roo.bootstrap.menu = Roo.bootstrap.menu || {}; - -/** +Roo/bootstrap/menu/Separator.js +/** * @class Roo.bootstrap.menu.Separator * @extends Roo.bootstrap.Component + * @licence LGPL * Bootstrap Separator class * * @constructor diff --git a/docs/symbols/Roo.bootstrap.Button.json b/docs/symbols/Roo.bootstrap.Button.json index 009b14224c..f1c6e104ee 100644 --- a/docs/symbols/Roo.bootstrap.Button.json +++ b/docs/symbols/Roo.bootstrap.Button.json @@ -244,7 +244,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "" } diff --git a/docs/symbols/Roo.bootstrap.ButtonUploader.json b/docs/symbols/Roo.bootstrap.ButtonUploader.json index d1d5323e1d..499c8192ab 100644 --- a/docs/symbols/Roo.bootstrap.ButtonUploader.json +++ b/docs/symbols/Roo.bootstrap.ButtonUploader.json @@ -263,7 +263,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "Roo.bootstrap.Button" } diff --git a/docs/symbols/Roo.bootstrap.CardUploader.json b/docs/symbols/Roo.bootstrap.CardUploader.json index 2915b2d322..5145edd41c 100644 --- a/docs/symbols/Roo.bootstrap.CardUploader.json +++ b/docs/symbols/Roo.bootstrap.CardUploader.json @@ -257,7 +257,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "Roo.bootstrap.Button" } diff --git a/docs/symbols/Roo.bootstrap.NavItem.json b/docs/symbols/Roo.bootstrap.NavItem.json index 06f099634d..0b9edb6b62 100644 --- a/docs/symbols/Roo.bootstrap.NavItem.json +++ b/docs/symbols/Roo.bootstrap.NavItem.json @@ -76,7 +76,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "" }, diff --git a/docs/symbols/Roo.bootstrap.NavSidebarItem.json b/docs/symbols/Roo.bootstrap.NavSidebarItem.json index 6a96b864bd..363c2c445d 100644 --- a/docs/symbols/Roo.bootstrap.NavSidebarItem.json +++ b/docs/symbols/Roo.bootstrap.NavSidebarItem.json @@ -77,7 +77,7 @@ }, { "name" : "menu", - "type" : "Roo.bootstrap.Menu", + "type" : "Roo.bootstrap.menu.Menu", "desc" : "a Menu", "memberOf" : "Roo.bootstrap.NavItem" }, diff --git a/docs/symbols/Roo.bootstrap.menu.Item.json b/docs/symbols/Roo.bootstrap.menu.Item.json index 13474f2838..1a992361b4 100644 --- a/docs/symbols/Roo.bootstrap.menu.Item.json +++ b/docs/symbols/Roo.bootstrap.menu.Item.json @@ -50,6 +50,12 @@ "desc" : "t) What element to use for visibility (@see getVisibilityEl())", "memberOf" : "Roo.bootstrap.Component" }, + { + "name" : "menu", + "type" : "Roo.bootsrap.Menu", + "desc" : "the child menu.", + "memberOf" : "" + }, { "name" : "can_build_overlaid", "type" : "Boolean", @@ -62,6 +68,12 @@ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", "memberOf" : "Roo.Component" }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "is the item disabled - default false", + "memberOf" : "" + }, { "name" : "style", "type" : "String", @@ -83,13 +95,13 @@ { "name" : "preventDefault", "type" : "Boolean", - "desc" : "e) default true", + "desc" : "stop trigger click event to parent elements - default true", "memberOf" : "" }, { "name" : "pos", "type" : "String", - "desc" : "Submenu align to (left | right) default right", + "desc" : "t) Submenu align to default right", "memberOf" : "" }, { @@ -101,13 +113,7 @@ { "name" : "submenu", "type" : "Boolean", - "desc" : "e) default false", - "memberOf" : "" - }, - { - "name" : "disable", - "type" : "Boolean", - "desc" : "e) default false", + "desc" : "default false -", "memberOf" : "" }, { @@ -122,18 +128,18 @@ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", "memberOf" : "Roo.Component" }, - { - "name" : "icon", - "type" : "String", - "desc" : "Font awesome icon", - "memberOf" : "" - }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", "memberOf" : "Roo.bootstrap.Component" }, + { + "name" : "fa", + "type" : "String", + "desc" : "Font awesome icon", + "memberOf" : "" + }, { "name" : "name", "type" : "string", diff --git a/docs/symbols/Roo.bootstrap.menu.Menu.json b/docs/symbols/Roo.bootstrap.menu.Menu.json index 6ed529cb02..92977071fc 100644 --- a/docs/symbols/Roo.bootstrap.menu.Menu.json +++ b/docs/symbols/Roo.bootstrap.menu.Menu.json @@ -5,7 +5,7 @@ "Roo.Component", "Roo.util.Observable" ], - "desc" : "Bootstrap Menu class - container for Menu", + "desc" : "Bootstrap Menu class - container for MenuItems", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, @@ -18,7 +18,7 @@ { "name" : "config", "type" : "Object", - "desc" : "The config object", + "desc" : "The config objectQ", "isOptional" : false } ], @@ -26,6 +26,12 @@ "throws" : "", "requires" : "", "config" : [ + { + "name" : "isLink", + "type" : "bool", + "desc" : "e) the menu has link disable auto expand and collaspe (default false)", + "memberOf" : "" + }, { "name" : "listeners", "type" : "Object", @@ -50,6 +56,18 @@ "desc" : "t) What element to use for visibility (@see getVisibilityEl())", "memberOf" : "Roo.bootstrap.Component" }, + { + "name" : "align", + "type" : "String", + "desc" : "default tl-bl? == below - how the menu should be aligned.", + "memberOf" : "" + }, + { + "name" : "hidden", + "type" : "bool", + "desc" : "if the menu should be hidden when rendered.", + "memberOf" : "" + }, { "name" : "can_build_overlaid", "type" : "Boolean", @@ -62,6 +80,12 @@ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", "memberOf" : "Roo.Component" }, + { + "name" : "stopEvent", + "type" : "bool", + "desc" : "e) Stop event after trigger press (default true)", + "memberOf" : "" + }, { "name" : "style", "type" : "String", @@ -74,18 +98,6 @@ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", "memberOf" : "Roo.Component" }, - { - "name" : "html", - "type" : "String", - "desc" : "Text of the menu", - "memberOf" : "" - }, - { - "name" : "pos", - "type" : "String", - "desc" : "Menu align to (top | bottom) default bottom", - "memberOf" : "" - }, { "name" : "cls", "type" : "String", @@ -105,9 +117,15 @@ "memberOf" : "Roo.Component" }, { - "name" : "icon", - "type" : "String", - "desc" : "Font awesome icon", + "name" : "hideTrigger", + "type" : "bool", + "desc" : "e) default false - hide the carret for trigger.", + "memberOf" : "" + }, + { + "name" : "registerMenu", + "type" : "Boolean", + "desc" : "True (default) - means that clicking on screen etc. hides it.", "memberOf" : "" }, { @@ -117,9 +135,9 @@ "memberOf" : "Roo.bootstrap.Component" }, { - "name" : "weight", + "name" : "type", "type" : "String", - "desc" : "e)", + "desc" : "u) type of menu", "memberOf" : "" }, { @@ -137,12 +155,12 @@ ], "methods" : [ { - "name" : "tooltipEl", + "name" : "hide", "type" : "function", - "desc" : "Fetch the element to display the tooltip on.", - "sig" : "()\n{\n\n}", + "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", "static" : false, - "memberOf" : "Roo.bootstrap.Component", + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, @@ -152,22 +170,23 @@ "see" : "", "exceptions" : "", "requires" : "", - "params" : [], - "returns" : [ + "params" : [ { - "name" : "", - "type" : "Roo.Element", - "desc" : "defaults to this.el" + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false } - ] + ], + "returns" : [] }, { - "name" : "hide", + "name" : "show", "type" : "function", - "desc" : "Hide a component - adds 'hidden' class", - "sig" : "()\n{\n\n}", + "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", "static" : false, - "memberOf" : "Roo.bootstrap.Component", + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, @@ -177,13 +196,64 @@ "see" : "", "exceptions" : "", "requires" : "", - "params" : [], + "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" : "show", + "name" : "showAt", + "type" : "function", + "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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" : "tooltipEl", "type" : "function", - "desc" : "Show a component - removes 'hidden' class", + "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, "memberOf" : "Roo.bootstrap.Component", @@ -197,7 +267,13 @@ "exceptions" : "", "requires" : "", "params" : [], - "returns" : [] + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] }, { "name" : "setVisibilityEl", @@ -884,7 +960,65 @@ "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, e)\n{\n\n}", + "sig" : "function (_self, menuItem, e)\n{\n\n}", + "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" : "itemclick", + "type" : "function", + "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", + "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" : "mouseout", + "type" : "function", + "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", "memberOf" : "", "example" : "", "deprecated" : "", @@ -893,7 +1027,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", "desc" : "", "isOptional" : false }, @@ -902,6 +1036,12 @@ "type" : "Roo.EventObject", "desc" : "", "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false } ], "returns" : [] @@ -909,7 +1049,7 @@ { "name" : "beforehide", "type" : "function", - "desc" : "Fires before this menu is hidden", + "desc" : "Fires before this menu is hidden (return false to block)", "sig" : "function (_self)\n{\n\n}", "memberOf" : "", "example" : "", @@ -919,7 +1059,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", "desc" : "", "isOptional" : false } @@ -929,7 +1069,7 @@ { "name" : "beforeshow", "type" : "function", - "desc" : "Fires before this menu is displayed", + "desc" : "Fires before this menu is displayed (return false to block)", "sig" : "function (_self)\n{\n\n}", "memberOf" : "", "example" : "", @@ -939,7 +1079,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", "desc" : "", "isOptional" : false } @@ -959,7 +1099,7 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", "desc" : "", "isOptional" : false } @@ -979,9 +1119,41 @@ "params" : [ { "name" : "this", - "type" : "Roo.bootstrap.menu.Menu", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "mouseover", + "type" : "function", + "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "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" : [] diff --git a/docs/tree.json b/docs/tree.json index b7e67845ca..c54ebe5377 100644 --- a/docs/tree.json +++ b/docs/tree.json @@ -555,26 +555,6 @@ "cn" : [], "is_class" : true }, - { - "name" : "Roo.bootstrap.Menu", - "cn" : [], - "is_class" : true - }, - { - "name" : "Roo.bootstrap.MenuItem", - "cn" : [], - "is_class" : true - }, - { - "name" : "Roo.bootstrap.MenuMgr", - "cn" : [], - "is_class" : true - }, - { - "name" : "Roo.bootstrap.MenuSeparator", - "cn" : [], - "is_class" : true - }, { "name" : "Roo.bootstrap.MessageBar", "cn" : [], @@ -873,6 +853,11 @@ "cn" : [], "is_class" : true }, + { + "name" : "Roo.bootstrap.menu.Manager", + "cn" : [], + "is_class" : true + }, { "name" : "Roo.bootstrap.menu.Menu", "cn" : [], diff --git a/roojs-bootstrap-debug.js b/roojs-bootstrap-debug.js index f9103833f2..2e21d952ab 100644 --- a/roojs-bootstrap-debug.js +++ b/roojs-bootstrap-debug.js @@ -1014,7 +1014,7 @@ Roo.extend(Roo.bootstrap.ButtonGroup, Roo.bootstrap.Component, { * @cfg {Boolean} removeClass remove the standard class.. * @cfg {String} target (_self|_blank|_parent|_top|other) target for a href. * @cfg {Boolean} grpup if parent is a btn group - then it turns it into a toogleGroup. - * @cfg {Roo.bootstrap.Menu} menu a Menu + * @cfg {Roo.bootstrap.menu.Menu} menu a Menu * @constructor * Create a new button @@ -3418,23 +3418,19 @@ Roo.extend(Roo.bootstrap.Header, Roo.bootstrap.Component, { - /* - * Based on: - * Ext JS Library 1.1.1 - * Copyright(c) 2006-2007, Ext JS, LLC. - * - * Originally Released Under LGPL - original licence link has changed is not relivant. - * - * Fork - LGPL - *