| Package | spark.components |
| Class | public class Scroller |
| Inheritance | Scroller  SkinnableComponent UIComponent FlexSprite flash.display.Sprite |
| Implements | IFocusManagerComponent, IVisualElementContainer |
| Subclasses | InlineScroller |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
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:
| Characteristic | Description |
|---|---|
| Default size | 0 |
| Minimum size | 0 |
| Maximum size | 10000 pixels wide and 10000 pixels high |
| Default skin class | spark.skins.spark.ScrollerSkin |
Hide MXML SyntaxThe <s:Scroller> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<s:Scroller
Properties
measuredSizeIncludesScrollBars="true"
minViewportInset="0"
pageScrollingEnabled="false"
scrollSnappingMode="none"
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
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : 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 | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : 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 | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| maxDragRate : Number [static]
Maximum number of times per second the scroll position
and the display will be updated while dragging. | Scroller | ||
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : 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 | ||
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| minHeight : 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 | ||
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : 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 | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : 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 | ||
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
 pageScrollingEnabled : Boolean
By default, for mobile applications, scrolling is pixel based. | Scroller | ||
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : 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 | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : 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 | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| rotation : Number [override] | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
| UIComponent | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollSnappingMode : String
By default, for mobile applications, scrolling is pixel based. | Scroller | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabFocusEnabled : 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 | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : 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 | ||
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
Scroller()
Constructor. | Scroller | ||
This operation is not supported in Scroller. | Scroller | ||
This operation is not supported in Scroller. | Scroller | ||
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | |
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | |
| 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 | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
ensureElementIsVisible(element:IVisualElement):void
Scrolls the viewport so the specified element is visible. | Scroller | ||
| executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
getElementAt(index:int):IVisualElement
Returns the viewport if there is a viewport and the
index passed in is 0. | Scroller | ||
getElementIndex(element:IVisualElement):int
Returns 0 if the element passed in is the viewport. | Scroller | ||
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| 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 | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
| globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| invalidateSkinState():void
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| measureHTMLText(htmlText:String):TextLineMetrics
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 | |
| measureText(text:String):TextLineMetrics
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 | |
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| regenerateStyleCache(recursive:Boolean):void
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 | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
removeAllElements():void
This operation is not supported in Scroller. | Scroller | ||
This operation is not supported in Scroller. | Scroller | ||
removeElementAt(index:int):IVisualElement
This operation is not supported in Scroller. | Scroller | ||
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
setElementIndex(element:IVisualElement, index:int):void
This operation is not supported in Scroller. | Scroller | ||
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| 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 | |
| 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 | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [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 | ||
| toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| 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 | |
| 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 | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| 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 | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched 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 | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the scroll position is going to change due to a mouseWheel event. | Scroller | |||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
alignmentBaseline | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
alternatingItemColors | Type: Array Format: Color CSS Inheritance: yes Theme: spark, mobile 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 | Scroller | ||
| Type: String CSS Inheritance: no 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 Amount to shift the baseline. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift. For the Mobile theme, this is not supported. See also | Scroller | ||
blockProgression | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
| Type: String CSS Inheritance: no 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 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. See also | Scroller | ||
cffHinting | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent | ||
clearFloats | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
color | Type: uint Format: Color CSS Inheritance: yes 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.See also | Scroller | ||
columnBreakAfter | Type: String CSS Inheritance: yes Controls column break after the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnBreakAfter. For the Mobile theme, this is not supported. See also | Scroller | ||
columnBreakBefore | Type: String CSS Inheritance: yes Controls column break before the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnBreakBefore. For the Mobile theme, this is not supported. See also | Scroller | ||
containerBreakAfter | Type: String CSS Inheritance: yes Controls container break after the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.containerBreakAfter. For the Mobile theme, this is not supported. See also | Scroller | ||
containerBreakBefore | Type: String CSS Inheritance: yes Controls container break before the element. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.containerBreakBefore. For the Mobile theme, this is not supported. See also | Scroller | ||
contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | Scroller | ||
contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. For a List, changing The default value for the Spark theme is | Scroller | ||
digitCase | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
digitWidth | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
direction | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
dominantBaseline | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
downColor | Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of the background of an item renderer when it is being pressed down If The default value for the Spark theme is | Scroller | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | ||
firstBaselineOffset | Type: Object CSS Inheritance: yes 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. See also | Scroller | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | Scroller | ||
focusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. For the Mobile theme, this is not supported. | Scroller | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
fontFamily | Type: String CSS Inheritance: yes 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 See also | Scroller | ||
fontLookup | Type: String CSS Inheritance: yes Font lookup to use. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup For the Mobile theme, this is not supported. See also | Scroller | ||
fontSize | Type: Number Format: Length CSS Inheritance: yes 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 See also | Scroller | ||
fontStyle | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
fontWeight | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
| Type: String CSS Inheritance: no 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 Indicates under what conditions the horizontal scroll bar is displayed.
The scroll policy affects the measured size of the Scroller component. The default value is ScrollPolicy.AUTO.See also | Scroller | ||
inactiveTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. For the Mobile theme, this is not supported. | Scroller | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
justificationRule | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
justificationStyle | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
kerning | Type: String CSS Inheritance: yes 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 For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning For the Mobile theme, this is not supported. See also | Scroller | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
leading | Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text.
For the Spark theme, this is not supported. See For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableStageText Style fontWeight and if using StyleableStageText, this is not supported. See also | Scroller | ||
leadingModel | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
letterSpacing | Type: Number CSS Inheritance: yes Theme: mobile The number of additional pixels to appear between each character.
For the Spark theme, this is not supported. See For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported. See also | Scroller | ||
ligatureLevel | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
lineHeight | Type: Object CSS Inheritance: yes Leading controls for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight.
For the Mobile theme, this is not supported. See See also | Scroller | ||
lineThrough | Type: Boolean CSS Inheritance: yes 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. See also | Scroller | ||
listAutoPadding | Type: Number Format: length CSS Inheritance: yes 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. See also | Scroller | ||
listStylePosition | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
listStyleType | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
liveScrolling | Type: Boolean CSS Inheritance: no A proxy for the liveDragging style of the scrollbars
used by the Scroller component.
If this style is set to Setting this style to By default this style is undefined. | Scroller | ||
locale | Type: String CSS Inheritance: yes 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 When using the Spark formatters and globalization classes, you can set this style on the
root application to the value of the undefined.See also | Scroller | ||
paragraphEndIndent | Type: Number Format: length CSS Inheritance: yes 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. See also | Scroller | ||
paragraphSpaceAfter | Type: Number Format: length CSS Inheritance: yes 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. See also | Scroller | ||
paragraphSpaceBefore | Type: Number Format: length CSS Inheritance: yes 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. See also | Scroller | ||
paragraphStartIndent | Type: Number Format: length CSS Inheritance: yes 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. See also | Scroller | ||
renderingMode | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
rollOverColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the highlights when the mouse is over the component. This style is only applicable in mouse 0xCEDBEF. | Scroller | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | ||
| Type: Class Name of the skin class to use for this component. | SkinnableComponent | ||
symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button. | Scroller | ||
tabStops | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
textAlign | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
textAlignLast | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
textAlpha | Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha For the Mobile theme, this is not supported. See also | Scroller | ||
textDecoration | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
textIndent | Type: Number Format: Length CSS Inheritance: yes 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. See also | Scroller | ||
textJustify | Type: String CSS Inheritance: yes Specifies options for justifying text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify For the Mobile theme, this is not supported. See also | Scroller | ||
textRotation | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
| Type: String CSS Inheritance: no 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 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 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. See also | Scroller | ||
trackingRight | Type: Object CSS Inheritance: yes 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. See also | Scroller | ||
typographicCase | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
unfocusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled but does not have focus. For the Mobile theme, this is not supported. | Scroller | ||
| Type: String CSS Inheritance: no 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 Indicates under what conditions the vertical scroll bar is displayed.
The scroll policy affects the measured size of the Scroller component. The default value is ScrollPolicy.AUTO.See also | Scroller | ||
whiteSpaceCollapse | Type: String CSS Inheritance: yes 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. See also | Scroller | ||
wordSpacing | Type: Object CSS Inheritance: yes 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. See also | Scroller | ||
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 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 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 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 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 | ||
| maxDragRate | property |
maxDragRate:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.5 |
| Runtime Versions : | Flash Player 10, AIR 2.5 |
Maximum number of times per second the scroll position and the display will be updated while dragging.
The default value is 30.
public static function get maxDragRate():Number public static function set maxDragRate(value:Number):void| 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.
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.
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.
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.
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".
public function get scrollSnappingMode():String public function set scrollSnappingMode(value:String):voidSee also
| 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.
The default value is null.
This property can be used as the source for data binding.
public function get viewport():IViewport public function set viewport(value:IViewport):void| Scroller | () | Constructor |
public function Scroller()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
| 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 |
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 |
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.
|
IVisualElement — The element at the specified index.
|
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.
|
int — The index position of the element to identify.
|
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 |
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 |
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 |
| mouseWheelChanging | Event |
mx.events.FlexMouseEventmx.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".
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:
| Property | Value |
|---|---|
altKey | Indicates whether the Alt key is down
(true) or not (false). |
bubbles | false |
buttonDown | Indicates whether the main mouse button is down
(true) or not (false). |
cancelable | false |
ctrlKey | Indicates whether the Control key is down
(true) or not (false). |
currentTarget | The 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.
|
delta | Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. |
localX | The horizontal position at which the event occurred. |
localY | The vertical position at which the event occurred. |
relatedObject | A 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. |
shiftKey | Indicates whether the Shift key is down
(true) or not (false). |
target | The 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.
|
<?xml version='1.0' encoding='UTF-8'?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- 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>