Package | feathers.controls |
Class | public class SpinnerList |
Inheritance | SpinnerList ![]() ![]() ![]() ![]() |
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 ListCollection( [ { 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
Property | Defined By | ||
---|---|---|---|
allowMultipleSelection : Boolean [override]
SpinnerList requires that the allowMultipleSelection
property is set to false. | SpinnerList | ||
![]() | autoHideBackground : Boolean
If true, the background's visible property
will be set to false when the scroll position is greater
than or equal to the minimum scroll position and less than or equal
to the maximum scroll position. | Scroller | |
![]() | backgroundDisabledSkin : DisplayObject
A background to display when the container is disabled. | Scroller | |
![]() | backgroundSkin : DisplayObject
The default background to display. | Scroller | |
![]() | clipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds. | Scroller | |
![]() | customHorizontalScrollBarName : String
DEPRECATED: Replaced by customHorizontalScrollBarName. | Scroller | |
![]() | customHorizontalScrollBarStyleName : String
A style name to add to the container's horizontal scroll bar
sub-component. | Scroller | |
![]() | customItemRendererStyleName : String
A style name to add to all item renderers in this list. | List | |
![]() | customVerticalScrollBarName : String
DEPRECATED: Replaced by customVerticalScrollBarStyleName. | Scroller | |
![]() | customVerticalScrollBarStyleName : String
A style name to add to the container's vertical scroll bar
sub-component. | Scroller | |
![]() | dataProvider : ListCollection
The collection of data displayed by the list. | List | |
![]() | 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 SpinnerList
components. | SpinnerList | ||
![]() | 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. | List | |
![]() | 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 | |
isSelectable : Boolean [override]
SpinnerList requires that the isSelectable
property is set to true. | SpinnerList | ||
![]() | itemRendererFactory : Function
A function called that is expected to return a new item renderer. | List | |
![]() | itemRendererName : String
DEPRECATED: Replaced by customItemRendererStyleName. | List | |
![]() | itemRendererProperties : 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 | |
![]() | itemRendererType : Class
The class used to instantiate item renderers. | List | |
![]() | 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 | |
![]() | layout : ILayout
The layout algorithm used to position and, optionally, size the
list's items. | List | |
![]() | 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 | |
![]() | 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 | |
![]() | selectedIndex : int
The index of the currently selected item. | List | |
![]() | selectedIndices : Vector.<int>
The indices of the currently selected items. | List | |
![]() | selectedItem : Object
The currently selected item. | List | |
![]() | selectedItems : Vector.<Object>
The currently selected item. | List | |
selectionOverlaySkin : DisplayObject
An optional skin to display in the horizontal or vertical center of
the list to highlight the currently selected item. | SpinnerList | ||
![]() | snapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole
pixels. | Scroller | |
snapToPages : Boolean [override]
SpinnerList requires that the snapToPages
property is set to true. | SpinnerList | ||
![]() | 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 | |
![]() | typicalItem : Object
Used to auto-size the list when a virtualized layout is used. | List | |
![]() | 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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | SpinnerList | ||
![]() | getSelectedItems(result:Vector.<Object> = null):Vector.<Object>
Returns the selected items, with the ability to pass in an optional
result vector. | List | |
![]() | 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 | |
![]() | revealScrollBars():void
If the scroll bars are floating, briefly show them as a hint to the
user. | Scroller | |
![]() | scrollToDisplayIndex(index:int, animationDuration:Number = 0):void
Scrolls the list so that the specified item is visible. | List | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
allowMultipleSelection | property |
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.
public function get allowMultipleSelection():Boolean
public function set allowMultipleSelection(value:Boolean):void
ArgumentError — SpinnerList requires allowMultipleSelection to be false.
|
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all SpinnerList
components.
The default value is null
.
See also
isSelectable | property |
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.
public function get isSelectable():Boolean
public function set isSelectable(value:Boolean):void
ArgumentError — SpinnerList requires isSelectable to be true.
|
selectionOverlaySkin | property |
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 Scale9Image( textures );
The default value is null
.
public function get selectionOverlaySkin():DisplayObject
public function set selectionOverlaySkin(value:DisplayObject):void
snapToPages | property |
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.
public function get snapToPages():Boolean
public function set snapToPages(value:Boolean):void
ArgumentError — SpinnerList requires snapToPages to be true.
|
SpinnerList | () | Constructor |
public function SpinnerList()
Constructor.