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

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