feathers.controls.text.BitmapFontTextRenderer

Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		baseline : Number [read-only] Returns the text baseline measurement, in pixels.	BitmapFontTextRenderer
		breakLongWords : Boolean If wordWrap is true, determines if words longer than the width of the text renderer will break in the middle or if the word will extend outside the edges until it ends.	BitmapFontTextRenderer
		currentTextFormat : BitmapFontTextFormat [read-only] For debugging purposes, the current feathers.text.BitmapFontTextFormat used to render the text.	BitmapFontTextRenderer
		defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance.	FeathersControl
		defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.	FeathersControl
		depth : int [read-only] The component's depth in the display list, relative to the stage.	FeathersControl
		disabledTextFormat : BitmapFontTextFormat 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 other features of bitmap fonts are required.	BitmapFontTextRenderer
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	FeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	FeathersControl
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	FeathersControl
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	FeathersControl
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	FeathersControl
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	FeathersControl
		explicitWidth : Number [read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.	FeathersControl
		focusInEffect : Function An optional effect that is activated when the component receives focus.	FeathersControl
		focusManager : IFocusManager The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.	FeathersControl
		focusOutEffect : Function An optional effect that is activated when the component loses focus.	FeathersControl
		focusOwner : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.	FeathersControl
		fontStyles : FontStylesSet The internal font styles used to render the text that are passed down from the parent component.	BaseTextRenderer
		globalStyleProvider : IStyleProvider [static] The default IStyleProvider for all BitmapFontTextRenderer components.	BitmapFontTextRenderer
		height : Number [override] The height of the component, in pixels.	FeathersControl
		hideEffect : Function An optional effect that is activated when the component is hidden.	FeathersControl
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		isCreated : Boolean [read-only] Determines if the component has been initialized and validated for the first time.	FeathersControl
		isEnabled : Boolean Indicates whether the control is interactive or not.	FeathersControl
		isFocusEnabled : Boolean The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.	FeathersControl
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	FeathersControl
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isShowingFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.	FeathersControl
		layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm.	FeathersControl
		maintainTouchFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.	FeathersControl
		maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.	FeathersControl
		minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.	FeathersControl
		minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		moveEffect : Function An optional effect that is activated when the component is moved to a new position.	FeathersControl
		nextDownFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextLeftFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextRightFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.	FeathersControl
		nextUpFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		numLines : int [read-only] The number of text lines in the text renderer.	BitmapFontTextRenderer
		pixelSnapping : Boolean Determines if the position of the text should be snapped to the nearest whole pixel when rendered.	BitmapFontTextRenderer
		previousTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.	FeathersControl
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		selectedTextFormat : BitmapFontTextFormat Advanced font formatting used to draw the text when the stateContext is disabled, if selectedFontStyles and starling.text.TextFormat cannot be used on the parent component because the other features of bitmap fonts are required.	BitmapFontTextRenderer
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		stateContext : IStateContext When the text renderer observes a state context, the text renderer may change its font styles based on the current state of that context.	BaseTextRenderer
		style : MeshStyle The style that is used to render the text's mesh.	BitmapFontTextRenderer
		styleName : String The concatenated styleNameList, with values separated by spaces.	FeathersControl
		styleNameList : TokenList [read-only] Contains a list of all "styles" assigned to this control.	FeathersControl
		styleProvider : IStyleProvider When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.	FeathersControl
		text : String The text to render.	BaseTextRenderer
		textFormat : BitmapFontTextFormat Advanced font formatting used to draw the text, if fontStyles and starling.text.TextFormat cannot be used on the parent component because the other features of bitmap fonts are required.	BitmapFontTextRenderer
		textureSmoothing : String A texture smoothing value passed to each character image.	BitmapFontTextRenderer
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	FeathersControl
		truncateToFit : Boolean If word wrap is disabled, and the text is longer than the width of the label, the text may be truncated using truncationText.	BitmapFontTextRenderer
		truncationText : String The text to display at the end of the label if it is truncated.	BitmapFontTextRenderer
		useSeparateBatch : Boolean Determines if the characters are batched normally by Starling or if they're batched separately.	BitmapFontTextRenderer
		width : Number [override] The width of the component, in pixels.	FeathersControl
		wordWrap : Boolean Determines if the text wraps to the next line when it reaches the width (or max width) of the component.	BaseTextRenderer

	Property	Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl

	Method	Defined By
		BitmapFontTextRenderer() Constructor.	BitmapFontTextRenderer
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.	FeathersControl
		getTextFormatForState(state:String):BitmapFontTextFormat Gets the advanced BitmapFontTextFormat font formatting passed in using setTextFormatForState() for the specified state.	BitmapFontTextRenderer
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		initializeNow():void If the component has not yet initialized, initializes immediately.	FeathersControl
		invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending.	FeathersControl
		isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not.	FeathersControl
		measureText(result:Point = null):Point Measures the text's bounds (without a full validation, if possible).	BitmapFontTextRenderer
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	FeathersControl
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	FeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	FeathersControl
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	FeathersControl
		setTextFormatForState(state:String, textFormat:BitmapFontTextFormat):void Sets the advanced BitmapFontTextFormat font formatting to be used by the text renderer when the currentState property of the stateContext matches the specified state value.	BitmapFontTextRenderer
		showFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		suspendEffects():void Indicates that effects should not be activated temporarily.	FeathersControl
		validate():void Immediately validates the display object, if it is invalid.	FeathersControl

	Method	Defined By
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		focusInHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.	FeathersControl
		focusOutHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.	FeathersControl
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	FeathersControl
		initialize():void Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.	FeathersControl
		processStyleRestriction(key:Object):Boolean Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.	FeathersControl
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	FeathersControl
		setInvalidationFlag(flag:String):void Sets an invalidation flag.	FeathersControl
		setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not.	FeathersControl

Summary	Defined By
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
resize	Dispatched when the width or height of the control changes.	FeathersControl

	Style	Defined By
		focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.	FeathersControl
		focusPadding : Number Quickly sets all focus padding properties to the same value.	FeathersControl
		focusPaddingBottom : Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.	FeathersControl
		focusPaddingLeft : Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.	FeathersControl
		focusPaddingRight : Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.	FeathersControl
		focusPaddingTop : Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.	FeathersControl

	Constant	Defined By
		INVALIDATION_FLAG_ALL : String = "all" [static] Flag to indicate that everything is invalid and should be redrawn.	FeathersControl
		INVALIDATION_FLAG_DATA : String = "data" [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_FOCUS : String = "focus" [static] Invalidation flag to indicate that the focus of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_LAYOUT : String = "layout" [static] Invalidation flag to indicate that the layout of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SCROLL : String = "scroll" [static] Invalidation flag to indicate that the scroll position of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SELECTED : String = "selected" [static] Invalidation flag to indicate that the selection of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SIZE : String = "size" [static] Invalidation flag to indicate that the dimensions of the UI control have changed.	FeathersControl
		INVALIDATION_FLAG_SKIN : String = "skin" [static] Invalidation flag to indicate that the skin of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_STATE : String = "state" [static] Invalidation flag to indicate that the state has changed.	FeathersControl
		INVALIDATION_FLAG_STYLES : String = "styles" [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.	FeathersControl

Property Detail

baseline

property

baseline:Number [read-only]

Returns the text baseline measurement, in pixels.

Implementation
public function get baseline():Number

breakLongWords

property

breakLongWords:Boolean

If wordWrap is true, determines if words longer than the width of the text renderer will break in the middle or if the word will extend outside the edges until it ends.

In the following example, the text will break long words:

textRenderer.breakLongWords = true;

The default value is false.

Implementation
public function get breakLongWords():Boolean
public function set breakLongWords(value:Boolean):void

See also

wordWrap

currentTextFormat

property

currentTextFormat:BitmapFontTextFormat [read-only]

For debugging purposes, the current feathers.text.BitmapFontTextFormat 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.

Implementation
public function get currentTextFormat():BitmapFontTextFormat

disabledTextFormat

property

disabledTextFormat:BitmapFontTextFormat

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 other features of bitmap fonts are required.

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

textRenderer.isEnabled = false;
textRenderer.disabledTextFormat = new BitmapFontTextFormat( bitmapFont );

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 BitmapFontTextFormat will always take precedence.

The default value is null.

Implementation
public function get disabledTextFormat():BitmapFontTextFormat
public function set disabledTextFormat(value:BitmapFontTextFormat):void

See also

textFormat
selectedTextFormat

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all BitmapFontTextRenderer components.

The default value is null.

numLines

property

numLines:int [read-only]

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.

Implementation
public function get numLines():int

pixelSnapping

property

pixelSnapping:Boolean

Determines if the position of the text should be snapped to the nearest whole pixel when rendered. When snapped to a whole pixel, the text is often more readable. When not snapped, the text may become blurry due to texture smoothing.

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

textRenderer.pixelSnapping = false;

The default value is true.

Implementation
public function get pixelSnapping():Boolean
public function set pixelSnapping(value:Boolean):void

selectedTextFormat

property

selectedTextFormat:BitmapFontTextFormat

Advanced font formatting used to draw the text when the stateContext is disabled, if selectedFontStyles and starling.text.TextFormat cannot be used on the parent component because the other features of bitmap fonts are required.

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

textRenderer.selectedTextFormat = new BitmapFontTextFormat( bitmapFont );

The default value is null.

Implementation
public function get selectedTextFormat():BitmapFontTextFormat
public function set selectedTextFormat(value:BitmapFontTextFormat):void

style

property

style:MeshStyle

The style that is used to render the text's mesh.

In the following example, the text renderer uses a custom style:

textRenderer.style = new DistanceFieldStyle();

The default value is null.

Implementation
public function get style():MeshStyle
public function set style(value:MeshStyle):void

textFormat

property

textFormat:BitmapFontTextFormat

Advanced font formatting used to draw the text, if fontStyles and starling.text.TextFormat cannot be used on the parent component because the other features of bitmap fonts are required.

In the following example, the text format is changed:

textRenderer.textFormat = new BitmapFontTextFormat( bitmapFont );

The default value is null.

Implementation
public function get textFormat():BitmapFontTextFormat
public function set textFormat(value:BitmapFontTextFormat):void

textureSmoothing

property

textureSmoothing:String

A texture smoothing value passed to each character image. If null, defaults to the value specified by the smoothing property of the BitmapFont.

In the following example, the texture smoothing is changed:

textRenderer.textureSmoothing = TextureSmoothing.NONE;

The default value is null.

Implementation
public function get textureSmoothing():String
public function set textureSmoothing(value:String):void

See also

starling.textures.TextureSmoothing

truncateToFit

property

truncateToFit:Boolean

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

Implementation
public function get truncateToFit():Boolean
public function set truncateToFit(value:Boolean):void

See also

truncationText

property

truncationText:String

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

Implementation
public function get truncationText():String
public function set truncationText(value:String):void

useSeparateBatch

property

useSeparateBatch:Boolean

Determines if the characters are batched normally by Starling or if they're batched separately. Batching separately may improve performance for text that changes often, while batching normally may be better when a lot of text is displayed on screen at once.

In the following example, separate batching is disabled:

textRenderer.useSeparateBatch = false;

The default value is true.

Implementation
public function get useSeparateBatch():Boolean
public function set useSeparateBatch(value:Boolean):void

Constructor Detail

BitmapFontTextRenderer

()

Constructor

public function BitmapFontTextRenderer()

Constructor.

Method Detail

getTextFormatForState

()

method

public function getTextFormatForState(state:String):BitmapFontTextFormat

Gets the advanced BitmapFontTextFormat font formatting passed in using setTextFormatForState() for the specified state.

If an BitmapFontTextFormat is not defined for a specific state, returns null.

Parameters

state:String

Returns

BitmapFontTextFormat

See also

setTextFormatForState()

measureText

()

method

public function measureText(result:Point = null):Point

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

Parameters

result:Point (default = null)

Returns

Point

setTextFormatForState

()

method

public function setTextFormatForState(state:String, textFormat:BitmapFontTextFormat):void

Sets the advanced BitmapFontTextFormat 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 other features of bitmap fonts are required.

If an BitmapFontTextFormat 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

	`state:String`

	`textFormat:BitmapFontTextFormat`

See also

stateContext
textFormat

Sat Jun 18 2022, 02:58 PM -07:00

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
BitmapFontTextRenderer	Properties Methods Events Styles Constants

Package	feathers.controls.text
Class	public class BitmapFontTextRenderer
Inheritance	BitmapFontTextRenderer BaseTextRenderer FeathersControl starling.display.Sprite
Implements	ITextRenderer
Subclasses	BitmapFontTextEditor