"Roo.Component",
"Roo.util.Observable"
],
- "desc" : "Bootstrap Menu class - container for Menu",
+ "desc" : "Bootstrap Menu class - container for MenuItems",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
{
"name" : "config",
"type" : "Object",
- "desc" : "The config object",
+ "desc" : "The config objectQ",
"isOptional" : false
}
],
"throws" : "",
"requires" : "",
"config" : [
+ {
+ "name" : "isLink",
+ "type" : "bool",
+ "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
+ "memberOf" : ""
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "default tl-bl? == below - how the menu should be aligned.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "hidden",
+ "type" : "bool",
+ "desc" : "if the menu should be hidden when rendered.",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "stopEvent",
+ "type" : "bool",
+ "desc" : "e) Stop event after trigger press (default true)",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "html",
- "type" : "String",
- "desc" : "Text of the menu",
- "memberOf" : ""
- },
- {
- "name" : "pos",
- "type" : "String",
- "desc" : "Menu align to (top | bottom) default bottom",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "Font awesome icon",
+ "name" : "hideTrigger",
+ "type" : "bool",
+ "desc" : "e) default false - hide the carret for trigger.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "registerMenu",
+ "type" : "Boolean",
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "weight",
+ "name" : "type",
"type" : "String",
- "desc" : "e)",
+ "desc" : "u) type of menu",
"memberOf" : ""
},
{
],
"methods" : [
{
- "name" : "tooltipEl",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "show",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "show",
+ "name" : "showAt",
+ "type" : "function",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
+ "desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.bootstrap.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
},
{
"name" : "setVisibilityEl",
"name" : "click",
"type" : "function",
"desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, e)\n{\n\n}",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "itemclick",
+ "type" : "function",
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
},
"type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
}
],
"returns" : []
{
"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" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
{
"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" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
}
],
"returns" : []
projects / roojs1 / blobdiff