git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Template.json

   1 {
   2   "name" : "Roo.Template",
   3   "augments" : [],
   4   "childClasses" : {
   5     "Roo.Template" : [
   6       "Roo.DomTemplate",
   7       "Roo.MasterTemplate",
   8       "Roo.XTemplate"
   9     ]
  10   },
  11   "tree_children" : [],
  12   "tree_parent" : [],
  13   "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>.",
  14   "isSingleton" : false,
  15   "isStatic" : false,
  16   "isBuiltin" : false,
  17   "isAbstract" : false,
  18   "isBuilderTop" : false,
  19   "memberOf" : "Template",
  20   "example" : "",
  21   "deprecated" : "",
  22   "since" : "",
  23   "see" : "",
  24   "params" : [
  25     {
  26       "name" : "cfg",
  27       "type" : "Object",
  28       "desc" : "- Configuration object.",
  29       "isOptional" : false
  30     }
  31   ],
  32   "returns" : [],
  33   "throws" : "",
  34   "requires" : "",
  35   "config" : [
  36     {
  37       "name" : "onLoad",
  38       "type" : "Function",
  39       "desc" : "Called after the template has been loaded and complied (usually from a remove source)",
  40       "memberOf" : "",
  41       "isOptional" : false,
  42       "optvalues" : []
  43     },
  44     {
  45       "name" : "html",
  46       "type" : "String",
  47       "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
  48       "memberOf" : "",
  49       "isOptional" : false,
  50       "optvalues" : []
  51     },
  52     {
  53       "name" : "url",
  54       "type" : "String",
  55       "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...",
  56       "memberOf" : "",
  57       "isOptional" : false,
  58       "optvalues" : []
  59     }
  60   ],
  61   "methods" : [
  62     {
  63       "name" : "insertFirst",
  64       "type" : "function",
  65       "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.",
  66       "sig" : "(el, values, returnElement)",
  67       "static" : false,
  68       "memberOf" : "",
  69       "isStatic" : false,
  70       "isConstructor" : false,
  71       "isPrivate" : false,
  72       "example" : "",
  73       "deprecated" : "",
  74       "since" : "",
  75       "see" : "",
  76       "exceptions" : "",
  77       "requires" : "",
  78       "params" : [
  79         {
  80           "name" : "el",
  81           "type" : "String/HTMLElement/Roo.Element",
  82           "desc" : "The context element",
  83           "isOptional" : false
  84         },
  85         {
  86           "name" : "values",
  87           "type" : "Object",
  88           "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
  89           "isOptional" : false
  90         },
  91         {
  92           "name" : "returnElement",
  93           "type" : "Boolean",
  94           "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
  95           "isOptional" : false
  96         }
  97       ],
  98       "returns" : [
  99         {
 100           "name" : "",
 101           "type" : "HTMLElement/Roo.Element",
 102           "desc" : "The new node or Element"
 103         }
 104       ]
 105     },
 106     {
 107       "name" : "overwrite",
 108       "type" : "function",
 109       "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).",
 110       "sig" : "(el, values, returnElement)",
 111       "static" : false,
 112       "memberOf" : "",
 113       "isStatic" : false,
 114       "isConstructor" : false,
 115       "isPrivate" : false,
 116       "example" : "",
 117       "deprecated" : "",
 118       "since" : "",
 119       "see" : "",
 120       "exceptions" : "",
 121       "requires" : "",
 122       "params" : [
 123         {
 124           "name" : "el",
 125           "type" : "String/HTMLElement/Roo.Element",
 126           "desc" : "The context element",
 127           "isOptional" : false
 128         },
 129         {
 130           "name" : "values",
 131           "type" : "Object",
 132           "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
 133           "isOptional" : false
 134         },
 135         {
 136           "name" : "returnElement",
 137           "type" : "Boolean",
 138           "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
 139           "isOptional" : false
 140         }
 141       ],
 142       "returns" : [
 143         {
 144           "name" : "",
 145           "type" : "HTMLElement/Roo.Element",
 146           "desc" : "The new node or Element"
 147         }
 148       ]
 149     },
 150     {
 151       "name" : "insertBefore",
 152       "type" : "function",
 153       "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.",
 154       "sig" : "(el, values, returnElement)",
 155       "static" : false,
 156       "memberOf" : "",
 157       "isStatic" : false,
 158       "isConstructor" : false,
 159       "isPrivate" : false,
 160       "example" : "",
 161       "deprecated" : "",
 162       "since" : "",
 163       "see" : "",
 164       "exceptions" : "",
 165       "requires" : "",
 166       "params" : [
 167         {
 168           "name" : "el",
 169           "type" : "String/HTMLElement/Roo.Element",
 170           "desc" : "The context element",
 171           "isOptional" : false
 172         },
 173         {
 174           "name" : "values",
 175           "type" : "Object",
 176           "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
 177           "isOptional" : false
 178         },
 179         {
 180           "name" : "returnElement",
 181           "type" : "Boolean",
 182           "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
 183           "isOptional" : false
 184         }
 185       ],
 186       "returns" : [
 187         {
 188           "name" : "",
 189           "type" : "HTMLElement/Roo.Element",
 190           "desc" : "The new node or Element"
 191         }
 192       ]
 193     },
 194     {
 195       "name" : "applyTemplate",
 196       "type" : "function",
 197       "desc" : "Returns an HTML fragment of this template with the specified values applied.",
 198       "sig" : "(values)",
 199       "static" : false,
 200       "memberOf" : "",
 201       "isStatic" : false,
 202       "isConstructor" : false,
 203       "isPrivate" : false,
 204       "example" : "",
 205       "deprecated" : "",
 206       "since" : "",
 207       "see" : "",
 208       "exceptions" : "",
 209       "requires" : "",
 210       "params" : [
 211         {
 212           "name" : "values",
 213           "type" : "Object",
 214           "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
 215           "isOptional" : false
 216         }
 217       ],
 218       "returns" : [
 219         {
 220           "name" : "",
 221           "type" : "String",
 222           "desc" : "The HTML fragment"
 223         }
 224       ]
 225     },
 226     {
 227       "name" : "compile",
 228       "type" : "function",
 229       "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.",
 230       "sig" : "()\n{\n\n}",
 231       "static" : false,
 232       "memberOf" : "",
 233       "isStatic" : false,
 234       "isConstructor" : false,
 235       "isPrivate" : false,
 236       "example" : "",
 237       "deprecated" : "",
 238       "since" : "",
 239       "see" : "",
 240       "exceptions" : "",
 241       "requires" : "",
 242       "params" : [],
 243       "returns" : [
 244         {
 245           "name" : "",
 246           "type" : "Roo.Template",
 247           "desc" : "this"
 248         }
 249       ]
 250     },
 251     {
 252       "name" : "set",
 253       "type" : "function",
 254       "desc" : "Sets the HTML used as the template and optionally compiles it.",
 255       "sig" : "(html, compile)",
 256       "static" : false,
 257       "memberOf" : "",
 258       "isStatic" : false,
 259       "isConstructor" : false,
 260       "isPrivate" : false,
 261       "example" : "",
 262       "deprecated" : "",
 263       "since" : "",
 264       "see" : "",
 265       "exceptions" : "",
 266       "requires" : "",
 267       "params" : [
 268         {
 269           "name" : "html",
 270           "type" : "String",
 271           "desc" : "",
 272           "isOptional" : false
 273         },
 274         {
 275           "name" : "compile",
 276           "type" : "Boolean",
 277           "desc" : "(optional) True to compile the template (defaults to undefined)",
 278           "isOptional" : false
 279         }
 280       ],
 281       "returns" : [
 282         {
 283           "name" : "",
 284           "type" : "Roo.Template",
 285           "desc" : "this"
 286         }
 287       ]
 288     },
 289     {
 290       "name" : "from",
 291       "type" : "function",
 292       "desc" : "Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.",
 293       "sig" : "(el)",
 294       "static" : true,
 295       "memberOf" : "",
 296       "isStatic" : true,
 297       "isConstructor" : false,
 298       "isPrivate" : false,
 299       "example" : "",
 300       "deprecated" : "",
 301       "since" : "",
 302       "see" : "",
 303       "exceptions" : "",
 304       "requires" : "",
 305       "params" : [
 306         {
 307           "name" : "el",
 308           "type" : "String/HTMLElement",
 309           "desc" : "A DOM element or its id",
 310           "isOptional" : false
 311         }
 312       ],
 313       "returns" : []
 314     },
 315     {
 316       "name" : "insertAfter",
 317       "type" : "function",
 318       "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.",
 319       "sig" : "(el, values, returnElement)",
 320       "static" : false,
 321       "memberOf" : "",
 322       "isStatic" : false,
 323       "isConstructor" : false,
 324       "isPrivate" : false,
 325       "example" : "",
 326       "deprecated" : "",
 327       "since" : "",
 328       "see" : "",
 329       "exceptions" : "",
 330       "requires" : "",
 331       "params" : [
 332         {
 333           "name" : "el",
 334           "type" : "String/HTMLElement/Roo.Element",
 335           "desc" : "The context element",
 336           "isOptional" : false
 337         },
 338         {
 339           "name" : "values",
 340           "type" : "Object",
 341           "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
 342           "isOptional" : false
 343         },
 344         {
 345           "name" : "returnElement",
 346           "type" : "Boolean",
 347           "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
 348           "isOptional" : false
 349         }
 350       ],
 351       "returns" : [
 352         {
 353           "name" : "",
 354           "type" : "HTMLElement/Roo.Element",
 355           "desc" : "The new node or Element"
 356         }
 357       ]
 358     },
 359     {
 360       "name" : "append",
 361       "type" : "function",
 362       "desc" : "Applies the supplied values to the template and appends the new node(s) to el.",
 363       "sig" : "(el, values, returnElement)",
 364       "static" : false,
 365       "memberOf" : "",
 366       "isStatic" : false,
 367       "isConstructor" : false,
 368       "isPrivate" : false,
 369       "example" : "",
 370       "deprecated" : "",
 371       "since" : "",
 372       "see" : "",
 373       "exceptions" : "",
 374       "requires" : "",
 375       "params" : [
 376         {
 377           "name" : "el",
 378           "type" : "String/HTMLElement/Roo.Element",
 379           "desc" : "The context element",
 380           "isOptional" : false
 381         },
 382         {
 383           "name" : "values",
 384           "type" : "Object",
 385           "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})",
 386           "isOptional" : false
 387         },
 388         {
 389           "name" : "returnElement",
 390           "type" : "Boolean",
 391           "desc" : "(optional) true to return a Roo.Element (defaults to undefined)",
 392           "isOptional" : false
 393         }
 394       ],
 395       "returns" : [
 396         {
 397           "name" : "",
 398           "type" : "HTMLElement/Roo.Element",
 399           "desc" : "The new node or Element"
 400         }
 401       ]
 402     },
 403     {
 404       "name" : "apply",
 405       "type" : "function",
 406       "desc" : "Alias for {@link #applyTemplate}",
 407       "sig" : "()\n{\n\n}",
 408       "static" : false,
 409       "memberOf" : "",
 410       "isStatic" : false,
 411       "isConstructor" : false,
 412       "isPrivate" : false,
 413       "example" : "",
 414       "deprecated" : "",
 415       "since" : "",
 416       "see" : "",
 417       "exceptions" : "",
 418       "requires" : "",
 419       "params" : [],
 420       "returns" : []
 421     }
 422   ],
 423   "events" : []
 424 }