The field in the item that contains a display object to be positioned in the accessory position of the renderer. If you wish to display an Image in the accessory position, it's better for performance to use accessorySourceField instead.

Warning: It is your responsibility to dispose all accessories included in the data provider and accessed with accessoryField, or any display objects returned by accessoryFunction. These display objects will not be disposed when the list is disposed. Not disposing an accessory may result in a memory leak.

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

1. accessorySourceFunction
2. accessorySourceField
3. accessoryLabelFunction
4. accessoryLabelField
5. accessoryFunction
6. accessoryField

In the following example, the accessory field is customized:

renderer.accessoryField = "component";

The default value is "accessory".

See also

A function that returns a display object to be positioned in the accessory position of the renderer. If you wish to display an Image in the accessory position, it's better for performance to use accessorySourceFunction instead.

Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new accessory every time. This will result in the unnecessary creation and destruction of many icons, which will overwork the garbage collector and hurt performance. It's better to return a new accessory the first time this function is called for a particular item and then return the same accessory if that item is passed to this function again.

Warning: It is your responsibility to dispose all accessories included in the data provider and accessed with accessoryField, or any display objects returned by accessoryFunction. These display objects will not be disposed when the list is disposed. Not disposing an accessory may result in a memory leak.

The function is expected to have the following signature:

function( item:Object ):DisplayObject

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):DisplayObject

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):DisplayObject

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

1. accessorySourceFunction
2. accessorySourceField
3. accessoryLabelFunction
4. accessoryLabelField
5. accessoryFunction
6. accessoryField

In the following example, the accessory function is customized:

renderer.accessoryFunction = function( item:Object ):DisplayObject
{
   if(item in cachedAccessories)
   {
       return cachedAccessories[item];
   }
   var accessory:DisplayObject = createAccessoryForItem( item );
   cachedAccessories[item] = accessory;
   return accessory;
};

The default value is null.

See also

A function that generates ITextRenderer that uses the result of accessoryLabelField or accessoryLabelFunction. CAn be used to set properties on the ITextRenderer.

The function is expected to have the following signature:

function():ITextRenderer

In the following example, the accessory label factory is customized:

renderer.accessoryLabelFactory = function():ITextRenderer
{
   var renderer:TextFieldTextRenderer = new TextFieldTextRenderer();
   renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
   renderer.embedFonts = true;
   return renderer;
};

The default value is null.

See also

The field in the item that contains a string to be displayed in a renderer-managed ITextRenderer in the accessory position of the renderer. The renderer will automatically reuse an internal ITextRenderer and swap the text when the data changes. This ITextRenderer may be skinned by changing the accessoryLabelFactory.

Using an accessory label will result in better performance than passing in a ITextRenderer through an accessoryField or accessoryFunction because the renderer can avoid costly display list manipulation.

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

1. accessorySourceFunction
2. accessorySourceField
3. accessoryLabelFunction
4. accessoryLabelField
5. accessoryFunction
6. accessoryField

In the following example, the accessory label field is customized:

renderer.accessoryLabelField = "text";

The default value is "accessoryLabel".

See also

A function that returns a string to be displayed in a renderer-managed ITextRenderer in the accessory position of the renderer. The renderer will automatically reuse an internal ITextRenderer and swap the text when the data changes. This ITextRenderer may be skinned by changing the accessoryLabelFactory.

Using an accessory label will result in better performance than passing in an ITextRenderer through an accessoryField or accessoryFunction because the renderer can avoid costly display list manipulation.

The function is expected to have the following signature:

function( item:Object ):String

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):String

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):String

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

1. accessorySourceFunction
2. accessorySourceField
3. accessoryLabelFunction
4. accessoryLabelField
5. accessoryFunction
6. accessoryField

In the following example, the accessory label function is customized:

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

The default value is null.

See also

