git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.Shadow.json

   1 {
   2   "name" : "Roo.Shadow",
   3   "augments" : [
   4   ],
   5   "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.",
   6   "isSingleton" : false,
   7   "isStatic" : true,
   8   "isBuiltin" : false,
   9   "config" : [
  10     {
  11       "name" : "offset",
  12       "type" : "String",
  13       "desc" : "The number of pixels to offset the shadow from the element (defaults to 4)",
  14       "memberOf" : "Roo.Shadow",
  15       "values" : [
  16       ]
  17     },
  18     {
  19       "name" : "mode",
  20       "type" : "String",
  21       "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)",
  22       "memberOf" : "Roo",
  23       "values" : [
  24       ]
  25     }
  26   ],
  27   "methods" : [
  28     {
  29       "name" : "setZIndex",
  30       "desc" : "Adjust the z-index of this shadow",
  31       "isStatic" : false,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "memberOf" : "Roo.Shadow",
  35       "example" : "",
  36       "deprecated" : "",
  37       "since" : "",
  38       "see" : "",
  39       "params" : [
  40         {
  41           "name" : "zindex",
  42           "type" : "Number",
  43           "desc" : "The new z-index",
  44           "isOptional" : false
  45         }
  46       ],
  47       "returns" : [
  48       ]
  49     },
  50     {
  51       "name" : "isVisible",
  52       "desc" : "Returns true if the shadow is visible, else false",
  53       "isStatic" : false,
  54       "isConstructor" : false,
  55       "isPrivate" : false,
  56       "memberOf" : "Roo.Shadow",
  57       "example" : "",
  58       "deprecated" : "",
  59       "since" : "",
  60       "see" : "",
  61       "params" : [
  62       ],
  63       "returns" : [
  64       ]
  65     },
  66     {
  67       "name" : "hide",
  68       "desc" : "Hides this shadow",
  69       "isStatic" : false,
  70       "isConstructor" : false,
  71       "isPrivate" : false,
  72       "memberOf" : "Roo.Shadow",
  73       "example" : "",
  74       "deprecated" : "",
  75       "since" : "",
  76       "see" : "",
  77       "params" : [
  78       ],
  79       "returns" : [
  80       ]
  81     },
  82     {
  83       "name" : "show",
  84       "desc" : "Displays the shadow under the target element",
  85       "isStatic" : false,
  86       "isConstructor" : false,
  87       "isPrivate" : false,
  88       "memberOf" : "Roo.Shadow",
  89       "example" : "",
  90       "deprecated" : "",
  91       "since" : "",
  92       "see" : "",
  93       "params" : [
  94         {
  95           "name" : "targetEl",
  96           "type" : "String/HTMLElement/Element",
  97           "desc" : "The id or element under which the shadow should display",
  98           "isOptional" : false
  99         }
 100       ],
 101       "returns" : [
 102       ]
 103     },
 104     {
 105       "name" : "realign",
 106       "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.",
 107       "isStatic" : false,
 108       "isConstructor" : false,
 109       "isPrivate" : false,
 110       "memberOf" : "Roo.Shadow",
 111       "example" : "",
 112       "deprecated" : "",
 113       "since" : "",
 114       "see" : "",
 115       "params" : [
 116         {
 117           "name" : "left",
 118           "type" : "Number",
 119           "desc" : "The target element left position",
 120           "isOptional" : false
 121         },
 122         {
 123           "name" : "top",
 124           "type" : "Number",
 125           "desc" : "The target element top position",
 126           "isOptional" : false
 127         },
 128         {
 129           "name" : "width",
 130           "type" : "Number",
 131           "desc" : "The target element width",
 132           "isOptional" : false
 133         },
 134         {
 135           "name" : "height",
 136           "type" : "Number",
 137           "desc" : "The target element height",
 138           "isOptional" : false
 139         }
 140       ],
 141       "returns" : [
 142       ]
 143     }
 144   ],
 145   "events" : [
 146   ]
 147 }