Packagefeathers.controls
Classpublic class SpinnerList
InheritanceSpinnerList Inheritance List Inheritance Scroller Inheritance FeathersControl Inheritance starling.display.Sprite

Product Version : Feathers 2.1.0

A customized List component where scrolling updates the the selected item. Layouts may loop infinitely.

The following example creates a list, gives it a data provider, tells the item renderer how to interpret the data, and listens for when the selection changes:

var list:SpinnerList = new SpinnerList();

list.dataProvider = new ArrayCollection(
[
    { text: "Milk", thumbnail: textureAtlas.getTexture( "milk" ) },
    { text: "Eggs", thumbnail: textureAtlas.getTexture( "eggs" ) },
    { text: "Bread", thumbnail: textureAtlas.getTexture( "bread" ) },
    { text: "Chicken", thumbnail: textureAtlas.getTexture( "chicken" ) },
]);

list.itemRendererFactory = function():IListItemRenderer
{
    var renderer:DefaultListItemRenderer = new DefaultListItemRenderer();
    renderer.labelField = "text";
    renderer.iconSourceField = "thumbnail";
    return renderer;
};

list.addEventListener( Event.CHANGE, list_changeHandler );

this.addChild( list );

See also

How to use the Feathers SpinnerList component

Public Properties
 PropertyDefined By
 InheritedaddedEffect : Function
An optional effect that is activated when the component is added to the stage.
FeathersControl
  allowMultipleSelection : Boolean
[override] SpinnerList requires that the allowMultipleSelection property is set to false.
SpinnerList
 InheritedbottomPullView : DisplayObject
A view that is displayed at the bottom of the scroller's view port when dragging up.
Scroller
 InheritedbottomPullViewDisplayMode : 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
 InheriteddataProvider : IListCollection
The collection of data displayed by the list.
List
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheriteddragEnabled : Boolean
Indicates if this list can initiate drag and drop operations by touching an item and dragging it.
List
 InheriteddragFormat : String
Drag and drop is restricted to components that have the same dragFormat.
List
 InheriteddropEnabled : Boolean
Indicates if this list can accept items that are dragged and dropped over the list's hit area.
List
 InheritedeffectsSuspended : Boolean
[read-only] Indicates if effects have been suspended.
FeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfactoryIDFunction : Function
When a list requires multiple item renderer types, this function is used to determine which type of item renderer is required for a specific item (or index).
List
 InheritedfocusInEffect : Function
An optional effect that is activated when the component receives focus.
FeathersControl
 InheritedfocusManager : 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
 InheritedfocusOutEffect : Function
An optional effect that is activated when the component loses focus.
FeathersControl
 InheritedfocusOwner : 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 SpinnerList components.
SpinnerList
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedhideEffect : Function
An optional effect that is activated when the component is hidden.
FeathersControl
 InheritedhorizontalPageCount : int
[read-only] The number of horizontal pages, if snapping is enabled.
Scroller
 InheritedhorizontalPageIndex : int
The index of the horizontal page, if snapping is enabled.
Scroller
 InheritedhorizontalScrollBarFactory : Function
Creates the horizontal scroll bar.
Scroller
 InheritedhorizontalScrollBarProperties : 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
 InheritedhorizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the x-axis) or not.
Scroller
 InheritedhorizontalScrollPosition : Number
The number of pixels the container has been scrolled horizontally (on the x-axis).
Scroller
 InheritedhorizontalScrollStep : Number
The number of pixels the horizontal scroll position can be adjusted by a "step".
Scroller
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisBottomPullViewActive : Boolean
Indicates if the bottomPullView has been activated.
Scroller
 InheritedisChildFocusEnabled : Boolean
Determines if this component's children can receive focus.
List
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : 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
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisLeftPullViewActive : Boolean
Indicates if the leftPullView has been activated.
Scroller
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisRightPullViewActive : Boolean
Indicates if the rightPullView has been activated.
Scroller
 InheritedisScrolling : Boolean
