| { "type": "class", | |
| "qname": "mx.core.ScrollControlBase", | |
| "baseClassname": "mx.core.UIComponent" | |
| , | |
| "description": "The ScrollControlBase class is the base class for controls with scroll bars. The user interacts with the scroll bar or the developer accesses methods and properties that alter the viewable area. The ScrollControlBase takes a single child object and positions and masks or sizes that object to display the viewable content. All items to be scrolled must be children of that content object <p>The <code><ScrollControlBase></code> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:</p> <pre>\\n <mx:<i>tagname</i>\\n <b>Properties</b>\\n border="<i>object of border skin style</i>"\\n horizontalScrollPolicy="off|on|auto"\\n horizontalScrollPosition="0"\\n liveScrolling="true|false"\\n maxHorizontalScrollPosition="NaN"\\n maxVerticalScrollPosition="NaN"\\n scrollTipFunction="undefined"\\n showScrollTips="false|true"\\n verticalScrollPolicy="auto|off|on"\\n verticalScrollPosition="0"\\n <b>Styles</b>\\n backgroundAlpha="1.0"\\n backgroundColor="undefined"\\n backgroundImage="undefined"\\n backgroundSize="auto"\\n borderColor="0xAAB3B3"\\n borderSides="left top right bottom"\\n borderSkin="ClassReference('mx.skins.halo.HaloBorder')"\\n borderStyle="inset"\\n borderThickness="1"\\n color="0x0B333C"\\n cornerRadius="0"\\n disabledColor="0xAAB3B3"\\n dropShadowColor="0x000000"\\n dropShadowEnabled="false"\\n fontFamily="Verdana"\\n fontSize="10"\\n fontStyle="normal|italic"\\n fontWeight="normal|bold"\\n horizontalScrollBarStyleName=""\\n leading="2"\\n shadowDirection="center"\\n shadowDistance="2"\\n textAlign="<i>value; see detail.</i>"\\n textDecoration="none|underline"\\n textIndent="0"\\n verticalScrollBarStyleName=""\\n \\n <b>Events</b>\\n scroll="<i>No default</i>"\\n />\\n </pre>", | |
| "tags": [ | |
| { "tagName": "helpid", | |
| "values": ["3270"]}, | |
| { "tagName": "tiptext", | |
| "values": ["base class for views/containers that support scrolling"]}, | |
| { "tagName": "mxml", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "mx.core.ScrollControlBase", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructor.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": []} | |
| , | |
| { "type": "field", | |
| "qname": "_maxHorizontalScrollPosition", | |
| "return": "Number", | |
| "namespace": "mx_internal", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}}, | |
| { "type": "field", | |
| "qname": "scrollAreaChanged", | |
| "return": "Boolean", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "A flag that the scrolling area changed due to the appearance or disappearance of scrollbars. Used by most layout methods to re-adjust the scrolling properties again.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "uint", | |
| "qname": "contentBackgroundColor", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Boolean", | |
| "qname": "borderVisible", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Number", | |
| "qname": "horizontalScrollPosition", | |
| "namespace": "public", | |
| "bindable": ["viewChanged","scroll"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The offset into the content from the left edge. This can be a pixel offset in some subclasses or some other metric like the number of columns in a DataGrid or number of items in a HorizontalList or TileList.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["0"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "horizontalScrollPolicy", | |
| "namespace": "public", | |
| "bindable": ["horizontalScrollPolicyChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "A property that indicates whether the horizontal scroll bar is always on, always off, or automatically changes based on the parameters passed to the <code>setScrollBarProperties()</code> method. Allowed values are <code>ScrollPolicy.ON</code>, <code>ScrollPolicy.OFF</code>, and <code>ScrollPolicy.AUTO</code>. MXML values can be <code>"on"</code>, <code>"off"</code>, and <code>"auto"</code>. <p>Setting this property to <code>ScrollPolicy.OFF</code> for ListBase subclasses does not affect the <code>horizontalScrollPosition</code> property; you can still scroll the contents programmatically.</p> <p>Note that the policy can affect the measured size of the component If the policy is <code>ScrollPolicy.AUTO</code> the scrollbar is not factored in the measured size. This is done to keep the layout from recalculating when the scrollbar appears. If you know that you will have enough data for scrollbars you should set the policy to <code>ScrollPolicy.ON</code>. If you don't know, you may need to set an explicit width or height on the component to allow for scrollbars to appear later.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["ScrollPolicy.OFF"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Number", | |
| "qname": "maxHorizontalScrollPosition", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The maximum value for the <code>horizontalScrollPosition</code> property. Note that this is not the width of the content because the <code>maxHorizontalScrollPosition</code> property contains the width of the content minus the width of the displayable area. <p>In most components, the value of the <code>maxHorizontalScrollPosition</code> property is computed from the data and size of component, and must not be set by the application code.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Number", | |
| "qname": "maxVerticalScrollPosition", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The maximum value for the <code>verticalScrollPosition</code> property. Note that this is not the height of the content because the <code>maxVerticalScrollPosition</code> property contains the height of the content minus the height of the displayable area. <p>The value of the <code>maxVerticalScrollPosition</code> property is computed from the data and size of component, and must not be set by the application code.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Number", | |
| "qname": "verticalScrollPosition", | |
| "namespace": "public", | |
| "bindable": ["viewChanged","scroll"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The offset into the content from the top edge. This can be a pixel offset in some subclasses or some other metric like number of lines in a List or number of tiles in a TileList.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["0"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "verticalScrollPolicy", | |
| "namespace": "public", | |
| "bindable": ["verticalScrollPolicyChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "A property that indicates whether the vertical scroll bar is always on, always off, or automatically changes based on the parameters passed to the <code>setScrollBarProperties()</code> method. Allowed values are <code>ScrollPolicy.ON</code>, <code>ScrollPolicy.OFF</code>, and <code>ScrollPolicy.AUTO</code>. MXML values can be <code>"on"</code>, <code>"off"</code>, and <code>"auto"</code>. <p>Setting this property to <code>ScrollPolicy.OFF</code> for ListBase subclasses does not affect the <code>verticalScrollPosition</code> property; you can still scroll the contents programmatically.</p> <p>Note that the policy can affect the measured size of the component If the policy is <code>ScrollPolicy.AUTO</code> the scrollbar is not factored in the measured size. This is done to keep the layout from recalculating when the scrollbar appears. If you know that you will have enough data for scrollbars you should set the policy to <code>ScrollPolicy.ON</code>. If you don't know, you may need to set an explicit width or height on the component to allow for scrollbars to appear later.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["ScrollPolicy.AUTO"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "textDecoration", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}}, | |
| { "type": "method", | |
| "qname": "addedToParent", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "return": "void", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "getHorizontalScrollElement", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "return": "HTMLElement", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "getVerticalScrollElement", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "return": "HTMLElement", | |
| "params": []} | |
| ] | |
| , | |
| "events": [ | |
| { "qname": "scroll", | |
| "type": "mx.events.ScrollEvent" | |
| , | |
| "description": "Dispatched when the content is scrolled.", | |
| "tags": [ | |
| { "tagName": "helpid", | |
| "values": ["3269"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.ScrollEvent.SCROLL"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |