X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.XTemplate.json;fp=docs%2Fsymbols%2FRoo.XTemplate.json;h=bb7866144290f0e5404d66d94f4943b69e5a82b0;hp=d7f671f79c50d6a12a365eb4c5fe747fcf834e8d;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.XTemplate.json b/docs/symbols/Roo.XTemplate.json index d7f671f79c..bb78661442 100644 --- a/docs/symbols/Roo.XTemplate.json +++ b/docs/symbols/Roo.XTemplate.json @@ -3,10 +3,15 @@ "augments" : [ "Roo.Template" ], + "childClasses" : { }, + "tree_children" : [], + "tree_parent" : [], "desc" : "Provides a template that can have nested templates for loops or conditionals. The syntax is:\n
\nvar t = new Roo.XTemplate(\n\t'<select name=\"{name}\">',\n\t\t'<tpl for=\"options\"><option value=\"{value:trim}\">{text:ellipsis(10)}</option></tpl>',\n\t'</select>'\n);\n \n// then append, applying the master template values\n 
\n\nSupported features:\n\n Tags:\n\n
\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
\n The tpl tag:\n
\n        <tpl for=\"a_variable or condition..\"></tpl>\n        <tpl if=\"a_variable or condition\"></tpl>\n        <tpl exec=\"some javascript\"></tpl>\n        <tpl name=\"named_template\"></tpl> (experimental)\n  \n        <tpl for=\".\"></tpl> - just iterate the property..\n        <tpl for=\"..\"></tpl> - iterates with the parent (probably the template) \n
", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "XTemplate", "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.XTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -73,29 +82,39 @@ }, { "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.XTemplate", "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", @@ -126,15 +145,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", @@ -165,15 +189,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", @@ -204,15 +233,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", @@ -231,15 +265,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", @@ -264,15 +303,20 @@ }, { "name" : "from", + "type" : "function", "desc" : "Creates a template from the passed element's value (display:none 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", @@ -285,15 +329,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", @@ -324,15 +373,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", @@ -363,15 +417,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" : [] }