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

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