asdoc/mx/events/ScrollEvent.swf.json

{ "type": "class",
  "qname": "mx.events.ScrollEvent",
  "baseClassname": "org.apache.royale.events.Event"
  ,
    "description": "Represents events that are dispatched by the ScrollBar class.",
  "tags": [
  {  "tagName": "see",
         "values": ["mx.core.UIComponent"]},
      {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.9.3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]},
      {  "tagName": "royalesuppresspublicvarwarning",
         "values": []}  ],
  "members": [
  { "type": "field",
        "qname": "SCROLL",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The <code>ScrollEvent.SCROLL</code> constant defines the value of the <code>type</code> property of the event object for a scroll event.  <p>The properties of the event object have the following values:</p> <table class=&quot;innertable&quot;> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td>false</td></tr> <tr><td><code>cancelable</code></td><td>false</td></tr> <tr><td><code>currentTarget</code></td><td>The Object that defines the event listener that handles the event. For example, if you use <code>myButton.addEventListener()</code> to register an event listener, myButton is the value of the <code>currentTarget</code>. </td></tr> <tr><td><code>delta</code></td><td>Contains the change in scroll position, expressed in pixels. A positive value indicates the scroll was down or to the right. A negative value indicates the scroll was up or to the left.</td></tr> <tr><td><code>direction</code></td><td>Contains the scroll direction, either <code>ScrollEventDirection.HORIZONTAL</code> or <code>ScrollEventDirection.VERTICAL</code>.</td></tr> <tr><td><code>position</code></td><td>Contains the new scroll position.</td></tr> <tr><td><code>target</code></td><td>The Object that dispatched the event; it is not always the Object listening for the event. Use the <code>currentTarget</code> property to always access the Object listening for the event.</td></tr> </table>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "eventType",
               "values": ["scroll"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "mx.events.ScrollEvent",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.   up the display list hierarchy.  can be prevented.  Constants for the possible values are provided in the ScrollEventDetail class.   either <code>ScrollEventDirection.HORIZONTAL</code> or <code>ScrollEventDirection.VERTICAL</code>.",
        "tags": [
        {  "tagName": "param",
               "values": ["type The event type; indicates the action that caused the event.", "bubbles Specifies whether the event can bubble", "cancelable Specifies whether the behavior associated with the event", "detail Provides the specifics of the type of scroll activity.", "position The new scroll position.", "direction The scroll direction,", "delta The change in scroll position, expressed in pixels."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "type", "type": "String"},
        { "name": "bubbles", "type": "Boolean"},
        { "name": "cancelable", "type": "Boolean"},
        { "name": "detail", "type": "String"},
        { "name": "position", "type": "Number"},
        { "name": "direction", "type": "String"},
        { "name": "delta", "type": "Number"}]}
      ,
      { "type": "field",
        "qname": "delta",
        "return": "Number",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The change in the scroll position value that resulted from the scroll. The value is expressed in pixels. A positive value indicates the scroll was down or to the right. A negative value indicates the scroll was up or to the left.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "detail",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Provides the details of the scroll activity. Constants for the possible values are provided in the ScrollEventDetail class.",
        "tags": [
        {  "tagName": "see",
               "values": ["mx.events.ScrollEventDetail"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "direction",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The direction of motion. The possible values are <code>ScrollEventDirection.VERTICAL</code> or <code>ScrollEventDirection.HORIZONTAL</code>.",
        "tags": [
        {  "tagName": "see",
               "values": ["mx.events.ScrollEventDirection"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "position",
        "return": "Number",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The new scroll position.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }