A view that is displayed at the bottom of the scroller's view port when dragging up. Events

The scroller will dispatch FeathersEventType.PULLING on the pull view as it is dragged into view. The event's data property will be a value between 0 and 1 to indicate how far the pull view has been dragged so far. A value of 1 does not necessarily indicate that the pull view has been activated yet. A value greater than 1 is possible if hasElasticEdges is true.

When the pull view is activated by the user, the scroller will dispatch Event.UPDATE. When the pull view should be deactivated, set the isBottomPullViewActive property to false.

The default value is null.

See also

Indicates whether the bottom pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.

The default value is feathers.controls.PullViewDisplayMode.DRAG.

See also

A flag that indicates if the scroller should scroll to a new page when it validates. If true, it will use the value of pendingHorizontalPageIndex as the target page index.

See also

A flag that indicates if the scroller should scroll to a new page when it validates. If true, it will use the value of pendingVerticalPageIndex as the target page index.

See also

The number of horizontal pages, if snapping is enabled. If snapping is disabled, the page count will always be 1.

If the scroller's view port supports infinite scrolling, this property will return int.MAX_VALUE, since an int cannot hold the value Number.POSITIVE_INFINITY.

See also

The index of the horizontal page, if snapping is enabled. If snapping is disabled, the index will always be 0.

See also

The horizontal scrollbar instance. May be null.

For internal use in subclasses.

See also

Creates the horizontal scroll bar. The horizontal scroll bar must be an instance of IScrollBar. This factory can be used to change properties on the horizontal scroll bar when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the horizontal scroll bar.

This function is expected to have the following signature:

function():IScrollBar

In the following example, a custom horizontal scroll bar factory is passed to the scroller:

scroller.horizontalScrollBarFactory = function():IScrollBar
{
    return new ScrollBar();
};

The default value is null.

See also

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. The available properties depend on which IScrollBar implementation is returned by horizontalScrollBarFactory. Refer to feathers.controls.IScrollBar for a list of available scroll bar implementations.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a horizontalScrollBarFactory function instead of using horizontalScrollBarProperties will result in better performance.

In the following example, properties for the horizontal scroll bar are passed to the scroller:

scroller.horizontalScrollBarProperties.liveDragging = false;

The default value is null.

See also

The value added to the styleNameList of the horizontal scroll bar. This variable is protected so that sub-classes can customize the horizontal scroll bar style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_HORIZONTAL_SCROLL_BAR.

To customize the horizontal scroll bar style name without subclassing, see customHorizontalScrollBarStyleName.

See also

Determines whether the scroller may scroll horizontally (on the x-axis) or not.

In the following example, horizontal scrolling is disabled:

scroller.horizontalScrollPolicy = ScrollPolicy.OFF;

The default value is feathers.controls.ScrollPolicy.AUTO.

See also

The number of pixels the container has been scrolled horizontally (on the x-axis).

In the following example, the horizontal scroll position is customized:

scroller.horizontalScrollPosition = scroller.maxHorizontalScrollPosition;

See also

The number of pixels the horizontal scroll position can be adjusted by a "step". Passed to the horizontal scroll bar, if one exists. Touch scrolling is not affected by the step value.

In the following example, the horizontal scroll step is customized:

scroller.horizontalScrollStep = 0;

The default value is NaN.

Indicates if the bottomPullView has been activated. Set to false to close the bottomPullView.

Note: Manually setting isBottomPullViewActive to true will not result in Event.UPDATE being dispatched.

See also

Indicates if the leftPullView has been activated. Set to false to close the leftPullView.

Note: Manually setting isLeftpPullViewActive to true will not result in Event.UPDATE being dispatched.

See also

Indicates if the rightPullView has been activated. Set to false to close the rightPullView.

Note: Manually setting isRightPullViewActive to true will not result in Event.UPDATE being dispatched.

See also

Determines if the scroller is currently scrolling with user interaction or with animation.

Indicates if the topPullView has been activated. Set to false to close the topPullView.

Note: Manually setting isTopPullViewActive to true will not result in Event.UPDATE being dispatched.

See also

A view that is displayed to the left of the scroller's view port when dragging to the right. Events

The scroller will dispatch FeathersEventType.PULLING on the pull view as it is dragged into view. The event's data property will be a value between 0 and 1 to indicate how far the pull view has been dragged so far. A value of 1 does not necessarily indicate that the pull view has been activated yet. A value greater than 1 is possible if hasElasticEdges is true.

When the pull view is activated by the user, the scroller will dispatch Event.UPDATE. When the pull view should be deactivated, set the isLeftPullViewActive property to false.

The default value is null.

See also

Indicates whether the left pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.

The default value is feathers.controls.PullViewDisplayMode.DRAG.

See also

The maximum horizontal page index that may be displayed by this container, if page snapping is enabled.

See also

The number of pixels the scroller may be scrolled horizontally to the right. This value is automatically calculated based on the bounds of the viewport. The horizontalScrollPosition property may have a higher value than the maximum due to elastic edges. However, once the user stops interacting with the scroller, it will automatically animate back to the maximum or minimum position.

See also

The maximum vertical page index that may be displayed by this container, if page snapping is enabled.

See also

The number of pixels the scroller may be scrolled vertically beyond the bottom edge. This value is automatically calculated based on the bounds of the viewport. The verticalScrollPosition property may have a lower value than the minimum due to elastic edges. However, once the user stops interacting with the scroller, it will automatically animate back to the maximum or minimum position.

See also

Determines if the dimensions of the view port are used when measuring the scroller. If disabled, only children other than the view port (such as the background skin) are used for measurement.

In the following example, the view port measurement is disabled:

scroller.measureViewPort = false;

The default value is true.

The minimum horizontal page index that may be displayed by this container, if page snapping is enabled.

See also

The number of pixels the scroller may be scrolled horizontally to the left. This value is automatically calculated based on the bounds of the viewport. The horizontalScrollPosition property may have a lower value than the minimum due to elastic edges. However, once the user stops interacting with the scroller, it will automatically animate back to the maximum or minimum position.

See also

The minimum physical distance (in inches) that a touch must move before the scroller starts scrolling.

In the following example, the minimum drag distance is customized:

scroller.minimumDragDistance = 0.1;

The default value is 0.04.

The minimum physical velocity (in inches per second) that a touch must move before the scroller will "throw" to the next page. Otherwise, it will settle to the nearest page.

In the following example, the minimum page throw velocity is customized:

scroller.minimumPageThrowVelocity = 2;

The default value is 5.

The minimum vertical page index that may be displayed by this container, if page snapping is enabled.

See also

The number of pixels the scroller may be scrolled vertically beyond the top edge. This value is automatically calculated based on the bounds of the viewport. The verticalScrollPosition property may have a lower value than the minimum due to elastic edges. However, once the user stops interacting with the scroller, it will automatically animate back to the maximum or minimum position.

See also

When set, the vertical pages snap to this height value instead of the height of the scroller.

In the following example, the page height is set to 200 pixels:

scroller.pageHeight = 200;

See also

When set, the horizontal pages snap to this width value instead of the width of the scroller.

In the following example, the page width is set to 200 pixels:

scroller.pageWidth = 200;

See also

The pending horizontal page index to scroll to after validating. The flag hasPendingHorizontalPageIndex must be set to true if there is a pending page index to scroll to.

See also

The pending horizontal scroll position to scroll to after validating. A value of NaN means that the scroller won't scroll to a horizontal position after validating.

The duration of the pending scroll action.

The pending vertical page index to scroll to after validating. The flag hasPendingVerticalPageIndex must be set to true if there is a pending page index to scroll to.

See also

The pending vertical scroll position to scroll to after validating. A value of NaN means that the scroller won't scroll to a vertical position after validating.

A view that is displayed to the right of the scroller's view port when dragging to the left. Events

The scroller will dispatch FeathersEventType.PULLING on the pull view as it is dragged into view. The event's data property will be a value between 0 and 1 to indicate how far the pull view has been dragged so far. A value of 1 does not necessarily indicate that the pull view has been activated yet. A value greater than 1 is possible if hasElasticEdges is true.

