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