mx.core
接口public interface IUITextField extends IIMESupport , IFlexModule , IInvalidating , ISimpleStyleClient , IToolTipManagerClient , IUIComponent , IFlexDisplayObject , IFlexDisplayObject , IBitmapDrawable , IEventDispatcher
实现器 UITextField

IUITextField 接口为 UITextField 实例定义基本 API 集。



公共属性
 属性定义方
 InheritedaccessibilityProperties : AccessibilityProperties
此显示对象的当前辅助功能选项。
IFlexDisplayObject
 Inheritedalpha : Number
指示指定对象的 Alpha 透明度值。
IFlexDisplayObject
  alwaysShowSelection : Boolean
ITextField 接口为 flash.display.TextField 定义基本 API 集
IUITextField
  antiAliasType : String
用于此文本字段的消除锯齿类型。
IUITextField
  autoSize : String
控制文本字段的自动大小调整和对齐。
IUITextField
  background : Boolean
指定文本字段是否具有背景填充。
IUITextField
  backgroundColor : uint
文本字段背景的颜色。
IUITextField
 InheritedbaselinePosition : Number
[只读 (read-only)] 组件第一行文本的基线的 y 坐标。
IUIComponent
 InheritedblendMode : String
BlendMode 类中的一个值,用于指定要使用的混合模式。
IFlexDisplayObject
  border : Boolean
指定文本字段是否具有边框。
IUITextField
  borderColor : uint
文本字段边框的颜色。
IUITextField
  bottomScrollV : int
[只读 (read-only)] 一个整数(从 1 开始的索引),指示指定文本字段中当前可以看到的最后一行。
IUITextField
 InheritedcacheAsBitmap : Boolean
如果设置为 true,则 Flash Player 或 Adobe AIR 将缓存显示对象的内部位图表示形式。
IFlexDisplayObject
  caretIndex : int
[只读 (read-only)] 插入点(尖号)位置的索引。
IUITextField
  condenseWhite : Boolean
一个布尔值,指定是否删除具有 HTML 文本的文本字段中的额外空白(空格、换行符等等)。
IUITextField
  defaultTextFormat : TextFormat
指定应用于新插入文本(例如,用户输入的文本或使用 replaceSelectedText() 方法插入的文本)的格式。
IUITextField
  displayAsPassword : Boolean
指定文本字段是否是密码文本字段。
IUITextField
 Inheriteddocument : Object
对与此组件关联的文档对象的引用。
IUIComponent
  doubleClickEnabled : Boolean
指定此对象是否接收 doubleClick 事件。
IUITextField
  embedFonts : Boolean
指定是否使用嵌入字体轮廓进行呈现。
IUITextField
 Inheritedenabled : Boolean
组件是否可以接受用户交互。
IUIComponent
 InheritedexplicitHeight : Number
在组件坐标中显式指定的组件高度(以像素为单位)。
IUIComponent
 InheritedexplicitMaxHeight : Number
[只读 (read-only)] 在组件坐标中指定组件最大高度的数字(以像素为单位)。
IUIComponent
 InheritedexplicitMaxWidth : Number
[只读 (read-only)] 在组件坐标中指定组件最大宽度的数字(以像素为单位)。
IUIComponent
 InheritedexplicitMinHeight : Number
[只读 (read-only)] 在组件坐标中指定组件最小高度的数字(以像素为单位)。
IUIComponent
 InheritedexplicitMinWidth : Number
[只读 (read-only)] 在组件坐标中指定组件最小宽度的数字(以像素为单位)。
IUIComponent
 InheritedexplicitWidth : Number
在组件坐标中显式指定的组件宽度(以像素为单位)。
IUIComponent
 Inheritedfilters : Array
包含当前与显示对象关联的每个滤镜对象的索引数组。
IFlexDisplayObject
 InheritedfocusPane : Sprite
在组件中共享并用作绘图焦点叠加层的单个 Sprite 对象。
IUIComponent
  focusRect : Object
指定此对象是否显示焦点矩形。
IUITextField
  gridFitType : String
用于此文本字段的网格固定类型。
IUITextField
 Inheritedheight : Number
指示显示对象的高度,以像素为单位。
IFlexDisplayObject
  htmlText : String
包含文本字段内容的 HTML 表示形式。
IUITextField
  ignorePadding : Boolean
如果为 true,paddingLeft 和 paddingRight 样式不会在组件文本周围添加空间。
IUITextField
 InheritedimeMode : String
组件的 IME 模式。
IIMESupport
 InheritedincludeInLayout : Boolean
指定此组件是否包含在父容器的布局中。
IUIComponent
  inheritingStyles : Object
此 UITextField 继承样式链的起始位置。
IUITextField
 InheritedisPopUp : Boolean
PopUpManager 将其设置为 true 以指示已弹出该组件。
IUIComponent
  length : int
[只读 (read-only)] 文本字段中的字符数。
IUITextField
 InheritedloaderInfo : LoaderInfo
[只读 (read-only)] 返回一个 LoaderInfo 对象,其中包含加载此显示对象所属的文件的相关信息。
IFlexDisplayObject
 Inheritedmask : DisplayObject
调用显示对象被指定的 mask 对象遮罩。
IFlexDisplayObject
  maxChars : int
文本字段中最多可包含的字符数(即用户输入的字符数)。
IUITextField
 InheritedmaxHeight : Number
[只读 (read-only)] 在组件坐标中指定组件最大高度的数字(以像素为单位)。
IUIComponent
  maxScrollH : int
[只读 (read-only)] scrollH 的最大值。
IUITextField
  maxScrollV : int
[只读 (read-only)] scrollV 的最大值。
IUITextField
 InheritedmaxWidth : Number
[只读 (read-only)] 在组件坐标中指定组件最大宽度的数字(以像素为单位)。
IUIComponent
 InheritedmeasuredHeight : Number
[只读 (read-only)] 此对象的测量高度。
IFlexDisplayObject
 InheritedmeasuredMinHeight : Number
组件的默认最小高度(以像素为单位)。
IUIComponent
 InheritedmeasuredMinWidth : Number
组件的默认最小宽度(以像素为单位)。
IUIComponent
 InheritedmeasuredWidth : Number
[只读 (read-only)] 此对象的测量宽度。
IFlexDisplayObject
 InheritedminHeight : Number
[只读 (read-only)] 在组件坐标中指定组件最小高度的数字(以像素为单位)。
IUIComponent
 InheritedminWidth : Number
[只读 (read-only)] 在组件坐标中指定组件最小宽度的数字(以像素为单位)。
IUIComponent
  mouseEnabled : Boolean
指定此对象是否接收鼠标消息。
IUITextField
  mouseWheelEnabled : Boolean
一个布尔值,指示当用户单击某个文本字段并滚动鼠标滚轮时,Flash Player 是否自动滚动多行文本字段。
IUITextField
 InheritedmouseX : Number
[只读 (read-only)] 指示鼠标位置的 x 坐标,以像素为单位。
IFlexDisplayObject
 InheritedmouseY : Number
[只读 (read-only)] 指示鼠标位置的 y 坐标,以像素为单位。
IFlexDisplayObject
  multiline : Boolean
指示字段是否为多行文本字段。
IUITextField
 Inheritedname : String
指示 DisplayObject 的实例名称。
IFlexDisplayObject
  nestLevel : int
此对象在所属关系层次结构中的深度。
IUITextField
  nonInheritingStyles : Object
此 UITextField 非继承样式链的起始位置。
IUITextField
  nonZeroTextHeight : Number
