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

   1 {
   2   "name" : "Roo.util.CSS",
   3   "augments" : [],
   4   "childClasses" : [],
   5   "desc" : "Utility class for manipulating CSS rules",
   6   "isSingleton" : true,
   7   "isStatic" : false,
   8   "isBuiltin" : false,
   9   "memberOf" : "CSS",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [],
  15   "returns" : [],
  16   "throws" : "",
  17   "requires" : "",
  18   "config" : [],
  19   "methods" : [
  20     {
  21       "name" : "createStyleSheet",
  22       "type" : "function",
  23       "desc" : "Very simple dynamic creation of stylesheets from a text blob of rules.  The text will wrapped in a style\ntag and appended to the HEAD of the document.",
  24       "sig" : "(cssText, id)",
  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" : "cssText",
  39           "type" : "String|Object",
  40           "desc" : "The text containing the css rules",
  41           "isOptional" : false
  42         },
  43         {
  44           "name" : "id",
  45           "type" : "String",
  46           "desc" : "An id to add to the stylesheet for later removal",
  47           "isOptional" : false
  48         }
  49       ],
  50       "returns" : [
  51         {
  52           "name" : "",
  53           "type" : "StyleSheet",
  54           "desc" : ""
  55         }
  56       ]
  57     },
  58     {
  59       "name" : "getRules",
  60       "type" : "function",
  61       "desc" : "Gets all css rules for the document",
  62       "sig" : "(refreshCache)",
  63       "static" : false,
  64       "memberOf" : "",
  65       "isStatic" : false,
  66       "isConstructor" : false,
  67       "isPrivate" : false,
  68       "example" : "",
  69       "deprecated" : "",
  70       "since" : "",
  71       "see" : "",
  72       "exceptions" : "",
  73       "requires" : "",
  74       "params" : [
  75         {
  76           "name" : "refreshCache",
  77           "type" : "Boolean",
  78           "desc" : "true to refresh the internal cache",
  79           "isOptional" : false
  80         }
  81       ],
  82       "returns" : [
  83         {
  84           "name" : "",
  85           "type" : "Object",
  86           "desc" : "An object (hash) of rules indexed by selector"
  87         }
  88       ]
  89     },
  90     {
  91       "name" : "swapStyleSheet",
  92       "type" : "function",
  93       "desc" : "Dynamically swaps an existing stylesheet reference for a new one",
  94       "sig" : "(id, url)",
  95       "static" : false,
  96       "memberOf" : "",
  97       "isStatic" : false,
  98       "isConstructor" : false,
  99       "isPrivate" : false,
 100       "example" : "",
 101       "deprecated" : "",
 102       "since" : "",
 103       "see" : "",
 104       "exceptions" : "",
 105       "requires" : "",
 106       "params" : [
 107         {
 108           "name" : "id",
 109           "type" : "String",
 110           "desc" : "The id of an existing link tag to remove",
 111           "isOptional" : false
 112         },
 113         {
 114           "name" : "url",
 115           "type" : "String",
 116           "desc" : "The href of the new stylesheet to include",
 117           "isOptional" : false
 118         }
 119       ],
 120       "returns" : []
 121     },
 122     {
 123       "name" : "updateRule",
 124       "type" : "function",
 125       "desc" : "Updates a rule property",
 126       "sig" : "(selector, property, value)",
 127       "static" : false,
 128       "memberOf" : "",
 129       "isStatic" : false,
 130       "isConstructor" : false,
 131       "isPrivate" : false,
 132       "example" : "",
 133       "deprecated" : "",
 134       "since" : "",
 135       "see" : "",
 136       "exceptions" : "",
 137       "requires" : "",
 138       "params" : [
 139         {
 140           "name" : "selector",
 141           "type" : "String/Array",
 142           "desc" : "If it's an array it tries each selector until it finds one. Stops immediately once one is found.",
 143           "isOptional" : false
 144         },
 145         {
 146           "name" : "property",
 147           "type" : "String",
 148           "desc" : "The css property",
 149           "isOptional" : false
 150         },
 151         {
 152           "name" : "value",
 153           "type" : "String",
 154           "desc" : "The new value for the property",
 155           "isOptional" : false
 156         }
 157       ],
 158       "returns" : [
 159         {
 160           "name" : "",
 161           "type" : "Boolean",
 162           "desc" : "true If a rule was found and updated"
 163         }
 164       ]
 165     },
 166     {
 167       "name" : "getRule",
 168       "type" : "function",
 169       "desc" : "Gets an an individual CSS rule by selector(s)",
 170       "sig" : "(selector, refreshCache)",
 171       "static" : false,
 172       "memberOf" : "",
 173       "isStatic" : false,
 174       "isConstructor" : false,
 175       "isPrivate" : false,
 176       "example" : "",
 177       "deprecated" : "",
 178       "since" : "",
 179       "see" : "",
 180       "exceptions" : "",
 181       "requires" : "",
 182       "params" : [
 183         {
 184           "name" : "selector",
 185           "type" : "String/Array",
 186           "desc" : "The CSS selector or an array of selectors to try. The first selector that is found is returned.",
 187           "isOptional" : false
 188         },
 189         {
 190           "name" : "refreshCache",
 191           "type" : "Boolean",
 192           "desc" : "true to refresh the internal cache if you have recently updated any rules or added styles dynamically",
 193           "isOptional" : false
 194         }
 195       ],
 196       "returns" : [
 197         {
 198           "name" : "",
 199           "type" : "CSSRule",
 200           "desc" : "The CSS rule or null if one is not found"
 201         }
 202       ]
 203     },
 204     {
 205       "name" : "refreshCache",
 206       "type" : "function",
 207       "desc" : "Refresh the rule cache if you have dynamically added stylesheets",
 208       "sig" : "()\n{\n\n}",
 209       "static" : false,
 210       "memberOf" : "",
 211       "isStatic" : false,
 212       "isConstructor" : false,
 213       "isPrivate" : false,
 214       "example" : "",
 215       "deprecated" : "",
 216       "since" : "",
 217       "see" : "",
 218       "exceptions" : "",
 219       "requires" : "",
 220       "params" : [],
 221       "returns" : [
 222         {
 223           "name" : "",
 224           "type" : "Object",
 225           "desc" : "An object (hash) of rules indexed by selector"
 226         }
 227       ]
 228     },
 229     {
 230       "name" : "removeStyleSheet",
 231       "type" : "function",
 232       "desc" : "Removes a style or link tag by id",
 233       "sig" : "(id)",
 234       "static" : false,
 235       "memberOf" : "",
 236       "isStatic" : false,
 237       "isConstructor" : false,
 238       "isPrivate" : false,
 239       "example" : "",
 240       "deprecated" : "",
 241       "since" : "",
 242       "see" : "",
 243       "exceptions" : "",
 244       "requires" : "",
 245       "params" : [
 246         {
 247           "name" : "id",
 248           "type" : "String",
 249           "desc" : "The id of the tag",
 250           "isOptional" : false
 251         }
 252       ],
 253       "returns" : []
 254     }
 255   ],
 256   "events" : []
 257 }