When the pull view is activated by the user, the scroller will dispatch Event.UPDATE. When the pull view should be deactivated, set the isRightPullViewActive property to false.

The default value is null.

See also

Indicates whether the right pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.

The default value is feathers.controls.PullViewDisplayMode.DRAG.

See also

A view that is displayed at the top of the scroller's view port when dragging down. Events

The scroller will dispatch FeathersEventType.PULLING on the pull view as it is dragged into view. The event's data property will be a value between 0 and 1 to indicate how far the pull view has been dragged so far. A value of 1 does not necessarily indicate that the pull view has been activated yet. A value greater than 1 is possible if hasElasticEdges is true.

When the pull view is activated by the user, the scroller will dispatch Event.UPDATE. When the pull view should be deactivated, set the isTopPullViewActive property to false.

The default value is null.

See also

Indicates whether the top pull view may be dragged with the content, or if its position is fixed to the edge of the scroller.

The default value is feathers.controls.PullViewDisplayMode.DRAG.

See also

The direction of scrolling when the user scrolls the mouse wheel vertically. In some cases, it is common for a container that only scrolls horizontally to scroll even when the mouse wheel is scrolled vertically.

In the following example, the direction of scrolling when using the mouse wheel is changed:

scroller.verticalMouseWheelScrollDirection = Direction.HORIZONTAL;

The default value is feathers.layout.Direction.VERTICAL.

See also

The number of pixels the vertical scroll position can be adjusted by a "step" when using the mouse wheel. If this value is NaN, the mouse wheel will use the same scroll step as the scroll bars.

In the following example, the vertical mouse wheel scroll step is customized:

scroller.verticalMouseWheelScrollStep = 10;

The default value is NaN.

The number of vertical pages, if snapping is enabled. If snapping is disabled, the page count will always be 1.

If the scroller's view port supports infinite scrolling, this property will return int.MAX_VALUE, since an int cannot hold the value Number.POSITIVE_INFINITY.

See also

The index of the vertical page, if snapping is enabled. If snapping is disabled, the index will always be 0.

See also

The vertical scrollbar instance. May be null.

For internal use in subclasses.

See also

Creates the vertical scroll bar. The vertical scroll bar must be an instance of Button. This factory can be used to change properties on the vertical scroll bar when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the vertical scroll bar.

This function is expected to have the following signature:

function():IScrollBar

In the following example, a custom vertical scroll bar factory is passed to the scroller:

scroller.verticalScrollBarFactory = function():IScrollBar
{
    return new ScrollBar();
};

The default value is null.

See also

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. The available properties depend on which IScrollBar implementation is returned by verticalScrollBarFactory. Refer to feathers.controls.IScrollBar for a list of available scroll bar implementations.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a verticalScrollBarFactory function instead of using verticalScrollBarProperties will result in better performance.

In the following example, properties for the vertical scroll bar are passed to the container:

scroller.verticalScrollBarProperties.liveDragging = false;

The default value is null.

See also

The value added to the styleNameList of the vertical scroll bar. This variable is protected so that sub-classes can customize the vertical scroll bar style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_VERTICAL_SCROLL_BAR.

To customize the vertical scroll bar style name without subclassing, see customVerticalScrollBarStyleName.

See also

Determines whether the scroller may scroll vertically (on the y-axis) or not.

In the following example, vertical scrolling is disabled:

scroller.verticalScrollPolicy = ScrollPolicy.OFF;

The default value is feathers.controls.ScrollPolicy.AUTO.

See also

The number of pixels the container has been scrolled vertically (on the y-axis).

In the following example, the vertical scroll position is customized:

scroller.verticalScrollPosition = scroller.maxVerticalScrollPosition;

See also

The number of pixels the vertical scroll position can be adjusted by a "step". Passed to the vertical scroll bar, if one exists. Touch scrolling is not affected by the step value.

In the following example, the vertical scroll step is customized:

scroller.verticalScrollStep = 0;

The default value is NaN.

