X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.menu.Adapter.json;fp=docs%2Fsymbols%2FRoo.menu.Adapter.json;h=fbbe9c983e90386e446e36be93b2f604e77273c9;hp=8e57700158d17b99505c73bc82c056d38373c350;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f
diff --git a/docs/symbols/Roo.menu.Adapter.json b/docs/symbols/Roo.menu.Adapter.json
index 8e57700158..fbbe9c983e 100644
--- a/docs/symbols/Roo.menu.Adapter.json
+++ b/docs/symbols/Roo.menu.Adapter.json
@@ -5,10 +5,20 @@
"Roo.Component",
"Roo.util.Observable"
],
+ "childClasses" : {
+ "Roo.menu.Adapter" : [
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "A base utility class that adapts a non-menu component so that it can be wrapped by a menu item and added to a menu.\nIt provides basic rendering, activation management and enable/disable logic required to work in menus.",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : true,
+ "isBuilderTop" : false,
"memberOf" : "Adapter",
"example" : "",
"deprecated" : "",
@@ -23,100 +33,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" : "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" : "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" : "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" : [
{
@@ -128,15 +131,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",
@@ -149,43 +157,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",
@@ -198,15 +221,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" : [
{
@@ -218,15 +246,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",
@@ -245,15 +278,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" : [
{
@@ -265,15 +303,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" : [
{
@@ -285,15 +328,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",
@@ -312,15 +360,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" : [
{
@@ -332,15 +385,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" : [
{
@@ -352,29 +410,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",
@@ -405,15 +473,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",
@@ -438,15 +511,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",
@@ -459,15 +537,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",
@@ -480,15 +563,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",
@@ -513,15 +601,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",
@@ -546,15 +639,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",
@@ -573,15 +671,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",
@@ -606,15 +709,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",
@@ -647,7 +755,9 @@
"events" : [
{
"name" : "click",
+ "type" : "function",
"desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
@@ -671,7 +781,9 @@
},
{
"name" : "activate",
+ "type" : "function",
"desc" : "Fires when this item is activated",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
@@ -689,7 +801,9 @@
},
{
"name" : "deactivate",
+ "type" : "function",
"desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.menu.BaseItem",
"example" : "",
"deprecated" : "",
@@ -707,7 +821,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" : "",
@@ -725,7 +841,9 @@
},
{
"name" : "disable",
+ "type" : "function",
"desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -743,7 +861,9 @@
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -761,7 +881,9 @@
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -779,7 +901,9 @@
},
{
"name" : "hide",
+ "type" : "function",
"desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -797,7 +921,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" : "",
@@ -815,7 +941,9 @@
},
{
"name" : "show",
+ "type" : "function",
"desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -833,7 +961,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" : "",
@@ -851,7 +981,9 @@
},
{
"name" : "enable",
+ "type" : "function",
"desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
@@ -869,7 +1001,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" : "",