ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.components 

Scroller  - AS3 Flex

Packagespark.components
Classpublic class Scroller
InheritanceScroller Inheritance SkinnableComponent Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusManagerComponent, IVisualElementContainer
Subclasses AXMScroller

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The Scroller component displays a single scrollable component, called a viewport, and horizontal and vertical scroll bars. The viewport must implement the IViewport interface. Its skin must be a derivative of the Group class.

The Spark Group, DataGroup, and RichEditableText components implement the IViewport interface and can be used as the children of the Scroller control, as the following example shows:

  <s:Scroller width="100" height="100">
       <s:Group> 
          <mx:Image width="300" height="400" 
               source="@Embed(source='assets/logo.jpg')"/> 
       </s:Group>        
  </s:Scroller>

The size of the Image control is set larger than that of its parent Group container. By default, the child extends past the boundaries of the parent container. Rather than allow the child to extend past the boundaries of the parent container, the Scroller specifies to clip the child to the boundaries and display scroll bars.

Not all Spark containers implement the IViewPort interface. Therefore, those containers, such as the BorderContainer and SkinnableContainer containers, cannot be used as the direct child of the Scroller component. However, all Spark containers can have a Scroller component as a child component. For example, to use scroll bars on a child of the Spark BorderContainer, wrap the child in a Scroller component.

To make the entire BorderContainer scrollable, wrap it in a Group container. Then, make the Group container the child of the Scroller component, For skinnable Spark containers that do not implement the IViewport interface, you can also create a custom skin for the container that includes the Scroller component.

The IViewport interface defines a viewport for the components that implement it. A viewport is a rectangular subset of the area of a container that you want to display, rather than displaying the entire container. The scroll bars control the viewport's horizontalScrollPosition and verticalScrollPosition properties. scroll bars make it possible to view the area defined by the viewport's contentWidth and contentHeight properties.

You can directly set properties on the component wrapped by the Scroller by using the Scroller.viewport property. For example, you can modify the viewport's horizontalScrollPosition and verticalScrollPosition properties.

To directly access the scroll bar instances, either HScrollBar or VScrollBar, created by the Scroller, use the Scroller.horizontalScrollBar and Scroller.verticalScrollBar properties.

You can combine scroll bars with explicit settings for the container's viewport. The viewport settings determine the initial position of the viewport, and then you can use the scroll bars to move it, as the following example shows:

  <s:Scroller width="100" height="100">
      <s:Group
          horizontalScrollPosition="50" verticalScrollPosition="50"> 
          <mx:Image width="300" height="400" 
              source="@Embed(source='assets/logo.jpg')"/> 
      </s:Group>                 
  </s:Scroller>

The scroll bars are displayed according to the vertical and horizontal scroll bar policy, which can be auto, on, or off. The auto policy means that the scroll bar will be visible and included in the layout when the viewport's content is larger than the viewport itself.

The Scroller skin layout cannot be changed. It is unconditionally set to a private layout implementation that handles the scroll policies. Scroller skins can only provide replacement scroll bars. To gain more control over the layout of a viewport and its scroll bars, instead of using Scroller, just add them to a Group and use the scroll bar viewport property to link them together.

The Scroller control has the following default characteristics:

CharacteristicDescription
Default size0
Minimum size0
Maximum size10000 pixels wide and 10000 pixels high
Default skin classspark.skins.spark.ScrollerSkin

MXML SyntaxexpandedHide MXML Syntax

