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

[roojs1] / docs / symbols / Roo.Shadow.json

diff --git a/docs/symbols/Roo.Shadow.json b/docs/symbols/Roo.Shadow.json
new file mode 100644 (file)
index 0000000..3ce868d
--- /dev/null
+++ b/docs/symbols/Roo.Shadow.json
@@ -0,0 +1,162 @@
+{
+  "name" : "Roo.Shadow",
+  "augments" : [
+  ],
+  "desc" : "Simple class that can provide a shadow effect for any element.  Note that the element MUST be absolutely positioned,\nand the shadow does not provide any shimming.  This should be used only in simple cases -- for more advanced\nfunctionality that can also provide the same shadow effect, see the {@link Roo.Layer} class.",
+  "isSingleton" : false,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "Shadow",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+    {
+      "name" : "config",
+      "type" : "Object",
+      "desc" : "The config object",
+      "isOptional" : false
+    }
+  ],
+  "returns" : [
+  ],
+  "config" : [
+    {
+      "name" : "offset",
+      "type" : "String",
+      "desc" : "The number of pixels to offset the shadow from the element (defaults to 4)",
+      "memberOf" : "Roo.Shadow",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "mode",
+      "type" : "String",
+      "desc" : "The shadow display mode.  Supports the following options:<br />\nsides: Shadow displays on both sides and bottom only<br />\nframe: Shadow displays equally on all four sides<br />\ndrop: Traditional bottom-right drop shadow (default)",
+      "memberOf" : "Roo",
+      "values" : [
+      ]
+    }
+  ],
+  "methods" : [
+    {
+      "name" : "setZIndex",
+      "desc" : "Adjust the z-index of this shadow",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.Shadow",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "zindex",
+          "type" : "Number",
+          "desc" : "The new z-index",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "isVisible",
+      "desc" : "Returns true if the shadow is visible, else false",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.Shadow",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "hide",
+      "desc" : "Hides this shadow",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.Shadow",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "show",
+      "desc" : "Displays the shadow under the target element",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.Shadow",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "targetEl",
+          "type" : "String/HTMLElement/Element",
+          "desc" : "The id or element under which the shadow should display",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "realign",
+      "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.Shadow",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "left",
+          "type" : "Number",
+          "desc" : "The target element left position",
+          "isOptional" : false
+        },
+        {
+          "name" : "top",
+          "type" : "Number",
+          "desc" : "The target element top position",
+          "isOptional" : false
+        },
+        {
+          "name" : "width",
+          "type" : "Number",
+          "desc" : "The target element width",
+          "isOptional" : false
+        },
+        {
+          "name" : "height",
+          "type" : "Number",
+          "desc" : "The target element height",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file