UITextFormat

包	mx.core
类	public class UITextFormat
继承	UITextFormat TextFormat Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

UITextFormat 类给出 UITextField 类的字符格式设置信息。UITextField 类定义由许多 Flex 组合组件用来显示文本的组件。

UITextFormat 类扩展 flash.text.TextFormat 类以添加文本测量方法 measureText() 和 measureHTMLText()，并添加控制字体的高级消除锯齿功能的属性。

相关 API 元素

mx.core.UITextField

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		align : String 表示段落的对齐方式。	TextFormat
		antiAliasType : String 定义 UITextField 类的消除锯齿设置。	UITextFormat
		blockIndent : Object 表示块缩进，以像素为单位。	TextFormat
		bold : Object 指定文本是否为粗体字。	TextFormat
		bullet : Object 表示文本为带项目符号的列表的一部分。	TextFormat
		color : Object 表示文本的颜色。	TextFormat
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		direction : String 文本的方向性。	UITextFormat
		font : String 使用此文本格式的文本的字体名称，以字符串形式表示。	TextFormat
		gridFitType : String 定义 UITextField 类的网格固定设置。	UITextFormat
		indent : Object 表示从左边距到段落中第一个字符的缩进。	TextFormat
		italic : Object 表示使用此文本格式的文本是否为斜体。	TextFormat
		kerning : Object 一个布尔值，表示是启用 (true) 还是禁用 (false) 字距调整。	TextFormat
		leading : Object 一个整数，表示行与行之间的垂直间距（称为前导）量。	TextFormat
		leftMargin : Object 段落的左边距，以像素为单位。	TextFormat
		letterSpacing : Object 一个数字，表示在所有字符之间均匀分配的空间量。	TextFormat
		locale : String 文本的区域设置。	UITextFormat
		moduleFactory : IFlexModuleFactory 用于创建嵌入字体的 TextField 的 moduleFactory。	UITextFormat
		rightMargin : Object 段落的右边距，以像素为单位。	TextFormat
		sharpness : Number 定义 UITextField 类的清晰度设置。	UITextFormat
		size : Object 使用此文本格式的文本的大小（以像素为单位）。	TextFormat
		tabStops : Array 将自定义 Tab 停靠位指定为一个非负整数的数组。	TextFormat
		target : String 表示显示超链接的目标窗口。	TextFormat
		thickness : Number 定义 UITextField 类的粗细设置。	UITextFormat
		underline : Object 表示使用此文本格式的文本是带下划线 (true) 还是不带下划线 (false)。	TextFormat
		url : String 表示使用此文本格式的文本的目标 URL。	TextFormat
		useFTE : Boolean = false 确定 measureText() 和 measureHTMLText() 方法如何进行文本测量。	UITextFormat

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		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) 构造函数。	UITextFormat
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		measureHTMLText(htmlText:String, roundUp:Boolean = true):flash.text:TextLineMetrics 返回指定 HTML 文本的测量信息，该文本可能包含 HTML 标签（如 <font> 和 <b>），假设该文本显示在单行 UITextField 中并使用此 UITextFormat 对象定义文本格式。	UITextFormat
		measureText(text:String, roundUp:Boolean = true):flash.text:TextLineMetrics 返回指定文本的测量信息，假设文本显示在单行 UITextField 组件中并使用此 UITextFormat 对象定义文本格式。	UITextFormat
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object

属性详细信息

antiAliasType

属性

public var antiAliasType:String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

定义 UITextField 类的消除锯齿设置。可能值为 "normal" (flash.text.AntiAliasType.NORMAL) 和 "advanced" (flash.text.AntiAliasType.ADVANCED)。

默认值为 "advanced"，该值将对嵌入字体启用高级消除锯齿功能。将此属性设置为 "normal" 可禁用高级消除锯齿功能。

此属性对系统字体不起作用。

此属性应用于 UITextField 对象中的所有文本；但不能将其应用于部分字符以及其他对象中的文本。

默认值为 "advanced"。

相关 API 元素

flash.text.AntiAliasType

direction

属性

public var direction:String

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

文本的方向性。

允许的值为“ltr”（适用于从左到右文本，就像在拉丁样式脚本中一样）和“rtl”（适用于从右到左文本，就像在阿拉伯语和希伯来语中一样）。

FTE 和 TLF 在其双向文本布局算法中使用此值，该算法会将 Unicode 字符顺序映射到字型顺序。

注意：此样式只应用于当该 UITextFormat 与 UIFTETextField（而非 UITextField）一起使用时。

默认值为 null。

gridFitType

属性

public var gridFitType:String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

定义 UITextField 类的网格固定设置。可能值为 "none" (flash.text.GridFitType.NONE)、"pixel" (flash.text.GridFitType.PIXEL) 和"subpixel" (flash.text.GridFitType.SUBPIXEL)。

仅当使用嵌入字体并将 fontAntiAliasType 属性设置为 "advanced" 时，才应用此属性。

此属性对系统字体不起作用。

此属性应用于 UITextField 对象中的所有文本；但不能将其应用于部分字符以及其他对象中的文本。

默认值为 "pixel"。

相关 API 元素

flash.text.GridFitType

locale

属性

public var locale:String

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

文本的区域设置。