An object that stores properties for the accessory label text renderer sub-component (if using accessoryLabelField or accessoryLabelFunction), and the properties will be passed down to the text renderer when this component validates. The available properties depend on which ITextRenderer implementation is returned by accessoryLabelFactory. Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

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 accessoryLabelFactory function instead of using accessoryLabelProperties will result in better performance.

In the following example, the accessory label properties are customized:

renderer.@accessoryLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
renderer.@accessoryLabelProperties.embedFonts = true;

The default value is null.

See also

The value added to the styleNameList of the accessory label text renderer, if it exists. This variable is protected so that sub-classes can customize the accessory label text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL.

To customize the accessory label text renderer style name without subclassing, see customAccessoryLabelStyleName.

See also

A function that generates an ImageLoader that uses the result of accessorySourceField or accessorySourceFunction. Useful for transforming the ImageLoader in some way. For example, you might want to scale the texture for current screen density or apply pixel snapping.

The function is expected to have the following signature:

function():ImageLoader

In the following example, the loader factory is customized:

renderer.accessoryLoaderFactory = function():ImageLoader
{
   var loader:ImageLoader = new ImageLoader();
   loader.scaleFactor = 2;
   return loader;
};

The default value is function():ImageLoader { return new ImageLoader(); }.

See also

The value added to the styleNameList of the accessory loader, if it exists. This variable is protected so that sub-classes can customize the accessory loader style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LOADER.

To customize the accessory loader style name without subclassing, see customAccessoryLoaderStyleName.

See also

A field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the accessoryLoaderFactory.

Using an accessory source will result in better performance than passing in an ImageLoader or Image through a accessoryField or accessoryFunction because the renderer can avoid costly display list manipulation.

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

1. accessorySourceFunction
2. accessorySourceField
3. accessoryLabelFunction
4. accessoryLabelField
5. accessoryFunction
6. accessoryField

In the following example, the accessory source field is customized:

renderer.accessorySourceField = "texture";

The default value is "accessorySource".

See also

A function that generates a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the accessoryLoaderFactory.

Using an accessory source will result in better performance than passing in an ImageLoader or Image through a accessoryField or accessoryFunction because the renderer can avoid costly display list manipulation.

Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new texture every time. This will result in the unnecessary creation and destruction of many textures, which will overwork the garbage collector and hurt performance. Creating a new texture at all is dangerous, unless you are absolutely sure to dispose it when necessary because neither the list nor its item renderer will dispose of the texture for you. If you are absolutely sure that you are managing the texture memory with proper disposal, it's better to return a new texture the first time this function is called for a particular item and then return the same texture if that item is passed to this function again.

The function is expected to have the following signature:

function( item:Object ):Object

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):Object

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):Object

The return value is a valid value for the source property of an ImageLoader component.

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

1. accessorySourceFunction
2. accessorySourceField
3. accessoryLabelFunction
4. accessoryLabelField
5. accessoryFunction
6. accessoryField

In the following example, the accessory source function is customized:

renderer.accessorySourceFunction = function( item:Object ):Object
{
   return "http://www.example.com/thumbs/" + item.name + "-thumb.png";
};

The default value is null.

See also

The item displayed by this renderer. This property is set by the list, and should not be set manually.

The accessory used when no other accessory is defined for the current state. Intended to be used when multiple states should share the same accessory.

This property will be ignored if a function is passed to the stateToAccessoryFunction property. This property may be ignored if the itemHasAccessory property is true.

The following example gives the item renderer a default accessory to use for all states when no specific accessory is available:

itemRenderer.defaultAccessory = new Image( texture );

The default value is null.

See also

If enabled, automatically manages the delayTextureCreation property on accessory and icon ImageLoader instances when the owner scrolls. This applies to the loaders created when the following properties are set: accessorySourceField, accessorySourceFunction, iconSourceField, and iconSourceFunction.

In the following example, any loaded textures won't be uploaded to the GPU until the owner stops scrolling:

renderer.delayTextureCreationOnScroll = true;

The default value is false.