[只读 (read-only)] 与 textHeight 不同,此方法将返回一个非零值,即使文本为空。
IUITextField
  numLines : int
[只读 (read-only)] 定义多行文本字段中的文本行数。
IUITextField
 InheritedopaqueBackground : Object
指定显示对象是否由于具有某种背景颜色而不透明。
IFlexDisplayObject
 Inheritedowner : DisplayObjectContainer
通常为此组件的父容器。
IUIComponent
 Inheritedparent : DisplayObjectContainer
[只读 (read-only)] 指示包含此显示对象的 DisplayObjectContainer 对象。
IFlexDisplayObject
 InheritedpercentHeight : Number
以组件父项大小百分比的方式指定组件高度的数字。
IUIComponent
 InheritedpercentWidth : Number
以组件父项大小百分比形式指定其宽度的数字。
IUIComponent
  restrict : String
指示用户可输入到文本字段中的字符集。
IUITextField
 Inheritedroot : DisplayObject
[只读 (read-only)] 此处介绍的几种方法通常只位于 IDisplayObject 中,但为了具有向后兼容性,在 IFlexDisplayObject 中还必须直接包含它们,因此这些方法存在于此独立的包含文件中。
IFlexDisplayObject
 Inheritedrotation : Number
指示 DisplayObject 实例距其原始方向的旋转程度,以度为单位。
IFlexDisplayObject
 Inheritedscale9Grid : Rectangle
当前有效的缩放网格。
IFlexDisplayObject
 InheritedscaleX : Number
指示从注册点开始应用的对象的水平缩放比例(百分比)。
IFlexDisplayObject
 InheritedscaleY : Number
指示从对象注册点开始应用的对象的垂直缩放比例(百分比)。
IFlexDisplayObject
  scrollH : int
当前水平滚动位置。
IUITextField
 InheritedscrollRect : Rectangle
显示对象的滚动矩形范围。
IFlexDisplayObject
  scrollV : int
文本在文本字段中的垂直位置。
IUITextField
  selectable : Boolean
一个布尔值,指示文本字段是否可选。
IUITextField
  selectionBeginIndex : int
[只读 (read-only)] 当前所选内容中第一个字符从零开始的字符索引值。
IUITextField
  selectionEndIndex : int
[只读 (read-only)] 当前所选内容中最后一个字符从零开始的字符索引值。
IUITextField
  sharpness : Number
此文本字段中字型边缘的清晰度。
IUITextField
 Inheritedstage : Stage
[只读 (read-only)] 显示对象的舞台。
IFlexDisplayObject
 InheritedstyleName : Object
该对象的样式值的源。
ISimpleStyleClient
  styleSheet : StyleSheet
将样式表附加到文本字段。
IUITextField
 InheritedsystemManager : ISystemManager
对此组件的 SystemManager 对象的引用。
IUIComponent
  tabEnabled : Boolean
此处的方法通常只位于 IInteractiveObject 中,但为了保持向后兼容,它们的始祖方法必须直接包含在 IFlexDisplayObject 中,因此这些方法还必须位于单独的包含文件中,以便在 ITextField 中使用
IUITextField
  tabIndex : int
指定 SWF 文件中的对象按 Tab 键顺序排列。
IUITextField
  text : String
作为文本字段中当前文本的字符串。
IUITextField
  textColor : uint
文本字段中文本的颜色(采用十六进制格式)。
IUITextField
  textHeight : Number
[只读 (read-only)] 文本的高度,以像素为单位。
IUITextField
  textWidth : Number
[只读 (read-only)] 文本的宽度,以像素为单位。
IUITextField
  thickness : Number
此文本字段中字型边缘的粗细。
IUITextField
 InheritedtoolTip : String
此组件的工具提示文本。
IToolTipManagerClient
 Inheritedtransform : Transform
一个对象,具有与显示对象的矩阵、颜色转换和像素范围有关的属性。
IFlexDisplayObject
 InheritedtweeningProperties : Array
由 EffectManager 使用。
IUIComponent
  type : String
文本字段的类型。
IUITextField
  useRichTextClipboard : Boolean
指定在复制和粘贴文本时是否同时复制和粘贴其格式。
IUITextField
 Inheritedvisible : Boolean
显示对象是否可见。
IFlexDisplayObject
 Inheritedwidth : Number
指示显示对象的宽度,以像素为单位。
IFlexDisplayObject
  wordWrap : Boolean
一个布尔值,指示文本字段是否自动换行。
IUITextField
 Inheritedx : Number
指示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。
IFlexDisplayObject
 Inheritedy : Number
指示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。
IFlexDisplayObject
公共方法
 方法定义方
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
IEventDispatcher
  
将 newText 参数指定的字符串追加到文本字段的文本的末尾。
IUITextField
 Inherited
将事件调度到事件流中。
IEventDispatcher
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
返回一个矩形,该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。
IFlexDisplayObject
  
返回一个矩形,该矩形是字符的边框。
IUITextField
  
在 x 和 y 参数指定的位置返回从零开始的字符索引值。
IUITextField
 Inherited
确定是使用显式高度还是测量高度的一种简便方法
IUIComponent
 Inherited
确定是使用显式宽度还是测量宽度的一种简便方法
IUIComponent
  
如果给定一个字符索引,则返回同一段落中第一个字符的索引。
IUITextField
  
返回给定 id 或已使用 <img> 标签添加到 HTML 格式文本字段中的图像或 SWF 文件的 DisplayObject 引用。
IUITextField
  
在 x 和 y 参数指定的位置返回从零开始的行索引值。
IUITextField
  
返回 charIndex 参数指定的字符所在的行的索引值(从零开始)。
IUITextField
  
getLineLength(lineIndex:int):int
返回特定文本行中的字符数。
IUITextField
  
返回给定文本行的度量信息。
IUITextField
  
getLineOffset(lineIndex:int):int
返回 lineIndex 参数指定的行中第一个字符的字符索引。
IUITextField
  
返回 lineIndex 参数指定的行的文本。
IUITextField
  
如果给定一个字符索引,则返回包含给定字符的段落的长度。
IUITextField
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
返回一个矩形,该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界,但不包括形状上的任何笔触。
IFlexDisplayObject
  
getStyle(styleProp:String):*
获取已在此组件的样式查找链中的某个位置设置过的样式属性。
IUITextField
  
getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
返回 TextFormat 对象,其中包含 beginIndex 和 endIndex 参数指定的文本范围的格式信息。
IUITextField
  
返回包含此组件的格式设置信息的 UITextFormat 对象。
IUITextField
 Inherited
将 point 对象从舞台(全局)坐标转换为显示对象的(本地)坐标。
IFlexDisplayObject
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
IEventDispatcher
 Inherited
计算显示对象,以确定它是否与 obj 显示对象重叠或相交。
IFlexDisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
计算显示对象,以确定它是否与 x 和 y 参数指定的点重叠或相交。
IFlexDisplayObject
 Inherited
初始化对象。
IUIComponent
 Inherited
调用此方法将导致在呈现显示列表前调用组件的 validateDisplayList() 方法。
IInvalidating
 Inherited
调用此方法将导致在呈现显示列表前调用组件的 validateProperties() 方法。
IInvalidating
 Inherited
调用此方法将导致在呈现显示列表前调用组件的 validateSize() 方法。
IInvalidating
 Inherited
将 point 对象从显示对象的(本地)坐标转换为舞台(全局)坐标。
IFlexDisplayObject
 Inherited
将此对象移动到指定的 x 和 y 坐标。
IFlexDisplayObject
 Inherited
如果 owner 属性链从 child 指向此 UIComponent,则返回 true。
IUIComponent
 Inherited