The display object displayed and scrolled within the Scroller.

The default value is null.

Constructor.

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Prepares the scroller for normal interaction and dispatches FeathersEventType.SCROLL_COMPLETE.

Creates and adds the horizontalScrollBar and verticalScrollBar sub-components and removes the old instances, if they exist.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Scrolls to a pending scroll position, if required.

Positions and sizes children based on the actual width and height values.

Choose the appropriate background skin based on the control's current state.

If the scroll bars are floating, briefly show them as a hint to the user. Useful when first navigating to a screen to give the user context about both the ability to scroll and the current scroll position.

See also

After the next validation, animates the scroll position to a specific page index. To scroll in only one direction, pass in the value of the horizontalPageIndex or the verticalPageIndex property to the appropriate parameter. If the animationDuration argument is NaN (the default value) the value of the pageThrowDuration property is used for the duration. The duration is in seconds.

You can only scroll to a page if the snapToPages property is true.

In the following example, we scroll to the last horizontal page:

scroller.scrollToPageIndex( scroller.horizontalPageCount - 1, scroller.verticalPageIndex );

Parameters

See also

After the next validation, animates the scroll positions to a specific location. May scroll in only one direction by passing in a value of NaN for either scroll position. If the animationDuration argument is NaN (the default value), the duration of a standard throw is used. The duration is in seconds.

Because this function is primarily designed for animation, using a duration of 0 may require a frame or two before the scroll position updates.

In the following example, we scroll to the maximum vertical scroll position:

scroller.scrollToPosition( scroller.horizontalScrollPosition, scroller.maxVerticalScrollPosition );

Parameters

See also

If scrolling hasn't already started, prepares the scroller to scroll and dispatches FeathersEventType.SCROLL_START.

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. This function may only be called during scrolling, so if you need to stop scrolling on a TouchEvent with TouchPhase.BEGAN, you may need to wait for the scroller to start scrolling before you can call this function.

In the following example, we listen for FeathersEventType.SCROLL_START to stop scrolling:

scroller.addEventListener( FeathersEventType.SCROLL_START, function( event:Event ):void
{
    scroller.stopScrolling();
});

Immediately throws the scroller to the specified position, with optional animation. If you want to throw in only one direction, pass in NaN for the value that you do not want to change. The scroller should be validated before throwing.

Parameters

See also

Immediately throws the scroller to the specified page index, with optional animation. If you want to throw in only one direction, pass in the value from the horizontalPageIndex or verticalPageIndex property to the appropriate parameter. The scroller must be validated before throwing, to ensure that the minimum and maximum scroll positions are accurate.

Parameters

See also

Dispatched when the user starts dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user starts interacting with the scroll bar.

Note: If horizontalScrollPosition or verticalScrollPosition is set manually (in other words, the scrolling is not triggered by user interaction), no FeathersEventType.BEGIN_INTERACTION or FeathersEventType.END_INTERACTION events will be dispatched.

The properties of the event object have the following values:

See also

Dispatched when the user stops dragging the scroller when ScrollInteractionMode.TOUCH is enabled or when the user stops interacting with the scroll bar. The scroller may continue scrolling after this event is dispatched if the user interaction has also triggered an animation.

Note: If horizontalScrollPosition or verticalScrollPosition is set manually (in other words, the scrolling is not triggered by user interaction), no FeathersEventType.BEGIN_INTERACTION or FeathersEventType.END_INTERACTION events will be dispatched.

The properties of the event object have the following values:

Depending on the control, the result of the interaction may continue after the interaction ends. For instance, a Scroller may be "thrown", and the scrolling will continue animating after the user has finished interacting with it.

See also

Dispatched when the component receives focus.

The properties of the event object have the following values:

Dispatched when the component loses focus.

The properties of the event object have the following values:

Dispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed. Listen for FeathersEventType.SCROLL_START to know when scrolling starts as a result of user interaction or when scrolling is triggered by an animation. Similarly, listen for FeathersEventType.SCROLL_COMPLETE to know when the scrolling ends.

The properties of the event object have the following values:

See also

Dispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation. Animations may not end at the same time that user interaction ends, so the event may be delayed if user interaction triggers scrolling again.

Note: If horizontalScrollPosition or verticalScrollPosition is set manually (in other words, the scrolling is not triggered by user interaction or an animated scroll), no FeathersEventType.SCROLL_START or FeathersEventType.SCROLL_COMPLETE events will be dispatched.

The properties of the event object have the following values:

See also

Dispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation.

Note: If horizontalScrollPosition or verticalScrollPosition is set manually (in other words, the scrolling is not triggered by user interaction or an animated scroll), no FeathersEventType.SCROLL_START or FeathersEventType.SCROLL_COMPLETE events will be dispatched.

The properties of the event object have the following values:

See also

Dispatched when a pull view is activated.

The properties of the event object have the following values:

Determines where the vertical scroll bar will be positioned.

In the following example, the scroll bars is positioned on the left:

scroller.verticalScrollBarPosition = RelativePosition.LEFT;

The default value is feathers.layout.RelativePosition.RIGHT.

See also

If true, the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity. This value may be set to false to have the scroller calculate a variable duration based on the velocity of the throw.

It may seem unintuitive, but using the same fixed duration for any velocity is recommended if you are looking to closely match the behavior of native scrolling on iOS.

In the following example, the behavior of a "throw" animation is changed:

scroller.useFixedThrowDuration = false;

The default value is true.

See also

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. A value of 0 means that the scroller will not go beyond its minimum or maximum bounds. A value of 1 means that going beyond the minimum or maximum bounds is completely unrestrained.

In the following example, the elasticity of throwing beyond the scroller's edges is customized:

scroller.throwElasticity = 0.1;

The default value is 0.05.

See also

The easing function used for "throw" animations.

In the following example, the ease of throwing animations is customized:

scroller.throwEase = Transitions.EASE_IN_OUT;

See also

Determines if scrolling will snap to the nearest page.

In the following example, the scroller snaps to the nearest page:

scroller.snapToPages = true;

The default value is false.

If enabled, the scroll position will always be adjusted to the nearest pixel on the physical screen. Depending on the value of Starling's contentScaleFactor, this may or may not result in an integer value for the scroll position.

In the following example, the scroll position is not snapped to pixels:

scroller.snapScrollPositionsToPixels = false;

The default value is true.

Determines how the scroll bars are displayed.

In the following example, the scroll bars are fixed:

scroller.scrollBarDisplayMode = ScrollBarDisplayMode.FIXED;

The default value is feathers.controls.ScrollBarDisplayMode.FLOAT.

See also

The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars()

The default value is 1.0.

See also

The duration, in seconds, of the animation when the scroller is thrown to a page.

In the following example, the duration of the animation that changes the page when thrown is set to 250 milliseconds:

scroller.pageThrowDuration = 0.25;

The default value is 0.5.

The minimum space, in pixels, between the container's left edge and the container's content.

In the following example, the left padding is set to 20 pixels:

scroller.paddingLeft = 20;

The default value is 0.

See also

The minimum space, in pixels, between the container's bottom edge and the container's content.

In the following example, the bottom padding is set to 20 pixels:

scroller.paddingBottom = 20;

The default value is 0.

See also

The minimum space, in pixels, between the container's right edge and the container's content.

In the following example, the right padding is set to 20 pixels:

scroller.paddingRight = 20;

The default value is 0.

See also

The minimum space, in pixels, between the container's top edge and the container's content.

In the following example, the top padding is set to 20 pixels:

scroller.paddingTop = 20;

The default value is 0.

See also

Quickly sets all padding properties to the same value. The padding getter always returns the value of paddingTop, but the other padding values may be different.

In the following example, the padding is set to 20 pixels:

scroller.padding = 20;

The default value is 0.

See also

The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.

In the following example, the duration of the animation that runs when the mouse wheel is scrolled is set to 500 milliseconds:

scroller.mouseWheelScrollDuration = 0.5;

The default value is 0.35.

Determines how the user may interact with the scroller.