The field in the item that determines if the item renderer is enabled, if the list is enabled. If the item does not have this field, and a enabledFunction is not defined, then the renderer will default to being enabled.

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

1. enabledFunction
2. enabledField

In the following example, the enabled field is customized:

renderer.itemHasEnabled = true;
renderer.enabledField = "isEnabled";

The default value is "enabled".

See also

A function used to determine if a specific item is enabled. If this function is not null, then the enabledField will be ignored.

The function is expected to have the following signature:

function( item:Object ):Boolean

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):Boolean

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):Boolean

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

1. enabledFunction
2. enabledField

In the following example, the enabled function is customized:

renderer.itemHasEnabled = true;
renderer.enabledFunction = function( item:Object ):Boolean
{
   return item.isEnabled;
};

The default value is null.

See also

The ID of the factory used to create this item renderer.

This property is set by the list, and should not be set manually.

The field in the item that contains a display object to be displayed as an icon or other graphic next to the label in the renderer.

Warning: It is your responsibility to dispose all icons included in the data provider and accessed with iconField, or any display objects returned by iconFunction. These display objects will not be disposed when the list is disposed. Not disposing an icon may result in a memory leak.

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

1. iconSourceFunction
2. iconSourceField
3. iconLabelFunction
4. iconLabelField
5. iconFunction
6. iconField

In the following example, the icon field is customized:

renderer.iconField = "photo";

The default value is "icon".

See also

A function used to generate an icon for a specific item.

Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new icon every time. This will result in the unnecessary creation and destruction of many icons, which will overwork the garbage collector and hurt performance. It's better to return a new icon the first time this function is called for a particular item and then return the same icon if that item is passed to this function again.

Warning: It is your responsibility to dispose all icons included in the data provider and accessed with iconField, or any display objects returned by iconFunction. These display objects will not be disposed when the list is disposed. Not disposing an icon may result in a memory leak.

The function is expected to have the following signature:

function( item:Object ):DisplayObject

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):DisplayObject

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):DisplayObject

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

1. iconSourceFunction
2. iconSourceField
3. iconLabelFunction
4. iconLabelField
5. iconFunction
6. iconField

In the following example, the icon function is customized:

renderer.iconFunction = function( item:Object ):DisplayObject
{
   if(item in cachedIcons)
   {
       return cachedIcons[item];
   }
   var icon:Image = new Image( textureAtlas.getTexture( item.textureName ) );
   cachedIcons[item] = icon;
   return icon;
};

The default value is null.

See also

A function that generates ITextRenderer that uses the result of iconLabelField or iconLabelFunction. CAn be used to set properties on the ITextRenderer.

The function is expected to have the following signature:

function():ITextRenderer

In the following example, the icon label factory is customized:

renderer.iconLabelFactory = function():ITextRenderer
{
   var renderer:TextFieldTextRenderer = new TextFieldTextRenderer();
   renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
   renderer.embedFonts = true;
   return renderer;
};

The default value is null.

See also

The field in the item that contains a string to be displayed in a renderer-managed ITextRenderer in the icon position of the renderer. The renderer will automatically reuse an internal ITextRenderer and swap the text when the data changes. This ITextRenderer may be skinned by changing the iconLabelFactory.

Using an icon label will result in better performance than passing in an ITextRenderer through a iconField or iconFunction because the renderer can avoid costly display list manipulation.

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

1. iconSourceFunction
2. iconSourceField
3. iconLabelFunction
4. iconLabelField
5. iconFunction
6. iconField

In the following example, the icon label field is customized:

renderer.iconLabelField = "text";

The default value is "iconLabel".

See also

A function that returns a string to be displayed in a renderer-managed ITextRenderer in the icon position of the renderer. The renderer will automatically reuse an internal ITextRenderer and swap the text when the data changes. This ITextRenderer may be skinned by changing the iconLabelFactory.

Using an icon label will result in better performance than passing in an ITextRenderer through a iconField or iconFunction because the renderer can avoid costly display list manipulation.

The function is expected to have the following signature:

