Specifies that you want to enhance screen appearance at the expense of what-you-see-is-what-you-get (WYSIWYG) print fidelity.

In the following example, this property is changed to false:

textRenderer.applyNonLinearFontScaling = false;

The default value is true.

See also

Returns the text baseline measurement, in pixels.

The font used to determine the baselines for all the lines created from the block, independent of their content.

In the following example, the baseline font description is changed:

textRenderer.baselineFontDescription = new FontDescription( "Source Sans Pro", FontWeight.BOLD );

The default value is null.

See also

The font size used to calculate the baselines for the lines created from the block.

In the following example, the baseline font size is changed:

textRenderer.baselineFontSize = 20;

The default value is 12.

See also

Specifies which baseline is at y=0 for lines created from this block.

In the following example, the baseline zero is changed:

textRenderer.baselineZero = TextBaseline.ASCENT;

The default value is TextBaseline.ROMAN.

See also

Specifies the bidirectional paragraph embedding level of the text block.

In the following example, the bidi level is changed:

textRenderer.bidiLevel = 1;

The default value is 0.

See also

Sets the contents of the TextBlock to a complex value that may contain graphics and text with multiple formats.

In the following example, the content is set to a GroupElement that contains text with multiple formats:

var format1:ElementFormat = new ElementFormat(new FontDescription("_sans"), 20, 0x000000);
var format2:ElementFormat = new ElementFormat(new FontDescription("_sans"), 20, 0xff0000);
var format3:ElementFormat = new ElementFormat(new FontDescription("_sans", FontWeight.NORMAL, FontPosture.ITALIC), 20, 0x000000);
var text1:TextElement = new TextElement("Different ", format1);
var text2:TextElement = new TextElement("colors", format2);
var text3:TextElement = new TextElement(" and ", format1);
var text4:TextElement = new TextElement("styles", format3);
var elements:Vector.<ContentElement> = new <ContentElement>[text1, text2, text3, text4];
var group:GroupElement = new GroupElement(elements);
var textRenderer:TextBlockTextRenderer = new TextBlockTextRenderer();
textRenderer.content = group;

In the following example, the content is set to a GroupElement that contains both text and a bitmap graphic:

var format:ElementFormat = new ElementFormat(new FontDescription("_sans"), 20);
var text:TextElement = new TextElement("Hi there! ", format);
var bitmap:Bitmap = new EmbeddedBitmap(); //a bitmap included with [Embed]
var graphic:GraphicElement = new GraphicElement(bitmap, bitmap.width, bitmap.height, format);
var elements:Vector.<ContentElement> = new <ContentElement>[text, graphic];
var group:GroupElement = new GroupElement(elements);
var textRenderer:TextBlockTextRenderer = new TextBlockTextRenderer();
textRenderer.content = group;

Note: The content property cannot be used when the TextBlockTextRenderer receives its text from a parent component, such as a Label or a Button.

The default value is null.

See also

For debugging purposes, the current flash.text.engine.ElementFormat 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 Engine are required.

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

textRenderer.isEnabled = false;
textRenderer.disabledElementFormat = new ElementFormat( new FontDescription( "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 ElementFormat will always take precedence.

Warning: This property will be ignored if the content property is customized with Flash Text Engine rich text objects such as GroupElement and GraphicElement.

The default value is null.

See also

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 Engine are required.

In the following example, the element format is changed:

textRenderer.elementFormat = new ElementFormat( new FontDescription( "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 ElementFormat will always take precedence.

Warning: This property will be ignored if the content property is customized with Flash Text Engine rich text objects such as GroupElement and GraphicElement.

The default value is null.

See also

The default IStyleProvider for all TextBlockTextRenderer components.

The default value is null.

See also

The amount of vertical space, in pixels, between lines.

If leading is NaN the leading from the starling.text.TextFormat font styles may be used. If no starling.text.TextFormat font styles have been provided by the parent component, the leading will default to 0.

In the following example, the leading is changed to 20 pixels:

textRenderer.leading = 20;

The default value is NaN.

Rotates the text lines in the text block as a unit.

In the following example, the line rotation is changed:

textRenderer.lineRotation = TextRotation.ROTATE_90;

The default value is TextRotation.ROTATE_0.

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.engine.TextLine instances 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 Engine are required.

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

textRenderer.selectedElementFormat = new ElementFormat( new FontDescription( "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 ElementFormat will always take precedence.

Warning: This property will be ignored if the content property is customized with Flash Text Engine rich text objects such as GroupElement and GraphicElement.

The default value is null.

See also

Specifies the tab stops for the text in the text block, in the form of a Vector of TabStop objects.

In the following example, the tab stops changed:

textRenderer.tabStops = new <TabStop>[ new TabStop( TabAlignment.CENTER ) ];

The default value is null.

See also

The alignment of the text. For justified text, see the textJustifier property.

If textAlign is null the horizontal alignment from the starling.text.TextFormat font styles may be used. If no starling.text.TextFormat font styles have been provided by the parent component, the alignment will default to HorizontalAlign.LEFT.

In the following example, the text alignment is changed:

textRenderer.textAlign = HorizontalAlign.CENTER;

The default value is null.

See also

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

Specifies the TextJustifier to use during line creation.

In the following example, the text justifier is changed:

textRenderer.textJustifier = new SpaceJustifier( "en", LineJustification.ALL_BUT_LAST );

See also

An image that displays a snapshot of the native TextBlock 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.

If word wrap is disabled, and the text is longer than the width of the label, the text may be truncated using truncationText.

This feature may be disabled to improve performance.

This feature only works when the text property is set to a string value. If the content property is set instead, then the content will not be truncated.

This feature does not currently support the truncation of text displayed on multiple lines.

In the following example, truncation is disabled:

textRenderer.truncateToFit = false;

The default value is true.

See also

The text to display at the end of the label if it is truncated.

In the following example, the truncation text is changed:

textRenderer.truncationText = " [more]";

The default value is "...".

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.

Provides a way for the application to associate arbitrary data with the text block.

In the following example, the user data is changed:

textRenderer.userData = { author: "William Shakespeare", title: "Much Ado About Nothing" };

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.

Gets the advanced ElementFormat font formatting passed in using setElementFormatForState() for the specified state.

If an ElementFormat 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 ElementFormat font formatting to be used by the text renderer when the currentState property of the stateContext matches the specified state value. For advanced use cases where starling.text.TextFormat cannot be used on the parent component because the full capabilities of Flash Text Engine are required.

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

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

Parameters

See also