FTE 和 TLF 使用此区域设置将 Unicode 字符映射到字体字型并查找后备字体。

注意：此样式只应用于当该 UITextFormat 与 UIFTETextField（而非 UITextField）一起使用时。

默认值为 null。

moduleFactory

属性

moduleFactory:IFlexModuleFactory

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

用于创建嵌入字体的 TextField 的 moduleFactory。

实现
public function get moduleFactory():IFlexModuleFactory
public function set moduleFactory(value:IFlexModuleFactory):void

sharpness

属性

public var sharpness:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

定义 UITextField 类的清晰度设置。此属性指定字型边缘的清晰度。可能值为从 -400 到 400 之间的数字。

仅当使用嵌入字体并将 fontAntiAliasType 属性设置为 "advanced" 时，才应用此属性。

此属性对系统字体不起作用。

此属性应用于 UITextField 对象中的所有文本；但不能将其应用于部分字符以及其他对象中的文本。

默认值为 0。

相关 API 元素

flash.text.TextField

thickness

属性

public var thickness:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

定义 UITextField 类的粗细设置。此属性指定字型边缘的粗细。可能值为从 -200 到 200 之间的数字。

仅当使用嵌入字体并将 fontAntiAliasType 属性设置为 "advanced" 时，才应用此属性。

此属性对系统字体不起作用。

此属性应用于 UITextField 对象中的所有文本；但不能将其应用于部分字符以及其他对象中的文本。

默认值为 0。

相关 API 元素

flash.text.TextField

useFTE

属性

public var useFTE:Boolean = false

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定 measureText() 和 measureHTMLText() 方法如何进行文本测量。

如果为 true，则这些方法使用 Text Layout Framework 中的 FTETextField 类的屏幕外实例。如果为 false，则这些方法使用 Flash Player 中的 TextField 类的屏幕外实例。

默认值为 false。

构造函数详细信息

()

构造函数

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)

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

构造函数。

参数

	`systemManager:ISystemManager` — SystemManager 对象。SystemManager 跟踪嵌入的字体。通常，这是从 UIComponent 的 `systemManager` 属性中获得的 SystemManager。

	`font:String` (default = `null`) — 指定字体名称的 String；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`size:Object` (default = `null`) — 指定字体大小（以像素为单位）的 Number；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`color:Object` (default = `null`) — 指定文本 RGB 颜色的无符号整数（如 0xFF0000 为红色）；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`bold:Object` (default = `null`) — 指定文本是否使用粗体的布尔值标志；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`italic:Object` (default = `null`) — 指定文本是否使用斜体的布尔值标志；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`underline:Object` (default = `null`) — 指定文本是否使用下划线的布尔值标志；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`url:String` (default = `null`) — 指定文本超链接到的 URL 的 String；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`target:String` (default = `null`) — 指定显示超链接 URL 的目标窗口的 String。如果目标窗口为 `null` 或空字符串，则超链接页面显示在同一浏览器窗口中。如果 `urlString` 参数为 `null` 或空字符串，则此属性不发挥作用。此参数是可选的，默认值为 `null`。

	`align:String` (default = `null`) — 指定段落对齐方式的 String（使用 flash.text.TextFormatAlign 值表示）；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`leftMargin:Object` (default = `null`) — 指定段落左边距（以像素为单位）的 Number；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`rightMargin:Object` (default = `null`) — 指定段落右边距（以像素为单位）的 Number；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`indent:Object` (default = `null`) — 指定从左边距到段落中第一个字符的缩进（以像素为单位）的 Number；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

	`leading:Object` (default = `null`) — 指定行与行之间的其他垂直间距量的 Number；或 `null` 以指示此 UITextFormat 不指定此属性。此参数是可选的，默认值为 `null`。

相关 API 元素

flash.text.TextFormatAlign

方法详细信息

measureHTMLText

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回指定 HTML 文本的测量信息，该文本可能包含 HTML 标签（如 <font> 和 <b>），假设该文本显示在单行 UITextField 中并使用此 UITextFormat 对象定义文本格式。

参数

	`htmlText:String` — 指定要测量的 HTML 文本的 String。

	`roundUp:Boolean` (default = `true`) — 指定是否将测量宽度和高度向上舍入为最接近的整数的布尔值标志。向上舍入适用于大多数情况。

flash.text:TextLineMetrics — 包含文本度量值的 TextLineMetrics 对象。

相关 API 元素

flash.text.TextLineMetrics

measureText

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回指定文本的测量信息，假设文本显示在单行 UITextField 组件中并使用此 UITextFormat 对象定义文本格式。

参数

	`text:String` — 指定要测量的文本的 String。

	`roundUp:Boolean` (default = `true`) — 指定是否将测量宽度和高度向上舍入为最接近的整数的布尔值标志。向上舍入适用于大多数情况。

flash.text:TextLineMetrics — 包含文本度量值的 TextLineMetrics 对象。

相关 API 元素

flash.text.TextLineMetrics

法律声明 | 在线隐私策略

UITextFormat - AS3 Flex

包x

语言元素

附录

包 mx.core

antiAliasType

direction

gridFitType

locale

moduleFactory

sharpness

thickness

useFTE

UITextFormat

measureHTMLText

measureText