function( item:Object ):String

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):String

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):String

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

1. iconSourceFunction
2. iconSourceField
3. iconLabelFunction
4. iconLabelField
5. iconFunction
6. iconField

In the following example, the icon label function is customized:

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

The default value is null.

See also

An object that stores properties for the icon label text renderer sub-component (if using iconLabelField or iconLabelFunction), and the properties will be passed down to the text renderer when this component validates. The available properties depend on which ITextRenderer implementation is returned by iconLabelFactory. Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

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 iconLabelFactory function instead of using iconLabelProperties will result in better performance.

In the following example, the icon label properties are customized:

renderer.@iconLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
renderer.@iconLabelProperties.embedFonts = true;

The default value is null.

See also

The value added to the styleNameList of the icon label text renderer, if it exists. This variable is protected so that sub-classes can customize the icon label text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ICON_LABEL.

To customize the icon label text renderer style name without subclassing, see customIconLabelStyleName.

See also

A function that generates an ImageLoader that uses the result of iconSourceField or iconSourceFunction. Useful for transforming the ImageLoader in some way. For example, you might want to scale the texture for current screen density or apply pixel snapping.

The function is expected to have the following signature:

function():ImageLoader

In the following example, the loader factory is customized:

renderer.iconLoaderFactory = function():ImageLoader
{
   var loader:ImageLoader = new ImageLoader();
   loader.scaleFactor = 2;
   return loader;
};

The default value is function():ImageLoader { return new ImageLoader(); }.

See also

The value added to the styleNameList of the icon loader, if it exists. This variable is protected so that sub-classes can customize the icon loader style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ICON_LOADER.

To customize the icon loader style name without subclassing, see customIconLoaderStyleName.

See also

The field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the iconLoaderFactory.

Using an icon source will result in better performance than passing in an ImageLoader or Image through a iconField or iconFunction because the renderer can avoid costly display list manipulation.

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

1. iconSourceFunction
2. iconSourceField
3. iconLabelFunction
4. iconLabelField
5. iconFunction
6. iconField

In the following example, the icon source field is customized:

renderer.iconSourceField = "texture";

The default value is "iconSource".

See also

A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the iconLoaderFactory.

Using an icon source will result in better performance than passing in an ImageLoader or Image through a iconField or iconFunction because the renderer can avoid costly display list manipulation.

Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new texture every time. This will result in the unnecessary creation and destruction of many textures, which will overwork the garbage collector and hurt performance. Creating a new texture at all is dangerous, unless you are absolutely sure to dispose it when necessary because neither the list nor its item renderer will dispose of the texture for you. If you are absolutely sure that you are managing the texture memory with proper disposal, it's better to return a new texture the first time this function is called for a particular item and then return the same texture if that item is passed to this function again.

The function is expected to have the following signature:

function( item:Object ):Object

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):Object

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):Object

The return value is a valid value for the source property of an ImageLoader component.

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

1. iconSourceFunction
2. iconSourceField
3. iconLabelFunction
4. iconLabelField
5. iconFunction
6. iconField

In the following example, the icon source function is customized:

renderer.iconSourceFunction = function( item:Object ):Object
{
   return "http://www.example.com/thumbs/" + item.name + "-thumb.png";
};

The default value is null.

See also

Determines if this component's children can receive focus. This property is completely independent from the isFocusEnabled property. In other words, it's possible to disable focus on this component while still allowing focus on its children (or the other way around).

In the following example, the focus is disabled:

object.isFocusEnabled = false;

The default value is true.

See also

If enabled, the item renderer may be selected by touching the accessory. By default, the accessory will not trigger selection when using defaultAccessory, accessoryField, or accessoryFunction and the accessory is a Feathers component.

In the following example, the item renderer can be selected when the accessory is touched:

renderer.isSelectableOnAccessoryTouch = true;

The default value is false.

Determines if the item renderer can be selected even if isToggle is set to false. Subclasses are expected to change this value, if required.

