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

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