X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.GridPanel.json;fp=docs%2Fsymbols%2FRoo.GridPanel.json;h=49ad87297664abb2d2afabbe21db5aaeee1eae5c;hp=e09cac899419fcd09792dca0ff2448bc912fa26e;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f
diff --git a/docs/symbols/Roo.GridPanel.json b/docs/symbols/Roo.GridPanel.json
index e09cac8994..49ad872976 100644
--- a/docs/symbols/Roo.GridPanel.json
+++ b/docs/symbols/Roo.GridPanel.json
@@ -4,10 +4,15 @@
"Roo.ContentPanel",
"Roo.util.Observable"
],
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "Create a new GridPanel.",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "GridPanel",
"example" : "",
"deprecated" : "",
@@ -28,145 +33,135 @@
}
],
"returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"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" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "toolbar",
- "type" : "Toolbar",
+ "type" : "Roo.Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "region",
"type" : "String",
- "desc" : "t) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : [
- "center",
- "north",
- "south",
- "east",
- "west"
- ]
+ "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
+ },
+ {
+ "name" : "menu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "popup menu",
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "style",
"type" : "String",
"desc" : "Extra style to add to the content panel",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
+ "type" : "Boolean|Object",
"desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "params",
- "type" : "String/Object",
+ "type" : "String|Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "adjustments",
"type" : "Array",
"desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
+ "type" : "String|HTMLElement|Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.ContentPanel",
- "optvals" : []
+ "memberOf" : "Roo.ContentPanel"
}
],
"methods" : [
{
"name" : "getGrid",
+ "type" : "function",
"desc" : "Returns the grid for this panel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.GridPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -178,15 +173,20 @@
},
{
"name" : "load",
+ "type" : "function",
"desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "url",
@@ -223,15 +223,20 @@
},
{
"name" : "getUpdateManager",
+ "type" : "function",
"desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -243,15 +248,20 @@
},
{
"name" : "isClosable",
+ "type" : "function",
"desc" : "Returns true is this panel was configured to be closable",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -263,29 +273,39 @@
},
{
"name" : "destroy",
+ "type" : "function",
"desc" : "Destroys this panel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getEl",
+ "type" : "function",
"desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -297,15 +317,20 @@
},
{
"name" : "setContent",
+ "type" : "function",
"desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "content",
@@ -324,15 +349,20 @@
},
{
"name" : "getId",
+ "type" : "function",
"desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -344,15 +374,20 @@
},
{
"name" : "addxtype",
+ "type" : "function",
"desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n
",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "cfg",
@@ -365,29 +400,39 @@
},
{
"name" : "refresh",
+ "type" : "function",
"desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "getTitle",
+ "type" : "function",
"desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -399,15 +444,20 @@
},
{
"name" : "setTitle",
+ "type" : "function",
"desc" : "Set this panel's title",
+ "sig" : "(title)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "title",
@@ -420,15 +470,20 @@
},
{
"name" : "getToolbar",
+ "type" : "function",
"desc" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : [
{
@@ -440,15 +495,20 @@
},
{
"name" : "setUrl",
+ "type" : "function",
"desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
+ "static" : false,
+ "memberOf" : "Roo.ContentPanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "url",
@@ -479,29 +539,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",
@@ -532,15 +602,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",
@@ -565,15 +640,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",
@@ -586,15 +666,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",
@@ -607,15 +692,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",
@@ -640,15 +730,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",
@@ -673,15 +768,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",
@@ -700,15 +800,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",
@@ -733,15 +838,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",
@@ -774,7 +884,9 @@
"events" : [
{
"name" : "deactivate",
+ "type" : "function",
"desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
@@ -792,7 +904,9 @@
},
{
"name" : "resize",
+ "type" : "function",
"desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
@@ -822,7 +936,9 @@
},
{
"name" : "render",
+ "type" : "function",
"desc" : "Fires when this tab is created",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",
@@ -840,7 +956,9 @@
},
{
"name" : "activate",
+ "type" : "function",
"desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.ContentPanel",
"example" : "",
"deprecated" : "",