If true, the accessory will come from the renderer's item using the appropriate field or function for the accessory. If false, the accessory may be set using other means.

In the following example, the item doesn't have an accessory:

renderer.itemHasAccessory = false;

The default value is true.

If true, the renderer's enabled state will come from the renderer's item using the appropriate field or function for enabled. If false, the renderer will be enabled if its owner is enabled.

In the following example, the item doesn't have an accessory:

renderer.itemHasEnabled = true;

The default value is false.

See also

If true, the icon will come from the renderer's item using the appropriate field or function for the icon. If false, the icon may be skinned for each state externally.

In the following example, the item doesn't have an icon:

renderer.itemHasIcon = false;

The default value is true.

If true, the label will come from the renderer's item using the appropriate field or function for the label. If false, the label may be set externally.

In the following example, the item doesn't have a label:

renderer.itemHasLabel = false;

The default value is true.

See also

If true, the ability to select the renderer will come from the renderer's item using the appropriate field or function for selectable. If false, the renderer will be selectable if its owner is selectable.

In the following example, the item doesn't have an accessory:

renderer.itemHasSelectable = true;

The default value is false.

See also

If true, the skin will come from the renderer's item using the appropriate field or function for the skin. If false, the skin may be set for each state externally.

In the following example, the item has a skin:

renderer.itemHasSkin = true;
renderer.skinField = "background";

The default value is false.

The field in the item that contains the label text to be displayed by the renderer. If the item does not have this field, and a labelFunction is not defined, then the renderer will default to calling toString() on the item. To omit the label completely, either provide a custom item renderer without a label or define a labelFunction that returns an empty string.

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

1. labelFunction
2. labelField

In the following example, the label field is customized:

renderer.labelField = "text";

The default value is "label".

See also

A function used to generate label text for a specific item. If this function is not null, then the labelField will be ignored.

The function is expected to have the following signature:

function( item:Object ):String

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):String

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):String

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

1. labelFunction
2. labelField

In the following example, the label function is customized:

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

The default value is null.

See also

The field in the item that determines if the item renderer can be selected, if the list allows selection. If the item does not have this field, and a selectableFunction is not defined, then the renderer will default to being selectable.

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

1. selectableFunction
2. selectableField

In the following example, the selectable field is customized:

renderer.itemHasSelectable = true;
renderer.selectableField = "isSelectable";

The default value is "selectable".

See also

A function used to determine if a specific item is selectable. If this function is not null, then the selectableField will be ignored.

The function is expected to have the following signature:

function( item:Object ):Boolean

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):Boolean

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):Boolean

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

1. selectableFunction
2. selectableField

In the following example, the selectable function is customized:

renderer.itemHasSelectable = true;
renderer.selectableFunction = function( item:Object ):Boolean
{
   return item.isSelectable;
};

The default value is null.

See also

The field in the item that contains a display object to be displayed as a background skin.

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

1. skinSourceFunction
2. skinSourceField
3. skinFunction
4. skinField

In the following example, the skin field is customized:

renderer.itemHasSkin = true;
renderer.skinField = "background";

The default value is "skin".

See also

A function used to generate a background skin for a specific item.

Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new display object every time. This will result in the unnecessary creation and destruction of many skins, which will overwork the garbage collector and hurt performance. It's better to return a new skin the first time this function is called for a particular item and then return the same skin if that item is passed to this function again.

The function is expected to have the following signature:

function( item:Object ):DisplayObject

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):DisplayObject

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):DisplayObject

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

1. skinSourceFunction
2. skinSourceField
3. skinFunction
4. skinField

In the following example, the skin function is customized:

renderer.itemHasSkin = true;
renderer.skinFunction = function( item:Object ):DisplayObject
{
   if(item in cachedSkin)
   {
       return cachedSkin[item];
   }
   var skin:Image = new Image( textureAtlas.getTexture( item.textureName ) );
   cachedSkin[item] = skin;
   return skin;
};

The default value is null.

See also

