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

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