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

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

1. contentSourceFunction
2. contentSourceField
3. contentLabelFunction
4. contentLabelField
5. contentFunction
6. contentField

In the following example, the content field is customized:

renderer.contentField = "header";

The default value is "content".

See also

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

The function is expected to have the following signature:

function( item:Object ):DisplayObject

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

1. contentSourceFunction
2. contentSourceField
3. contentLabelFunction
4. contentLabelField
5. contentFunction
6. contentField

In the following example, the content function is customized:

renderer.contentFunction = function( item:Object ):DisplayObject
{
   if(item in cachedContent)
   {
       return cachedContent[item];
   }
   var content:DisplayObject = createContentForHeader( item );
   cachedContent[item] = content;
   return content;
};

The default value is null.

See also

A function that generates an ITextRenderer that uses the result of contentLabelField or contentLabelFunction. Can be used to set properties on the ITextRenderer.

In the following example, a custom content label factory is passed to the renderer:

renderer.contentLabelFactory = 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 Label in the content position of the renderer. The renderer will automatically reuse an internal Label and swap the text when the data changes. This Label may be skinned by changing the contentLabelFactory.

Using an content label will result in better performance than passing in a Label through a contentField or contentFunction because the renderer can avoid costly display list manipulation.

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

1. contentTextureFunction
2. contentTextureField
3. contentLabelFunction
4. contentLabelField
5. contentFunction
6. contentField

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

renderer.contentLabelField = "text";

The default value is "label".

See also

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

Using an content label will result in better performance than passing in a Label through a contentField or contentFunction because the renderer can avoid costly display list manipulation.

The function is expected to have the following signature:

function( item:Object ):String

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

1. contentTextureFunction
2. contentTextureField
3. contentLabelFunction
4. contentLabelField
5. contentFunction
6. contentField

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

renderer.contentLabelFunction = function( item:Object ):String
{
   return item.category + " > " + item.subCategory;
};

The default value is null.

See also

An object that stores properties for the content label text renderer sub-component, 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 contentLabelFactory. 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);

In the following example, a custom content label properties are customized:

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

The default value is null.

See also

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

To customize the content label text renderer style name without subclassing, see customContentLabelStyleName.

See also

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

In the following example, a custom content loader factory is passed to the renderer:

renderer.contentLoaderFactory = 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 data that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the renderer's content. 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 contentLoaderFactory.

Using an content source will result in better performance than passing in an ImageLoader or Image through contentField or contentFunction because the renderer can avoid costly display list manipulation.

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

1. contentSourceFunction
2. contentSourceField
3. contentLabelFunction
4. contentLabelField
5. contentFunction
6. contentField

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

renderer.contentSourceField = "texture";

The default value is "source".

See also

A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the renderer's content. 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 contentLoaderFactory.

Using an content source will result in better performance than passing in an ImageLoader or Image through contentField or contentFunction because the renderer can avoid costly display list manipulation.

The function is expected to have the following signature:

function( item:Object ):Object

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

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

1. contentSourceFunction
2. contentSourceField
3. contentLabelFunction
4. contentLabelField
5. contentFunction
6. contentField

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

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

The default value is null.

See also

Data for a footer renderer from the grouped list's data provider. A footer renderer should be designed with the assumption that its data will change as the list scrolls.

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

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

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

The default IStyleProvider for all DefaultGroupedListHeaderOrFooterRenderer components.

The default value is null.

See also

The index of the group within the data provider of the grouped list.

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

The index of this display object within the layout.

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

The number of text lines displayed by the renderer. The component may contain multiple text lines if the text contains line breaks or if the wordWrap property is enabled.

See also

The grouped list that contains this footer renderer.

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

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.

Uses the content fields and functions to generate content for a specific group header or footer.

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

1. contentTextureFunction
2. contentTextureField
3. contentLabelFunction
4. contentLabelField
5. contentFunction
6. contentField

Parameters

Determines if the text wraps to the next line when it reaches the width (or max width) of the component.

In the following example, the renderer's text is wrapped:

renderer.wordWrap = true;

The default value is false.

The location where the renderer's content is aligned vertically (on the y-axis).

In the following example, the vertical alignment is changed to bottom:

renderer.verticalAlign = VerticalAlign.BOTTOM;

The default value is feathers.layout.VerticalAlign.MIDDLE.

See also

The minimum space, in pixels, between the component's left edge and the component's content.

In the following example, the left padding is set to 20 pixels:

renderer.paddingLeft = 20;

The default value is 0.

See also

The minimum space, in pixels, between the component's bottom edge and the component's content.

In the following example, the bottom padding is set to 20 pixels:

renderer.paddingBottom = 20;

The default value is 0.

See also

The minimum space, in pixels, between the component's right edge and the component's content.

In the following example, the right padding is set to 20 pixels:

renderer.paddingRight = 20;

The default value is 0.

See also

The minimum space, in pixels, between the component's top edge and the component's content.

In the following example, the top padding is set to 20 pixels:

renderer.paddingTop = 20;

The default value is 0.

See also

Quickly sets all padding properties to the same value. The padding getter always returns the value of paddingTop, but the other padding values may be different.

In the following example, the padding on all four sides is set to 20 pixels:

renderer.padding = 20;

The default value is 0.

See also

The location where the renderer's content is aligned horizontally (on the x-axis).

In the following example, the horizontal alignment is changed to right:

renderer.horizontalAlign = HorizontalAlign.RIGHT;

The default value is feathers.layout.HorizontalAlign.LEFT.

See also

The font styles used to display the content label's text.

In the following example, the font styles are customized:

renderer.fontStyles = 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 contentLabelFactory to set more advanced styles.

The default value is null.

See also

The font styles used to display the content label's text when the component is disabled.

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

renderer.disabledFontStyles = 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 contentLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

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

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

renderer.customContentLabelStyleName = "my-custom-header-or-footer-renderer-label";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-header-or-footer-label", setCustomHeaderOrFooterLabelStyles );

The default value is null.

See also

A background to display when the component is disabled.

In the following example, the header renderers is given a disabled background skin:

renderer.backgroundDisabledSkin = new Image( texture );

The default value is null.

See also

A background to behind the component's content.

In the following example, the header renderers is given a background skin:

renderer.backgroundSkin = new Image( texture );

The default value is null.

See also

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

See also