[read-only] Determines if the scroller is currently scrolling with user interaction or with animation.
Scroller
  isSelectable : Boolean
[override] SpinnerList requires that the isSelectable property is set to true.
SpinnerList
 InheritedisShowingFocus : 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
 InheritedisTopPullViewActive : Boolean
Indicates if the topPullView has been activated.
Scroller
 InheriteditemRendererFactory : Function
A function called that is expected to return a new item renderer.
List
 InheriteditemRendererProperties : Object
An object that stores properties for all of the list's item renderers, and the properties will be passed down to every item renderer when the list validates.
List
 InheriteditemRendererType : Class
The class used to instantiate item renderers.
List
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedleftPullView : DisplayObject
A view that is displayed to the left of the scroller's view port when dragging to the right.
Scroller
 InheritedleftPullViewDisplayMode : 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
 InheritedmaintainTouchFocus : 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
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxHorizontalPageIndex : int
[read-only] The maximum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the right.
Scroller
 InheritedmaxVerticalPageIndex : int
[read-only] The maximum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedmaxVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the bottom edge.
Scroller
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmeasureViewPort : Boolean
Determines if the dimensions of the view port are used when measuring the scroller.
Scroller
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHorizontalPageIndex : int
[read-only] The minimum horizontal page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminHorizontalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled horizontally to the left.
Scroller
 InheritedminimumAutoScrollDistance : Number
The minimum physical distance (in inches) that a touch must be from the edge of the container during a drag and drop action before the container starts scrolling.
List
 InheritedminimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move before the scroller starts scrolling.
Scroller
 InheritedminimumPageThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch must move before the scroller will "throw" to the next page.
Scroller
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminVerticalPageIndex : int
[read-only] The minimum vertical page index that may be displayed by this container, if page snapping is enabled.
Scroller
 InheritedminVerticalScrollPosition : Number
[read-only] The number of pixels the scroller may be scrolled vertically beyond the top edge.
Scroller
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmoveEffect : Function
An optional effect that is activated when the component is moved to a new position.
FeathersControl
 InheritednextDownFocus : 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
 InheritednextLeftFocus : 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
 InheritednextRightFocus : 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
 InheritednextTabFocus : 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
 InheritednextUpFocus : 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
 InheritedpageHeight : Number
When set, the vertical pages snap to this height value instead of the height of the scroller.
Scroller
 InheritedpageWidth : Number
When set, the horizontal pages snap to this width value instead of the width of the scroller.
Scroller
 InheritedpreviousTabFocus : 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
 InheritedresizeEffect : Function
An optional effect that is activated when the component is resized with new dimensions.
FeathersControl
 InheritedrightPullView : DisplayObject
A view that is displayed to the right of the scroller's view port when dragging to the left.
Scroller
 InheritedrightPullViewDisplayMode : 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
 InheritedselectedIndex : int
The index of the currently selected item.
List
 InheritedselectedIndices : Vector.<int>
The indices of the currently selected items.
List
 InheritedselectedItem : Object
The currently selected item.
List
 InheritedselectedItems : Vector.<Object>
The currently selected item.
List
 InheritedshowEffect : Function
An optional effect that is activated when the component is shown.
FeathersControl
  snapToPages : Boolean
[override] SpinnerList requires that the snapToPages property is set to true.
SpinnerList
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 InheritedtopPullView : DisplayObject
A view that is displayed at the top of the scroller's view port when dragging down.
Scroller
 InheritedtopPullViewDisplayMode : 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
 InheritedtypicalItem : Object
Used to auto-size the list when a virtualized layout is used.
List
 InheritedverticalMouseWheelScrollDirection : String
The direction of scrolling when the user scrolls the mouse wheel vertically.
Scroller
 InheritedverticalMouseWheelScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step" when using the mouse wheel.
Scroller
 InheritedverticalPageCount : int