A function that generates an ImageLoader that uses the result of skinSourceField or skinSourceFunction. Useful for transforming the ImageLoader in some way. For example, you might want to scale the texture for current screen density or apply pixel snapping.

The function is expected to have the following signature:

function():ImageLoader

In the following example, the loader factory is customized:

renderer.skinLoaderFactory = function():ImageLoader
{
   var loader:ImageLoader = new ImageLoader();
   loader.scaleFactor = 2;
   return loader;
};

The default value is function():ImageLoader { return new ImageLoader(); }.

See also

The field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's skin. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the skinLoaderFactory.

Using a skin source will result in better performance than passing in an ImageLoader or Image through a skinField or skinFunction because the renderer can avoid costly display list manipulation.

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

1. skinSourceFunction
2. skinSourceField
3. skinFunction
4. skinField

In the following example, the skin source field is customized:

renderer.itemHasSkin = true;
renderer.skinSourceField = "texture";

The default value is "skinSource".

See also

A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's skin. The renderer will automatically manage and reuse an internal ImageLoader sub-component and this value will be passed to the source property. The ImageLoader may be customized by changing the skinLoaderFactory.

Using a skin source will result in better performance than passing in an ImageLoader or Image through a skinField or skinnFunction because the renderer can avoid costly display list manipulation.

Note: As the list scrolls, this function will almost always be called more than once for each individual item in the list's data provider. Your function should not simply return a new texture every time. This will result in the unnecessary creation and destruction of many textures, which will overwork the garbage collector and hurt performance. Creating a new texture at all is dangerous, unless you are absolutely sure to dispose it when necessary because neither the list nor its item renderer will dispose of the texture for you. If you are absolutely sure that you are managing the texture memory with proper disposal, it's better to return a new texture the first time this function is called for a particular item and then return the same texture if that item is passed to this function again.

The function is expected to have the following signature:

function( item:Object ):Object

If the item renderer is an IListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, index:int ):Object

If the item renderer is an IGroupedListItemRenderer, the function may optionally have the following signature instead:

function( item:Object, groupIndex:int, itemIndex:int ):Object

The return value is a valid value for the source property of an ImageLoader component.

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

1. skinSourceFunction
2. skinSourceField
3. skinFunction
4. skinField

In the following example, the skin source function is customized:

renderer.itemHasSkin = true;
renderer.skinSourceFunction = function( item:Object ):Object
{
   return "http://www.example.com/images/" + item.name + "-skin.png";
};

The default value is null.

See also

If enabled, calls owner.stopScrolling() when TouchEvents are dispatched by the accessory.

In the following example, the list won't stop scrolling when the accessory is touched:

renderer.stopScrollingOnAccessoryTouch = false;

The default value is true.

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.

Updates the renderer to display the item's data. Override this function to pass data to sub-components and react to data changes.

Don't forget to handle the case where the data is null.

Gets the accessory to be used by the item renderer when the item renderer's currentState property matches the specified state value.

If a accessory is not defined for a specific state, returns null.

Parameters

See also

Gets the font styles to be used to display the item renderer's accessory label text when the item renderer's currentState property matches the specified state value.

If icon label font styles are not defined for a specific state, returns null.

Parameters

See also

Gets the font styles to be used to display the item renderer's icon label text when the item renderer's currentState property matches the specified state value.

If icon label font styles are not defined for a specific state, returns null.

Parameters

See also

Uses the accessory fields and functions to generate an accessory for a specific item.

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

1. accessorySourceFunction
2. accessorySourceField
3. accessoryLabelFunction
4. accessoryLabelField
5. accessoryFunction
6. accessoryField

Parameters

Uses the enabled fields and functions to generate a enabled value for a specific item.

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

1. enabledFunction
2. enabledField

Parameters

Uses the icon fields and functions to generate an icon for a specific item.

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

1. iconSourceFunction
2. iconSourceField
3. iconLabelFunction
4. iconLabelField
5. iconFunction
6. iconField

