The type of anti-aliasing used for this text field, defined as constants in the flash.text.AntiAliasType class. You can control this setting only if the font is embedded (with the embedFonts property set to true).

In the following example, the anti-alias type is changed:

textRenderer.antiAliasType = AntiAliasType.NORMAL;

The default value is flash.text.AntiAliasType.ADVANCED.

See also

Specifies whether the text field has a background fill. Use the backgroundColor property to set the background color of a text field.

In the following example, the background is enabled:

textRenderer.background = true;
textRenderer.backgroundColor = 0xff0000;

The default value is false.

See also

The color of the text field background that is displayed if the background property is set to true.

In the following example, the background color is changed:

textRenderer.background = true;
textRenderer.backgroundColor = 0xff000ff;

The default value is 0xffffff.

See also

Returns the text baseline measurement, in pixels.

Specifies whether the text field has a border. Use the borderColor property to set the border color.

Note: If border is set to true, the component will behave as if useGutter is also set to true because the border will not render correctly without the gutter.

In the following example, the border is enabled:

textRenderer.border = true;
textRenderer.borderColor = 0xff0000;

The default value is false.

See also

The color of the text field border that is displayed if the border property is set to true.

In the following example, the border color is changed:

textRenderer.border = true;
textRenderer.borderColor = 0xff00ff;

The default value is 0x000000.

See also

A boolean value that specifies whether extra white space (spaces, line breaks, and so on) in a text field with HTML text is removed.

In the following example, whitespace is condensed:

textRenderer.condenseWhite = true;

The default value is false.

See also

For debugging purposes, the current flash.text.TextFormat used to render the text. Updated during validation, and may be null before the first validation.

Do not modify this value. It is meant for testing and debugging only. Use the parent's starling.text.TextFormat font styles APIs instead.

Advanced font formatting used to draw the text when the component is disabled, if disabledFontStyles and starling.text.TextFormat cannot be used on the parent component because the full capabilities of flash.text.TextField are required.

In the following example, the disabled text format is changed:

textRenderer.isEnabled = false;
textRenderer.disabledTextFormat = new TextFormat( "Source Sans Pro" );

Warning: If this property is not null, any starling.text.TextFormat font styles that are passed in from the parent component may be ignored. In other words, advanced font styling with flash.text.TextFormat will always take precedence.

The default value is null.

See also

Specifies whether the text field is a password text field that hides the input characters using asterisks instead of the actual characters.

In the following example, the text is displayed as a password:

textRenderer.displayAsPassword = true;

The default value is false.

See also

If advanced flash.text.TextFormat styles are specified, determines if the TextField should use an embedded font or not. If the specified font is not embedded, the text may not be displayed at all.

If the font styles are passed in from the parent component, the text renderer will automatically detect if a font is embedded or not, and the embedFonts property will be ignored if it is set to false. Setting it to true will force the TextField to always try to use embedded fonts.

In the following example, the font is embedded:

textRenderer.embedFonts = true;

The default value is false.

See also

The default IStyleProvider for all TextFieldTextRenderer components.

The default value is null.

See also

Determines whether Flash Player forces strong horizontal and vertical lines to fit to a pixel or subpixel grid, or not at all using the constants defined in the flash.text.GridFitType class. This property applies only if the antiAliasType property of the text field is set to flash.text.AntiAliasType.ADVANCED.

In the following example, the grid fit type is changed:

textRenderer.gridFitType = GridFitType.SUBPIXEL;

The default value is flash.text.GridFitType.PIXEL.

See also

Determines if the TextField should display the text as HTML or not.

In the following example, the text is displayed as HTML:

textRenderer.isHTML = true;
textRenderer.text = "<span class='heading'>hello</span> world!";

The default value is false.

See also

The maximum size of individual textures that are managed by this text renderer. Must be a power of 2. A larger value will create fewer individual textures, but a smaller value may use less overall texture memory by incrementing over smaller powers of two.

In the following example, the maximum size of the textures is changed:

renderer.maxTextureDimensions = 4096;

The default value is 2048.

Native filters to pass to the flash.text.TextField before creating the texture snapshot.

In the following example, the native filters are changed:

renderer.nativeFilters = [ new GlowFilter() ];

The default value is null.

See also

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

