X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.menu.BaseItem.json;fp=docs%2Fsymbols%2FRoo.menu.BaseItem.json;h=3c8c05528571e9ad8d4c981f1ccc1e2705e521ea;hp=96badcb2b840f2789435f7d02b7995bd437b45c6;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.menu.BaseItem.json b/docs/symbols/Roo.menu.BaseItem.json index 96badcb2b8..3c8c055285 100644 --- a/docs/symbols/Roo.menu.BaseItem.json +++ b/docs/symbols/Roo.menu.BaseItem.json @@ -4,10 +4,29 @@ "Roo.Component", "Roo.util.Observable" ], + "childClasses" : { + "Roo.menu.BaseItem" : [ + "Roo.menu.Adapter", + "Roo.menu.Item", + "Roo.menu.Separator", + "Roo.menu.TextItem" + ], + "Roo.menu.Adapter" : [ + "Roo.menu.ColorItem", + "Roo.menu.DateItem" + ], + "Roo.menu.Item" : [ + "Roo.menu.CheckItem" + ] + }, + "tree_children" : [], + "tree_parent" : [], "desc" : "The base class for all items that render into menus. BaseItem provides default rendering, activated state\nmanagement and base configuration options shared by all menu components.", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : true, + "isBuilderTop" : false, "memberOf" : "BaseItem", "example" : "", "deprecated" : "", @@ -22,100 +41,93 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n
",
- "memberOf" : "Roo.util.Observable",
- "optvals" : []
+ "memberOf" : "Roo.util.Observable"
},
{
"name" : "activeClass",
"type" : "String",
"desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem",
- "optvals" : []
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "optvals" : []
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"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",
- "optvals" : [
- "display",
- "visibility"
- ]
+ "memberOf" : "Roo.Component"
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem",
- "optvals" : []
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem",
- "optvals" : []
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem",
- "optvals" : []
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component",
- "optvals" : []
+ "memberOf" : "Roo.Component"
},
{
"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",
- "optvals" : []
+ "memberOf" : "Roo.Component"
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem",
- "optvals" : []
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component",
- "optvals" : []
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
{
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -127,15 +139,20 @@
},
{
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "container",
@@ -148,43 +165,58 @@
},
{
"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,
- "memberOf" : "Roo.Component",
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "disabled",
@@ -197,15 +229,20 @@
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -217,15 +254,20 @@
},
{
"name" : "focus",
+ "type" : "function",
"desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "selectText",
@@ -244,15 +286,20 @@
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -264,15 +311,20 @@
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -284,15 +336,20 @@
},
{
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "visible",
@@ -311,15 +368,20 @@
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -331,15 +393,20 @@
},
{
"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,
- "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -351,29 +418,39 @@
},
{
"name" : "purgeListeners",
+ "type" : "function",
"desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "on",
+ "type" : "function",
"desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -404,15 +481,20 @@
},
{
"name" : "un",
+ "type" : "function",
"desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -437,15 +519,20 @@
},
{
"name" : "addEvents",
+ "type" : "function",
"desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "object",
@@ -458,15 +545,20 @@
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
@@ -479,15 +571,20 @@
},
{
"name" : "removeListener",
+ "type" : "function",
"desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -512,15 +609,20 @@
},
{
"name" : "fireEvent",
+ "type" : "function",
"desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -545,15 +647,20 @@
},
{
"name" : "hasListener",
+ "type" : "function",
"desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -572,15 +679,20 @@
},
{
"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,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
@@ -605,15 +717,20 @@
},
{
"name" : "addListener",
+ "type" : "function",
"desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -646,8 +763,10 @@
"events" : [
{
"name" : "click",
+ "type" : "function",
"desc" : "Fires when this item is clicked",
- "memberOf" : "Roo.menu.BaseItem",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -670,8 +789,10 @@
},
{
"name" : "activate",
+ "type" : "function",
"desc" : "Fires when this item is activated",
- "memberOf" : "Roo.menu.BaseItem",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -688,8 +809,10 @@
},
{
"name" : "deactivate",
+ "type" : "function",
"desc" : "Fires when this item is deactivated",
- "memberOf" : "Roo.menu.BaseItem",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
@@ -706,7 +829,9 @@
},
{
"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" : "",
@@ -724,7 +849,9 @@
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -742,7 +869,9 @@
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -760,7 +889,9 @@
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -778,7 +909,9 @@
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -796,7 +929,9 @@
},
{
"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" : "",
@@ -814,7 +949,9 @@
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -832,7 +969,9 @@
},
{
"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" : "",
@@ -850,7 +989,9 @@
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -868,7 +1009,9 @@
},
{
"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" : "",