Parameters

Using labelField and labelFunction, generates a label from the item.

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

1. labelFunction
2. labelField

Parameters

Uses the selectable fields and functions to generate a selectable value for a specific item.

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

1. selectableFunction
2. selectableField

Parameters

Uses the skin fields and functions to generate a skin for a specific item.

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

1. skinSourceFunction
2. skinSourceField
3. skinFunction
4. skinField

Parameters

Sets the accessory to be used by the item renderer when the item renderer's currentState property matches the specified state value.

If an accessory is not defined for a specific state, the value of the defaultAccessory property will be used instead.

Parameters

See also

Sets the font styles to be used to display the accessory label's text when the item renderer's currentState property matches the specified state value.

If font styles are not defined for a specific state, the value of the accessoryLabelFontStyles property will be used instead.

Note: if the text renderer has been customized with advanced font formatting, it may override the values specified with setAccessoryLabelFontStylesForState() and properties like accessoryLabelFontStyles and disabledAccessoryLabelFontStyles.

Parameters

See also

Sets the font styles to be used to display the icon label's text when the item renderer's currentState property matches the specified state value.

If font styles are not defined for a specific state, the value of the iconLabelFontStyles property will be used instead.

Note: if the text renderer has been customized with advanced font formatting, it may override the values specified with setIconLabelFontStylesForState() and properties like iconLabelFontStyles and disabledIconLabelFontStyles.

Parameters

See also

If true, the down state (and subsequent state changes) will be delayed to improve the user experience when scrolling on a touch screen. Without the delay, the down state will appear immediately and then disappear once touch-based scrolling begins. This might be described as flickering, which is typically undesirable.

In the following example, the state delay timer is disabled:

renderer.useStateDelayTimer = false;

The default value is true.

The font styles used to display the item renderer's accessory label text when the item renderer is selected.

In the following example, the accessory label selected font styles are customized:

itemRenderer.accessoryLabelSelectedFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the accessoryLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The font styles used to display the item renderer's accessory label text when the item renderer is disabled.

In the following example, the accessory label disabled font styles are customized:

itemRenderer.accessoryLabelDisabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the accessoryLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The font styles used to display the item renderer's accessory label text.

In the following example, the accessory label font styles are customized:

itemRenderer.accessoryLabelFontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the accessoryLabelFactory to set more advanced styles.

The default value is null.

See also

The font styles used to display the item renderer's icon label text when the item renderer is selected.

In the following example, the icon label selected font styles are customized:

itemRenderer.iconLabelSelectedFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the iconLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The font styles used to display the item renderer's icon label text when the item renderer is disabled.

In the following example, the icon label disabled font styles are customized:

itemRenderer.iconLabelDisabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the iconLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The font styles used to display the item renderer's icon label text.

In the following example, the icon label font styles are customized:

itemRenderer.iconLabelFontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the iconLabelFactory to set more advanced styles.

The default value is null.

See also

If the value of the accessoryGap property is Number.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible, the final calculated value will not be smaller than the value of the minAccessoryGap property. If the value of minAccessoryGap is NaN, the value of the minGap property will be used instead.

The following example ensures that the gap is never smaller than 20 pixels:

button.gap = Number.POSITIVE_INFINITY;
button.minGap = 20;

renderer.accessoryGap = 20;

The default value is NaN.

See also

The accessory's position will be based on which other child (the label or the icon) the accessory should be relative to.

The accessoryPositionOrigin property will be ignored if accessoryPosition is set to RelativePosition.MANUAL.

In the following example, the layout order is changed:

renderer.layoutOrder = ItemRendererLayoutOrder.LABEL_ACCESSORY_ICON;

The default value is feathers.controls.ItemRendererLayoutOrder.LABEL_ICON_ACCESSORY.

See also

A style name to add to the item renderer's icon label text renderer sub-component. Typically used by a theme to provide different styles to different item renderers.

In the following example, a custom icon label style name is passed to the item renderer:

