Package | feathers.controls.text |
Class | public class TextFieldTextRenderer |
Inheritance | TextFieldTextRenderer ![]() ![]() |
Implements | ITextRenderer |
flash.text.TextField
and draws
it to BitmapData
to convert to Starling textures. Textures
are completely managed by this component, and they will be automatically
disposed when the component is disposed.
For longer passages of text, this component will stitch together multiple individual textures both horizontally and vertically, as a grid, if required. This may require quite a lot of texture memory, possibly exceeding the limits of some mobile devices, so use this component with caution when displaying a lot of text.
See also
Property | Defined By | ||
---|---|---|---|
antiAliasType : String
The type of anti-aliasing used for this text field, defined as
constants in the flash.text.AntiAliasType class. | TextFieldTextRenderer | ||
background : Boolean
Specifies whether the text field has a background fill. | TextFieldTextRenderer | ||
backgroundColor : uint
The color of the text field background that is displayed if the
background property is set to true. | TextFieldTextRenderer | ||
baseline : Number [read-only]
Returns the text baseline measurement, in pixels. | TextFieldTextRenderer | ||
border : Boolean
Specifies whether the text field has a border. | TextFieldTextRenderer | ||
borderColor : uint
The color of the text field border that is displayed if the
border property is set to true. | TextFieldTextRenderer | ||
condenseWhite : Boolean
A boolean value that specifies whether extra white space (spaces,
line breaks, and so on) in a text field with HTML text is removed. | TextFieldTextRenderer | ||
![]() | 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 : TextFormat
The font and styles used to draw the text when the component is disabled. | TextFieldTextRenderer | ||
displayAsPassword : Boolean
Specifies whether the text field is a password text field that hides
the input characters using asterisks instead of the actual
characters. | TextFieldTextRenderer | ||
embedFonts : Boolean
Determines if the TextField should use an embedded font or not. | TextFieldTextRenderer | ||
![]() | 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 TextFieldTextRenderer
components. | TextFieldTextRenderer | ||
gridFitType : String
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. | TextFieldTextRenderer | ||
![]() | 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 | |
isHTML : Boolean
Determines if the TextField should display the text as HTML or not. | TextFieldTextRenderer | ||
![]() | 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 | |
maxTextureDimensions : int
The maximum size of individual textures that are managed by this text
renderer. | TextFieldTextRenderer | ||
![]() | 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 | |
nativeFilters : Array
Native filters to pass to the flash.text.TextField
before creating the texture snapshot. | TextFieldTextRenderer | ||
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
sharpness : Number
The sharpness of the glyph edges in this text field. | TextFieldTextRenderer | ||
snapToPixels : Boolean
Determines if the text should be snapped to the nearest whole pixel
when rendered. | TextFieldTextRenderer | ||
![]() | 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 | |
styleSheet : StyleSheet
The StyleSheet object to pass to the TextField. | TextFieldTextRenderer | ||
text : String
The text to render. | TextFieldTextRenderer | ||
textFormat : TextFormat
The font and styles used to draw the text. | TextFieldTextRenderer | ||
thickness : Number
The thickness of the glyph edges in this text field. | TextFieldTextRenderer | ||
updateSnapshotOnScaleChange : Boolean
Refreshes the texture snapshot every time that the text renderer is
scaled. | TextFieldTextRenderer | ||
useGutter : Boolean
Determines if the 2-pixel gutter around the edges of the
flash.text.TextField will be used in measurement and
layout. | TextFieldTextRenderer | ||
useSnapshotDelayWorkaround : Boolean
Fixes an issue where flash.text.TextField renders
incorrectly when drawn to BitmapData by waiting one
frame. | TextFieldTextRenderer | ||
![]() | 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. | TextFieldTextRenderer |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height 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
globalStyleProvider property is set to this value. | FeathersControl | |
![]() | explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
![]() | explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
textField : TextField
The TextField instance used to render the text before taking a
texture snapshot. | TextFieldTextRenderer | ||
textSnapshot : Image
An image that displays a snapshot of the native TextField
in the Starling display list when the editor doesn't have focus. | TextFieldTextRenderer | ||
textSnapshots : Vector.<Image>
If multiple snapshots are needed due to texture size limits, the
snapshots appearing after the first are stored here. | TextFieldTextRenderer |
Method | Defined By | ||
---|---|---|---|
Constructor. | TextFieldTextRenderer | ||
![]() | 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). | TextFieldTextRenderer | ||
![]() | 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 |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | TextFieldTextRenderer | ||
![]() | 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 | |
![]() | 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 | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | 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 |
antiAliasType | property |
antiAliasType:String
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
.
public function get antiAliasType():String
public function set antiAliasType(value:String):void
See also
background | property |
background:Boolean
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
.
public function get background():Boolean
public function set background(value:Boolean):void
See also
backgroundColor | property |
backgroundColor:uint
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
.
public function get backgroundColor():uint
public function set backgroundColor(value:uint):void
See also
baseline | property |
baseline:Number
[read-only] Returns the text baseline measurement, in pixels.
public function get baseline():Number
border | property |
border:Boolean
Specifies whether the text field has a border. Use the
borderColor
property to set the border color.
Note: this property cannot be used when the useGutter
property is set to false
(the default value!).
In the following example, the border is enabled:
textRenderer.border = true; textRenderer.borderColor = 0xff0000;
The default value is false
.
public function get border():Boolean
public function set border(value:Boolean):void
See also
borderColor | property |
borderColor:uint
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
.
public function get borderColor():uint
public function set borderColor(value:uint):void
See also
condenseWhite | property |
condenseWhite:Boolean
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
.
public function get condenseWhite():Boolean
public function set condenseWhite(value:Boolean):void
See also
disabledTextFormat | property |
disabledTextFormat:TextFormat
The font and styles used to draw the text when the component is disabled.
In the following example, the disabled text format is changed:
textRenderer.isEnabled = false; textRenderer.disabledTextFormat = new TextFormat( "Source Sans Pro" );
The default value is null
.
public function get disabledTextFormat():TextFormat
public function set disabledTextFormat(value:TextFormat):void
See also
displayAsPassword | property |
displayAsPassword:Boolean
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
.
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
See also
embedFonts | property |
embedFonts:Boolean
Determines if the TextField should use an embedded font or not. If the specified font is not embedded, the text is not displayed.
In the following example, the font is embedded:
textRenderer.embedFonts = true;
The default value is false
.
public function get embedFonts():Boolean
public function set embedFonts(value:Boolean):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all TextFieldTextRenderer
components.
The default value is null
.
See also
gridFitType | property |
gridFitType:String
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
.
public function get gridFitType():String
public function set gridFitType(value:String):void
See also
isHTML | property |
isHTML:Boolean
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
.
public function get isHTML():Boolean
public function set isHTML(value:Boolean):void
See also
maxTextureDimensions | property |
maxTextureDimensions:int
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
.
public function get maxTextureDimensions():int
public function set maxTextureDimensions(value:int):void
nativeFilters | property |
nativeFilters:Array
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
.
public function get nativeFilters():Array
public function set nativeFilters(value:Array):void
See also
sharpness | property |
sharpness:Number
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
.
public function get sharpness():Number
public function set sharpness(value:Number):void
See also
snapToPixels | property |
snapToPixels:Boolean
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.snapToPixels = false;
The default value is true
.
public function get snapToPixels():Boolean
public function set snapToPixels(value:Boolean):void
styleSheet | property |
styleSheet:StyleSheet
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
.
public function get styleSheet():StyleSheet
public function set styleSheet(value:StyleSheet):void
See also
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 ""
.
public function get text():String
public function set text(value:String):void
See also
textField | property |
protected var textField:TextField
The TextField instance used to render the text before taking a texture snapshot.
textFormat | property |
textFormat:TextFormat
The font and styles used to draw the text.
In the following example, the text format is changed:
textRenderer.textFormat = new TextFormat( "Source Sans Pro" );
The default value is null
.
public function get textFormat():TextFormat
public function set textFormat(value:TextFormat):void
See also
textSnapshot | property |
protected var textSnapshot:Image
An image that displays a snapshot of the native TextField
in the Starling display list when the editor doesn't have focus.
textSnapshots | property |
protected var textSnapshots:Vector.<Image>
If multiple snapshots are needed due to texture size limits, the snapshots appearing after the first are stored here.
thickness | property |
thickness:Number
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
.
public function get thickness():Number
public function set thickness(value:Number):void
See also
updateSnapshotOnScaleChange | property |
updateSnapshotOnScaleChange:Boolean
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
.
public function get updateSnapshotOnScaleChange():Boolean
public function set updateSnapshotOnScaleChange(value:Boolean):void
useGutter | property |
useGutter:Boolean
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.
In the following example, the gutter is enabled:
textEditor.useGutter = true;
The default value is false
.
public function get useGutter():Boolean
public function set useGutter(value:Boolean):void
useSnapshotDelayWorkaround | property |
useSnapshotDelayWorkaround:Boolean
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
.
public function get useSnapshotDelayWorkaround():Boolean
public function set useSnapshotDelayWorkaround(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
See also
TextFieldTextRenderer | () | Constructor |
public function TextFieldTextRenderer()
Constructor.
autoSizeIfNeeded | () | method |
protected function autoSizeIfNeeded():Boolean
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 setSizeInternal()
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.
ReturnsBoolean |
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 |