当在父项中添加或删除 UIComponent 对象时由 Flex 调用。
IUIComponent
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
IEventDispatcher
  
使用 value 参数的内容替换当前所选内容。
IUITextField
  
replaceText(beginIndex:int, endIndex:int, newText:String):void
使用 newText 参数的内容替换 beginIndex 和 endIndex 参数指定的字符范围。
IUITextField
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
设置此对象的实际大小。
IFlexDisplayObject
  
设置文本的字体颜色。
IUITextField
  
设置此组件的焦点。
IUITextField
  
setSelection(beginIndex:int, endIndex:int):void
将第一个字符和最后一个字符的索引值(使用 beginIndex 和 endIndex 参数指定)指定的文本设置为所选内容。
IUITextField
  
setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
将 format 参数指定的文本格式应用于文本字段中的指定文本。
IUITextField
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
当 visible 属性发生更改时调用。
IUIComponent
 Inherited
当样式属性的值发生更改时调用。
ISimpleStyleClient
  
truncateToFit(truncationIndicator:String = null):Boolean
截断文本使其在水平方向适合为控件定义的区域,并向文本追加省略号 (...)。
IUITextField
 Inherited
根据需要,通过立即调用 validateProperties()、validateSize() 和 validateDisplayList() 来验证并更新此对象的属性和布局。
IInvalidating
 Inherited
检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。
IEventDispatcher
属性详细信息
alwaysShowSelection属性
alwaysShowSelection:Boolean  [读写]

ITextField 接口为 flash.display.TextField 定义基本 API 集



实现
    public function get alwaysShowSelection():Boolean
    public function set alwaysShowSelection(value:Boolean):void
antiAliasType属性 
antiAliasType:String  [读写]

用于此文本字段的消除锯齿类型。将 flash.text.AntiAliasType 常数用于此属性。仅在字体为嵌入(即 embedFonts 属性设置为 true)时可以控制此设置。默认设置为 flash.text.AntiAliasType.NORMAL

若要设置此属性的值,请使用下列字符串值:

字符串值Description
flash.text.AntiAliasType.NORMAL 应用常规文本消除锯齿功能。 此值与 Flash Player 7 和早期版本中使用的消除锯齿的类型匹配。
flash.text.AntiAliasType.ADVANCED 应用高级消除锯齿功能,这增加了文本的可读性。(此功能在 Flash Player 8 中可用。) 高级消除锯齿功能可以高品质呈现小尺寸的字体。 它最适合在具有大量小字号文本的应用程序中使用。建议不要对大于 48 磅的字体使用高级消除锯齿功能。



实现
    public function get antiAliasType():String
    public function set antiAliasType(value:String):void
autoSize属性 
autoSize:String  [读写]

控制文本字段的自动大小调整和对齐。TextFieldAutoSize 常数的可接受值为 TextFieldAutoSize.NONE(默认值)、TextFieldAutoSize.LEFTTextFieldAutoSize.RIGHTTextFieldAutoSize.CENTER

如果 autoSize 设置为 TextFieldAutoSize.NONE(默认值),则不会进行调整。

如果 autoSize 设置为 TextFieldAutoSize.LEFT,会将文本视为左对齐文本,这意味着该文本字段的左边距保持固定,在右边可调整单个文本字段行。如果文本中包括换行符(例如 "\n""\r"),则会另外调整底边来适合文本的下一行。如果 wordWrap 也设置为 true,则仅调整文本字段的底边,而右边距保持固定。

如果 autoSize 设置为 TextFieldAutoSize.RIGHT,会将文本视为右对齐文本,这意味着该文本字段的右边距保持固定,可在左边调整单个文本字段行。如果文本中包括换行符(例如 "\n" or "\r")),则会另外调整底边来适合文本的下一行。如果 wordWrap 也设置为 true,则仅调整文本字段的底边,而左边距保持固定。

如果 autoSize 设置为 TextFieldAutoSize.CENTER,会将文本视为居中对齐文本,这意味着对单个文本字段行的调整将使其在左右边距间均衡分布。如果文本中包括换行符(例如 "\n""\r"),则会另外调整底边来适合文本的下一行。如果 wordWrap 也设置为 true,则仅调整文本字段的底边,而左右边距保持固定。



实现
    public function get autoSize():String
    public function set autoSize(value:String):void
background属性 
background:Boolean  [读写]

指定文本字段是否具有背景填充。如果为 true,则文本字段具有背景填充。如果为 false,则文本字段没有背景填充。使用 backgroundColor 属性来设置文本字段的背景颜色。



实现
    public function get background():Boolean
    public function set background(value:Boolean):void
backgroundColor属性 
backgroundColor:uint  [读写]

文本字段背景的颜色。默认值为 0xFFFFFF(白色)。即使当前没有背景,也可检索或设置此属性,但只有当文本字段已将 background 属性设置为 true 时,才可以看到颜色。



实现
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
border属性 
border:Boolean  [读写]

指定文本字段是否具有边框。如果为 true,则文本字段具有边框。如果为 false,则文本字段没有边框。使用 borderColor 属性来设置边框颜色。



实现
    public function get border():Boolean
    public function set border(value:Boolean):void
borderColor属性 
borderColor:uint  [读写]

文本字段边框的颜色。默认值为 0x000000(黑色)。即使当前没有边框,也可检索或设置此属性,但只有当文本字段已将 border 属性设置为 true 时,才可以看到颜色。



实现
    public function get borderColor():uint
    public function set borderColor(value:uint):void
bottomScrollV属性 
bottomScrollV:int  [只读 (read-only)]

一个整数(从 1 开始的索引),指示指定文本字段中当前可以看到的最后一行。可将文本字段看作文本块上的一个窗口。scrollV 属性是此窗口中最顶端可见行的从 1 开始的索引。

当前可以看到文本字段中 scrollVbottomScrollV 指示的行之间的所有文本。



实现
    public function get bottomScrollV():int
caretIndex属性 
caretIndex:int  [只读 (read-only)]

插入点(尖号)位置的索引。如果没有显示任何插入点,则在将焦点恢复到字段时,值将为插入点所在的位置(通常为插入点上次所在的位置,如果字段不曾具有焦点,则为 0)。

选择范围索引是从零开始的(例如,第一个位置为 0、第二个位置为 1,依此类推)。



实现
    public function get caretIndex():int
condenseWhite属性 
condenseWhite:Boolean  [读写]

一个布尔值,指定是否删除具有 HTML 文本的文本字段中的额外空白(空格、换行符等等)。默认值为 falsecondenseWhite 属性只影响使用 htmlText 属性(而非 text 属性)设置的文本。如果使用 text 属性设置文本,则忽略 condenseWhite

如果 condenseWhite 设置为 true,请使用标准 HTML 命令(如 <BR><P>),将换行符放在文本字段中。

在设置 htmlText 属性之前设置 condenseWhite 属性。



实现
    public function get condenseWhite():Boolean
    public function set condenseWhite(value:Boolean):void
defaultTextFormat属性 
defaultTextFormat:TextFormat  [读写]

指定应用于新插入文本(例如,用户输入的文本或使用 replaceSelectedText() 方法插入的文本)的格式。

注意:当选择要替换为 setSelection()replaceSelectedText() 的字符时,仅在选择的文本达到和包括最后字符时才会应用 defaultTextFormat。下面是一个示例:

