The index of the header within the layout.

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

A column from a data grid. The data may change if this header renderer is reused for a new column because it's no longer needed for the original column.

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

The default IStyleProvider for all DefaultDataGridHeaderRenderer components.

The default value is null.

See also

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 data grid that contains this header renderer.

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

Indicates if this column is sorted.

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

A function that generates an ITextRenderer that displays the header's text. The factory may be used to set custom properties on the ITextRenderer.

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

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

The default value is null.

See also

The value added to the styleNameList of the 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_TEXT_RENDERER.

To customize the text renderer style name without subclassing, see customTextRendererStyleName.

See also

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.

Determines which text to display in the header.

Parameters

Dispatched when the the user taps or clicks the header renderer. The touch must remain within the bounds of the header renderer on release to register as a tap or a click.

The properties of the event object have the following values:

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 header renderer's text is wrapped:

headerRenderer.wordWrap = true;

The default value is false.

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

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

headerRenderer.verticalAlign = VerticalAlign.BOTTOM;

Note: The VerticalAlign.JUSTIFY constant is not supported.

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

See also

An icon to display when the column is sorted in descending order.

In the following example, the sort descending icon is customized:

headerRenderer.sortDescendingIcon = new Image( texture );

The default value is null.

See also

An icon to display when the column is sorted in ascending order.

In the following example, sort ascending icon is customized:

headerRenderer.sortAscendingIcon = new Image( texture );

The default value is null.

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:

headerRenderer.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:

headerRenderer.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:

headerRenderer.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:

headerRenderer.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:

headerRenderer.padding = 20;

The default value is 0.

See also

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

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

headerRenderer.horizontalAlign = HorizontalAlign.RIGHT;

Note: The HorizontalAlign.JUSTIFY constant is not supported.

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

See also

The font styles used to display the header renderer's text.

In the following example, the font styles are customized:

headerRenderer.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 textRendererFactory to set more advanced styles.

The default value is null.

See also

The font styles used to display the header renderer's text when the component is disabled.

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

headerRenderer.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 textRendererFactory to set more advanced styles on the text renderer.

The default value is null.

See also

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

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

headerRenderer.customTextRendererStyleName = "my-custom-header-text";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-header-text", setCustomHeaderTextStyles );

The default value is null.

See also

A background to display when the header renderer is disabled.

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

headerRenderer.backgroundDisabledSkin = new Image( texture );

The default value is null.

See also

A background to behind the header renderer's content.

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

headerRenderer.backgroundSkin = new Image( texture );

The default value is null.

See also

The default value added to the styleNameList of the text renderer.

See also