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