The <s:Scroller> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:Scroller
   Properties
    measuredSizeIncludesScrollBars="true"
    minViewportInset="0"
    viewport="null"
  
    Styles
    alignmentBaseline="use_dominant_baseline"
    alternatingItemColors=""
    baselineShift="0.0"
    blockProgression="TB"
    breakOpportunity="auto"
    cffHinting="horizontal_stem"
    clearFloats="none"
    color="0"
    contentBackgroundAlpha=""
    contentBackgroundColor=""
    digitCase="default"
    digitWidth="default"
    direction="LTR"
    dominantBaseline="auto"
    downColor=""
    firstBaselineOffset="auto"
    focusColor=""
    focusedTextSelectionColor=""
    fontFamily="Arial"
    fontLookup="device"
    fontSize="12"
    fontStyle="normal"
    fontWeight="normal"
    horizontalScrollPolicy="auto"
    inactiveTextSelection=""
    justificationRule="auto"
    justificationStyle="auto"
    kerning="auto"
    leadingModel="auto"
    ligatureLevel="common"
    lineHeight="120%"
    lineThrough="false"
    listAutoPadding="40"
    listStylePosition="outside"
    listStyleType="disc"
    locale="en"
    paragraphEndIndent="0"
    paragraphSpaceAfter="0"
    paragraphSpaceBefore="0"
    paragraphStartIndent="0"
    renderingMode="CFF"
    rollOverColor=""
    symbolColor=""
    tabStops="null"
    textAlign="start"
    textAlignLast="start"
    textAlpha="1"
    textDecoration="none"
    textIndent="0"
    textJustify="inter_word"
    textRotation="auto"
    trackingLeft="0"
    trackingRight="0"
    typographicCase="default"
    unfocusedTextSelectionColor=""
    verticalScrollPolicy="auto"
    whiteSpaceCollapse="collapse"
    wordSpacing="100%,50%,150%"
  />
  

Default MXML Propertyviewport

View the examples

More examples

Learn more

Related API Elements



Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIComponent
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 Inheritedbaseline : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbaselinePosition : Number
[override] [read-only] The y-coordinate of the baseline of the first line of text of the component.
SkinnableComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 Inheritedbottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 Inherited    cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
UIComponent
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
  measuredSizeIncludesScrollBars : Boolean
If true, the Scroller's measured size includes the space required for the visible scroll bars, otherwise the Scroller's measured size depends only on its viewport.
Scroller
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedmetaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
DisplayObject
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
  minViewportInset : Number
The minimum space between the viewport and the edges of the Scroller.
Scroller
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritedneedsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.
InteractiveObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
  numElements : int
[read-only] Returns 1 if there is a viewport, 0 otherwise.
Scroller
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
      pageScrollingEnabled : Boolean
