| Package | feathers.controls |
| Class | public class PickerList |
| Inheritance | PickerList  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
See also
| Property | Defined By | ||
|---|---|---|---|
 | 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 | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| buttonFactory : Function
A function used to generate the picker list's button sub-component. | PickerList | ||
| buttonProperties : Object
A set of key/value pairs to be passed down to the picker's button
sub-component. | PickerList | ||
| clipRect : Rectangle [override] | FeathersControl | |
| customButtonName : String
A name to add to the picker list's button sub-component. | PickerList | ||
| customListName : String
A name to add to the picker list's list sub-component. | PickerList | ||
| dataProvider : ListCollection
The collection of data displayed by the list. | PickerList | ||
| 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 | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | 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 | |
| labelField : String
The field in the selected item that contains the label text to be
displayed by the picker list's button control. | PickerList | ||
| labelFunction : Function
A function used to generate label text for the selected item
displayed by the picker list's button control. | PickerList | ||
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| listFactory : Function
A function used to generate the picker list's pop-up list
sub-component. | PickerList | ||
| listProperties : Object
A set of key/value pairs to be passed down to the picker's pop-up
list sub-component. | PickerList | ||
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| 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 | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| 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 | |
| popUpContentManager : IPopUpContentManager
A manager that handles the details of how to display the pop-up list. | PickerList | ||
| prompt : String
Text displayed by the button sub-component when no items are
currently selected. | PickerList | ||
| 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 | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| selectedIndex : int
The index of the currently selected item. | PickerList | ||
| selectedItem : Object
The currently selected item. | PickerList | ||
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| typicalItem : Object
Used to auto-size the list. | PickerList | ||
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| 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 | |
| Property | Defined By | ||
|---|---|---|---|
| actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
| actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
| button : Button
The button sub-component. | PickerList | ||
| buttonName : String = feathers-picker-list-button
The default value added to the nameList of the button. | PickerList | ||
| explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
| explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
| list : List
The list sub-component. | PickerList | ||
| listName : String = feathers-picker-list-list
The default value added to the nameList of the pop-up list. | PickerList | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | PickerList | ||
| 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] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign: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(type: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]
| PickerList | ||
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| 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 | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| 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 | |
itemToLabel(item:Object):String
Using labelField and labelFunction,
generates a label from the selected item to be displayed by the
picker list's button control. | PickerList | ||
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| 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] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | 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 | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an object is added to a parent. | DisplayObject | ||
| Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
| Dispatched when the selected item changes. | PickerList | |||
| Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
| Dispatched on all children when the object is flattened. | Sprite | ||
| Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
| Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
| Dispatched when a key on the keyboard is released. | DisplayObject | ||
| Dispatched when an object is removed from its parent. | DisplayObject | ||
| Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
| Dispatched when the width or height of the control changes. | FeathersControl | ||
| Dispatched when an object is touched. | DisplayObject | ||
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_CHILD_NAME_BUTTON : String = feathers-picker-list-button [static]
The default value added to the nameList of the button. | PickerList | ||
| DEFAULT_CHILD_NAME_LIST : String = feathers-picker-list-list [static]
The default value added to the nameList of the pop-up
list. | PickerList | ||
| INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
| INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
| INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
| INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
| INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
| INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
| INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl | |
| button | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var button:ButtonThe button sub-component.
| buttonFactory | property |
buttonFactory:Function
A function used to generate the picker list's button sub-component.
This can be used to change properties on the button when it is first
created. For instance, if you are skinning Feathers components
without a theme, you might use buttonFactory to set
skins and text styles on the button.
The function should have the following signature:
function():Button
public function get buttonFactory():Function public function set buttonFactory(value:Function):voidSee also
| buttonName | property |
protected var buttonName:String = feathers-picker-list-button
The default value added to the nameList of the button.
| buttonProperties | property |
buttonProperties:Object
A set of key/value pairs to be passed down to the picker's button
sub-component. It is a feathers.controls.Button
instance.
If the subcomponent has its own subcomponents, their properties
can be set too, using attribute @ notation. For example,
to set the skin on the thumb of a SimpleScrollBar
which is in a Scroller which is in a List,
you can use the following syntax:
list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
public function get buttonProperties():Object public function set buttonProperties(value:Object):voidSee also
| customButtonName | property |
customButtonName:StringA name to add to the picker list's button sub-component. Typically used by a theme to provide different skins to different picker lists.
public function get customButtonName():String public function set customButtonName(value:String):voidSee also
| customListName | property |
customListName:StringA name to add to the picker list's list sub-component. Typically used by a theme to provide different skins to different picker lists.
public function get customListName():String public function set customListName(value:String):voidSee also
| dataProvider | property |
dataProvider:ListCollectionThe collection of data displayed by the list.
public function get dataProvider():ListCollection public function set dataProvider(value:ListCollection):void| labelField | property |
labelField:String
The field in the selected item that contains the label text to be
displayed by the picker list's button control. If the selected item
does not have this field, and a labelFunction is not
defined, then the picker list will default to calling
toString() on the selected item. To omit the
label completely, define a labelFunction that returns an
empty string.
Important: This value only affects the selected item displayed by the picker list's button control. It will not affect the label text of the pop-up list's item renderers.
public function get labelField():String public function set labelField(value:String):voidSee also
| labelFunction | property |
labelFunction:Function
A function used to generate label text for the selected item
displayed by the picker list's button control. If this
function is not null, then the labelField will be
ignored.
Important: This value only affects the selected item displayed by the picker list's button control. It will not affect the label text of the pop-up list's item renderers.
public function get labelFunction():Function public function set labelFunction(value:Function):voidSee also
| list | property |
protected var list:ListThe list sub-component.
| listFactory | property |
listFactory:Function
A function used to generate the picker list's pop-up list
sub-component. This can be used to change properties on the list when
it is first created. For instance, if you are skinning Feathers
components without a theme, you might use listFactory to
set skins and other styles on the list.
The function should have the following signature:
function():List
public function get listFactory():Function public function set listFactory(value:Function):voidSee also
| listName | property |
protected var listName:String = feathers-picker-list-list
The default value added to the nameList of the pop-up list.
| listProperties | property |
listProperties:Object
A set of key/value pairs to be passed down to the picker's pop-up
list sub-component. The pop-up list is a
feathers.controls.List instance.
If the subcomponent has its own subcomponents, their properties
can be set too, using attribute @ notation. For example,
to set the skin on the thumb of a SimpleScrollBar
which is in a Scroller which is in a List,
you can use the following syntax:
list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
public function get listProperties():Object public function set listProperties(value:Object):voidSee also
| popUpContentManager | property |
popUpContentManager:IPopUpContentManagerA manager that handles the details of how to display the pop-up list.
public function get popUpContentManager():IPopUpContentManager public function set popUpContentManager(value:IPopUpContentManager):void| prompt | property |
prompt:StringText displayed by the button sub-component when no items are currently selected.
public function get prompt():String public function set prompt(value:String):void| selectedIndex | property |
selectedIndex:intThe index of the currently selected item. Returns -1 if no item is selected.
public function get selectedIndex():int public function set selectedIndex(value:int):void| selectedItem | property |
selectedItem:ObjectThe currently selected item. Returns null if no item is selected.
public function get selectedItem():Object public function set selectedItem(value:Object):void| typicalItem | property |
typicalItem:ObjectUsed to auto-size the list. If the list's width or height is NaN, the list will try to automatically pick an ideal size. This item is used in that process to create a sample item renderer.
public function get typicalItem():Object public function set typicalItem(value:Object):void| PickerList | () | Constructor |
public function PickerList()Constructor.
| dispose | () | method |
override public function dispose():void
| itemToLabel | () | method |
public function itemToLabel(item:Object):String
Using labelField and labelFunction,
generates a label from the selected item to be displayed by the
picker list's button control.
Important: This value only affects the selected item displayed by the picker list's button control. It will not affect the label text of the pop-up list's item renderers.
Parameters
item:Object |
String |
| change | Event |
starling.events.Eventstarling.events.Event.CHANGEDispatched when the selected item changes.
An event type to be utilized in custom events. Not used by Starling right now.| DEFAULT_CHILD_NAME_BUTTON | Constant |
public static const DEFAULT_CHILD_NAME_BUTTON:String = feathers-picker-list-button
The default value added to the nameList of the button.
| DEFAULT_CHILD_NAME_LIST | Constant |
public static const DEFAULT_CHILD_NAME_LIST:String = feathers-picker-list-list
The default value added to the nameList of the pop-up
list.