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