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

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