[read-only] The number of vertical pages, if snapping is enabled.
Scroller
 InheritedverticalPageIndex : int
The index of the vertical page, if snapping is enabled.
Scroller
 InheritedverticalScrollBarFactory : Function
Creates the vertical scroll bar.
Scroller
 InheritedverticalScrollBarProperties : 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
 InheritedverticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the y-axis) or not.
Scroller
 InheritedverticalScrollPosition : Number
The number of pixels the container has been scrolled vertically (on the y-axis).
Scroller
 InheritedverticalScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by a "step".
Scroller
 InheritedviewPort : IViewPort
The display object displayed and scrolled within the Scroller.
Scroller
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
 InheritedhasPendingHorizontalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 InheritedhasPendingVerticalPageIndex : Boolean = false
A flag that indicates if the scroller should scroll to a new page when it validates.
Scroller
 InheritedhorizontalScrollBar : IScrollBar
The horizontal scrollbar instance.
Scroller
 InheritedhorizontalScrollBarStyleName : String = "feathers-scroller-horizontal-scroll-bar"
The value added to the styleNameList of the horizontal scroll bar.
Scroller
 InheritedpendingHorizontalPageIndex : int
The pending horizontal page index to scroll to after validating.
Scroller
 InheritedpendingHorizontalScrollPosition : Number = NaN
The pending horizontal scroll position to scroll to after validating.
Scroller
 InheritedpendingItemIndex : int = -1
The pending item index to scroll to after validating.
List
 InheritedpendingScrollDuration : Number
The duration of the pending scroll action.
Scroller
 InheritedpendingVerticalPageIndex : int
The pending vertical page index to scroll to after validating.
Scroller
 InheritedpendingVerticalScrollPosition : Number = NaN
The pending vertical scroll position to scroll to after validating.
Scroller
 InheritedverticalScrollBar : IScrollBar
The vertical scrollbar instance.
Scroller
 InheritedverticalScrollBarStyleName : String = "feathers-scroller-vertical-scroll-bar"
The value added to the styleNameList of the vertical scroll bar.
Scroller
Public Methods
 MethodDefined By
  
SpinnerList()
Constructor.
SpinnerList
 Inherited
addItemWithEffect(item:Object, index:int, effect:Function):void
Adds an item from the data provider and animates its item renderer using an effect.
List
 Inherited
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
 Inherited
getItemRendererFactoryWithID(id:String):Function
Returns the item renderer factory associated with a specific ID.
List
 Inherited
getSelectedItems(result:Vector.<Object> = null):Vector.<Object>
Returns the selected items, with the ability to pass in an optional result vector.
List
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
initializeNow():void
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
itemToItemRenderer(item:Object):IListItemRenderer
Returns the current item renderer used to render a specific item.
List
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent.
FeathersControl
 Inherited
removeItemWithEffect(item:Object, effect:Function):void
Removes an item from the data provider after animating its item renderer using an effect.
List
 Inherited
resetStyleProvider():void
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
resumeEffects():void
Indicates that effects should be re-activated after being suspended.
FeathersControl
 Inherited
revealScrollBars():void
If the scroll bars are floating, briefly show them as a hint to the user.
Scroller
 Inherited
scrollToDisplayIndex(index:int, animationDuration:Number = 0):void
Scrolls the list so that the specified item is visible.
List
 Inherited
scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number):void
After the next validation, animates the scroll position to a specific page index.
Scroller
 Inherited
scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number):void
After the next validation, animates the scroll positions to a specific location.
Scroller
 Inherited
setItemRendererFactoryWithID(id:String, factory:Function):void
Associates an item renderer factory with an ID to allow multiple types of item renderers may be displayed in the list.
List
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
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
 Inherited
suspendEffects():void
Indicates that effects should not be activated temporarily.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
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
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
completeScroll():void
Prepares the scroller for normal interaction and dispatches FeathersEventType.SCROLL_COMPLETE.
Scroller
 Inherited
