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

   1 {
   2   "name" : "Roo.DomHelper",
   3   "augments" : [
   4   ],
   5   "desc" : "Utility class for working with DOM and/or Templates. It transparently supports using HTML fragments or DOM.\nFor more information see <a href=\"http://web.archive.org/web/20071221063734/http://www.jackslocum.com/blog/2006/10/06/domhelper-create-elements-using-dom-html-fragments-or-templates/\">this blog post with examples</a>.",
   6   "isSingleton" : true,
   7   "isStatic" : false,
   8   "isBuiltin" : false,
   9   "memberOf" : "DomHelper",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [
  15   ],
  16   "returns" : [
  17   ],
  18   "config" : [
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "insertHtml",
  23       "desc" : "Inserts an HTML fragment into the Dom",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.DomHelper",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33         {
  34           "name" : "where",
  35           "type" : "String",
  36           "desc" : "Where to insert the html in relation to el - beforeBegin, afterBegin, beforeEnd, afterEnd.",
  37           "isOptional" : false
  38         },
  39         {
  40           "name" : "el",
  41           "type" : "HTMLElement",
  42           "desc" : "The context element",
  43           "isOptional" : false
  44         },
  45         {
  46           "name" : "html",
  47           "type" : "String",
  48           "desc" : "The HTML fragmenet",
  49           "isOptional" : false
  50         }
  51       ],
  52       "returns" : [
  53         {
  54           "name" : "",
  55           "type" : "HTMLElement",
  56           "desc" : "The new node"
  57         }
  58       ]
  59     },
  60     {
  61       "name" : "createTemplate",
  62       "desc" : "Creates a new Roo.DomHelper.Template from the Dom object spec",
  63       "isStatic" : false,
  64       "isConstructor" : false,
  65       "isPrivate" : false,
  66       "memberOf" : "Roo.DomHelper",
  67       "example" : "",
  68       "deprecated" : "",
  69       "since" : "",
  70       "see" : "",
  71       "params" : [
  72         {
  73           "name" : "o",
  74           "type" : "Object",
  75           "desc" : "The Dom object spec (and children)",
  76           "isOptional" : false
  77         }
  78       ],
  79       "returns" : [
  80         {
  81           "name" : "",
  82           "type" : "Roo.DomHelper.Template",
  83           "desc" : "The new template"
  84         }
  85       ]
  86     },
  87     {
  88       "name" : "insertAfter",
  89       "desc" : "Creates new Dom element(s) and inserts them after el",
  90       "isStatic" : false,
  91       "isConstructor" : false,
  92       "isPrivate" : false,
  93       "memberOf" : "Roo.DomHelper",
  94       "example" : "",
  95       "deprecated" : "",
  96       "since" : "",
  97       "see" : "",
  98       "params" : [
  99         {
 100           "name" : "el",
 101           "type" : "String/HTMLElement/Element",
 102           "desc" : "The context element",
 103           "isOptional" : false
 104         },
 105         {
 106           "name" : "o",
 107           "type" : "Object",
 108           "desc" : "The Dom object spec (and children)",
 109           "isOptional" : false
 110         },
 111         {
 112           "name" : "returnElement",
 113           "type" : "Boolean",
 114           "desc" : "(optional) true to return a Roo.Element",
 115           "isOptional" : false
 116         }
 117       ],
 118       "returns" : [
 119         {
 120           "name" : "",
 121           "type" : "HTMLElement/Roo.Element",
 122           "desc" : "The new node"
 123         }
 124       ]
 125     },
 126     {
 127       "name" : "insertFirst",
 128       "desc" : "Creates new Dom element(s) and inserts them as the first child of el",
 129       "isStatic" : false,
 130       "isConstructor" : false,
 131       "isPrivate" : false,
 132       "memberOf" : "Roo.DomHelper",
 133       "example" : "",
 134       "deprecated" : "",
 135       "since" : "",
 136       "see" : "",
 137       "params" : [
 138         {
 139           "name" : "el",
 140           "type" : "String/HTMLElement/Element",
 141           "desc" : "The context element",
 142           "isOptional" : false
 143         },
 144         {
 145           "name" : "o",
 146           "type" : "Object/String",
 147           "desc" : "The Dom object spec (and children) or raw HTML blob",
 148           "isOptional" : false
 149         },
 150         {
 151           "name" : "returnElement",
 152           "type" : "Boolean",
 153           "desc" : "(optional) true to return a Roo.Element",
 154           "isOptional" : false
 155         }
 156       ],
 157       "returns" : [
 158         {
 159           "name" : "",
 160           "type" : "HTMLElement/Roo.Element",
 161           "desc" : "The new node"
 162         }
 163       ]
 164     },
 165     {
 166       "name" : "append",
 167       "desc" : "Creates new Dom element(s) and appends them to el",
 168       "isStatic" : false,
 169       "isConstructor" : false,
 170       "isPrivate" : false,
 171       "memberOf" : "Roo.DomHelper",
 172       "example" : "",
 173       "deprecated" : "",
 174       "since" : "",
 175       "see" : "",
 176       "params" : [
 177         {
 178           "name" : "el",
 179           "type" : "String/HTMLElement/Element",
 180           "desc" : "The context element",
 181           "isOptional" : false
 182         },
 183         {
 184           "name" : "o",
 185           "type" : "Object/String",
 186           "desc" : "The Dom object spec (and children) or raw HTML blob",
 187           "isOptional" : false
 188         },
 189         {
 190           "name" : "returnElement",
 191           "type" : "Boolean",
 192           "desc" : "(optional) true to return a Roo.Element",
 193           "isOptional" : false
 194         }
 195       ],
 196       "returns" : [
 197         {
 198           "name" : "",
 199           "type" : "HTMLElement/Roo.Element",
 200           "desc" : "The new node"
 201         }
 202       ]
 203     },
 204     {
 205       "name" : "applyStyles",
 206       "desc" : "Applies a style specification to an element",
 207       "isStatic" : false,
 208       "isConstructor" : false,
 209       "isPrivate" : false,
 210       "memberOf" : "Roo.DomHelper",
 211       "example" : "",
 212       "deprecated" : "",
 213       "since" : "",
 214       "see" : "",
 215       "params" : [
 216         {
 217           "name" : "el",
 218           "type" : "String/HTMLElement",
 219           "desc" : "The element to apply styles to",
 220           "isOptional" : false
 221         },
 222         {
 223           "name" : "styles",
 224           "type" : "String/Object/Function",
 225           "desc" : "A style specification string eg \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
 226           "isOptional" : false
 227         }
 228       ],
 229       "returns" : [
 230       ]
 231     },
 232     {
 233       "name" : "markup",
 234       "desc" : "Returns the markup for the passed Element(s) config",
 235       "isStatic" : false,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "memberOf" : "Roo.DomHelper",
 239       "example" : "",
 240       "deprecated" : "",
 241       "since" : "",
 242       "see" : "",
 243       "params" : [
 244         {
 245           "name" : "o",
 246           "type" : "Object",
 247           "desc" : "The Dom object spec (and children)",
 248           "isOptional" : false
 249         }
 250       ],
 251       "returns" : [
 252         {
 253           "name" : "",
 254           "type" : "String",
 255           "desc" : ""
 256         }
 257       ]
 258     },
 259     {
 260       "name" : "overwrite",
 261       "desc" : "Creates new Dom element(s) and overwrites the contents of el with them",
 262       "isStatic" : false,
 263       "isConstructor" : false,
 264       "isPrivate" : false,
 265       "memberOf" : "Roo.DomHelper",
 266       "example" : "",
 267       "deprecated" : "",
 268       "since" : "",
 269       "see" : "",
 270       "params" : [
 271         {
 272           "name" : "el",
 273           "type" : "String/HTMLElement/Element",
 274           "desc" : "The context element",
 275           "isOptional" : false
 276         },
 277         {
 278           "name" : "o",
 279           "type" : "Object/String",
 280           "desc" : "The Dom object spec (and children) or raw HTML blob",
 281           "isOptional" : false
 282         },
 283         {
 284           "name" : "returnElement",
 285           "type" : "Boolean",
 286           "desc" : "(optional) true to return a Roo.Element",
 287           "isOptional" : false
 288         }
 289       ],
 290       "returns" : [
 291         {
 292           "name" : "",
 293           "type" : "HTMLElement/Roo.Element",
 294           "desc" : "The new node"
 295         }
 296       ]
 297     },
 298     {
 299       "name" : "insertBefore",
 300       "desc" : "Creates new Dom element(s) and inserts them before el",
 301       "isStatic" : false,
 302       "isConstructor" : false,
 303       "isPrivate" : false,
 304       "memberOf" : "Roo.DomHelper",
 305       "example" : "",
 306       "deprecated" : "",
 307       "since" : "",
 308       "see" : "",
 309       "params" : [
 310         {
 311           "name" : "el",
 312           "type" : "String/HTMLElement/Element",
 313           "desc" : "The context element",
 314           "isOptional" : false
 315         },
 316         {
 317           "name" : "o",
 318           "type" : "Object/String",
 319           "desc" : "The Dom object spec (and children) or raw HTML blob",
 320           "isOptional" : false
 321         },
 322         {
 323           "name" : "returnElement",
 324           "type" : "Boolean",
 325           "desc" : "(optional) true to return a Roo.Element",
 326           "isOptional" : false
 327         }
 328       ],
 329       "returns" : [
 330         {
 331           "name" : "",
 332           "type" : "HTMLElement/Roo.Element",
 333           "desc" : "The new node"
 334         }
 335       ]
 336     }
 337   ],
 338   "events" : [
 339   ]
 340 }