Returns the text baseline measurement, in pixels.

The button sub-component.

For internal use in subclasses.

See also

A function used to generate the picker list's button sub-component. The button must be an instance of Button. This factory 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 this factory to set skins and other styles on the button.

The function should have the following signature:

function():Button

In the following example, a custom button factory is passed to the picker list:

list.buttonFactory = function():Button
{
    var button:Button = new Button();
    button.defaultSkin = new Image( upTexture );
    button.downSkin = new Image( downTexture );
    return button;
};

The default value is null.

See also

An object that stores properties for the picker's button sub-component, and the properties will be passed down to the button when the picker validates. For a list of available properties, refer to feathers.controls.Button.

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

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

Setting properties in a buttonFactory function instead of using buttonProperties will result in better performance.

In the following example, the button properties are passed to the picker list:

list.buttonProperties.defaultSkin = new Image( upTexture );
list.buttonProperties.downSkin = new Image( downTexture );

The default value is null.

See also

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

To customize the button style name without subclassing, see customButtonStyleName.

See also

The collection of data displayed by the list.

The following example passes in a data provider and tells the item renderer how to interpret the data:

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;
};

The default value is null.

See also

The default IStyleProvider for all PickerList components.

The default value is null.

See also

A function called that is expected to return a new item renderer.

The function is expected to have the following signature:

function():IListItemRenderer

The following example provides a factory for the item renderer:

list.itemRendererFactory = function():IListItemRenderer
{
    var renderer:CustomItemRendererClass = new CustomItemRendererClass();
    renderer.backgroundSkin = new Quad( 10, 10, 0xff0000 );
    return renderer;
};

The default value is null.

See also

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.

In the following example, the label field is changed:

list.labelField = "text";

The default value is "label".

See also

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.

The function is expected to have the following signature:

function( item:Object ):String

All of the label fields and functions, ordered by priority:

1. labelFunction
2. labelField

In the following example, the label field is changed:

list.labelFunction = function( item:Object ):String
{
    return item.firstName + " " + item.lastName;
};

The default value is null.

See also

The list sub-component.

For internal use in subclasses.

See also

A function used to generate the picker list's pop-up list sub-component. The list must be an instance of List. This factory 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 this factory to set skins and other styles on the list.

The function should have the following signature:

function():List

In the following example, a custom list factory is passed to the picker list:

list.listFactory = function():List
{
    var popUpList:List = new List();
    popUpList.backgroundSkin = new Image( texture );
    return popUpList;
};

The default value is null.

See also

An object that stores properties for the picker's pop-up list sub-component, and the properties will be passed down to the pop-up list when the picker validates. For a list of available properties, refer to feathers.controls.List.

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

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

Setting properties in a listFactory function instead of using listProperties will result in better performance.

In the following example, the list properties are passed to the picker list:

list.listProperties.backgroundSkin = new Image( texture );

The default value is null.

See also

The default value added to the styleNameList of the pop-up list. This variable is protected so that sub-classes can customize the list style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_LIST.

To customize the pop-up list name without subclassing, see customListStyleName.

See also

Text displayed by the button sub-component when no items are currently selected.

In the following example, a prompt is given to the picker list and the selected item is cleared to display the prompt:

list.prompt = "Select an Item";
list.selectedIndex = -1;

The default value is null.

The index of the currently selected item. Returns -1 if no item is selected.

The following example selects an item by its index:

list.selectedIndex = 2;

The following example clears the selected index:

list.selectedIndex = -1;

The following example listens for when selection changes and requests the selected index:

function list_changeHandler( event:Event ):void
{
    var list:PickerList = PickerList( event.currentTarget );
    var index:int = list.selectedIndex;
}
list.addEventListener( Event.CHANGE, list_changeHandler );

The default value is -1.

See also

The currently selected item. Returns null if no item is selected.

The following example changes the selected item:

list.selectedItem = list.dataProvider.getItemAt(0);

The following example clears the selected item:

list.selectedItem = null;

The following example listens for when selection changes and requests the selected item:

function list_changeHandler( event:Event ):void
{
    var list:PickerList = PickerList( event.currentTarget );
    var item:Object = list.selectedItem;
}
list.addEventListener( Event.CHANGE, list_changeHandler );

The default value is null.

See also

Used 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.

The following example provides a typical item:

list.typicalItem = { text: "A typical item", thumbnail: texture };

The default value is null.

Constructor.

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

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

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

Closes the pop-up list, if it is open.

Creates and adds the button sub-component and removes the old instance, if one exists.

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

See also

Creates and adds the list sub-component and removes the old instance, if one exists.

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

See also

Disposes the display object.

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

Opens the pop-up list, if it isn't already open.

Dispatched when the selected item changes.

The properties of the event object have the following values:

See also

Dispatched when the pop-up list is closed.

The properties of the event object have the following values:

Dispatched when the pop-up list is opened.

The properties of the event object have the following values:

Determines if the isSelected property of the picker list's button sub-component is toggled when the list is opened and closed, if the class used to create the thumb implements the IToggle interface. Useful for skinning to provide a different appearance for the button based on whether the list is open or not.

In the following example, the button is toggled on open and close:

list.toggleButtonOnOpenAndClose = true;

The default value is false.

See also

A manager that handles the details of how to display the pop-up list.

In the following example, a pop-up content manager is provided:

list.popUpContentManager = new CalloutPopUpContentManager();

The default value is null.

A style name to add to the picker list's list sub-component. Typically used by a theme to provide different styles to different picker lists.

In the following example, a custom list style name is passed to the picker list:

list.customListStyleName = "my-custom-list";

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

getStyleProviderForClass( List ).setFunctionForStyleName( "my-custom-list", setCustomListStyles );

The default value is null.

See also

A style name to add to all item renderers in the pop-up list. Typically used by a theme to provide different skins to different lists.

The following example sets the item renderer name:

list.customItemRendererStyleName = "my-custom-item-renderer";

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

getStyleProviderForClass( DefaultListItemRenderer ).setFunctionForStyleName( "my-custom-item-renderer", setCustomItemRendererStyles );

The default value is null.

See also

A style name to add to the picker list's button sub-component. Typically used by a theme to provide different styles to different picker lists.

In the following example, a custom button style name is passed to the picker list:

list.customButtonStyleName = "my-custom-button";

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

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-button", setCustomButtonStyles );

The default value is null.

See also

The default value added to the styleNameList of the button.

See also

The default value added to the styleNameList of the pop-up list.

See also