By default, for mobile applications, scrolling is pixel based.
Scroller
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 Inheritedright : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedroot : DisplayObject
[read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
DisplayObject
 Inheritedrotation : Number
[override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
      scrollSnappingMode : String
By default, for mobile applications, scrolling is pixel based.
Scroller
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 Inheritedskin : UIComponent
[read-only] The instance of the skin class for this component instance.
SkinnableComponent
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsuggestedFocusSkinExclusions : Array
[read-only] Lists the skin parts that are excluded from bitmaps captured and used to show focus.
SkinnableComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIComponent
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedtransform : flash.geom:Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  viewport : IViewport
The viewport component to be scrolled.
Scroller
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
 InheritedcurrentCSSState : String
[override] [read-only] The state to be used when matching CSS pseudo-selectors.
SkinnableComponent
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
Public Methods
 MethodDefined By
  
Constructor.
Scroller
  
This operation is not supported in Scroller.
Scroller
  
This operation is not supported in Scroller.
Scroller
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Adds a non-visual style client to this component instance.
UIComponent
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
  
Scrolls the viewport so the specified element is visible.
Scroller
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
  
Returns the viewport if there is a viewport and the index passed in is 0.
Scroller
  
Returns 0 if the element passed in is the viewport.
Scroller
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
Gets the object that currently has focus.
UIComponent
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Returns true if currentCSSState is not null.
UIComponent
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Marks the component so that the new state of the skin is set during a later screen update.
SkinnableComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Moves the component to a specified position within its parent.
UIComponent
 Inherited
Propagates style changes to the children.
UIComponent
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
  
This operation is not supported in Scroller.
Scroller
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
  
This operation is not supported in Scroller.
Scroller
  
This operation is not supported in Scroller.
Scroller
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Removes a non-visual style client from this component instance.
UIComponent
 Inherited
Replays the specified event.
UIComponent
 Inherited
Raises a virtual keyboard.
InteractiveObject
 Inherited
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
  
This operation is not supported in Scroller.
Scroller
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Recursively stops the timeline execution of all MovieClips rooted at this object.
DisplayObjectContainer
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
  
This operation is not supported in Scroller.
Scroller
  
swapElementsAt(index1:int, index2:int):void
This operation is not supported in Scroller.
Scroller
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Adjust the focus rectangle.
UIComponent
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Create the skin for the component.
SkinnableComponent
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Clear out references to skin parts.
SkinnableComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
Create child objects of the component.
UIComponent
 Inherited
Create an instance of a dynamic skin part.
SkinnableComponent
 Inherited
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
Destroys and removes the skin for this component.
SkinnableComponent
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
Find the skin parts in the skin class and assign them to the properties of the component.
SkinnableComponent
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Returns the name of the state to be applied to the skin.
SkinnableComponent
 Inherited
Returns a specific instance of a dynamic part.
SkinnableComponent
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
The event handler called for a keyUp event.
UIComponent
 Inherited
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
Returns the number of instances of a dynamic part.
SkinnableComponent
 Inherited
partAdded(partName:String, instance:Object):void
Called when a skin part is added.
SkinnableComponent
 Inherited
partRemoved(partName:String, instance:Object):void
Called when an instance of a skin part is being removed.
SkinnableComponent
 Inherited
Remove an instance of a dynamic part.
SkinnableComponent
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited
    contextMenu
Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched just before the component exits a view state.UIComponent
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
  Dispatched when the scroll position is going to change due to a mouseWheel event.Scroller
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited
    proximityEnd
Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.InteractiveObject
 Inherited
    proximityOut
Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).InteractiveObject
 InheritedDispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched immediately after the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately before the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately after the soft keyboard is lowered.InteractiveObject
 InheritedDispatched after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
 InheritedDispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedA non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
 InheritedA cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.UIComponent
 InheritedDispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
 Style Description Defined By
  
alignmentBaseline
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the baseline to which the dominant baseline aligns.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
  
baselineShift
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Amount to shift the baseline.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
blockProgression
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies a vertical or horizontal progression of line placement.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
  
breakOpportunity
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls where lines are allowed to break when breaking wrapping text into multiple lines.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
cffHinting
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The type of CFF hinting used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.cffHinting.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
clearFloats
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls how text wraps around a float.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.clearFloats.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
color
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.color.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style color, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style color.

The default value is 0x000000.

Related API Elements

Scroller
  
digitCase
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The type of digit case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitCase.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
digitWidth
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Type of digit width used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitWidth.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
direction
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the default bidirectional embedding level of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.direction.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
dominantBaseline
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Color of the component highlight when validation fails.
UIComponent
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Name of the skin class to use for this component when a validation error occurs.
SkinnableComponent
  
firstBaselineOffset
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the baseline position of the first line in the container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Blend mode used by the focus rectangle.
UIComponent
  
focusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of text when the component is enabled and has focus.

For the Mobile theme, this is not supported.

Scroller
 InheritedType: Class CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Thickness, in pixels, of the focus rectangle outline.
UIComponent
  
fontFamily
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The name of the font to use, or a comma-separated list of font names.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontFamily.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontFamily, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontFamily.

The default value for the Spark theme is Arial. The default value for the Mobile theme is _sans.

Related API Elements

Scroller
  
fontLookup
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Font lookup to use.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
fontSize
Type: Number Format: Length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Height of the text, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontSize

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontSize, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontSize.

The default value for the Spark theme is 12. The default value for the Mobile theme is 24.

Related API Elements

Scroller
  
fontStyle
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is italic font.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontStyle

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontStyle, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontStyle.

Related API Elements

Scroller
  
fontWeight
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is boldface.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontWeight

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontWeight, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontWeight.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
horizontalScrollPolicy
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Indicates under what conditions the horizontal scroll bar is displayed.
  • ScrollPolicy.ON ("on") - the scroll bar is always displayed.
  • ScrollPolicy.OFF ("off") - the scroll bar is never displayed. The viewport can still be scrolled programmatically, by setting its horizontalScrollPosition property.
  • ScrollPolicy.AUTO ("auto") - the scroll bar is displayed when the viewport's contentWidth is larger than its width.

The scroll policy affects the measured size of the Scroller component.

The default value is ScrollPolicy.AUTO.

Related API Elements

Scroller
  
inactiveTextSelectionColor
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of text when the component is disabled.

For the Mobile theme, this is not supported.

Scroller
 InheritedType: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 2.5

The primary interaction mode for this component.
UIComponent
  
justificationRule
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Rule used to justify text in a paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationRule

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
justificationStyle
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The style used for justification of the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationStyle

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
kerning
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The style used for justification of the paragraph.

Kerning is enabled by default for Spark components, but is disabled by default for MX components. Spark components interpret default as auto, while MX components interpret default as false.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.1  Runtime Versions: Flash10, AIR 1.5

Specifies the desired layout direction of a component.
UIComponent
  
leadingModel
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the leading model, which is a combination of leading basis and leading direction.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.leadingModel.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
  
ligatureLevel
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls which of the ligatures that are defined in the font may be used in the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
lineHeight
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Leading controls for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight.

For the Mobile theme, this is not supported. See leading.

Related API Elements

Scroller
  
lineThrough
Type: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

If true, applies strikethrough, a line drawn through the middle of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineThrough

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
listAutoPadding
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
listStylePosition
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 2.5

This controls the placement of a list item marker relative to the list item.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStylePosition.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
listStyleType
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 2.5

This controls the appearance of items in a list.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStyleType.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
liveScrolling
Type: Boolean CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

A proxy for the liveDragging style of the scrollbars used by the Scroller component.

If this style is set to true, then the liveDragging styles are set to true (the default). That means dragging a scrollbar thumb immediately updates the viewport's scroll position. If this style is set to false, then the liveDragging styles are set to false. That means when a scrollbar thumb is dragged the viewport's scroll position is only updated then the mouse button is released.

Setting this style to false can be helpful when updating the viewport's display is so expensive that "liveDragging" performs poorly.

By default this style is undefined, which means that the liveDragging styles are not modified.

The default value is undefined.
Scroller
  
locale
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The locale of the text. Controls case transformations and shaping. Uses standard locale identifiers as described in Unicode Technical Standard #35. For example "en", "en_US" and "en-US" are all English, "ja" is Japanese.

The default value is undefined. This property inherits its value from an ancestor; if still undefined, it inherits from the global locale style. During the application initialization, if the global locale style is undefined, then the default value is set to "en".

When using the Spark formatters and globalization classes, you can set this style on the root application to the value of the LocaleID.DEFAULT constant. Those classes will then use the client operating system's international preferences.

The default value is undefined.

Learn more

Scroller
  
paragraphEndIndent
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount to indent the paragraph's end edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
paragraphSpaceAfter
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of space to leave after the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
paragraphSpaceBefore
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of space to leave before the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
paragraphStartIndent
Type: Number Format: length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount to indent the paragraph's start edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
renderingMode
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The rendering mode used for this text which applies only to embedded fonts.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.renderingMode

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 1.5

Show the error border or skin when this component is invalid
UIComponent
 InheritedType: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 1.5

Show the error tip when this component is invalid and the user rolls over it
UIComponent
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Name of the skin class to use for this component.
SkinnableComponent
  
tabStops
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the tab stops associated with the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.tabStops.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
textAlign
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Alignment of text within a container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlign

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textAlign, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style textAlign.

Related API Elements

Scroller
  
textAlignLast
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Alignment of the last line in the paragraph relative to the container in justified text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlignLast

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
textAlpha
Type: Number CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Alpha (transparency) value for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
textDecoration
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is underlined.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textDecoration

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textDecoration, and if using StyleableStageText, this is not supported.

Related API Elements

Scroller
  
textIndent
Type: Number Format: Length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Offset of first line of text from the left side of the container. .

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textIndent.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textIndent, and if using StyleableStageText this is not supported.

Related API Elements

Scroller
  
textJustify
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies options for justifying text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
textRotation
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines the number of degrees to rotate this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textRotation.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
  
touchDelay
Type: Number Format: Time CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.1, AIR 2.5

When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state.

The reason for this delay is because when a user initiates a scroll gesture, we don't want components to flicker as they touch the screen. By having a reasonable delay, we make sure that the user still gets feedback when they press down on a component, but that the feedback doesn't come too quickly that it gets displayed during a scroll gesture operation.

If the mobile theme is applied, the default value for this style is 100 ms for components inside of a Scroller and 0 ms for components outside of a Scroller.

Scroller
  
trackingLeft
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of tracking (manual kerning) to be applied to the left of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingLeft

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
trackingRight
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The amount of tracking (manual kerning) to be applied to the right of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingRight

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
typographicCase
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The type of typographic case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.typographicCase

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
unfocusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of text when the component is enabled but does not have focus.

For the Mobile theme, this is not supported.

Scroller
 InheritedType: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
verticalScrollPolicy
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Indicates under what conditions the vertical scroll bar is displayed.
  • ScrollPolicy.ON ("on") - the scroll bar is always displayed.
  • ScrollPolicy.OFF ("off") - the scroll bar is never displayed. The viewport can still be scrolled programmatically, by setting its verticalScrollPosition property.
  • ScrollPolicy.AUTO ("auto") - the scroll bar is displayed when the viewport's contentHeight is larger than its height.

The scroll policy affects the measured size of the Scroller component.

The default value is ScrollPolicy.AUTO.

Related API Elements

Scroller
  
whiteSpaceCollapse
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Collapses or preserves whitespace when importing text into a TextFlow.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
  
wordSpacing
Type: Object CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.5, AIR 2.0

Specifies the spacing between words to use during justification.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.wordSpacing.

For the Mobile theme, this is not supported.

Related API Elements

Scroller
Spark Theme Styles
 Style Description Defined By
  
alternatingItemColors
Type: Array Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The colors to use for the backgrounds of the items in the list. The value is an array of one or more colors. The backgrounds of the list items alternate among the colors in the array.

The default value for the Spark theme is undefined. The default value for the Mobile theme is 0xFFFFFF.

Scroller
 InheritedType: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The main color for a component.
SkinnableComponent
  
contentBackgroundAlpha
Type: Number CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The alpha of the content background for this component.
Scroller
  
contentBackgroundColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of the content background for this component.

For a List, changing contentBackgroundColor will change the content background color of the List; however, if the item renderer is opaque, the user may not see any difference. The item renderer's color is affected by alternatingItemColors. In the Spark theme, by default, item renderers are transparent (alternatingItemColors = undefined); however, in the Mobile theme, item renderers are opaque by default (alternatingItemColors = 0xFFFFFF).

The default value for the Spark theme is 0xFFFFFF. The default value for the Mobile theme is 0xF0F0F0.

Scroller
  
focusColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of focus ring when the component is in focus.
Scroller
  
rollOverColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of the highlights when the mouse is over the component.

This style is only applicable in mouse interactionMode.

The default value is 0xCEDBEF.
Scroller
  
symbolColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button.
Scroller
Mobile Theme Styles
 Style Description Defined By
  
alternatingItemColors
Type: Array Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The colors to use for the backgrounds of the items in the list. The value is an array of one or more colors. The backgrounds of the list items alternate among the colors in the array.

The default value for the Spark theme is undefined. The default value for the Mobile theme is 0xFFFFFF.

Scroller
 InheritedType: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The main color for a component.
SkinnableComponent
  
contentBackgroundAlpha
Type: Number CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The alpha of the content background for this component.
Scroller
  
contentBackgroundColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The color of the content background for this component.

For a List, changing contentBackgroundColor will change the content background color of the List; however, if the item renderer is opaque, the user may not see any difference. The item renderer's color is affected by alternatingItemColors. In the Spark theme, by default, item renderers are transparent (alternatingItemColors = undefined); however, in the Mobile theme, item renderers are opaque by default (alternatingItemColors = 0xFFFFFF).

The default value for the Spark theme is 0xFFFFFF. The default value for the Mobile theme is 0xF0F0F0.

Scroller
  
downColor
Type: uint Format: Color CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.1, AIR 2.5

Color of the background of an item renderer when it is being pressed down

If downColor is set to undefined, downColor is not used.

The default value for the Spark theme is undefined. The default value for the Mobile theme is 0xE0E0E0.

Scroller
  
focusColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of focus ring when the component is in focus.
Scroller
  
leading
Type: Number Format: Length CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.1, AIR 2.0

Additional vertical space between lines of text.

For the Spark theme, this is not supported. See lineHeight.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableStageText Style fontWeight and if using StyleableStageText, this is not supported.

Related API Elements

Scroller
  
letterSpacing
Type: Number CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.1, AIR 2.0

The number of additional pixels to appear between each character.

For the Spark theme, this is not supported. See trackingLeft and trackingRight.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported.

Related API Elements

Scroller
  
symbolColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button.
Scroller
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
horizontalScrollBar:HScrollBar
Required: false Part Type: Static
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

A skin part that defines the horizontal scroll bar. This property should be considered read-only. It is only set by the Scroller's skin. This property is Bindable.
Scroller
  
horizontalScrollBarFactory:IFactory
Required: false Part Type: Dynamic
Language Version: ActionScript  Product Version:  Runtime Versions: , 

A skin part that defines the horizontal scroll bar component. The horizontalScrollBar skin part takes precedence over this skin part. When Scroller creates an instance of this part, it will set the horizontalScrollBar skin part to that instance. This property should be considered read-only. It is only set by the Scroller's skin. To access the HScrollBar instance, use horizontalScrollBar.

The IFactory must return an object of type HScrollBar.
Scroller
  
verticalScrollBar:VScrollBar
Required: false Part Type: Static
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

A skin part that defines the vertical scroll bar. This property should be considered read-only. It is only set by the Scroller's skin. This property is Bindable.
Scroller
  
verticalScrollBarFactory:IFactory
Required: false Part Type: Dynamic
Language Version: ActionScript  Product Version:  Runtime Versions: , 

A skin part that defines the vertical scroll bar. The verticalScrollBar skin part takes precedence over this skin part. When Scroller creates an instance of this part, it will set the verticalScrollBar skin part to that instance. This property should be considered read-only. It is only set by the Scroller's skin. To access the VScrollBar instance, use verticalScrollBar.

The IFactory must return an object of type VScrollBar.
Scroller
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
Property Detail

measuredSizeIncludesScrollBars

property
measuredSizeIncludesScrollBars:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

If true, the Scroller's measured size includes the space required for the visible scroll bars, otherwise the Scroller's measured size depends only on its viewport.

Components like TextArea, which "reflow" their contents to fit the available width or height may use this property to stabilize their measured size. By default a TextArea's is defined by its widthInChars and heightInChars properties and in many applications it's preferable for the measured size to remain constant, event when scroll bars are displayed by the TextArea skin's Scroller.

In components where the content does not reflow, like a typical List's items, the default behavior is preferable because it makes it less likely that the component's content will be obscured by a scroll bar.

The default value is true.



Implementation
    public function get measuredSizeIncludesScrollBars():Boolean
    public function set measuredSizeIncludesScrollBars(value:Boolean):void

minViewportInset

property 
minViewportInset:Number

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The minimum space between the viewport and the edges of the Scroller. If neither of the scroll bars is visible, then the viewport is inset by minViewportInset on all four sides. If a scroll bar is visible then the viewport is inset by minViewportInset or by the scroll bar's size, whichever is larger. ScrollBars are laid out flush with the edges of the Scroller.

The default value is 0.



Implementation
    public function get minViewportInset():Number
    public function set minViewportInset(value:Number):void

numElements

property 
numElements:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns 1 if there is a viewport, 0 otherwise.



Implementation
    public function get numElements():int
    

pageScrollingEnabled

property 
pageScrollingEnabled:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.6
Runtime Versions: AIR 3

By default, for mobile applications, scrolling is pixel based. The final scroll location is any pixel location based on the drag and throw gesture. Set pageScrollingEnabled to true to enable page scrolling.

Note: This property is only valid when the interactionMode style is set to touch, indicating a mobile application.

The size of the page is determined by the size of the viewport of the scrollable component. You can only scroll a single page at a time, regardless of the scroll gesture.

You must scroll at least 50% of the visible area of the component to cause the page to change. If you scroll less than 50%, the component remains on the current page. Alternatively, if the velocity of the scroll is high enough, the next page display. If the velocity is not high enough, the component remains on the current page.

The default value is false.



Implementation
    public function get pageScrollingEnabled():Boolean
    public function set pageScrollingEnabled(value:Boolean):void
    

scrollSnappingMode

property 
scrollSnappingMode:String

Language Version: ActionScript 3.0
Product Version: Flex 4.6
Runtime Versions: AIR 3

By default, for mobile applications, scrolling is pixel based. The final scroll location is any pixel location based on the drag and throw gesture. Set scrollSnappingMode to other than none to enable scroll snapping. With scroll snapping enabled, the content snaps to a final position based on the value of scrollSnappingMode.

Note: This property is only valid when the interactionMode style is set to touch, indicating a mobile application.

For example, you scroll a List vertically with scrollSnappingMode set to a value of leadingEdge. The List control snaps to a final scroll position where the top list element is aligned to the top of the list.

Changing this property to anything other than none can result in an immediate change in scroll position to ensure an element is correctly snapped into position. This change in scroll position is not animated

in MXML, the possible values are "leadingEdge", "center", "trailingEdge", and "none". ActionScript values are defined by spark.components.ScrollSnappingMode.

The default value is "none".



Implementation
    public function get scrollSnappingMode():String
    public function set scrollSnappingMode(value:String):void

Related API Elements

viewport

property 
viewport:IViewport

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The viewport component to be scrolled.

The viewport is added to the Scroller component's skin, which lays out both the viewport and scroll bars. When the viewport property is set, the viewport's clipAndEnableScrolling property is set to true to enable scrolling. The Scroller does not support rotating the viewport directly. The viewport's contents can be transformed arbitrarily, but the viewport itself cannot.

This property is Bindable.

The default value is null.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get viewport():IViewport
    public function set viewport(value:IViewport):void
Constructor Detail

Scroller

()Constructor
public function Scroller()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Method Detail

addElement

()method
public function addElement(element:IVisualElement):IVisualElement

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

Parameters

element:IVisualElement

Returns
IVisualElement

addElementAt

()method 
public function addElementAt(element:IVisualElement, index:int):IVisualElement

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

Parameters

element:IVisualElement
 
index:int

Returns
IVisualElement

ensureElementIsVisible

()method 
public function ensureElementIsVisible(element:IVisualElement):void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

Scrolls the viewport so the specified element is visible.

Parameters

element:IVisualElement — A child element of the container, or of a nested container, wrapped by the Scroller.

getElementAt

()method 
public function getElementAt(index:int):IVisualElement

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the viewport if there is a viewport and the index passed in is 0. Otherwise, it throws a RangeError.

Parameters

index:int — The index of the element to retrieve.

Returns
IVisualElement — The element at the specified index.

Throws
RangeError — If the index position does not exist in the child list.

getElementIndex

()method 
public function getElementIndex(element:IVisualElement):int

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns 0 if the element passed in is the viewport. Otherwise, it throws an ArgumentError.

Parameters

element:IVisualElement — The element to identify.

Returns
int — The index position of the element to identify.

Throws
ArgumentError — If the element is not a child of this object.

removeAllElements

()method 
public function removeAllElements():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

removeElement

()method 
public function removeElement(element:IVisualElement):IVisualElement

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

Parameters

element:IVisualElement

Returns
IVisualElement

removeElementAt

()method 
public function removeElementAt(index:int):IVisualElement

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

Parameters

index:int

Returns
IVisualElement

setElementIndex

()method 
public function setElementIndex(element:IVisualElement, index:int):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

Parameters

element:IVisualElement
 
index:int

swapElements

()method 
public function swapElements(element1:IVisualElement, element2:IVisualElement):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

Parameters

element1:IVisualElement
 
element2:IVisualElement

swapElementsAt

()method 
public function swapElementsAt(index1:int, index2:int):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

This operation is not supported in Scroller. A Scroller control has only one child. Use the viewport property to manipulate it.

Parameters

index1:int
 
index2:int
Event Detail

mouseWheelChanging

Event
Event Object Type: mx.events.FlexMouseEvent
property FlexMouseEvent.type = mx.events.FlexMouseEvent.MOUSE_WHEEL_CHANGING

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

Dispatched when the scroll position is going to change due to a mouseWheel event.

If there is a visible verticalScrollBar, then by default the viewport is scrolled vertically by event.delta "steps". The height of the step is determined by the viewport's getVerticalScrollPositionDelta method using either UP or DOWN, depending on the scroll direction.

Otherwise, if there is a visible horizontalScrollBar, then by default the viewport is scrolled horizontally by event.delta "steps". The width of the step is determined by the viewport's getHorizontalScrollPositionDelta method using either LEFT or RIGHT, depending on the scroll direction.

Calling the preventDefault() method on the event prevents the scroll position from changing. Otherwise if you modify the delta property of the event, that value will be used as the number of "steps".

The FlexMouseEvent.MOUSE_WHEEL_CHANGING constant defines the value of the type property of the event object for a mouseWheelChanging event.

The properties of the event object have the following values:

PropertyValue
altKeyIndicates whether the Alt key is down (true) or not (false).
bubblesfalse
buttonDownIndicates whether the main mouse button is down (true) or not (false).
cancelablefalse
ctrlKeyIndicates whether the Control key is down (true) or not (false).
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaIndicates how many lines should be scrolled for each notch the user scrolls the mouse wheel.
localXThe horizontal position at which the event occurred.
localYThe vertical position at which the event occurred.
relatedObjectA reference to a display list object that is related to the event. For this event, the object is the component which is the target of the mouseWheel event.
shiftKeyIndicates whether the Shift key is down (true) or not (false).
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
ScrollerExample.mxml
<?xml version='1.0' encoding='UTF-8'?>
<!-- Simple example to demonstrate the Scroller control -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:s="library://ns.adobe.com/flex/spark" 
    xmlns:mx="library://ns.adobe.com/flex/mx">

    <!-- Panel used as a container for Scroller control examples -->
    <mx:Panel title="Scroller Control Example" height="75%" width="75%" paddingTop="10"
        paddingLeft="10" horizontalCenter="0" verticalCenter="0">

        <s:Scroller width="100" height="100">
            <s:Group> 
                <mx:Image width="300" height="400" 
                    source="@Embed(source='/assets/logo.jpg')"/> 
            </s:Group>        
        </s:Scroller>     
                                                          
    </mx:Panel>          
</s:Application>