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