ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.core 

UITextFormat  - AS3 Flex

Packagemx.core
Classpublic class UITextFormat
InheritanceUITextFormat Inheritance TextFormat Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The UITextFormat class represents character formatting information for the UITextField class. The UITextField class defines the component used by many Flex composite components to display text.

The UITextFormat class extends the flash.text.TextFormat class to add the text measurement methods measureText() and measureHTMLText() and to add properties for controlling the advanced anti-aliasing of fonts.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedalign : String
Indicates the alignment of the paragraph.
TextFormat
  antiAliasType : String
Defines the anti-aliasing setting for the UITextField class.
UITextFormat
 InheritedblockIndent : Object
Indicates the block indentation in pixels.
TextFormat
 Inheritedbold : Object
Specifies whether the text is boldface.
TextFormat
 Inheritedbullet : Object
Indicates that the text is part of a bulleted list.
TextFormat
 Inheritedcolor : Object
Indicates the color of the text.
TextFormat
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  direction : String
The directionality of the text.
UITextFormat
 Inheritedfont : String
The name of the font for text in this text format, as a string.
TextFormat
  gridFitType : String
Defines the grid-fitting setting for the UITextField class.
UITextFormat
 Inheritedindent : Object
Indicates the indentation from the left margin to the first character in the paragraph.
TextFormat
 Inheriteditalic : Object
Indicates whether text in this text format is italicized.
TextFormat
 Inheritedkerning : Object
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
TextFormat
 Inheritedleading : Object
An integer representing the amount of vertical space (called leading) between lines.
TextFormat
 InheritedleftMargin : Object
The left margin of the paragraph, in pixels.
TextFormat
 InheritedletterSpacing : Object
A number representing the amount of space that is uniformly distributed between all characters.
TextFormat
  locale : String
The locale of the text.
UITextFormat
  moduleFactory : IFlexModuleFactory
The moduleFactory used to create TextFields for embedded fonts.
UITextFormat
 InheritedrightMargin : Object
The right margin of the paragraph, in pixels.
TextFormat
  sharpness : Number
Defines the sharpness setting for the UITextField class.
UITextFormat
 Inheritedsize : Object
The size in pixels of text in this text format.
TextFormat
 InheritedtabStops : Array
Specifies custom tab stops as an array of non-negative integers.
TextFormat
 Inheritedtarget : String
Indicates the target window where the hyperlink is displayed.
TextFormat
  thickness : Number
Defines the thickness setting for the UITextField class.
UITextFormat
 Inheritedunderline : Object
Indicates whether the text that uses this text format is underlined (true) or not (false).
TextFormat
 Inheritedurl : String
Indicates the target URL for the text in this text format.
TextFormat
  useFTE : Boolean = false
Determines how the measureText() and measureHTMLText() methods do text measurement.
UITextFormat
Public Methods
 MethodDefined By
  
UITextFormat(systemManager:ISystemManager, font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)
Constructor.
UITextFormat
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Returns measurement information for the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField, and using this UITextFormat object to define the text format.
UITextFormat
  
Returns measurement information for the specified text, assuming that it is displayed in a single-line UITextField component, and using this UITextFormat object to define the text format.
UITextFormat
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

antiAliasType

property
public var antiAliasType:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Defines the anti-aliasing setting for the UITextField class. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables advanced anti-aliasing for the embedded font. Set this property to "normal" to disable the advanced anti-aliasing.

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is "advanced".

Related API Elements

direction

property 
public var direction:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The directionality of the text.

The allowed values are "ltr" for left-to-right text, as in Latin-style scripts, and "rtl" for right-to-left text, as in Arabic and Hebrew.

FTE and TLF use this value in their bidirectional text layout algorithm, which maps Unicode character order to glyph order.

Note: This style only applies when this UITextFormat is used with a UIFTETextField rather than a UITextField.

The default value is null.

gridFitType

property 
public var gridFitType:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Defines the grid-fitting setting for the UITextField class. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is "pixel".

Related API Elements

locale

property 
public var locale:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The locale of the text.

FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts.

Note: This style only applies when this UITextFormat is used with a UIFTETextField rather than a UITextField.

The default value is null.

moduleFactory

property 
moduleFactory:IFlexModuleFactory

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The moduleFactory used to create TextFields for embedded fonts.



Implementation
    public function get moduleFactory():IFlexModuleFactory
    public function set moduleFactory(value:IFlexModuleFactory):void

sharpness

property 
public var sharpness:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Defines the sharpness setting for the UITextField class. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is 0.

Related API Elements

thickness

property 
public var thickness:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Defines the thickness setting for the UITextField class. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is 0.

Related API Elements

useFTE

property 
public var useFTE:Boolean = false

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Determines how the measureText() and measureHTMLText() methods do text measurement.

If true, they use an offscreen instance of the FTETextField class in the Text Layout Framework. If false, they use an offscreen instance of the TextField class in the Flash Player.

The default value is false.

Constructor Detail

UITextFormat

()Constructor
public function UITextFormat(systemManager:ISystemManager, font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
systemManager:ISystemManager — A SystemManager object. The SystemManager keeps track of which fonts are embedded. Typically this is the SystemManager obtained from the systemManager property of UIComponent.
 
font:String (default = null) — A String specifying the name of a font, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
size:Object (default = null) — A Number specifying a font size in pixels, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
color:Object (default = null) — An unsigned integer specifying the RGB color of the text, such as 0xFF0000 for red, or null to indicate that is UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
bold:Object (default = null) — A Boolean flag specifying whether the text is bold, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
italic:Object (default = null) — A Boolean flag specifying whether the text is italic, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
underline:Object (default = null) — A Boolean flag specifying whether the text is underlined, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
url:String (default = null) — A String specifying the URL to which the text is hyperlinked, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
target:String (default = null) — A String specifying the target window where the hyperlinked URL is displayed. If the target window is null or an empty string, the hyperlinked page is displayed in the same browser window. If the urlString parameter is null or an empty string, this property has no effect. This parameter is optional, with a default value of null.
 
align:String (default = null) — A String specifying the alignment of the paragraph, as a flash.text.TextFormatAlign value, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
leftMargin:Object (default = null) — A Number specifying the left margin of the paragraph, in pixels, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
rightMargin:Object (default = null) — A Number specifying the right margin of the paragraph, in pixels, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
indent:Object (default = null) — A Number specifying the indentation from the left margin to the first character in the paragraph, in pixels, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.
 
leading:Object (default = null) — A Number specifying the amount of additional vertical space between lines, or null to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of null.

Related API Elements

Method Detail

measureHTMLText

()method
public function measureHTMLText(htmlText:String, roundUp:Boolean = true):flash.text:TextLineMetrics

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns measurement information for the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField, and using this UITextFormat object to define the text format.

Parameters

htmlText:String — A String specifying the HTML text to measure.
 
roundUp:Boolean (default = true) — A Boolean flag specifying whether to round up the the measured width and height to the nearest integer. Rounding up is appropriate in most circumstances.

Returns
flash.text:TextLineMetrics — A TextLineMetrics object containing the text measurements.

Related API Elements

measureText

()method 
public function measureText(text:String, roundUp:Boolean = true):flash.text:TextLineMetrics

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns measurement information for the specified text, assuming that it is displayed in a single-line UITextField component, and using this UITextFormat object to define the text format.

Parameters

text:String — A String specifying the text to measure.
 
roundUp:Boolean (default = true) — A Boolean flag specifying whether to round up the the measured width and height to the nearest integer. Rounding up is appropriate in most circumstances.

Returns
flash.text:TextLineMetrics — A TextLineMetrics object containing the text measurements.

Related API Elements