Fix #5654 - roojspacker - get it working as a doc tool...

[roojs1] / docs / symbols / Roo.util.CSS.json

diff --git a/docs/symbols/Roo.util.CSS.json b/docs/symbols/Roo.util.CSS.json
new file mode 100644 (file)
index 0000000..f426591
--- /dev/null
+++ b/docs/symbols/Roo.util.CSS.json
@@ -0,0 +1,227 @@
+{
+  "name" : "Roo.util.CSS",
+  "augments" : [
+  ],
+  "desc" : "Utility class for manipulating CSS rules",
+  "isSingleton" : true,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "CSS",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+  ],
+  "returns" : [
+  ],
+  "config" : [
+  ],
+  "methods" : [
+    {
+      "name" : "createStyleSheet",
+      "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.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.CSS",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "cssText",
+          "type" : "String|Object",
+          "desc" : "The text containing the css rules",
+          "isOptional" : false
+        },
+        {
+          "name" : "id",
+          "type" : "String",
+          "desc" : "An id to add to the stylesheet for later removal",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "StyleSheet",
+          "desc" : ""
+        }
+      ]
+    },
+    {
+      "name" : "getRules",
+      "desc" : "Gets all css rules for the document",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.CSS",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "refreshCache",
+          "type" : "Boolean",
+          "desc" : "true to refresh the internal cache",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Object",
+          "desc" : "An object (hash) of rules indexed by selector"
+        }
+      ]
+    },
+    {
+      "name" : "swapStyleSheet",
+      "desc" : "Dynamically swaps an existing stylesheet reference for a new one",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.CSS",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "id",
+          "type" : "String",
+          "desc" : "The id of an existing link tag to remove",
+          "isOptional" : false
+        },
+        {
+          "name" : "url",
+          "type" : "String",
+          "desc" : "The href of the new stylesheet to include",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "updateRule",
+      "desc" : "Updates a rule property",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.CSS",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "selector",
+          "type" : "String/Array",
+          "desc" : "If it's an array it tries each selector until it finds one. Stops immediately once one is found.",
+          "isOptional" : false
+        },
+        {
+          "name" : "property",
+          "type" : "String",
+          "desc" : "The css property",
+          "isOptional" : false
+        },
+        {
+          "name" : "value",
+          "type" : "String",
+          "desc" : "The new value for the property",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Boolean",
+          "desc" : "true If a rule was found and updated"
+        }
+      ]
+    },
+    {
+      "name" : "getRule",
+      "desc" : "Gets an an individual CSS rule by selector(s)",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.CSS",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "selector",
+          "type" : "String/Array",
+          "desc" : "The CSS selector or an array of selectors to try. The first selector that is found is returned.",
+          "isOptional" : false
+        },
+        {
+          "name" : "refreshCache",
+          "type" : "Boolean",
+          "desc" : "true to refresh the internal cache if you have recently updated any rules or added styles dynamically",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "CSSRule",
+          "desc" : "The CSS rule or null if one is not found"
+        }
+      ]
+    },
+    {
+      "name" : "refreshCache",
+      "desc" : "Refresh the rule cache if you have dynamically added stylesheets",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.CSS",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Object",
+          "desc" : "An object (hash) of rules indexed by selector"
+        }
+      ]
+    },
+    {
+      "name" : "removeStyleSheet",
+      "desc" : "Removes a style or link tag by id",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.util.CSS",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "id",
+          "type" : "String",
+          "desc" : "The id of the tag",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file