itemRenderer.customIconLabelStyleName = "my-custom-icon-label";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-icon-label", setCustomIconLabelStyles );

The default value is null.

See also

A style name to add to the item renderer's icon loader sub-component. Typically used by a theme to provide different styles to different item renderers.

In the following example, a custom icon loader style name is passed to the item renderer:

itemRenderer.customIconLodaerStyleName = "my-custom-icon-loader";

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

getStyleProviderForClass( ImageLoader ).setFunctionForStyleName( "my-custom-icon-loader", setCustomIconLoaderStyles );

The default value is null.

See also

A style name to add to the item renderer's accessory label text renderer sub-component. Typically used by a theme to provide different styles to different item renderers.

In the following example, a custom accessory label style name is passed to the item renderer:

itemRenderer.customAccessoryLabelStyleName = "my-custom-accessory-label";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-accessory-label", setCustomAccessoryLabelStyles );

The default value is null.

See also

A style name to add to the item renderer's accessory loader sub-component. Typically used by a theme to provide different styles to different item renderers.

In the following example, a custom accessory loader style name is passed to the item renderer:

itemRenderer.customAccessoryLoaderStyleName = "my-custom-accessory-loader";

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

getStyleProviderForClass( ImageLoader ).setFunctionForStyleName( "my-custom-accessory-loader", setCustomAccessoryLoaderStyles );

The default value is null.

See also

The space, in pixels, between the accessory and the other child it is positioned relative to. Applies to either horizontal or vertical spacing, depending on the value of accessoryPosition. If the value is NaN, the value of the gap property will be used instead.

If accessoryGap is set to Number.POSITIVE_INFINITY, the accessory and the component it is relative to will be positioned as far apart as possible.

In the following example, the accessory gap is set to 20 pixels:

renderer.accessoryGap = 20;

The default value is NaN.

See also

Offsets the y position of the accessory by a certain number of pixels.

In the following example, the accessory y position is adjusted by 20 pixels:

renderer.accessoryOffsetY = 20;

The default value is 0.

See also

Offsets the x position of the accessory by a certain number of pixels.

In the following example, the accessory x position is adjusted by 20 pixels:

renderer.accessoryOffsetX = 20;

The default value is 0.

See also

The location of the accessory, relative to one of the other children. Use RelativePosition.MANUAL to position the accessory from the top-left corner.

In the following example, the accessory is placed on the bottom:

renderer.accessoryPosition = RelativePosition.BOTTOM;

The default value is feathers.layout.RelativePosition.RIGHT.

See also

An alternate style name to use with the default item renderer to allow a theme to give it a "check" style. If a theme does not provide a style for a check item renderer, the theme will automatically fall back to using the default item renderer style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the check item renderer style is applied to a list's item renderers:

list.itemRendererFactory = function():IListItemRenderer
{
    var itemRenderer:DefaultListItemRenderer = new DefaultListItemRenderer();
    itemRenderer.styleNameList.add( DefaultListItemRenderer.ALTERNATE_STYLE_NAME_CHECK );
    return itemRenderer;
};

See also

An alternate style name to use with the default item renderer to allow a theme to give it a "drill-down" style. If a theme does not provide a style for a drill-down item renderer, the theme will automatically fall back to using the default item renderer style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the drill-down style is applied to a list's item renderers:

list.itemRendererFactory = function():IListItemRenderer
{
    var itemRenderer:DefaultListItemRenderer = new DefaultListItemRenderer();
    itemRenderer.styleNameList.add( DefaultListItemRenderer.ALTERNATE_STYLE_NAME_DRILL_DOWN );
    return itemRenderer;
};

See also

The default value added to the styleNameList of the accessory label, if it exists.

See also

The default value added to the styleNameList of the accessory loader, if it exists.

See also

The default value added to the styleNameList of the icon label, if it exists.

See also

The default value added to the styleNameList of the icon loader, if it exists.

See also

The default value added to the styleNameList of the primary label.

See also