Determines if the text should be snapped to the nearest whole pixel when rendered. When this is false, text may be displayed on sub-pixels, which often results in blurred rendering due to texture smoothing.

In the following example, the text is not snapped to pixels:

textRenderer.pixelSnapping = false;

The default value is true.

Advanced font formatting used to draw the text when the stateContext is selected, if selectedFontStyles and starling.text.TextFormat cannot be used on the parent component because the full capabilities of flash.text.TextField are required. The font and styles used to draw the text when the stateContext implements the IToggle interface, and it is selected.

In the following example, the selected text format is changed:

textRenderer.selectedTextFormat = new TextFormat( "Source Sans Pro" );

Warning: If this property is not null, any starling.text.TextFormat font styles that are passed in from the parent component may be ignored. In other words, advanced font styling with flash.text.TextFormat will always take precedence.

The default value is null.

See also

The sharpness of the glyph edges in this text field. This property applies only if the antiAliasType property of the text field is set to flash.text.AntiAliasType.ADVANCED. The range for sharpness is a number from -400 to 400.

In the following example, the sharpness is changed:

textRenderer.sharpness = 200;

The default value is 0.

See also

The StyleSheet object to pass to the TextField.

In the following example, a style sheet is applied:

var style:StyleSheet = new StyleSheet();
var heading:Object = new Object();
heading.fontWeight = "bold";
heading.color = "#FF0000";
var body:Object = new Object();
body.fontStyle = "italic";
style.setStyle(".heading", heading);
style.setStyle("body", body);
textRenderer.styleSheet = style;
textRenderer.isHTML = true;
textRenderer.text = "<body><span class='heading'>Hello</span> World...</body>";

The default value is null.

See also

The TextField instance used to render the text before taking a texture snapshot.

Advanced font formatting used to draw the text, if fontStyles and starling.text.TextFormat cannot be used on the parent component because the full capabilities of flash.text.TextField are required.

In the following example, the text format is changed:

textRenderer.textFormat = new TextFormat( "Source Sans Pro" );

Warning: If this property is not null, any starling.text.TextFormat font styles that are passed in from the parent component may be ignored. In other words, advanced font styling with flash.text.TextFormat will always take precedence.

The default value is null.

See also

An image that displays a snapshot of the native TextField in the Starling display list when the editor doesn't have focus.

If multiple snapshots are needed due to texture size limits, the snapshots appearing after the first are stored here.

The thickness of the glyph edges in this text field. This property applies only if the antiAliasType property is set to flash.text.AntiAliasType.ADVANCED. The range for thickness is a number from -200 to 200.

In the following example, the thickness is changed:

textRenderer.thickness = 100;

The default value is 0.

See also

Refreshes the texture snapshot every time that the text renderer is scaled. Based on the scale in global coordinates, so scaling the parent will require a new snapshot.

Warning: setting this property to true may result in reduced performance because every change of the scale requires uploading a new texture to the GPU. Use with caution. Consider setting this property to false temporarily during animations that modify the scale.

In the following example, the snapshot will be updated when the text renderer is scaled:

textRenderer.updateSnapshotOnScaleChange = true;

The default value is false.

Determines if the 2-pixel gutter around the edges of the flash.text.TextField will be used in measurement and layout. To visually align with other text renderers and text editors, it is often best to leave the gutter disabled.

Returns true if the border property is true.

In the following example, the gutter is enabled:

textEditor.useGutter = true;

The default value is false.

Fixes an issue where flash.text.TextField renders incorrectly when drawn to BitmapData by waiting one frame.

Warning: enabling this workaround may cause slight flickering after the text property is changed.

In the following example, the workaround is enabled:

textRenderer.useSnapshotDelayWorkaround = true;

The default value is false.

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.

Gets the advanced flash.text.TextFormat font formatting passed in using setTextFormatForState() for the specified state.

If an flash.text.TextFormat is not defined for a specific state, returns null.

Parameters

See also

Measures the text's bounds (without a full validation, if possible).

Parameters

Sets the advanced flash.text.TextFormat font formatting to be used by the text renderer when the currentState property of the stateContext matches the specified state value.

If a flash.text.TextFormat is not defined for a specific state, the value of the textFormat property will be used instead.

If the disabledTextFormat property is not null and the isEnabled property is false, all other text formats will be ignored.

Parameters

See also