In the following example, the interaction mode is optimized for mouse:

scroller.interactionMode = ScrollInteractionMode.MOUSE;

The default value is feathers.controls.ScrollInteractionMode.TOUCH.

See also

Determines where the horizontal scroll bar will be positioned.

In the following example, the scroll bars is positioned on the top:

scroller.horizontalScrollBarPosition = RelativePosition.TOP;

The default value is feathers.layout.RelativePosition.BOTTOM.

See also

The easing function used for hiding the scroll bars, if applicable.

In the following example, the ease of the animation that hides the scroll bars is customized:

scroller.hideScrollBarAnimationEase = Transitions.EASE_IN_OUT;

The default value is starling.animation.Transitions.EASE_OUT.

See also

The duration, in seconds, of the animation when a scroll bar fades out.

In the following example, the duration of the animation that hides the scroll bars is set to 500 milliseconds:

scroller.hideScrollBarAnimationDuration = 0.5;

The default value is 0.2.

See also

Determines if the scrolling can go beyond the edges of the viewport.

In the following example, elastic edges are disabled:

scroller.hasElasticEdges = false;

The default value is true.

See also

The duration, in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds.

In the following example, the duration of the animation that snaps the content back after pulling it beyond the edge is set to 750 milliseconds:

scroller.elasticSnapDuration = 0.75;

The default value is 0.5.

See also

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. A value of 0 means that the scroller will not go beyond its minimum or maximum bounds. A value of 1 means that going beyond the minimum or maximum bounds is completely unrestrained.

In the following example, the elasticity of dragging beyond the scroller's edges is customized:

scroller.elasticity = 0.5;

The default value is 0.33.

See also

This value is used to decelerate the scroller when "thrown". The velocity of a throw is multiplied by this value once per millisecond to decelerate. A value greater than 0 and less than 1 is expected.

In the following example, deceleration rate is lowered to adjust the behavior of a throw:

scroller.decelerationRate = DecelerationRate.FAST;

The default value is feathers.controls.DecelerationRate.NORMAL.

See also

A style name to add to the container's vertical scroll bar sub-component. Typically used by a theme to provide different styles to different containers.

In the following example, a custom vertical scroll bar style name is passed to the scroller:

scroller.customVerticalScrollBarStyleName = "my-custom-vertical-scroll-bar";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( SimpleScrollBar ).setFunctionForStyleName( "my-custom-vertical-scroll-bar", setCustomVerticalScrollBarStyles );

The default value is null.

See also

A style name to add to the container's horizontal scroll bar sub-component. Typically used by a theme to provide different styles to different containers.

In the following example, a custom horizontal scroll bar style name is passed to the scroller:

scroller.customHorizontalScrollBarStyleName = "my-custom-horizontal-scroll-bar";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( SimpleScrollBar ).setFunctionForStyleName( "my-custom-horizontal-scroll-bar", setCustomHorizontalScrollBarStyles );

The default value is null.

See also

If true, the viewport will be clipped to the scroller's bounds. In other words, anything appearing outside the scroller's bounds will not be visible.

To improve performance, turn off clipping and place other display objects over the edges of the scroller to hide the content that bleeds outside of the scroller's bounds.

In the following example, clipping is disabled:

scroller.clipContent = false;

The default value is true.

A background to display when the container is disabled.

In the following example, the scroller is given a disabled background skin:

scroller.backgroundDisabledSkin = new Image( texture );

The default value is null.

See also

The default background to display.

In the following example, the scroller is given a background skin:

scroller.backgroundSkin = new Image( texture );

The default value is null.

See also

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. The background will be visible when the content is extended beyond the scrolling bounds, such as when hasElasticEdges is true.

If the content is not fully opaque, this setting should not be enabled.

This setting may be enabled to potentially improve performance.

In the following example, the background is automatically hidden:

scroller.autoHideBackground = true;

The default value is false.

See also

The default value added to the styleNameList of the horizontal scroll bar.

See also

The default value added to the styleNameList of the vertical scroll bar.

See also

Flag to indicate that the clipping has changed.