The baseline measurement of the text, in pixels.

The default IStyleProvider for all Label components.

The default value is null.

See also

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

See also

The text displayed by the label.

In the following example, the label's text is updated:

label.text = "Hello World";

The default value is null.

The text renderer.

See also

A function used to instantiate the label's text renderer sub-component. By default, the label will use the global text renderer factory, FeathersControl.defaultTextRendererFactory(), to create the text renderer. The text renderer must be an instance of ITextRenderer. This factory can be used to change properties on the text renderer when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to style the text renderer.

The factory should have the following function signature:

function():ITextRenderer

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

label.textRendererFactory = function():ITextRenderer
{
    return new TextFieldTextRenderer();
}

The default value is null.

See also

An object that stores properties for the label's text renderer sub-component, and the properties will be passed down to the text renderer when the label validates. The available properties depend on which ITextRenderer implementation is returned by textRendererFactory. 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 textRendererFactory function instead of using textRendererProperties will result in better performance.

In the following example, the label's text renderer's properties are updated (this example assumes that the label text renderer is a TextFieldTextRenderer):

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

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

Creates and adds the textRenderer 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

Positions and sizes children based on the actual width and height values.

Choose the appropriate background skin based on the control's current state.

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

label.wordWrap = true;

The default value is false.

The minimum space, in pixels, between the label's left edge and the label's text.

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

label.paddingLeft = 20;

The default value is 0.

See also

The minimum space, in pixels, between the label's bottom edge and the label's text.

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

label.paddingBottom = 20;

The default value is 0.

See also

The minimum space, in pixels, between the label's right edge and the label's text.

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

label.paddingRight = 20;

The default value is 0.

See also

The minimum space, in pixels, between the label's top edge and the label's text.

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

label.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 is set to 20 pixels:

label.padding = 20;

The default value is 0.

See also

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

In the following example, the font styles are customized:

label.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 label's text when the label is disabled.

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

label.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 label's text renderer sub-component. Typically used by a theme to provide different styles to different labels.

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

label.customTextRendererStyleName = "my-custom-label-text-renderer";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-label-text-renderer", setCustomLabelTextRendererStyles );

The default value is null.

See also

The default background to display behind the label's text.

In the following example, the label is given a background skin:

label.backgroundSkin = new Image( texture );

The default value is null.

See also

A background to display when the label is disabled.

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

label.backgroundDisabledSkin = new Image( texture );

The default value is null.

See also

An alternate style name to use with Label to allow a theme to give it a smaller style meant for less-important details. If a theme does not provide a style for a detail label, the theme will automatically fall back to using the default style for a label.

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 detail style is applied to a label:

var label:Label = new Label();
label.text = "Less important, detailed text";
label.styleNameList.add( Label.ALTERNATE_STYLE_NAME_DETAIL );
this.addChild( label );

See also

An alternate style name to use with Label to allow a theme to give it a larger style meant for headings. If a theme does not provide a style for a heading label, the theme will automatically fall back to using the default style for a label.

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 heading style is applied to a label:

var label:Label = new Label();
label.text = "Very Important Heading";
label.styleNameList.add( Label.ALTERNATE_STYLE_NAME_HEADING );
this.addChild( label );

See also

An alternate style name to use with Label to allow a theme to give it a tool tip style for use with the tool tip manager. If a theme does not provide a style for a tool tip label, the theme will automatically fall back to using the default style for a label.

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.

See also

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

See also