Package | feathers.controls.text |
Class | public class BitmapFontTextRenderer |
Inheritance | BitmapFontTextRenderer ![]() ![]() |
Implements | ITextRenderer |
Subclasses | BitmapFontTextEditor |
starling.text.BitmapFont
.
See also
Property | Defined By | ||
---|---|---|---|
baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | 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
The font and styles used to draw the text when the label is disabled. | BitmapFontTextRenderer | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | 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 | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all BitmapFontTextRenderer
components. | BitmapFontTextRenderer | ||
![]() | height : Number [override]
The height of the component, in pixels. | 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 | 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 | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | 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 | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | previousTabFocus : 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 | ||
![]() | 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. | 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 | ||
![]() | 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. | BitmapFontTextRenderer |
Method | Defined By | ||
---|---|---|---|
Constructor. | BitmapFontTextRenderer | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | 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 | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
baseline | property |
baseline:Number
[read-only] Returns the text baseline measurement, in pixels.
public function get baseline():Number
disabledTextFormat | property |
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
.
public function get disabledTextFormat():BitmapFontTextFormat
public function set disabledTextFormat(value:BitmapFontTextFormat):void
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all BitmapFontTextRenderer
components.
The default value is null
.
See also
smoothing | property |
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
.
public function get smoothing():String
public function set smoothing(value:String):void
See also
snapToPixels | property |
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
.
public function get snapToPixels():Boolean
public function set snapToPixels(value:Boolean):void
text | property |
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
.
public function get text():String
public function set text(value:String):void
textFormat | property |
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
.
public function get textFormat():BitmapFontTextFormat
public function set textFormat(value:BitmapFontTextFormat):void
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
.
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 "..."
.
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
.
public function get useSeparateBatch():Boolean
public function set useSeparateBatch(value:Boolean):void
wordWrap | property |
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
.
public function get wordWrap():Boolean
public function set wordWrap(value:Boolean):void
BitmapFontTextRenderer | () | Constructor |
public function BitmapFontTextRenderer()
Constructor.
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 )
|
Point |