Package | feathers.controls |
Class | public class ScrollContainer |
Inheritance | ScrollContainer ![]() ![]() ![]() |
Implements | IScrollContainer, IFocusContainer |
Subclasses | Panel, ScrollScreen |
LayoutGroup
, which
focuses specifically on layout without scrolling.
The following example creates a scroll container with a horizontal layout and adds two buttons to it:
var container:ScrollContainer = new ScrollContainer(); var layout:HorizontalLayout = new HorizontalLayout(); layout.gap = 20; layout.padding = 20; container.layout = layout; this.addChild( container ); var yesButton:Button = new Button(); yesButton.label = "Yes"; container.addChild( yesButton ); var noButton:Button = new Button(); noButton.label = "No"; container.addChild( noButton );
See also
Property | 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 | |
autoSizeMode : String
Determines how the container will set its own size when its
dimensions (width and height) aren't set explicitly. | ScrollContainer | ||
![]() | 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 | |
![]() | customHorizontalScrollBarName : String
DEPRECATED: Replaced by customHorizontalScrollBarName. | Scroller | |
![]() | customHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar
sub-component. | Scroller | |
![]() | customVerticalScrollBarName : String
DEPRECATED: Replaced by customVerticalScrollBarStyleName. | 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | 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 | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ScrollContainer
components. | ScrollContainer | ||
![]() | hasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport. | Scroller | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | 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 | |
![]() | horizontalPageCount : int [read-only]
The number of horizontal pages, if snapping is enabled. | Scroller | |
![]() | horizontalPageIndex : int [read-only]
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 | |
![]() | interactionMode : String
Determines how the user may interact with the scroller. | 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 | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isScrolling : Boolean [read-only]
Determines if the scroller is currently scrolling with user
interaction or with animation. | Scroller | |
layout : ILayout
Controls the way that the container's children are positioned and
sized. | ScrollContainer | ||
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | 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 | |
![]() | mouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel
initiates a scroll action. | Scroller | |
![]() | nextTabFocus : IFocusDisplayObject | 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 | ||
![]() | 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 | |
![]() | pageHeight : Number
When set, the vertical pages snap to this height value instead of
the height of the scroller. | Scroller | |
![]() | pageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is
thrown to a page. | Scroller | |
![]() | pageWidth : Number
When set, the horizontal pages snap to this width value instead of
the width of the scroller. | Scroller | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | 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 whole
pixels. | Scroller | |
![]() | snapToPages : Boolean
Determines if scrolling will snap to the nearest page. | Scroller | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 [read-only]
The index of the vertical page, if snapping is enabled. | Scroller | |
![]() | verticalScrollBarFactory : Function
Creates the vertical scroll bar. | Scroller | |
![]() | verticalScrollBarPosition : String
Determines where the vertical scroll bar will be positioned. | 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 | |
![]() | 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
globalStyleProvider 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 | ||
![]() | explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
![]() | explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
![]() | 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 | |
![]() | horizontalScrollBarName : String
DEPRECATED: Replaced by horizontalScrollBarStyleName. | 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 | |
![]() | verticalScrollBarName : String
DEPRECATED: Replaced by verticalScrollBarStyleName. | Scroller | |
![]() | verticalScrollBarStyleName : String = feathers-scroller-vertical-scroll-bar
The value added to the styleNameList of the vertical
scroll bar. | Scroller |
Method | Defined By | ||
---|---|---|---|
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 | ||
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
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | 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 | ||
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 | ||
![]() | 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
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | 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 | |
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 |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when the user starts dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user starts interacting with the scroll bar. | Scroller | ||
Dispatched when the container is scrolled. | ScrollContainer | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched when the user stops dragging the scroller when INTERACTION_MODE_TOUCH is enabled or when the user stops interacting with the scroll bar. | Scroller | ||
![]() | Dispatched when the component receives focus. | Scroller | ||
![]() | Dispatched when the component loses focus. | Scroller | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
![]() | Dispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed. | Scroller | ||
![]() | Dispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation. | Scroller | ||
![]() | Dispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation. | Scroller |
Constant | Defined By | ||
---|---|---|---|
ALTERNATE_NAME_TOOLBAR : String = feathers-toolbar-scroll-container [static]
DEPRECATED: Replaced by ScrollContainer.ALTERNATE_STYLE_NAME_TOOLBAR. | ScrollContainer | ||
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 | ||
AUTO_SIZE_MODE_CONTENT : String = content [static]
The container will auto size itself to fit its content. | ScrollContainer | ||
AUTO_SIZE_MODE_STAGE : String = stage [static]
The container will auto size itself to fill the entire stage. | ScrollContainer | ||
DECELERATION_RATE_FAST : Number = 0.99 [static]
Decelerates a bit faster per millisecond than the default. | ScrollContainer | ||
DECELERATION_RATE_NORMAL : Number = 0.998 [static]
The default deceleration rate per millisecond. | ScrollContainer | ||
![]() | DEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar [static]
DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR. | Scroller | |
![]() | DEFAULT_CHILD_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar [static]
DEPRECATED: Replaced by Scroller.DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR. | Scroller | |
![]() | 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 | |
INTERACTION_MODE_MOUSE : String = mouse [static]
The user may only interact with the scroll bars to scroll. | ScrollContainer | ||
INTERACTION_MODE_TOUCH : String = touch [static]
The user may touch anywhere on the scroller and drag to scroll. | ScrollContainer | ||
INTERACTION_MODE_TOUCH_AND_SCROLL_BARS : String = touchAndScrollBars [static]
The user may touch anywhere on the scroller and drag to scroll, and
the scroll bars may be dragged separately. | ScrollContainer | ||
![]() | 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 | |
MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL : String = horizontal [static]
The scroller will scroll horizontally when the mouse wheel is scrolled. | ScrollContainer | ||
MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL : String = vertical [static]
The scroller will scroll vertically when the mouse wheel is scrolled. | ScrollContainer | ||
SCROLL_BAR_DISPLAY_MODE_FIXED : String = fixed [static]
The scroll bars are always visible and appear next to the scroller's
view port, making the view port smaller than the scroller. | ScrollContainer | ||
SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT : String = fixedFloat [static]
The scroll bars appear above the scroller's view port, overlapping
the content, but they do not fade out when not in use. | ScrollContainer | ||
SCROLL_BAR_DISPLAY_MODE_FLOAT : String = float [static]
The scroll bars appear above the scroller's view port, overlapping
the content, and they fade out when not in use. | ScrollContainer | ||
SCROLL_BAR_DISPLAY_MODE_NONE : String = none [static]
The scroll bars are never visible. | ScrollContainer | ||
SCROLL_POLICY_AUTO : String = auto [static]
The scroller may scroll if the view port is larger than the
scroller's bounds. | ScrollContainer | ||
SCROLL_POLICY_OFF : String = off [static]
The scroller does not scroll at all. | ScrollContainer | ||
SCROLL_POLICY_ON : String = on [static]
The scroller will always scroll. | ScrollContainer | ||
VERTICAL_SCROLL_BAR_POSITION_LEFT : String = left [static]
The vertical scroll bar will be positioned on the left. | ScrollContainer | ||
VERTICAL_SCROLL_BAR_POSITION_RIGHT : String = right [static]
The vertical scroll bar will be positioned on the right. | ScrollContainer |
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 = ScrollContainer.AUTO_SIZE_MODE_STAGE;
The default value is ScrollContainer.AUTO_SIZE_MODE_CONTENT
.
public function get autoSizeMode():String
public function set autoSizeMode(value:String):void
See also
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
.
See also
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
.
public function get isChildFocusEnabled():Boolean
public function set isChildFocusEnabled(value:Boolean):void
See also
layout | property |
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
.
public function get layout():ILayout
public function set layout(value:ILayout):void
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.
public function get numRawChildren():int
ScrollContainer | () | Constructor |
public function ScrollContainer()
Constructor.
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 |
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 |
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 |
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 |
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 |
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 )
|
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 )
|
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 |
change | Event |
starling.events.Event
starling.events.Event.SCROLL
Dispatched when the container is scrolled.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | 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 . |
data | null |
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. |
ALTERNATE_NAME_TOOLBAR | Constant |
public static const ALTERNATE_NAME_TOOLBAR:String = feathers-toolbar-scroll-container
DEPRECATED: Replaced by ScrollContainer.ALTERNATE_STYLE_NAME_TOOLBAR
.
DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
See also
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 );
See also
AUTO_SIZE_MODE_CONTENT | Constant |
public static const AUTO_SIZE_MODE_CONTENT:String = content
The container will auto size itself to fit its content.
See also
AUTO_SIZE_MODE_STAGE | Constant |
public static const AUTO_SIZE_MODE_STAGE:String = stage
The container will auto size itself to fill the entire stage.
See also
DECELERATION_RATE_FAST | Constant |
public static const DECELERATION_RATE_FAST:Number = 0.99
Decelerates a bit faster per millisecond than the default.
See also
DECELERATION_RATE_NORMAL | Constant |
public static const DECELERATION_RATE_NORMAL:Number = 0.998
The default deceleration rate per millisecond.
See also
INTERACTION_MODE_MOUSE | Constant |
public static const INTERACTION_MODE_MOUSE:String = mouse
The user may only interact with the scroll bars to scroll. The user cannot touch anywhere in the scroller's content and drag like a touch interface.
See also
INTERACTION_MODE_TOUCH | Constant |
public static const INTERACTION_MODE_TOUCH:String = touch
The user may touch anywhere on the scroller and drag to scroll. The scroll bars will be visual indicator of position, but they will not be interactive.
See also
INTERACTION_MODE_TOUCH_AND_SCROLL_BARS | Constant |
public static const INTERACTION_MODE_TOUCH_AND_SCROLL_BARS:String = touchAndScrollBars
The user may touch anywhere on the scroller and drag to scroll, and the scroll bars may be dragged separately. For most touch interfaces, this is not a common behavior. The scroll bar on touch interfaces is often simply a visual indicator and non-interactive.
One case where this mode might be used is a "scroll bar" that
displays a tappable alphabetical index to navigate a
GroupedList
with alphabetical categories.
See also
MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL | Constant |
public static const MOUSE_WHEEL_SCROLL_DIRECTION_HORIZONTAL:String = horizontal
The scroller will scroll horizontally when the mouse wheel is scrolled.
See also
MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL | Constant |
public static const MOUSE_WHEEL_SCROLL_DIRECTION_VERTICAL:String = vertical
The scroller will scroll vertically when the mouse wheel is scrolled.
See also
SCROLL_BAR_DISPLAY_MODE_FIXED | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_FIXED:String = fixed
The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.
See also
SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_FIXED_FLOAT:String = fixedFloat
The scroll bars appear above the scroller's view port, overlapping the content, but they do not fade out when not in use.
See also
SCROLL_BAR_DISPLAY_MODE_FLOAT | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_FLOAT:String = float
The scroll bars appear above the scroller's view port, overlapping the content, and they fade out when not in use.
See also
SCROLL_BAR_DISPLAY_MODE_NONE | Constant |
public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = none
The scroll bars are never visible.
See also
SCROLL_POLICY_AUTO | Constant |
public static const SCROLL_POLICY_AUTO:String = auto
The scroller may scroll if the view port is larger than the scroller's bounds. If the interaction mode is touch, the elastic edges will only be active if the maximum scroll position is greater than zero. If the scroll bar display mode is fixed, the scroll bar will only be visible when the maximum scroll position is greater than zero.
See also
SCROLL_POLICY_OFF | Constant |
public static const SCROLL_POLICY_OFF:String = off
The scroller does not scroll at all. If the scroll bar display mode is fixed or float, the scroll bar will never be visible.
See also
SCROLL_POLICY_ON | Constant |
public static const SCROLL_POLICY_ON:String = on
The scroller will always scroll. If the interaction mode is touch, elastic edges will always be active, even when the maximum scroll position is zero. If the scroll bar display mode is fixed, the scroll bar will always be visible.
See also
VERTICAL_SCROLL_BAR_POSITION_LEFT | Constant |
public static const VERTICAL_SCROLL_BAR_POSITION_LEFT:String = left
The vertical scroll bar will be positioned on the left.
See also
VERTICAL_SCROLL_BAR_POSITION_RIGHT | Constant |
public static const VERTICAL_SCROLL_BAR_POSITION_RIGHT:String = right
The vertical scroll bar will be positioned on the right.
See also