major doc changes

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

diff --git a/docs/symbols/Roo.DomTemplate.json b/docs/symbols/Roo.DomTemplate.json
index bfd0e5d..dd8e120 100644 (file)
--- a/docs/symbols/Roo.DomTemplate.json
+++ b/docs/symbols/Roo.DomTemplate.json
@@ -3,10 +3,15 @@
   "augments" : [
     "Roo.Template"
   ],
+  "childClasses" : {  },
+  "tree_children" : [],
+  "tree_parent" : [],
   "desc" : "An effort at a dom based template engine..\n\nSimilar to XTemplate, except it uses dom parsing to create the template..\n\nSupported features:\n\n Tags:\n\n<pre><code>\n      {a_variable} - output encoded.\n      {a_variable.format:(\"Y-m-d\")} - call a method on the variable\n      {a_variable:raw} - unencoded output\n      {a_variable:toFixed(1,2)} - Roo.util.Format.\"toFixed\"\n      {a_variable:this.method_on_template(...)} - call a method on the template object.\n \n</code></pre>\n The tpl tag:\n<pre><code>\n        &lt;div roo-for=\"a_variable or condition..\"&gt;&lt;/div&gt;\n        &lt;div roo-if=\"a_variable or condition\"&gt;&lt;/div&gt;\n        &lt;div roo-exec=\"some javascript\"&gt;&lt;/div&gt;\n        &lt;div roo-name=\"named_template\"&gt;&lt;/div&gt; \n  \n</code></pre>",
   "isSingleton" : false,
   "isStatic" : false,
   "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : false,
   "memberOf" : "DomTemplate",
   "example" : "",
   "deprecated" : "",
@@ -14,41 +19,45 @@
   "see" : "",
   "params" : [],
   "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" : "applySubTemplate",
+      "type" : "function",
       "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);",
+      "sig" : "(id, values, parent)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.DomTemplate",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "id",
@@ -73,43 +82,58 @@
     },
     {
       "name" : "compile",
+      "type" : "function",
       "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.DomTemplate",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "name" : "compileTpl",
+      "type" : "function",
       "desc" : "Compile a segment of the template into a 'sub-template'",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.DomTemplate",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "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" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -140,15 +164,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" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -179,15 +208,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" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -218,15 +252,20 @@
     },
     {
       "name" : "applyTemplate",
+      "type" : "function",
       "desc" : "Returns an HTML fragment of this template with the specified values applied.",
+      "sig" : "(values)",
+      "static" : false,
+      "memberOf" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "values",
@@ -245,15 +284,20 @@
     },
     {
       "name" : "set",
+      "type" : "function",
       "desc" : "Sets the HTML used as the template and optionally compiles it.",
+      "sig" : "(html, compile)",
+      "static" : false,
+      "memberOf" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "html",
@@ -278,15 +322,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" : "Roo.Template",
       "isStatic" : true,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -299,15 +348,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" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -338,15 +392,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" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
@@ -377,15 +436,20 @@
     },
     {
       "name" : "apply",
+      "type" : "function",
       "desc" : "Alias for {@link #applyTemplate}",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "Roo.Template",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.Template",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     }