Packagefeathers.controls.text
Classpublic class BitmapFontTextRenderer
InheritanceBitmapFontTextRenderer Inheritance FeathersControl Inheritance starling.display.Sprite
Implements ITextRenderer
Subclasses BitmapFontTextEditor

Renders text using starling.text.BitmapFont.

See also

Introduction to Feathers text renderers
starling.text.BitmapFont


Public Properties
 PropertyDefined By
  baseline : Number
[read-only] Returns the text baseline measurement, in pixels.
BitmapFontTextRenderer
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
  disabledTextFormat : BitmapFontTextFormat
The font and styles used to draw the text when the label is disabled.
BitmapFontTextRenderer
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all BitmapFontTextRenderer components.
BitmapFontTextRenderer
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
FeathersControl
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
  smoothing : String
A smoothing value passed to each character image.
BitmapFontTextRenderer
  snapToPixels : Boolean
Determines if the position of the text should be snapped to the nearest whole pixel when rendered.
BitmapFontTextRenderer
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : 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.
BitmapFontTextRenderer
  textFormat : BitmapFontTextFormat
The font and styles used to draw the text.
BitmapFontTextRenderer
  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
 Inheritedwidth : 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.
BitmapFontTextRenderer
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
Public Methods
 MethodDefined By
  
Constructor.
BitmapFontTextRenderer
 Inherited
hideFocus():void
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
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
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
Public Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = focus
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = styles
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
baselineproperty
baseline:Number  [read-only]

Returns the text baseline measurement, in pixels.


Implementation
    public function get baseline():Number
disabledTextFormatproperty 
disabledTextFormat:BitmapFontTextFormat

The font and styles used to draw the text when the label is disabled.

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

         textRenderer.disabledTextFormat = new BitmapFontTextFormat( bitmapFont );

The default value is null.


Implementation
    public function get disabledTextFormat():BitmapFontTextFormat
    public function set disabledTextFormat(value:BitmapFontTextFormat):void
globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all BitmapFontTextRenderer components.

The default value is null.

See also

smoothingproperty 
smoothing:String

A smoothing value passed to each character image.

In the following example, the texture smoothing is changed:

         textRenderer.smoothing = TextureSmoothing.NONE;

The default value is starling.textures.TextureSmoothing.BILINEAR.


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

See also

snapToPixelsproperty 
snapToPixels: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.snapToPixels = false;

The default value is true.


Implementation
    public function get snapToPixels():Boolean
    public function set snapToPixels(value:Boolean):void
textproperty 
text:String

The text to render.

If using the Label component, this property should be set on the Label, and it will be passed down to the text renderer.

The default value is null.


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

The font and styles used to draw the text.

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

truncationTextproperty 
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
useSeparateBatchproperty 
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
wordWrapproperty 
wordWrap:Boolean

Determines if the text wraps to the next line when it reaches the width (or max width) of the component.

If using the Label component, this property should be set on the Label, and it will be passed down to the text renderer automatically.

The default value is false.


Implementation
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void
Constructor Detail
BitmapFontTextRenderer()Constructor
public function BitmapFontTextRenderer()

Constructor.

Method Detail
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