major doc changes

[roojs1] / docs / symbols / Roo.Template.json

diff --git a/docs/symbols/Roo.Template.json b/docs/symbols/Roo.Template.json
index df4aa66..09887d8 100644 (file)
--- a/docs/symbols/Roo.Template.json
+++ b/docs/symbols/Roo.Template.json
@@ -1,10 +1,21 @@
 {
   "name" : "Roo.Template",
   "augments" : [],
+  "childClasses" : {
+    "Roo.Template" : [
+      "Roo.DomTemplate",
+      "Roo.MasterTemplate",
+      "Roo.XTemplate"
+    ]
+  },
+  "tree_children" : [],
+  "tree_parent" : [],
   "desc" : "Represents an HTML fragment template. Templates can be precompiled for greater performance.\nFor a list of available format functions, see {@link Roo.util.Format}.<br />\nUsage:\n<pre><code>\nvar t = new Roo.Template({\n    html :  '&lt;div name=\"{id}\"&gt;' + \n        '&lt;span class=\"{cls}\"&gt;{name:trim} {someval:this.myformat}{value:ellipsis(10)}&lt;/span&gt;' +\n        '&lt;/div&gt;',\n    myformat: function (value, allValues) {\n        return 'XX' + value;\n    }\n});\nt.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});\n</code></pre>\nFor more information see this blog post with examples:\n <a href=\"http://www.cnitblog.com/seeyeah/archive/2011/12/30/38728.html/\">DomHelper\n     - Create Elements using DOM, HTML fragments and Templates</a>.",
   "isSingleton" : false,
   "isStatic" : false,
   "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : false,
   "memberOf" : "Template",
   "example" : "",
   "deprecated" : "",
@@ -19,41 +30,45 @@
     }
   ],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [
     {
       "name" : "onLoad",
       "type" : "Function",
       "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
-      "memberOf" : "Roo.Template",
-      "optvals" : []
+      "memberOf" : "Roo.Template"
     },
     {
       "name" : "html",
       "type" : "String",
       "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
-      "memberOf" : "Roo.Template",
-      "optvals" : []
+      "memberOf" : "Roo.Template"
     },
     {
       "name" : "url",
       "type" : "String",
       "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n                   it should be fixed so that template is observable...",
-      "memberOf" : "Roo.Template",
-      "optvals" : []
+      "memberOf" : "Roo.Template"
     }
   ],
   "methods" : [
     {
       "name" : "insertFirst",
+      "type" : "function",
       "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
+      "sig" : "(el, values, returnElement)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -84,15 +99,20 @@
     },
     {
       "name" : "overwrite",
+      "type" : "function",
       "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
+      "sig" : "(el, values, returnElement)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -123,15 +143,20 @@
     },
     {
       "name" : "insertBefore",
+      "type" : "function",
       "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
+      "sig" : "(el, values, returnElement)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -162,15 +187,20 @@
     },
     {
       "name" : "applyTemplate",
+      "type" : "function",
       "desc" : "Returns an HTML fragment of this template with the specified values applied.",
+      "sig" : "(values)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "values",
@@ -189,15 +219,20 @@
     },
     {
       "name" : "compile",
+      "type" : "function",
       "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
@@ -209,15 +244,20 @@
     },
     {
       "name" : "set",
+      "type" : "function",
       "desc" : "Sets the HTML used as the template and optionally compiles it.",
+      "sig" : "(html, compile)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "html",
@@ -242,15 +282,20 @@
     },
     {
       "name" : "from",
+      "type" : "function",
       "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
+      "sig" : "(el)",
+      "static" : true,
+      "memberOf" : "",
       "isStatic" : true,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -263,15 +308,20 @@
     },
     {
       "name" : "insertAfter",
+      "type" : "function",
       "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
+      "sig" : "(el, values, returnElement)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -302,15 +352,20 @@
     },
     {
       "name" : "append",
+      "type" : "function",
       "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
+      "sig" : "(el, values, returnElement)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -341,15 +396,20 @@
     },
     {
       "name" : "apply",
+      "type" : "function",
       "desc" : "Alias for {@link #applyTemplate}",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     }