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

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