var my_txt:TextField new TextField();
  my_txt.text = "Flash Macintosh version";
  var my_fmt:TextFormat = new TextFormat();
  my_fmt.color = 0xFF0000;
  my_txt.defaultTextFormat = my_fmt;
  my_txt.setSelection(6,15); // partial text selected - defaultTextFormat not applied
  my_txt.setSelection(6,23); // text selected to end - defaultTextFormat applied
  my_txt.replaceSelectedText("Windows version");

在访问 defaultTextFormat 属性时,返回的 TextFormat 对象已定义了它的所有属性。所有属性都不为 null

注意:如果对文本字段应用了样式表,则不能设置该属性。



实现
    public function get defaultTextFormat():TextFormat
    public function set defaultTextFormat(value:TextFormat):void
displayAsPassword属性 
displayAsPassword:Boolean  [读写]

指定文本字段是否是密码文本字段。 如果此属性的值为 true,则文本字段被视为密码文本字段,并使用星号而不是实际字符来隐藏输入的字符。如果为 false,则不会将文本字段视为密码文本字段。启用密码模式时,“剪切”和“复制”命令及其对应的键盘快捷键将不起作用。此安全机制可防止不良用户使用快捷键在无人看管的计算机上破译密码。



实现
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void
doubleClickEnabled属性 
doubleClickEnabled:Boolean  [读写]

指定此对象是否接收 doubleClick 事件。默认值为 false,这意味着在默认情况下,InteractiveObject 实例不接收 doubleClick 事件。如果将 doubleClickEnabled 属性设置为 true,实例在其范围内接收 doubleClick 事件。InteractiveObject 实例的 mouseEnabled 属性也必须设置为 true,以便对象能够接收 doubleClick 事件。

设置此属性不会调度任何事件。必须使用 addEventListener() 方法为 doubleClick 事件添加事件侦听器。



实现
    public function get doubleClickEnabled():Boolean
    public function set doubleClickEnabled(value:Boolean):void
embedFonts属性 
embedFonts:Boolean  [读写]

指定是否使用嵌入字体轮廓进行呈现。如果为 false,则 Flash Player 使用设备字体呈现文本字段。

如果将文本字段的 embedFonts 属性设置为 true,则必须使用应用于该文本字段的 TextFormat 对象的 font 属性来指定该文本的字体。如果指定的字体没有嵌入 SWF 文件中,则不会显示该文本。



实现
    public function get embedFonts():Boolean
    public function set embedFonts(value:Boolean):void
focusRect属性 
focusRect:Object  [读写]

指定此对象是否显示焦点矩形。它可以采用三个值中的一个:truefalsenulltruefalse 值按预期工作,指定是否显示焦点矩形。null 值指示此对象遵循舞台的 stageFocusRect 属性。



实现
    public function get focusRect():Object
    public function set focusRect(value:Object):void
gridFitType属性 
gridFitType:String  [读写]

用于此文本字段的网格固定类型。仅在文本字段的 flash.text.AntiAliasType 属性设置为 flash.text.AntiAliasType.ADVANCED 时才应用此属性。

使用的网格固定类型确定了 Flash Player 是否强制让粗水平线和垂直线适合像素网格或子像素网格。

对于 flash.text.GridFitType 属性,您可以使用下列字符串值:

字符串值Description
flash.text.GridFitType.NONE 指定无网格固定。不强制根据像素网格调整字型中的水平线和垂直线。 建议对动画或大号字使用此设置。
flash.text.GridFitType.PIXEL 指定粗水平线和垂直线适合像素网格。此设置仅适用于左对齐文本字段。若要使用此设置,文本字段的 flash.dispaly.AntiAliasType 属性必须设置为 flash.text.AntiAliasType.ADVANCED。此设置通常能为左对齐文本提供最佳可读性。
flash.text.GridFitType.SUBPIXEL 指定粗水平线和垂直线适合 LCD 显示器上的子像素网格。若要使用此设置,文本字段的 flash.text.AntiAliasType 属性必须设置为 flash.text.AntiAliasType.ADVANCEDflash.text.GridFitType.SUBPIXEL 设置通常适合右对齐或居中的动态文本,有时,为了在动画与文本品质之间达到一种平衡,也可使用此设置。



实现
    public function get gridFitType():String
    public function set gridFitType(value:String):void
htmlText属性 
htmlText:String  [读写]

包含文本字段内容的 HTML 表示形式。

Flash Player 支持以下 HTML 标签:

标签Description
锚标签 <a> 标签创建超文本链接并支持以下属性:
  • target:指定加载页面的目标窗口的名称。选项包括 _self_blank_parent_top_self 选项指定当前窗口中的当前帧,_blank 指定一个新窗口,_parent 指定当前帧的父级,而 _top 指定当前窗口中的顶级帧。
  • href:指定 URL 或 ActionScript link 事件。URL 可以是绝对路径或相对路径(相对于加载页的 SWF 文件的位置)。http://www.adobe.com 示例表示对 URL 的绝对引用;/index.html 示例表示相对引用。绝对 URL 必须以 http:// 为前缀,否则 Flash Player 或 AIR 会将其视为相对 URL。可以使用 link 事件使链接执行 SWF 文件中的 ActionScript 函数,而不是打开 URL。若要指定 link 事件,请在 href 属性中使用 event 方案,而不是 http 方案。例如,使用 href="event:myText" 而不是 href="http://myURL";当用户单击包含 event 方案的超文本链接时,文本字段将调度 link TextEvent,并将其 text 属性设置为“myText”。可随后创建一个 ActionScript 函数,每次调度 link TextEvent 时都会执行该函数。还可以使用样式表为锚标签定义 a:linka:hovera:active 样式。