createScrollBars():void
Creates and adds the horizontalScrollBar and verticalScrollBar sub-components and removes the old instances, if they exist.
Scroller
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
handlePendingScroll():void
Scrolls to a pending scroll position, if required.
Scroller
 Inherited
ignoreNextStyleRestriction():void
The next style that is set will not be restricted.
FeathersControl
 Inherited
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
 Inherited
layoutChildren():void
Positions and sizes children based on the actual width and height values.
Scroller
 Inherited
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
 Inherited
refreshBackgroundSkin():void
Choose the appropriate background skin based on the control's current state.
Scroller
 Inherited
refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
 Inherited
startScroll():void
If scrolling hasn't already started, prepares the scroller to scroll and dispatches FeathersEventType.SCROLL_START.
Scroller
 Inherited
throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void
Immediately throws the scroller to the specified position, with optional animation.
Scroller
 Inherited
throwToPage(targetHorizontalPageIndex:int, targetVerticalPageIndex:int, duration:Number = 0.5):void
Immediately throws the scroller to the specified page index, with optional animation.
Scroller
Events
 Event Summary Defined By
 Inherited
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
 Inherited
change
Dispatched when the selected item changes.List
 Inherited
creationComplete
Dispatched after the component has validated for the first time.FeathersControl
 Inherited
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
 Inherited
focusIn
Dispatched when the component receives focus.Scroller
 Inherited
focusOut
Dispatched when the component loses focus.Scroller
 Inherited
initialize
Dispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 Inherited
rendererAdd
Dispatched when an item renderer is added to the list.List
 Inherited
rendererRemove
Dispatched when an item renderer is removed from the list.List
 Inherited
resize
Dispatched when the width or height of the control changes.FeathersControl
 Inherited
scroll
Dispatched when the scroller scrolls in either direction or when the view port's scrolling bounds have changed.Scroller
 Inherited
scrollComplete
Dispatched when the scroller finishes scrolling in either direction as a result of either user interaction or animation.Scroller
 Inherited
scrollStart
Dispatched when the scroller starts scrolling in either direction as a result of either user interaction or animation.Scroller
 Inherited
triggered
Dispatched when the the user taps or clicks an item renderer in the list.List
 Inherited
update
Dispatched when a pull view is activated.Scroller
Styles
 StyleDefined By
 Inherited
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
 Inherited
backgroundDisabledSkin : DisplayObject
A background to display when the container is disabled.
Scroller
 Inherited
backgroundSkin : DisplayObject
The default background to display.
Scroller
 Inherited
clipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds.
Scroller
 Inherited
customHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar sub-component.
Scroller
 Inherited
customItemRendererStyleName : String
A style name to add to all item renderers in this list.
List
 Inherited
customVerticalScrollBarStyleName : String
A style name to add to the container's vertical scroll bar sub-component.
Scroller
 Inherited
decelerationRate : Number
This value is used to decelerate the scroller when "thrown".
Scroller
 Inherited
dropIndicatorSkin : DisplayObject
A skin to display when dragging one an item to indicate where it can be dropped.
List
 Inherited
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
 Inherited
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
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
 Inherited
hasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport.
Scroller
 Inherited
hideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades out.
Scroller
 Inherited
hideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable.
Scroller
  
hideSelectionOverlayUnlessFocused : Boolean
Determines if the selectionOverlaySkin is hidden when the list is not focused.
SpinnerList
 Inherited
horizontalScrollBarPosition : String
Determines where the horizontal scroll bar will be positioned.
Scroller
 Inherited
interactionMode : String
Determines how the user may interact with the scroller.
Scroller
 Inherited
keyScrollDuration : Number
The duration, in seconds, of the animation when the selected item is changed by keyboard navigation and the item scrolls into view.
List
 Inherited
layout : ILayout
The layout algorithm used to position and, optionally, size the list's items.
List
 Inherited
mouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.
Scroller
 Inherited
padding : Number
Quickly sets all padding properties to the same value.
Scroller
 Inherited
paddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and the container's content.
Scroller
 Inherited
paddingLeft : Number
The minimum space, in pixels, between the container's left edge and the container's content.
Scroller
 Inherited
paddingRight : Number
The minimum space, in pixels, between the container's right edge and the container's content.
Scroller
 Inherited
paddingTop : Number
The minimum space, in pixels, between the container's top edge and the container's content.
Scroller
 Inherited
pageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is thrown to a page.
Scroller
 Inherited
revealScrollBarsDuration : Number
The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars().
Scroller
 Inherited
scrollBarDisplayMode : String
Determines how the scroll bars are displayed.
Scroller
  
selectionOverlaySkin : DisplayObject
An optional skin to display in the horizontal or vertical center of the list to highlight the currently selected item.
SpinnerList
  
showSelectionOverlay : Boolean
Determines if the selectionOverlaySkin is visible or hidden.
SpinnerList
 Inherited
snapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to the nearest pixel on the physical screen.
Scroller
 Inherited
snapToPages : Boolean
Determines if scrolling will snap to the nearest page.
Scroller
 Inherited
throwEase : Object
The easing function used for "throw" animations.
Scroller
 Inherited
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
 Inherited
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
 Inherited
verticalScrollBarPosition : String
Determines where the vertical scroll bar will be positioned.
Scroller
Public Constants
 ConstantDefined By
 InheritedDEFAULT_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
 InheritedDEFAULT_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
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = "clipping"
[static] Flag to indicate that the clipping has changed.
Scroller
Property Detail
allowMultipleSelectionproperty
allowMultipleSelection:Boolean[override]

SpinnerList requires that the allowMultipleSelection property is set to false. Attempts to set it to true will result in a runtime error.


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

Throws
ArgumentError — SpinnerList requires allowMultipleSelection to be false.
globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all SpinnerList components.

The default value is null.

See also

feathers.core.FeathersControl.styleProvider
isSelectableproperty 
isSelectable:Boolean[override]

SpinnerList requires that the isSelectable property is set to true. Attempts to set it to false will result in a runtime error.


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

Throws
ArgumentError — SpinnerList requires isSelectable to be true.
snapToPagesproperty 
snapToPages:Boolean[override]

SpinnerList requires that the snapToPages property is set to true. Attempts to set it to false will result in a runtime error.


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

Throws
ArgumentError — SpinnerList requires snapToPages to be true.
Constructor Detail
SpinnerList()Constructor
public function SpinnerList()

Constructor.

Style Detail
showSelectionOverlaystyle
showSelectionOverlay:Boolean

Determines if the selectionOverlaySkin is visible or hidden.

The following example hides the selection overlay skin:

list.showSelectionOverlay = false;

The default value is true.

See also

selectionOverlaySkin
hideSelectionOverlayUnlessFocused
selectionOverlaySkinstyle 
selectionOverlaySkin:DisplayObject

An optional skin to display in the horizontal or vertical center of the list to highlight the currently selected item. If the list scrolls vertically, the selectionOverlaySkin will fill the entire width of the list, and it will be positioned in the vertical center. If the list scrolls horizontally, the selectionOverlaySkin will fill the entire height of the list, and it will be positioned in the horizontal center.

The following example gives the spinner list a selection overlay skin:

list.selectionOverlaySkin = new Image( texture );

The default value is null.

hideSelectionOverlayUnlessFocusedstyle 
hideSelectionOverlayUnlessFocused:Boolean

Determines if the selectionOverlaySkin is hidden when the list is not focused. 

list.hideSelectionOverlayUnlessFocused = true;

Note: If the showSelectionOverlay property is false, the selectionOverlaySkin will always be hidden.

The default value is false.

See also

selectionOverlaySkin
showSelectionOverlay




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