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

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