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