asdoc/mx/controls/VScrollBar.swf.json

{ "type": "class",
  "qname": "mx.controls.VScrollBar",
  "baseClassname": "mx.core.UIComponent"
  ,
    "description": "The VScrollBar (vertical ScrollBar) control  lets you control the portion of data that is displayed when there is too much data to fit in a display area.  This control extends the base ScrollBar control.  <p>Although you can use the VScrollBar control as a stand-alone control, you usually combine it as part of another group of components to provide scrolling functionality.</p>  <p>A ScrollBar control consist of four parts: two arrow buttons, a track, and a thumb. The position of the thumb and the display of the arrow buttons depend on the current state of the ScrollBar control. The ScrollBar control uses four parameters to calculate its display state:</p>  <ul> <li>Minimum range value</li> <li>Maximum range value</li> <li>Current position - must be within the minimum and maximum range values</li> <li>Viewport size - represents the number of items in the range that you can display at one time. The number of items must be less than or equal to the range, where the range is the set of values between the minimum range value and the maximum range value.</li> </ul>   <p>The <code>&lt;mx:VScrollBar&gt;</code> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:</p>  <pre>\\n &lt;mx:VScrollBar\\n <strong>Styles</strong>\\n repeatDelay=&quot;500&quot;\\n repeatInterval=&quot;35&quot;\\n \\n <strong>Events</strong>\\n scroll=&quot;<i>No default</i>&quot;\\n /&gt;\\n </pre>",
  "tags": [
  {  "tagName": "includeExample",
         "values": ["examples/VScrollBarExample.mxml"]},
      {  "tagName": "see",
         "values": ["mx.controls.scrollClasses.ScrollBar"]},
      {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "mxml",
         "values": []},
      {  "tagName": "productversion",
         "values": ["Royale 0.9.3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.controls.VScrollBar",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "scrollPosition",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Number that represents the current scroll position.  The value is between <code>minScrollPosition</code> and <code>maxScrollPosition</code> inclusively.",
        "tags": [
        {  "tagName": "default",
               "values": ["0"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "setScrollProperties",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Sets the range and viewport size of the ScrollBar control.  The ScrollBar control updates the state of the arrow buttons and size of the scroll thumb accordingly.   scrolling range.  scrolling range.  the scroll track is pressed.",
        "tags": [
        {  "tagName": "param",
               "values": ["pageSize Number which represents the size of one page.", "minScrollPosition Number which represents the bottom of the", "maxScrollPosition Number which represents the top of the", "pageScrollSize Number which represents the increment to move when"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "pageSize", "type": "Number"},
        { "name": "minScrollPosition", "type": "Number"},
        { "name": "maxScrollPosition", "type": "Number"},
        { "name": "pageScrollSize", "type": "Number"}]}
      ]
  }