粗体标签 <b> 标签以粗体形式呈现文本。粗体必须可用于所使用的字体。
换行标签 <br> 标签将在文本字段中创建一个换行符。 将文本字段设置为多行文本字段以使用此标签。
字体标签 <font> 标签指定一种字体或一个字体列表来显示文本。字体标签支持以下属性:
  • color:只支持十六进制颜色 (#FFFFFF) 值。
  • face:指定要使用的字体的名称。如下例所示,您可以指定一个以逗号分隔的字体名称的列表,在这种情况下,Flash Player 选择第一个可用字体。 如果本地计算机系统上未安装指定的字体,或 SWF 文件中未嵌入指定的字体,则 Flash Player 将选择替代字体。
  • size:指定字体的大小。您可以使用绝对像素大小(如 16 或 18),也可以使用相对磅值(如 +2 或 -4)。
图像标签 使用 <img> 标签可将外部图像文件(JPEG、GIF、PNG)、SWF 文件和影片剪辑嵌入到文本字段中。在文本字段中,文本在嵌入的图像旁自动换行。 您必须将文本字段设置为多行才能在图像周围绕排文本。

<img> 标签支持以下属性:

  • src:指定图像或 SWF 文件的 URL,或库中影片剪辑元件的链接标识符。此属性是必需的,所有其它属性都是可选的。外部文件(JPEG、GIF、PNG 和 SWF 文件)只有在完全下载之后才能显示。
  • width:所插入的图像、SWF 文件或影片剪辑的宽度(以像素为单位)。
  • height:所插入的图像、SWF 文件或影片剪辑的高度(以像素为单位)。
  • align:指定文本字段中嵌入图像的水平对齐方式。有效值为 leftright。默认值为 left
  • hspace:指定图像周围不显示任何文本的水平空间量。默认值为 8。
  • vspace:指定图像周围不显示任何文本的垂直空间量。默认值为 8。
  • id:指定包含嵌入的图像文件、SWF 文件或影片剪辑的影片剪辑实例(由 Flash Player 创建)的名称。此方法可用于使用 ActionScript 控制嵌入的内容。
  • checkPolicyFile:指定 Flash Player 将在与图像域相关的服务器上查找 URL 策略文件。如果存在策略文件,则此文件中列出的域中的 SWF 文件可以访问所加载的图像的数据,例如,通过使用此图像作为 source 参数来调用 BitmapData.draw() 方法。有关详细信息,请参阅《ActionScript 3.0 编程》中的“Flash Player 安全性”一章。

Flash 以完全大小显示文本字段中嵌入的媒体。 若要指定嵌入的媒体的尺寸,请使用 <img> 标签的 heightwidth 属性。

通常情况下,文本字段中嵌入的图像显示在 <img> 标签后的行上。 但是,如果 <img> 标签是文本字段中的第一个字符,则该图像显示在文本字段的第一行上。

对于应用程序安全沙箱中的 AIR 内容,AIR 会忽略 ActionScript TextField 对象的 HTML 内容中的 img 标签。这是为了防止可能发生的仿冒攻击,

斜体标签 <i> 标签以斜体形式显示标签中的文本。斜体必须可用于所使用的字体。
列表项标签 <li> 标签在所包含的文本前放置项目符号。注意:因为 Flash Player 和 AIR 无法识别有序和无序列表标签(<ol><ul>),所以这些标签无法修改列表的呈现方式。所有列表都是无序的,所有列表项都使用项目符号。
段落标签 <p> 标签创建一个新段落。 必须将文本字段设置为多行文本字段才能使用此标签。<p> 标签支持以下属性:
  • align:指定段落内文本的对齐方式;有效值为 leftrightjustifycenter
  • class:指定 flash.text.StyleSheet 对象定义的 CSS 样式类。
Span 标签 <span> 标签只可用于 CSS 文本样式。它支持以下属性:
  • class:指定 flash.text.StyleSheet 对象定义的 CSS 样式类。
文本格式标签

使用 <textformat> 标签可在文本字段中使用 TextFormat 类的段落格式设置属性的子集,其中包括行距、缩进、边距和 Tab 停靠位。您可以将 <textformat> 标签与内置 HTML 标签结合使用。

<textformat> 标签具有以下属性:

  • blockindent:指定块缩进(以磅为单位);对应于 TextFormat.blockIndent
  • indent:指定从左边距到段落中第一个字符的缩进;对应于 TextFormat.indent。正数和负数均可以接受。
  • leading:指定行与行之间的前导量(垂直间距);对应于 TextFormat.leading。正数和负数均可以接受。
  • leftmargin:指定段落的左边距(以磅为单位);对应于 TextFormat.leftMargin
  • rightmargin:指定段落的右边距(以磅为单位);对应于 TextFormat.rightMargin
  • tabstops:将自定义 Tab 停靠位指定为一个非负整数的数组;对应于 TextFormat.tabStops
下划线标签 <u> 标签为标签文本添加下划线。

Flash Player 和 AIR 支持以下 HTML 实体:

实体Description
<< (小于)
>> (大于)
&&(和)
""(双引号)
''(撇号,单引号)

Flash Player 和 AIR 还支持显式字符代码,如 &#38;(ASCII 和号)和 &#x20AC;(Unicode € 符号)。



实现
    public function get htmlText():String
    public function set htmlText(value:String):void
ignorePadding属性 
ignorePadding:Boolean  [读写]

如果为 truepaddingLeftpaddingRight 样式不会在组件文本周围添加空间。



实现
    public function get ignorePadding():Boolean
    public function set ignorePadding(value:Boolean):void
inheritingStyles属性 
inheritingStyles:Object  [读写]

此 UITextField 继承样式链的起始位置。getStyle() 方法访问 inheritingStyles[styleName] 以搜索整个原型链接的链。此对象由 initProtoChain() 方法设置。通常情况下,您不需要直接访问此属性。



实现
    public function get inheritingStyles():Object
    public function set inheritingStyles(value:Object):void
length属性 
length:int  [只读 (read-only)]

文本字段中的字符数。如 tab (\t) 之类的字符视为一个字符。



实现
    public function get length():int
maxChars属性 
maxChars:int  [读写]

文本字段中最多可包含的字符数(即用户输入的字符数)。脚本可以插入比 maxChars 允许的字符数更多的文本;maxChars 属性仅指示用户可以输入多少文本。如果此属性的值为 0,则用户可以输入无限数量的文本。



实现
    public function get maxChars():int
    public function set maxChars(value:int):void
maxScrollH属性 
maxScrollH:int  [只读 (read-only)]

scrollH 的最大值。



实现
    public function get maxScrollH():int
maxScrollV属性 
maxScrollV:int  [只读 (read-only)]

scrollV 的最大值。



实现
    public function get maxScrollV():int
mouseEnabled属性 
mouseEnabled:Boolean  [读写]

指定此对象是否接收鼠标消息。默认值为 true,这意味着在默认情况下,显示列表上的任何 InteractiveObject 实例均接收鼠标事件。如果将 mouseEnabled 设置为 false,实例不接收任何鼠标事件。显示列表上的该实例的任何子级都不会受到影响。要更改显示列表上对象的所有子级的 mouseEnabled 行为,请使用 flash.display.DisplayObjectContainer.mouseChildren

设置此属性不会调度任何事件。您必须使用 addEventListener() 方法才能创建交互式功能。



实现
    public function get mouseEnabled():Boolean
    public function set mouseEnabled(value:Boolean):void
mouseWheelEnabled属性 
mouseWheelEnabled:Boolean  [读写]

一个布尔值,指示当用户单击某个文本字段并滚动鼠标滚轮时,Flash Player 是否自动滚动多行文本字段。默认情况下,此值为 true。如果您想让文本字段在用户滚动鼠标滚轮时不随之滚动,或要实现您自己的文本字段滚动方式,可以使用此属性。



实现
    public function get mouseWheelEnabled():Boolean
    public function set mouseWheelEnabled(value:Boolean):void
multiline属性 
multiline:Boolean  [读写]

指示字段是否为多行文本字段。如果值为 true,则文本字段为多行文本字段;如果值为 false,则文本字段为单行文本字段。在类型为 TextFieldType.INPUT 的字段中,multiline 值将确定 Enter 键是否创建新行(如果值为 false,则将忽略 Enter 键)。如果将文本粘贴到其 multiline 值为 falseTextField 中,则文本中将除去新行。



实现
    public function get multiline():Boolean
    public function set multiline(value:Boolean):void
nestLevel属性 
nestLevel:int  [读写]

此对象在所属关系层次结构中的深度。测量和布局代码都使用此编号。如果 DisplayList 中没有此组件,则值为 0。



实现
    public function get nestLevel():int
    public function set nestLevel(value:int):void
nonInheritingStyles属性 
nonInheritingStyles:Object  [读写]

此 UITextField 非继承样式链的起始位置。getStyle() 方法访问 nonInheritingStyles[styleName] 方法以搜索整个原型链接的链。此对象由 initProtoChain() 方法设置。通常情况下,您不需要直接访问此属性。



实现
    public function get nonInheritingStyles():Object
    public function set nonInheritingStyles(value:Object):void
nonZeroTextHeight属性 
nonZeroTextHeight:Number  [只读 (read-only)]

与 textHeight 不同,此方法将返回一个非零值,即使文本为空。在这种情况下,它返回文本不为空的情况下 textHeight 的值。



实现
    public function get nonZeroTextHeight():Number
numLines属性 
numLines:int  [只读 (read-only)]

定义多行文本字段中的文本行数。如果 wordWrap 属性设置为 true,则在文本自动换行时会增加行数。



实现
    public function get numLines():int
restrict属性 
restrict:String  [读写]

指示用户可输入到文本字段中的字符集。如果 restrict 属性的值为 null,则可以输入任何字符。如果 restrict 属性的值为空字符串,则不能输入任何字符。如果 restrict 属性的值为一串字符,则只能在文本字段中输入该字符串中的字符。从左向右扫描该字符串。可以使用连字符 (-) 指定一个范围。 只限制用户交互;脚本可将任何文本放入文本字段中。

如果字符串以尖号 (^) 开头,则先接受所有字符,然后从接受字符集中排除字符串中 ^ 之后的字符。如果字符串不以尖号 (^) 开头,则最初不接受任何字符,然后将字符串中的字符包括在接受字符集中。

下例仅允许在文本字段中输入大写字符、空格和数字:

my_txt.restrict = "A-Z 0-9";

下例包含除小写字母之外的所有字符:

my_txt.restrict = "^a-z";

可以使用反斜杠输入 ^ 或 - 的本义。认可的反斜杠序列为 \-、\^ 或 \\。反斜杠在字符串中必须是一个本义字符,因此在 ActionScript 中指定时必须使用两个反斜杠。例如,下面的代码只包含短划线 (-) 和尖号 (^):

my_txt.restrict = "\\-\\^";

可在字符串中的任何位置使用 ^,以在包含字符与排除字符之间进行切换。下面的代码只包含除大写字母 Q 之外的大写字母:

my_txt.restrict = "A-Z^Q";

可以使用 u 转义序列构造 restrict 字符串。下面的代码只包含从 ASCII 32(空格)到 ASCII 126(代字号)之间的字符。

my_txt.restrict = "\u0020-\u007E";



实现
    public function get restrict():String
    public function set restrict(value:String):void
scrollH属性 
scrollH:int  [读写]

当前水平滚动位置。如果 scrollH 属性为 0,则不能水平滚动文本。此属性值是一个以像素为单位表示水平位置的整数。

水平滚动的单位是像素,而垂直滚动的单位是行。水平滚动以像素计量是因为您通常使用的大多数字体都是按比例隔开的;这意味着字符可以有不同的宽度。Flash Player 按行进行垂直滚动是因为用户通常希望看到完整的一行文本,而不是一行的局部。即使一行中包含多种字体,行的高度也会调整到与使用的最大字体相适合。

注意: scrollH 属性是从 0 开始的,不像 scrollV 垂直滚动属性是从 1 开始的。



实现
    public function get scrollH():int
    public function set scrollH(value:int):void
scrollV属性 
scrollV:int  [读写]

文本在文本字段中的垂直位置。scrollV 属性可帮助用户定位到长篇文章的特定段落,还可用于创建滚动文本字段。

垂直滚动的单位是行,而水平滚动的单位是像素。如果显示的第一行是文本字段中的第一行,则 scrollV 设置为 1(而非 0)。水平滚动以像素计量是因为大多数字体都是按比例隔开的;这意味着字符可以有不同的宽度。Flash 按行进行垂直滚动是因为用户通常希望看到完整的一行文本,而不是一行的局部。即使一行上有多种字体,行的高度也会调整到与使用的最大字体相适合。



实现
    public function get scrollV():int
    public function set scrollV(value:int):void
selectable属性 
selectable:Boolean  [读写]

一个布尔值,指示文本字段是否可选。值 true 表示文本可选。selectable 属性控制文本字段是否可选,而不控制文本字段是否可编辑。动态文本字段即使不可编辑,它也可能是可选的。如果动态文本字段是不可选的,则用户不能选择其中的文本。

如果 selectable 设置为 false,则文本字段中的文本不响应来自鼠标或键盘的选择命令,并且不能使用“复制”命令复制文本。如果 selectable 设置为 true,则可以使用鼠标或键盘选择文本字段中的文本,并且可以使用“复制”命令复制文本。即使文本字段是动态文本字段而不是输入文本字段,您也可以用这种方式选择文本。



实现
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void
selectionBeginIndex属性 
selectionBeginIndex:int  [只读 (read-only)]

当前所选内容中第一个字符从零开始的字符索引值。例如,第一个字符的索引值是 0,第二个字符的索引值是 1,依此类推。如果未选定任何文本,此属性为 caretIndex 的值。



实现
    public function get selectionBeginIndex():int
selectionEndIndex属性 
selectionEndIndex:int  [只读 (read-only)]

当前所选内容中最后一个字符从零开始的字符索引值。例如,第一个字符的索引值是 0,第二个字符的索引值是 1,依此类推。如果未选定任何文本,此属性为 caretIndex 的值。



实现
    public function get selectionEndIndex():int
sharpness属性 
sharpness:Number  [读写]

此文本字段中字型边缘的清晰度。仅在文本字段的 flash.text.AntiAliasType 属性设置为 flash.text.AntiAliasType.ADVANCED 时才应用此属性。sharpness 的范围是从 -400 到 400 的一个数字。如果尝试将 sharpness 设置为该范围外的值,则 Flash 会将该属性设置为范围内最接近的值(-400 或 400)。



实现
    public function get sharpness():Number
    public function set sharpness(value:Number):void
styleSheet属性 
styleSheet:StyleSheet  [读写]

将样式表附加到文本字段。有关创建样式表的信息,请参阅 StyleSheet 类和《ActionScript 3.0 编程》

您可以随时更改与文本字段相关的样式表。如果更改使用中的样式表,会使用新的样式表重绘文本字段。您可以将样式表设置为 nullundefined 以删除此样式表。如果删除正在使用的样式表,则不使用样式表重绘文本字段。

注意:如果删除样式表,则 TextField.text TextField.htmlText 的内容都将体现先前由该样式表应用的格式。若要保留不带格式的原始 TextField.htmlText 内容,请在删除样式表前将该值保存在变量中。



实现
    public function get styleSheet():StyleSheet
    public function set styleSheet(value:StyleSheet):void
tabEnabled属性 
tabEnabled:Boolean  [读写]

此处的方法通常只位于 IInteractiveObject 中,但为了保持向后兼容,它们的始祖方法必须直接包含在 IFlexDisplayObject 中,因此这些方法还必须位于单独的包含文件中,以便在 ITextField 中使用



实现
    public function get tabEnabled():Boolean
    public function set tabEnabled(value:Boolean):void
tabIndex属性 
tabIndex:int  [读写]

指定 SWF 文件中的对象按 Tab 键顺序排列。默认情况下,tabIndex 属性为 -1,这意味着没有为该对象设置任何 Tab 索引。

如果 SWF 文件中当前显示的任何对象包含 tabIndex 属性,则禁用 Tab 键自动排序,而使用该 SWF 文件中对象的 tabIndex 属性来计算 Tab 键顺序。这个自定义的 Tab 键排序仅包括指定了 tabIndex 属性的对象。

tabIndex 属性可以是非负整数。这些对象按照其 tabIndex 属性按升序进行排序。tabIndex 值为 1 的对象在 tabIndex 值为 2 的对象的前面。不要对多个对象使用相同的 tabIndex 值。

tabIndex 属性定义的自定义 Tab 键顺序为平构。这意味着不考虑 SWF 文件中对象的层次结构关系。SWF 文件中具有 tabIndex 属性的所有对象都排入 Tab 键顺序中,而 Tab 键顺序由 tabIndex 值的顺序确定。



实现
    public function get tabIndex():int
    public function set tabIndex(value:int):void
text属性 
text:String  [读写]

作为文本字段中当前文本的字符串。各行之间用回车符('\r',即 ASCII 13)分隔。此属性包含文本字段中的无格式文本,不带 HTML 标签。

若要获取 HTML 形式的文本,请使用 htmlText 属性。



实现
    public function get text():String
    public function set text(value:String):void
textColor属性 
textColor:uint  [读写]

文本字段中文本的颜色(采用十六进制格式)。十六进制颜色系统使用六位数表示颜色值。 每位数有 16 个可能的值或字符。字符范围从 0 到 9,然后从 A 到 F。例如,黑色是 0x000000;白色是 0xFFFFFF



实现
    public function get textColor():uint
    public function set textColor(value:uint):void
textHeight属性 
textHeight:Number  [只读 (read-only)]

文本的高度,以像素为单位。



实现
    public function get textHeight():Number
textWidth属性 
textWidth:Number  [只读 (read-only)]

文本的宽度,以像素为单位。



实现
    public function get textWidth():Number
thickness属性 
thickness:Number  [读写]

此文本字段中字型边缘的粗细。仅在 flash.text.AntiAliasType 设置为 flash.text.AntiAliasType.ADVANCED 时才可应用此属性。

thickness 的范围是从 -200 到 200 的一个数字。如果要尝试将 thickness 设置为该范围外的值,则该属性会设置为范围内最接近的值(-200 或 200)。



实现
    public function get thickness():Number
    public function set thickness(value:Number):void
type属性 
type:String  [读写]

文本字段的类型。以下 TextFieldType 常数中的任一个:TextFieldType.DYNAMIC(指定用户无法编辑的动态文本字段),或 TextFieldType.INPUT(指定用户可以编辑的输入文本字段)。



实现
    public function get type():String
    public function set type(value:String):void
useRichTextClipboard属性 
useRichTextClipboard:Boolean  [读写]

指定在复制和粘贴文本时是否同时复制和粘贴其格式。如果设置为 true,则在文本字段之间复制和粘贴时,Flash Player 也将复制和粘贴格式设置(例如,对齐方式、粗体和斜体)。复制和粘贴过程中的原始和目标文本字段必须已将 useRichTextClipboard 设置为 true。默认值为 false



实现
    public function get useRichTextClipboard():Boolean
    public function set useRichTextClipboard(value:Boolean):void
wordWrap属性 
wordWrap:Boolean  [读写]

一个布尔值,指示文本字段是否自动换行。 如果 wordWrap 的值为 true,则该文本字段自动换行;如果值为 false,则该文本字段不自动换行。默认值为 false



实现
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void
方法详细信息
appendText()方法
public function appendText(newText:String):void

newText 参数指定的字符串追加到文本字段的文本的末尾。此方法要比对 text 属性的加法赋值 (+=)(如 someTextField.text += moreText)更有效,对于包含大量内容的文本字段尤其有效。

参数

newText:String — 要追加到现有文本末尾的字符串。

getCharBoundaries()方法 
public function getCharBoundaries(charIndex:int):Rectangle

返回一个矩形,该矩形是字符的边框。

参数

charIndex:int — 从零开始的字符索引值(例如,第一个位置为 0,第二个位置为 1,依此类推)。

返回
Rectangle — 一个矩形,具有定义字符边框的 xy 最小值和最大值。
getCharIndexAtPoint()方法 
public function getCharIndexAtPoint(x:Number, y:Number):int

xy 参数指定的位置返回从零开始的字符索引值。

参数

x:Number — 字符的 x 坐标。
 
y:Number — 字符的 y 坐标。

返回
int — 从零开始的字符索引值(例如,第一个位置为 0,第二个位置为 1,依此类推)。如果该位置没有任何字符,则返回 -1。
getFirstCharInParagraph()方法 
public function getFirstCharInParagraph(charIndex:int):int

如果给定一个字符索引,则返回同一段落中第一个字符的索引。

参数

charIndex:int — 从零开始的字符索引值(例如,第一个字符的索引值是 0,第二个字符的索引值是 1,依此类推)。

返回
int — 同一段落中从零开始的第一个字符索引值。
getImageReference()方法 
public function getImageReference(id:String):DisplayObject

返回给定 id 或已使用 <img> 标签添加到 HTML 格式文本字段中的图像或 SWF 文件的 DisplayObject 引用。<img> 标签的格式如下:

              <img src = 'filename.jpg' id = 'instanceName' >
            

参数

id:String — 要匹配的 id(在 <img> 标签的 id 属性中)。

返回
DisplayObject — 与图像或 SWF 文件(在文本字段的 <img> 标签中具有匹配 id 属性)对应的显示对象。对于从外部源加载的媒体,此对象是 Loader 对象,加载后,媒体对象是该 Loader 对象的子项。 对于在 SWF 文件中嵌入的媒体,这是加载的对象。如果不存在具有匹配 id<img> 标签,则此方法会返回 null
getLineIndexAtPoint()方法 
public function getLineIndexAtPoint(x:Number, y:Number):int

xy 参数指定的位置返回从零开始的行索引值。

参数

x:Number — 行的 x 坐标。
 
y:Number — 行的 y 坐标。

返回
int — 从零开始的行索引值(例如,第一行的索引值是 0,第二行的索引值是 1,依此类推)。如果该位置没有任何行,则返回 -1。
getLineIndexOfChar()方法 
public function getLineIndexOfChar(charIndex:int):int

返回 charIndex 参数指定的字符所在的行的索引值(从零开始)。

参数

charIndex:int — 从零开始的字符索引值(例如,第一个字符的索引值是 0,第二个字符的索引值是 1,依此类推)。

返回
int — 从零开始的行索引值。
getLineLength()方法 
public function getLineLength(lineIndex:int):int

返回特定文本行中的字符数。

参数

lineIndex:int — 需要其长度的行号。

返回
int — 行中的字符数。
getLineMetrics()方法 
public function getLineMetrics(lineIndex:int):TextLineMetrics

返回给定文本行的度量信息。

参数

lineIndex:int — 需要相关度量信息的行号。

返回
TextLineMetrics — 一个 TextLineMetrics 对象。
getLineOffset()方法 
public function getLineOffset(lineIndex:int):int

返回 lineIndex 参数指定的行中第一个字符的字符索引。

参数

lineIndex:int — 从零开始的行索引值(例如,第一行的索引值是 0,第二行的索引值是 1,依此类推)。

返回
int — 行中第一个字符的索引值(从零开始)。
getLineText()方法 
public function getLineText(lineIndex:int):String

返回 lineIndex 参数指定的行的文本。

参数

lineIndex:int — 从零开始的行索引值(例如,第一行的索引值是 0,第二行的索引值是 1,依此类推)。

返回
String — 指定行中包含的文本字符串。
getParagraphLength()方法 
public function getParagraphLength(charIndex:int):int

如果给定一个字符索引,则返回包含给定字符的段落的长度。长度与段落中的第一个字符(由 getFirstCharInParagraph() 返回)有关,与传入的字符索引无关。

参数

charIndex:int — 从零开始的字符索引值(例如,第一个字符的索引值是 0,第二个字符的索引值是 1,依此类推)。

返回
int — 返回段落中的字符数。
getStyle()方法 
public function getStyle(styleProp:String):*

获取已在此组件的样式查找链中的某个位置设置过的样式属性。

因为此方法同样可用于获取任何类型的样式属性,所以返回值可能是 Boolean、String、Number、int、uint(用于 RGB 颜色)、Class(用于外观)或任何类型的对象。因此,只需将返回类型指定为 *。

如果要获取特定的样式属性,您需要了解其类型,而且通常希望将结果存储在该类型的某个变量中。无需将 * 转换为该类型。

var backgroundColor:uint = getStyle("backgroundColor");

如果尚未在样式查找链中设置该样式属性,则 getStyle() 返回的值将是 undefined。请注意,undefined 是一个特殊值,它与 false""NaN0null 均不同。如果没有有效的样式值,则总是 undefined。可以使用静态方法 StyleManager.isValidStyleValue() 来测试是否设置了值。

参数

styleProp:String — 样式属性的名称。

返回
* — 样式值。
getTextFormat()方法 
public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat

返回 TextFormat 对象,其中包含 beginIndexendIndex 参数指定的文本范围的格式信息。在生成的 TextFormat 对象中,只设置指定的整个文本共有的属性。所有混合型属性(意味着它在文本中的不同位置有不同的值)的值都为 null

如果没有为这些参数指定值,则此方法适用于文本字段中的所有文本。

下表描述三种可能的用法:

用法Description
my_textField.getTextFormat() 返回一个 TextFormat 对象,该对象包含文本字段中所有文本的格式设置信息。在结果 TextFormat 对象中只设置文本字段中所有文本共有的属性。所有混合型属性(意味着它在文本中的不同位置有不同的值)的值都为 null
my_textField.getTextFormat(beginIndex:Number) 返回一个 TextFormat 对象,其中包含 beginIndex 位置处字符的文本格式的一个副本。
my_textField.getTextFormat(beginIndex:Number,endIndex:Number) 返回一个 TextFormat 对象,该对象包含从 beginIndexendIndex-1 范围内文本的格式设置信息。在结果 TextFormat 对象中只设置特定范围内所有文本共有的属性。所有混合型属性(也就是说,在该范围内的不同位置有不同的值)的值都设置为 null

参数

beginIndex:int (default = -1) — 可选;一个指定文本字段中某段文本起始位置的整数。
 
endIndex:int (default = -1) — 可选;一个整数,指定所需文本范围后面的第一个字符的位置。正如所设计的一样,如果指定 beginIndexendIndex 值,则读取从 beginIndexendIndex-1 的文本。

返回
TextFormat — 表示指定文本格式设置属性的 TextFormat 对象。
getUITextFormat()方法 
public function getUITextFormat():UITextFormat

返回包含此组件的格式设置信息的 UITextFormat 对象。此方法与 flash.text.TextField 类的 getTextFormat() 方法类似,但它返回 UITextFormat 对象而不是 TextFormat 对象。

UITextFormat 类扩展 TextFormat 类以添加文本测量方法 measureText()measureHTMLText()

返回
UITextFormat — 包含此组件格式设置信息的对象。
replaceSelectedText()方法 
public function replaceSelectedText(value:String):void

使用 value 参数的内容替换当前所选内容。使用当前默认字符格式和默认段落格式,在当前所选内容的所在位置插入文本。不将该文本视为 HTML。

可以使用 replaceSelectedText() 方法插入和删除文本,而不破坏其余文本的字符和段落格式。

注意:如果已对文本字段应用了样式表,则此方法不起作用。

参数

value:String — 要替换当前所选文本的字符串。

replaceText()方法 
public function replaceText(beginIndex:int, endIndex:int, newText:String):void

beginIndexendIndex 参数指定的字符范围替换为 newText 参数的内容。正如所设计的一样,将替换从 beginIndexendIndex-1 的文本。

注意:如果已对文本字段应用了样式表,则此方法不起作用。

参数

beginIndex:int — 替换范围的开始位置处从零开始的索引值。
 
endIndex:int — 所需文本范围后面的第一个字符的从零开始的索引位置。
 
newText:String — 要用来替换指定范围字符的文本。

setColor()方法 
public function setColor(color:uint):void

设置文本的字体颜色。

参数

color:uint — 新的字体颜色。

setFocus()方法 
public function setFocus():void

设置此组件的焦点。组件可能依次将焦点传递给子组件。

注意:使用此方法设置焦点时,只有 TextInput 和 TextArea 控件加亮显示。当用户按 Tab 键切换控件时,所有控件都加亮显示。

setSelection()方法 
public function setSelection(beginIndex:int, endIndex:int):void

将第一个字符和最后一个字符的索引值(使用 beginIndexendIndex 参数指定)指定的文本设置为所选内容。 如果两个参数值相同,则此方法会设置插入点,就如同设置 caretIndex 属性一样。

参数

beginIndex:int — 所选内容中第一个字符从零开始的索引值(例如,第一个字符的索引值是 0,第二个字符的索引值是 1,依此类推)。
 
endIndex:int — 所选内容中最后一个字符从零开始的索引值。

setTextFormat()方法 
public function setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void

format 参数指定的文本格式应用于文本字段中的指定文本。format 的值必须是指定所需文本格式设置更改的 TextFormat 对象。只有 format 的非空属性才会应用到文本字段。不会应用 format 的设置为 null 的任何属性。默认情况下,新创建的 TextFormat 对象的所有属性都设置为 null

注意:如果已对文本字段应用了样式表,则此方法不起作用。

setTextFormat() 方法会更改应用于文本字段中一定范围的字符或整个文本的文本格式设置。 若要将 format 的属性应用于文本字段中的所有文本,请不要指定 beginIndexendIndex 的值。若要将 format 的属性应用于一定范围的文本,请指定 beginIndexendIndex 参数的值。可以使用 length 属性来确定索引值。

TextFormat 对象中包含两种类型的格式设置信息:字符级格式设置和段落级格式设置。 文本字段中的每个字符都可以有自己的字符格式设置,例如字体名称、字体大小、粗体和斜体。

对于段落,通过检查段落的第一个字符可了解整个段落的格式设置。 段落格式设置的示例有左边距、右边距和缩进。

对于用户手动插入的任何文本或通过 replaceSelectedText() 方法替换的任何文本,将接收默认的文本格式设置(而非为文本插入点指定的格式设置)以应用于新文本。若要为新文本设置默认格式,请使用 defaultTextFormat

参数

format:TextFormat — 一个包含字符和段落格式设置信息的 TextFormat 对象。
 
beginIndex:int (default = -1) — 可选;一个整数,指定所需文本范围内第一个字符的从零开始的索引位置。
 
endIndex:int (default = -1) — 可选;一个整数,指定所需文本范围后面的第一个字符。正如所设计的一样,如果指定 beginIndexendIndex 值,则更新从 beginIndexendIndex-1 的文本。

用法Description
my_textField.setTextFormat(textFormat:TextFormat) textFormat 的属性应用于文本字段中的所有文本。
my_textField.setTextFormat(textFormat:TextFormat, beginIndex:int) textFormat 的属性应用于从 beginIndex 处开始的文本。
my_textField.setTextFormat(textFormat:TextFormat, beginIndex:int, endIndex:int) textFormat 参数的属性应用于范围从 beginIndex 处到 endIndex-1 处的文本。

请注意,对于用户手动插入的任何文本或通过 replaceSelectedText() 方法替换的任何文本,将接收默认的文本格式设置(而非为文本插入点指定的格式设置)以应用于新文本。若要为新文本设置文本字段的默认格式设置,请使用 defaultTextFormat 属性。

truncateToFit()方法 
public function truncateToFit(truncationIndicator:String = null):Boolean

截断文本使其在水平方向适合为控件定义的区域,并向文本追加省略号 (...)。

参数

truncationIndicator:String (default = null) — 截断后追加的文本。如果传递 null,将使用可本地化的字符串,如 "..."

返回
Boolean — 如果此文本需要截断,则返回 true