X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fjson%2Froodata.json;h=904fcc6197ed2f95266db642fa50f81d2af71c5c;hb=a5c010ae8950880b8957d4e8d2c8279a0451f7ee;hp=ff660f497488be28c5a4899d7dd26d31dbfe1efa;hpb=bb0417ecef61b91dc7a5ebcba6168e05ad39cf54;p=roojs1 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" : [] }, {