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