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