Package | feathers.controls |
Class | public class SpinnerList |
Inheritance | SpinnerList ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Product Version : | Feathers 2.1.0 |
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
Property | Defined By | ||
---|---|---|---|
![]() | addedEffect : 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 | ||
![]() | alpha : Number The opacity of the object. | DisplayObject | |
![]() | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
![]() | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
![]() | bottomPullView : DisplayObject
A view that is displayed at the bottom of the scroller's view port
when dragging up. | Scroller | |
![]() | bottomPullViewDisplayMode : String
Indicates whether the bottom pull view may be dragged with the
content, or if its position is fixed to the edge of the scroller. | Scroller | |
![]() | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | dataProvider : IListCollection
The collection of data displayed by the list. | List | |
![]() | 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 | |
![]() | dragEnabled : Boolean
Indicates if this list can initiate drag and drop operations by
touching an item and dragging it. | List | |
![]() | dragFormat : String
Drag and drop is restricted to components that have the same
dragFormat. | List | |
![]() | dropEnabled : Boolean
Indicates if this list can accept items that are dragged and
dropped over the list's hit area. | List | |
![]() | effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
![]() | explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
![]() | explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
![]() | explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
![]() | explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
![]() | explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
![]() | explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
![]() | factoryIDFunction : 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 | |
![]() | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
![]() | focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
![]() | focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
![]() | focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all SpinnerList
components. | SpinnerList | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
![]() | horizontalPageCount : int [read-only]
The number of horizontal pages, if snapping is enabled. | Scroller | |
![]() | horizontalPageIndex : int
The index of the horizontal page, if snapping is enabled. | Scroller | |
![]() | horizontalScrollBarFactory : Function
Creates the horizontal scroll bar. | Scroller | |
![]() | horizontalScrollBarProperties : Object
An object that stores properties for the container's horizontal
scroll bar, and the properties will be passed down to the horizontal
scroll bar when the container validates. | Scroller | |
![]() | horizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the
x-axis) or not. | Scroller | |
![]() | horizontalScrollPosition : Number
The number of pixels the container has been scrolled horizontally (on
the x-axis). | Scroller | |
![]() | horizontalScrollStep : Number
The number of pixels the horizontal scroll position can be adjusted
by a "step". | Scroller | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
![]() | isBottomPullViewActive : Boolean
Indicates if the bottomPullView has been activated. | 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
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isLeftPullViewActive : Boolean
Indicates if the leftPullView has been activated. | Scroller | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isRightPullViewActive : Boolean
Indicates if the rightPullView has been activated. | Scroller | |
![]() | isScrolling : Boolean [read-only]
Determines if the scroller is currently scrolling with user
interaction or with animation. | Scroller | |
isSelectable : Boolean [override]
SpinnerList requires that the isSelectable
property is set to true. | SpinnerList | ||
![]() | isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
![]() | isTopPullViewActive : Boolean
Indicates if the topPullView has been activated. | Scroller | |
![]() | itemRendererFactory : Function
A function called that is expected to return a new item renderer. | 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 | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | leftPullView : DisplayObject
A view that is displayed to the left of the scroller's view port
when dragging to the right. | Scroller | |
![]() | leftPullViewDisplayMode : String
Indicates whether the left pull view may be dragged with the content,
or if its position is fixed to the edge of the scroller. | Scroller | |
![]() | maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
![]() | mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
![]() | maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxHorizontalPageIndex : int [read-only]
The maximum horizontal page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | maxHorizontalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled horizontally to the
right. | Scroller | |
![]() | maxVerticalPageIndex : int [read-only]
The maximum vertical page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | maxVerticalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled vertically beyond
the bottom edge. | Scroller | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | measureViewPort : Boolean
Determines if the dimensions of the view port are used when measuring
the scroller. | Scroller | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHorizontalPageIndex : int [read-only]
The minimum horizontal page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | minHorizontalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled horizontally to the
left. | Scroller | |
![]() | minimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move
before the scroller starts scrolling. | Scroller | |
![]() | minimumPageThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch
must move before the scroller will "throw" to the next page. | Scroller | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minVerticalPageIndex : int [read-only]
The minimum vertical page index that may be displayed by this
container, if page snapping is enabled. | Scroller | |
![]() | minVerticalScrollPosition : Number [read-only]
The number of pixels the scroller may be scrolled vertically beyond
the top edge. | Scroller | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
![]() | name : String The name of the display object (default: null). | DisplayObject | |
![]() | nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
![]() | nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
![]() | pageHeight : Number
When set, the vertical pages snap to this height value instead of
the height of the scroller. | Scroller | |
![]() | pageWidth : Number
When set, the horizontal pages snap to this width value instead of
the width of the scroller. | Scroller | |
![]() | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
![]() | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
![]() | requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
![]() | resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
![]() | rightPullView : DisplayObject
A view that is displayed to the right of the scroller's view port
when dragging to the left. | Scroller | |
![]() | rightPullViewDisplayMode : String
Indicates whether the right pull view may be dragged with the
content, or if its position is fixed to the edge of the scroller. | Scroller | |
![]() | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
![]() | rotation : Number The rotation of the object in radians. | DisplayObject | |
![]() | scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
![]() | scaleX : Number The horizontal scale factor. | DisplayObject | |
![]() | scaleY : Number The vertical scale factor. | DisplayObject | |
![]() | 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 | |
![]() | showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
![]() | skewX : Number The horizontal skew angle in radians. | DisplayObject | |
![]() | skewY : Number The vertical skew angle in radians. | DisplayObject | |
snapToPages : Boolean [override]
SpinnerList requires that the snapToPages
property is set to true. | SpinnerList | ||
![]() | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
![]() | toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
![]() | topPullView : DisplayObject
A view that is displayed at the top of the scroller's view port when
dragging down. | Scroller | |
![]() | topPullViewDisplayMode : String
Indicates whether the top pull view may be dragged with the content,
or if its position is fixed to the edge of the scroller. | Scroller | |
![]() | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
![]() | touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
![]() | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | typicalItem : Object
Used to auto-size the list when a virtualized layout is used. | List | |
![]() | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
![]() | verticalMouseWheelScrollDirection : String
The direction of scrolling when the user scrolls the mouse wheel
vertically. | Scroller | |
![]() | verticalMouseWheelScrollStep : Number
The number of pixels the vertical scroll position can be adjusted by
a "step" when using the mouse wheel. | Scroller | |
![]() | verticalPageCount : int [read-only]
The number of vertical pages, if snapping is enabled. | Scroller | |
![]() | verticalPageIndex : int
The index of the vertical page, if snapping is enabled. | Scroller | |
![]() | verticalScrollBarFactory : Function
Creates the vertical scroll bar. | Scroller | |
![]() | verticalScrollBarProperties : Object
An object that stores properties for the container's vertical scroll
bar, and the properties will be passed down to the vertical scroll
bar when the container validates. | Scroller | |
![]() | verticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the
y-axis) or not. | Scroller | |
![]() | verticalScrollPosition : Number
The number of pixels the container has been scrolled vertically (on
the y-axis). | Scroller | |
![]() | verticalScrollStep : Number
The number of pixels the vertical scroll position can be adjusted
by a "step". | Scroller | |
![]() | viewPort : IViewPort
The display object displayed and scrolled within the Scroller. | Scroller | |
![]() | visible : Boolean The visibility of the object. | DisplayObject | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
Constructor. | SpinnerList | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
![]() | addItemWithEffect(item:Object, index:int, effect:Function):void
Adds an item from the data provider and animates its item renderer
using an effect. | List | |
![]() | alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
![]() | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
![]() | broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
![]() | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
![]() | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
![]() | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
![]() | dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer | |
![]() | drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
![]() | 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 | |
![]() | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
![]() | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
![]() | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
![]() | getItemRendererFactoryWithID(id:String):Function
Returns the item renderer factory associated with a specific ID. | List | |
![]() | getSelectedItems(result:Vector.<Object> = null):Vector.<Object>
Returns the selected items, with the ability to pass in an optional
result vector. | List | |
![]() | getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
![]() | globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
![]() | hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
![]() | hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
![]() | hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
![]() | initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | itemToItemRenderer(item:Object):IListItemRenderer
Returns the current item renderer used to render a specific item. | List | |
![]() | local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | Removes a child from the container. | DisplayObjectContainer | |
![]() | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
![]() | removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
![]() | removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
![]() | removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
![]() | removeItemWithEffect(item:Object, effect:Function):void
Removes an item from the data provider after
animating its item renderer using an effect. | List | |
![]() | [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
![]() | resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
![]() | resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
![]() | revealScrollBars():void
If the scroll bars are floating, briefly show them as a hint to the
user. | Scroller | |
![]() | 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 | |
![]() | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
![]() | 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 | |
![]() | setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
![]() | stopScrolling():void
If the user is scrolling with touch or if the scrolling is animated,
calling stopScrolling() will cause the scroller to ignore the drag
and stop animations. | Scroller | |
![]() | suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
![]() | Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Style | Description | Defined By | ||
---|---|---|---|---|
![]() | Type: 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.See also | Scroller | ||
![]() | Type: starling.display.DisplayObject A background to display when the container is disabled. See also | Scroller | ||
![]() | Type: starling.display.DisplayObject The default background to display. See also | Scroller | ||
![]() | Type: Boolean If true, the viewport will be clipped to the scroller's bounds. | Scroller | ||
![]() | Type: String A style name to add to the container's horizontal scroll bar sub-component. See also | Scroller | ||
![]() | Type: String A style name to add to all item renderers in this list. See also | List | ||
![]() | Type: String A style name to add to the container's vertical scroll bar sub-component. See also | Scroller | ||
![]() | Type: Number This value is used to decelerate the scroller when "thrown". See also | Scroller | ||
![]() | Type: starling.display.DisplayObject A skin to display when dragging one an item to indicate where it can be dropped. | List | ||
![]() | Type: 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. See also | Scroller | ||
![]() | Type: 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. See also | Scroller | ||
![]() | Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.See also | FeathersControl | ||
![]() | Type: Number Quickly sets all focus padding properties to the same value. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Boolean Determines if the scrolling can go beyond the edges of the viewport. See also | Scroller | ||
![]() | Type: Number The duration, in seconds, of the animation when a scroll bar fades out. See also | Scroller | ||
![]() | Type: Object The easing function used for hiding the scroll bars, if applicable. See also | Scroller | ||
hideSelectionOverlayUnlessFocused | Type: Boolean Determines if the selectionOverlaySkin is hidden when
the list is not focused.
list.hideSelectionOverlayUnlessFocused = true;
Note: If the false .See also | SpinnerList | ||
![]() | Type: String Determines where the horizontal scroll bar will be positioned. See also | Scroller | ||
![]() | Type: String Determines how the user may interact with the scroller. See also | Scroller | ||
![]() | Type: Number The duration, in seconds, of the animation when the selected item is changed by keyboard navigation and the item scrolls into view. | List | ||
![]() | Type: feathers.layout.ILayout The layout algorithm used to position and, optionally, size the list's items. | List | ||
![]() | Type: Number The duration, in seconds, of the animation when the mouse wheel initiates a scroll action. | Scroller | ||
![]() | Type: Number Quickly sets all padding properties to the same value. See also | Scroller | ||
![]() | Type: Number The minimum space, in pixels, between the container's bottom edge and the container's content. See also | Scroller | ||
![]() | Type: Number The minimum space, in pixels, between the container's left edge and the container's content. See also | Scroller | ||
![]() | Type: Number The minimum space, in pixels, between the container's right edge and the container's content. See also | Scroller | ||
![]() | Type: Number The minimum space, in pixels, between the container's top edge and the container's content. See also | Scroller | ||
![]() | Type: Number The duration, in seconds, of the animation when the scroller is thrown to a page. | Scroller | ||
![]() | Type: Number The duration, in seconds, that the scroll bars will be shown when calling revealScrollBars() .See also | Scroller | ||
![]() | Type: String Determines how the scroll bars are displayed. See also | Scroller | ||
selectionOverlaySkin | Type: starling.display.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 . | SpinnerList | ||
showSelectionOverlay | Type: 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 | SpinnerList | ||
![]() | Type: Boolean If enabled, the scroll position will always be adjusted to the nearest pixel on the physical screen. | Scroller | ||
![]() | Type: Boolean Determines if scrolling will snap to the nearest page. | Scroller | ||
![]() | Type: Object The easing function used for "throw" animations. See also | Scroller | ||
![]() | Type: 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. See also | Scroller | ||
![]() | Type: Boolean If true , the duration of a "throw" animation will be the same no matter the value of the throw's initial velocity.See also | Scroller | ||
![]() | Type: String Determines where the vertical scroll bar will be positioned. See also | Scroller |
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.
|
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.