feathers.controls.ScrollContainer

Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		autoSizeMode : String Determines how the container will set its own size when its dimensions (width and height) aren't set explicitly.	ScrollContainer
		bottomPullView : DisplayObject A view that is displayed at the bottom of the scroller's view port when dragging up.	Scroller
		bottomPullViewDisplayMode : String Indicates whether the bottom pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance.	FeathersControl
		defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.	FeathersControl
		depth : int [read-only] The component's depth in the display list, relative to the stage.	FeathersControl
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	FeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	FeathersControl
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	FeathersControl
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	FeathersControl
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	FeathersControl
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	FeathersControl
		explicitWidth : Number [read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.	FeathersControl
		focusInEffect : Function An optional effect that is activated when the component receives focus.	FeathersControl
		focusManager : IFocusManager The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.	FeathersControl
		focusOutEffect : Function An optional effect that is activated when the component loses focus.	FeathersControl
		focusOwner : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.	FeathersControl
		globalStyleProvider : IStyleProvider [static] The default IStyleProvider for all ScrollContainer components.	ScrollContainer
		height : Number [override] The height of the component, in pixels.	FeathersControl
		hideEffect : Function An optional effect that is activated when the component is hidden.	FeathersControl
		horizontalPageCount : int [read-only] The number of horizontal pages, if snapping is enabled.	Scroller
		horizontalPageIndex : int The index of the horizontal page, if snapping is enabled.	Scroller
		horizontalScrollBarFactory : Function Creates the horizontal scroll bar.	Scroller
		horizontalScrollBarProperties : Object An object that stores properties for the container's horizontal scroll bar, and the properties will be passed down to the horizontal scroll bar when the container validates.	Scroller
		horizontalScrollPolicy : String Determines whether the scroller may scroll horizontally (on the x-axis) or not.	Scroller
		horizontalScrollPosition : Number The number of pixels the container has been scrolled horizontally (on the x-axis).	Scroller
		horizontalScrollStep : Number The number of pixels the horizontal scroll position can be adjusted by a "step".	Scroller
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		isBottomPullViewActive : Boolean Indicates if the bottomPullView has been activated.	Scroller
		isChildFocusEnabled : Boolean Determines if this component's children can receive focus.	ScrollContainer
		isCreated : Boolean [read-only] Determines if the component has been initialized and validated for the first time.	FeathersControl
		isEnabled : Boolean Indicates whether the control is interactive or not.	FeathersControl
		isFocusEnabled : Boolean The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.	FeathersControl
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	FeathersControl
		isLeftPullViewActive : Boolean Indicates if the leftPullView has been activated.	Scroller
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isRightPullViewActive : Boolean Indicates if the rightPullView has been activated.	Scroller
		isScrolling : Boolean [read-only] Determines if the scroller is currently scrolling with user interaction or with animation.	Scroller
		isShowingFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.	FeathersControl
		isTopPullViewActive : Boolean Indicates if the topPullView has been activated.	Scroller
		layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm.	FeathersControl
		leftPullView : DisplayObject A view that is displayed to the left of the scroller's view port when dragging to the right.	Scroller
		leftPullViewDisplayMode : String Indicates whether the left pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		maintainTouchFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.	FeathersControl
		maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		maxHorizontalPageIndex : int [read-only] The maximum horizontal page index that may be displayed by this container, if page snapping is enabled.	Scroller
		maxHorizontalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled horizontally to the right.	Scroller
		maxVerticalPageIndex : int [read-only] The maximum vertical page index that may be displayed by this container, if page snapping is enabled.	Scroller
		maxVerticalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled vertically beyond the bottom edge.	Scroller
		maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		measureViewPort : Boolean Determines if the dimensions of the view port are used when measuring the scroller.	Scroller
		minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minHorizontalPageIndex : int [read-only] The minimum horizontal page index that may be displayed by this container, if page snapping is enabled.	Scroller
		minHorizontalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled horizontally to the left.	Scroller
		minimumDragDistance : Number The minimum physical distance (in inches) that a touch must move before the scroller starts scrolling.	Scroller
		minimumPageThrowVelocity : Number The minimum physical velocity (in inches per second) that a touch must move before the scroller will "throw" to the next page.	Scroller
		minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.	FeathersControl
		minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.	FeathersControl
		minVerticalPageIndex : int [read-only] The minimum vertical page index that may be displayed by this container, if page snapping is enabled.	Scroller
		minVerticalScrollPosition : Number [read-only] The number of pixels the scroller may be scrolled vertically beyond the top edge.	Scroller
		minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		moveEffect : Function An optional effect that is activated when the component is moved to a new position.	FeathersControl
		nextDownFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextLeftFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextRightFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.	FeathersControl
		nextUpFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		numRawChildren : int [read-only] Returns the number of raw children that are added directly to the Scroller rather than delegating the call to the view port.	ScrollContainer
		pageHeight : Number When set, the vertical pages snap to this height value instead of the height of the scroller.	Scroller
		pageWidth : Number When set, the horizontal pages snap to this width value instead of the width of the scroller.	Scroller
		previousTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.	FeathersControl
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		rightPullView : DisplayObject A view that is displayed to the right of the scroller's view port when dragging to the left.	Scroller
		rightPullViewDisplayMode : String Indicates whether the right pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		styleName : String The concatenated styleNameList, with values separated by spaces.	FeathersControl
		styleNameList : TokenList [read-only] Contains a list of all "styles" assigned to this control.	FeathersControl
		styleProvider : IStyleProvider When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.	FeathersControl
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	FeathersControl
		topPullView : DisplayObject A view that is displayed at the top of the scroller's view port when dragging down.	Scroller
		topPullViewDisplayMode : String Indicates whether the top pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.	Scroller
		verticalMouseWheelScrollDirection : String The direction of scrolling when the user scrolls the mouse wheel vertically.	Scroller
		verticalMouseWheelScrollStep : Number The number of pixels the vertical scroll position can be adjusted by a "step" when using the mouse wheel.	Scroller
		verticalPageCount : int [read-only] The number of vertical pages, if snapping is enabled.	Scroller
		verticalPageIndex : int The index of the vertical page, if snapping is enabled.	Scroller
		verticalScrollBarFactory : Function Creates the vertical scroll bar.	Scroller
		verticalScrollBarProperties : Object An object that stores properties for the container's vertical scroll bar, and the properties will be passed down to the vertical scroll bar when the container validates.	Scroller
		verticalScrollPolicy : String Determines whether the scroller may scroll vertically (on the y-axis) or not.	Scroller
		verticalScrollPosition : Number The number of pixels the container has been scrolled vertically (on the y-axis).	Scroller
		verticalScrollStep : Number The number of pixels the vertical scroll position can be adjusted by a "step".	Scroller
		viewPort : IViewPort The display object displayed and scrolled within the Scroller.	Scroller
		width : Number [override] The width of the component, in pixels.	FeathersControl

	Property	Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl
		displayListBypassEnabled : Boolean = true A flag that indicates if the display list functions like addChild() and removeChild() will be passed to the internal view port.	ScrollContainer
		hasPendingHorizontalPageIndex : Boolean = false A flag that indicates if the scroller should scroll to a new page when it validates.	Scroller
		hasPendingVerticalPageIndex : Boolean = false A flag that indicates if the scroller should scroll to a new page when it validates.	Scroller
		horizontalScrollBar : IScrollBar The horizontal scrollbar instance.	Scroller
		horizontalScrollBarStyleName : String = "feathers-scroller-horizontal-scroll-bar" The value added to the styleNameList of the horizontal scroll bar.	Scroller
		pendingHorizontalPageIndex : int The pending horizontal page index to scroll to after validating.	Scroller
		pendingHorizontalScrollPosition : Number = NaN The pending horizontal scroll position to scroll to after validating.	Scroller
		pendingScrollDuration : Number The duration of the pending scroll action.	Scroller
		pendingVerticalPageIndex : int The pending vertical page index to scroll to after validating.	Scroller
		pendingVerticalScrollPosition : Number = NaN The pending vertical scroll position to scroll to after validating.	Scroller
		verticalScrollBar : IScrollBar The vertical scrollbar instance.	Scroller
		verticalScrollBarStyleName : String = "feathers-scroller-vertical-scroll-bar" The value added to the styleNameList of the vertical scroll bar.	Scroller

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ScrollContainer() Constructor.	ScrollContainer
		addRawChild(child:DisplayObject):DisplayObject Adds a child to the Scroller rather than delegating the call to the view port.	ScrollContainer
		addRawChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the Scroller at a specific index rather than delegating the call to the view port.	ScrollContainer
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.	FeathersControl
		getRawChildAt(index:int):DisplayObject Gets the direct child of the Scroller at a specific index rather than delegating the call to the view port.	ScrollContainer
		getRawChildByName(name:String):DisplayObject Gets the name of a direct child of the Scroller rather than delegating the call to the view port.	ScrollContainer
		getRawChildIndex(child:DisplayObject):int Gets the index of a direct child of the Scroller rather than delegating the call to the view port.	ScrollContainer
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		initializeNow():void If the component has not yet initialized, initializes immediately.	FeathersControl
		invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending.	FeathersControl
		isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not.	FeathersControl
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	FeathersControl
		readjustLayout():void Readjusts the layout of the container according to its current content.	ScrollContainer
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		removeRawChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the Scroller rather than delegating the call to the view port.	ScrollContainer
		removeRawChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child from the Scroller at a specific index rather than delegating the call to the view port.	ScrollContainer
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	FeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	FeathersControl
		revealScrollBars():void If the scroll bars are floating, briefly show them as a hint to the user.	Scroller
		scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void After the next validation, animates the scroll position to a specific page index.	Scroller
		scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void After the next validation, animates the scroll positions to a specific location.	Scroller
		setRawChildIndex(child:DisplayObject, index:int):void Sets the index of a direct child of the Scroller rather than delegating the call to the view port.	ScrollContainer
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	FeathersControl
		showFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		sortRawChildren(compareFunction:Function):void Sorts the children of the Scroller rather than delegating the call to the view port.	ScrollContainer
		stopScrolling():void If the user is scrolling with touch or if the scrolling is animated, calling stopScrolling() will cause the scroller to ignore the drag and stop animations.	Scroller
		suspendEffects():void Indicates that effects should not be activated temporarily.	FeathersControl
		swapRawChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the children of the Scroller rather than delegating the call to the view port.	ScrollContainer
		swapRawChildrenAt(index1:int, index2:int):void Swaps the children of the Scroller rather than delegating the call to the view port.	ScrollContainer
		validate():void Immediately validates the display object, if it is invalid.	FeathersControl

	Method	Defined By
		autoSizeIfNeeded():Boolean If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.	Scroller
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		completeScroll():void Prepares the scroller for normal interaction and dispatches FeathersEventType.SCROLL_COMPLETE.	Scroller
		createScrollBars():void Creates and adds the horizontalScrollBar and verticalScrollBar sub-components and removes the old instances, if they exist.	Scroller
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		focusInHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.	FeathersControl
		focusOutHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.	FeathersControl
		handlePendingScroll():void Scrolls to a pending scroll position, if required.	Scroller
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	FeathersControl
		initialize():void Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.	FeathersControl
		layoutChildren():void Positions and sizes children based on the actual width and height values.	Scroller
		processStyleRestriction(key:Object):Boolean Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.	FeathersControl
		refreshBackgroundSkin():void Choose the appropriate background skin based on the control's current state.	Scroller
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	FeathersControl
		setInvalidationFlag(flag:String):void Sets an invalidation flag.	FeathersControl
		setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not.	FeathersControl
		startScroll():void If scrolling hasn't already started, prepares the scroller to scroll and dispatches FeathersEventType.SCROLL_START.	Scroller
		throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void Immediately throws the scroller to the specified position, with optional animation.	Scroller
		throwToPage(targetHorizontalPageIndex:int, targetVerticalPageIndex:int, duration:Number = 0.5):void Immediately throws the scroller to the specified page index, with optional animation.	Scroller

Summary	Defined By
beginInteraction	Dispatched when the user starts dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user starts interacting with the scroll bar.	Scroller
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
endInteraction	Dispatched when the user stops dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user stops interacting with the scroll bar.	Scroller
focusIn	Dispatched when the component receives focus.	Scroller
focusOut	Dispatched when the component loses focus.	Scroller
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
resize	Dispatched when the width or height of the control changes.	FeathersControl
scroll	Dispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed.	Scroller
scrollComplete	Dispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation.	Scroller
scrollStart	Dispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation.	Scroller
update	Dispatched when a pull view is activated.	Scroller

Styles

Hide Inherited Styles

Show Inherited Styles

	Style		Defined By
		autoHideBackground : Boolean If true, the background's visible property will be set to false when the scroll position is greater than or equal to the minimum scroll position and less than or equal to the maximum scroll position.	Scroller
		backgroundDisabledSkin : DisplayObject A background to display when the container is disabled.	Scroller
		backgroundSkin : DisplayObject The default background to display.	Scroller
		clipContent : Boolean If true, the viewport will be clipped to the scroller's bounds.	Scroller
		customHorizontalScrollBarStyleName : String A style name to add to the container's horizontal scroll bar sub-component.	Scroller
		customVerticalScrollBarStyleName : String A style name to add to the container's vertical scroll bar sub-component.	Scroller
		decelerationRate : Number This value is used to decelerate the scroller when "thrown".	Scroller
		elasticity : Number If the scroll position goes outside the minimum or maximum bounds when the scroller's content is being actively dragged, the scrolling will be constrained using this multiplier.	Scroller
		elasticSnapDuration : Number The duration, in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds.	Scroller
		focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.	FeathersControl
		focusPadding : Number Quickly sets all focus padding properties to the same value.	FeathersControl
		focusPaddingBottom : Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.	FeathersControl
		focusPaddingLeft : Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.	FeathersControl
		focusPaddingRight : Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.	FeathersControl
		focusPaddingTop : Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.	FeathersControl
		hasElasticEdges : Boolean Determines if the scrolling can go beyond the edges of the viewport.	Scroller
		hideScrollBarAnimationDuration : Number The duration, in seconds, of the animation when a scroll bar fades out.	Scroller
		hideScrollBarAnimationEase : Object The easing function used for hiding the scroll bars, if applicable.	Scroller
		horizontalScrollBarPosition : String Determines where the horizontal scroll bar will be positioned.	Scroller
		interactionMode : String Determines how the user may interact with the scroller.	Scroller
		layout : ILayout Controls the way that the container's children are positioned and sized.	ScrollContainer
		mouseWheelScrollDuration : Number The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.	Scroller
		padding : Number Quickly sets all padding properties to the same value.	Scroller
		paddingBottom : Number The minimum space, in pixels, between the container's bottom edge and the container's content.	Scroller
		paddingLeft : Number The minimum space, in pixels, between the container's left edge and the container's content.	Scroller
		paddingRight : Number The minimum space, in pixels, between the container's right edge and the container's content.	Scroller
		paddingTop : Number The minimum space, in pixels, between the container's top edge and the container's content.	Scroller
		pageThrowDuration : Number The duration, in seconds, of the animation when the scroller is thrown to a page.	Scroller
		revealScrollBarsDuration : Number The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars().	Scroller
		scrollBarDisplayMode : String Determines how the scroll bars are displayed.	Scroller
		snapScrollPositionsToPixels : Boolean If enabled, the scroll position will always be adjusted to the nearest pixel on the physical screen.	Scroller
		snapToPages : Boolean Determines if scrolling will snap to the nearest page.	Scroller
		throwEase : Object The easing function used for "throw" animations.	Scroller
		throwElasticity : Number If the scroll position goes outside the minimum or maximum bounds when the scroller's content is "thrown", the scrolling will be constrained using this multiplier.	Scroller
		useFixedThrowDuration : Boolean If true, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity.	Scroller
		verticalScrollBarPosition : String Determines where the vertical scroll bar will be positioned.	Scroller

	Constant	Defined By
		ALTERNATE_STYLE_NAME_TOOLBAR : String = "feathers-toolbar-scroll-container" [static] An alternate style name to use with ScrollContainer to allow a theme to give it a toolbar style.	ScrollContainer
		DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR : String = "feathers-scroller-horizontal-scroll-bar" [static] The default value added to the styleNameList of the horizontal scroll bar.	Scroller
		DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR : String = "feathers-scroller-vertical-scroll-bar" [static] The default value added to the styleNameList of the vertical scroll bar.	Scroller
		INVALIDATION_FLAG_ALL : String = "all" [static] Flag to indicate that everything is invalid and should be redrawn.	FeathersControl
		INVALIDATION_FLAG_DATA : String = "data" [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_FOCUS : String = "focus" [static] Invalidation flag to indicate that the focus of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_LAYOUT : String = "layout" [static] Invalidation flag to indicate that the layout of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SCROLL : String = "scroll" [static] Invalidation flag to indicate that the scroll position of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SELECTED : String = "selected" [static] Invalidation flag to indicate that the selection of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SIZE : String = "size" [static] Invalidation flag to indicate that the dimensions of the UI control have changed.	FeathersControl
		INVALIDATION_FLAG_SKIN : String = "skin" [static] Invalidation flag to indicate that the skin of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_STATE : String = "state" [static] Invalidation flag to indicate that the state has changed.	FeathersControl
		INVALIDATION_FLAG_STYLES : String = "styles" [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.	FeathersControl

	Constant	Defined By
		INVALIDATION_FLAG_CLIPPING : String = "clipping" [static] Flag to indicate that the clipping has changed.	Scroller

Property Detail

autoSizeMode

property

autoSizeMode:String

Determines how the container will set its own size when its dimensions (width and height) aren't set explicitly.

In the following example, the container will be sized to match the stage:

container.autoSizeMode = AutoSizeMode.STAGE;

Usually defaults to AutoSizeMode.CONTENT. However, if this component is the root of the Starling display list, defaults to AutoSizeMode.STAGE instead.

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

displayListBypassEnabled

property

protected var displayListBypassEnabled:Boolean = true

A flag that indicates if the display list functions like addChild() and removeChild() will be passed to the internal view port.

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all ScrollContainer components.

The default value is null.

isChildFocusEnabled

property

isChildFocusEnabled:Boolean

Determines if this component's children can receive focus. This property is completely independent from the isFocusEnabled property. In other words, it's possible to disable focus on this component while still allowing focus on its children (or the other way around).

In the following example, the focus is disabled:

object.isFocusEnabled = false;

The default value is true.

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

See also

isFocusEnabled

numRawChildren

property

numRawChildren:int [read-only]

Returns the number of raw children that are added directly to the Scroller rather than delegating the call to the view port.

Implementation
public function get numRawChildren():int

Constructor Detail

ScrollContainer

()

Constructor

public function ScrollContainer()

Constructor.

Method Detail

addRawChild

()

method

public function addRawChild(child:DisplayObject):DisplayObject

Adds a child to the Scroller rather than delegating the call to the view port.

Parameters

child:DisplayObject

Returns

DisplayObject

addRawChildAt

()

method

public function addRawChildAt(child:DisplayObject, index:int):DisplayObject

Adds a child to the Scroller at a specific index rather than delegating the call to the view port.

Parameters

	`child:DisplayObject`

	`index:int`

Returns

DisplayObject

getRawChildAt

()

method

public function getRawChildAt(index:int):DisplayObject

Gets the direct child of the Scroller at a specific index rather than delegating the call to the view port.

Parameters

index:int

Returns

DisplayObject

getRawChildByName

()

method

public function getRawChildByName(name:String):DisplayObject

Gets the name of a direct child of the Scroller rather than delegating the call to the view port.

Parameters

name:String

Returns

DisplayObject

getRawChildIndex

()

method

public function getRawChildIndex(child:DisplayObject):int

Gets the index of a direct child of the Scroller rather than delegating the call to the view port.

Parameters

child:DisplayObject

Returns

int

readjustLayout

()

method

public function readjustLayout():void

Readjusts the layout of the container according to its current content. Call this method when changes to the content cannot be automatically detected by the container. For instance, Feathers components dispatch FeathersEventType.RESIZE when their width and height values change, but standard Starling display objects like Sprite and Image do not.

removeRawChild

()

method

public function removeRawChild(child:DisplayObject, dispose:Boolean = false):DisplayObject

Removes a child from the Scroller rather than delegating the call to the view port.

Parameters

	`child:DisplayObject`

	`dispose:Boolean` (default = `false`)

Returns

DisplayObject

removeRawChildAt

()

method

public function removeRawChildAt(index:int, dispose:Boolean = false):DisplayObject

Removes a child from the Scroller at a specific index rather than delegating the call to the view port.

Parameters

	`index:int`

	`dispose:Boolean` (default = `false`)

Returns

DisplayObject

setRawChildIndex

()

method

public function setRawChildIndex(child:DisplayObject, index:int):void

Sets the index of a direct child of the Scroller rather than delegating the call to the view port.

Parameters

	`child:DisplayObject`

	`index:int`

sortRawChildren

()

method

public function sortRawChildren(compareFunction:Function):void

Sorts the children of the Scroller rather than delegating the call to the view port.

Parameters

compareFunction:Function

swapRawChildren

()

method

public function swapRawChildren(child1:DisplayObject, child2:DisplayObject):void

Swaps the children of the Scroller rather than delegating the call to the view port.

Parameters

	`child1:DisplayObject`

	`child2:DisplayObject`

swapRawChildrenAt

()

method

public function swapRawChildrenAt(index1:int, index2:int):void

Swaps the children of the Scroller rather than delegating the call to the view port.

Parameters

	`index1:int`

	`index2:int`

Style Detail

layout

style

layout:ILayout

Controls the way that the container's children are positioned and sized.

The following example tells the container to use a horizontal layout:

var layout:HorizontalLayout = new HorizontalLayout();
layout.gap = 20;
layout.padding = 20;
container.layout = layout;

The default value is null.

Constant Detail

ALTERNATE_STYLE_NAME_TOOLBAR

Constant

public static const ALTERNATE_STYLE_NAME_TOOLBAR:String = "feathers-toolbar-scroll-container"

An alternate style name to use with ScrollContainer to allow a theme to give it a toolbar style. If a theme does not provide a style for the toolbar container, the theme will automatically fall back to using the default scroll container skin.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the toolbar style is applied to a scroll container:

var container:ScrollContainer = new ScrollContainer();
container.styleNameList.add( ScrollContainer.ALTERNATE_STYLE_NAME_TOOLBAR );
this.addChild( container );

Sat Jun 18 2022, 02:58 PM -07:00

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
ScrollContainer	Properties Methods Events Styles Constants

Package	feathers.controls
Class	public class ScrollContainer
Inheritance	ScrollContainer Scroller FeathersControl starling.display.Sprite
Implements	IScrollContainer, IFocusContainer
Subclasses	Panel, ScrollScreen