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

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