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

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