flash.text
public class TextField
继承TextField Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
子类 FlexTextField

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

TextField 类用于创建显示对象以显示和输入文本。SWF 文件中的所有动态文本字段和输入文本字段都是 TextField 类的实例。可以使用 TextField 类执行低级文本呈现。但是,在 Flex 中,您通常使用 Label、Text、TextArea 和 TextInput 控件来处理文本。

若要动态创建文本字段,请使用 TextField() 构造函数。

TextField 类的方法允许您设置、选择并操作在创作过程中或运行时创建的动态或输入文本字段中的文本。

ActionScript 提供了多种在运行时设置文本格式的方法。TextFormat 类允许您设置 TextField 对象的字符和段落格式。您可以使用 TextField.styleSheet 属性和 StyleSheet 类来对文本字段应用层叠样式表 (CSS) 样式。您可以使用 CSS 设置内置 HTML 标签的样式、定义新的格式设置标签或应用样式。 可以将 HTML 格式的文本(该文本可以选择使用 CSS 样式)直接分配给文本字段。分配给文本字段的 HTML 文本可以包含嵌入的媒体(影片剪辑、SWF 文件、GIF 文件、PNG 文件和 JPEG 文件)。 文本在嵌入的媒体旁自动换行,这与 Web 浏览器的文本在 HTML 文档中嵌入的媒体旁换行非常类似。

Flash Player 还支持部分 HTML 标签,可以使用这些 HTML 标签设置文本格式。要查看受支持 HTML 标签的列表,请参阅对 htmlText 属性的描述。

查看示例

另请参见

flash.text.TextFormat
flash.text.StyleSheet
Core display classes
Basics of working with text


公共属性
 属性定义方
 InheritedaccessibilityProperties : AccessibilityProperties
此显示对象的当前辅助功能选项。
DisplayObject
 Inheritedalpha : Number
指示指定对象的 Alpha 透明度值。
DisplayObject
  alwaysShowSelection : Boolean
如果设置为 true 且文本字段没有焦点,Flash Player 将以灰色突出显示文本字段中的所选内容。
TextField
  antiAliasType : String
用于此文本字段的消除锯齿类型。
TextField
  autoSize : String
控制文本字段的自动大小调整和对齐。
TextField
  background : Boolean
指定文本字段是否具有背景填充。
TextField
  backgroundColor : uint
文本字段背景的颜色。
TextField
 InheritedblendMode : String
BlendMode 类中的一个值,用于指定要使用的混合模式。
DisplayObject
 InheritedblendShader : Shader
[只写] 设置用于混合前景和背景的着色器。
DisplayObject
  border : Boolean
指定文本字段是否具有边框。
TextField
  borderColor : uint
文本字段边框的颜色。
TextField
  bottomScrollV : int
[只读 (read-only)] 一个整数(从 1 开始的索引),指示指定文本字段中当前可以看到的最后一行。
TextField
 InheritedcacheAsBitmap : Boolean
如果设置为 true,则 Flash Player 或 Adobe AIR 将缓存显示对象的内部位图表示形式。
DisplayObject
  caretIndex : int
[只读 (read-only)] 插入点(尖号)位置的索引。
TextField
  condenseWhite : Boolean
一个布尔值,指定是否删除具有 HTML 文本的文本字段中的额外空白(空格、换行符等等)。
TextField
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
 InheritedcontextMenu : NativeMenu
指定与此对象相关联的上下文菜单。
InteractiveObject
  defaultTextFormat : TextFormat
指定应用于新插入文本(例如,用户输入的文本或使用 replaceSelectedText() 方法插入的文本)的格式。
TextField
  displayAsPassword : Boolean
指定文本字段是否是密码文本字段。
TextField
 InheriteddoubleClickEnabled : Boolean
指定此对象是否接收 doubleClick 事件。
InteractiveObject
  embedFonts : Boolean
指定是否使用嵌入字体轮廓进行呈现。
TextField
 Inheritedfilters : Array
包含当前与显示对象关联的每个滤镜对象的索引数组。
DisplayObject
 InheritedfocusRect : Object
指定此对象是否显示焦点矩形。
InteractiveObject
  gridFitType : String
用于此文本字段的网格固定类型。
TextField
 Inheritedheight : Number
指示显示对象的高度,以像素为单位。
DisplayObject
  htmlText : String
包含文本字段内容的 HTML 表示形式。
TextField
  length : int
[只读 (read-only)] 文本字段中的字符数。
TextField
 InheritedloaderInfo : LoaderInfo
[只读 (read-only)] 返回一个 LoaderInfo 对象,其中包含加载此显示对象所属的文件的相关信息。
DisplayObject
 Inheritedmask : DisplayObject
调用显示对象被指定的 mask 对象遮罩。
DisplayObject
  maxChars : int
文本字段中最多可包含的字符数(即用户输入的字符数)。
TextField
  maxScrollH : int
[只读 (read-only)] scrollH 的最大值。
TextField
  maxScrollV : int
[只读 (read-only)] scrollV 的最大值。
TextField
 InheritedmouseEnabled : Boolean
指定此对象是否接收鼠标消息。
InteractiveObject
  mouseWheelEnabled : Boolean
一个布尔值,指示当用户单击某个文本字段并滚动鼠标滚轮时,Flash Player 是否自动滚动多行文本字段。
TextField
 InheritedmouseX : Number
[只读 (read-only)] 指示鼠标位置的 x 坐标,以像素为单位。
DisplayObject
 InheritedmouseY : Number
[只读 (read-only)] 指示鼠标位置的 y 坐标,以像素为单位。
DisplayObject
  multiline : Boolean
指示字段是否为多行文本字段。
TextField
 Inheritedname : String
指示 DisplayObject 的实例名称。
DisplayObject
  numLines : int
[只读 (read-only)] 定义多行文本字段中的文本行数。
TextField
 InheritedopaqueBackground : Object
指定显示对象是否由于具有某种背景颜色而不透明。
DisplayObject
 Inheritedparent : DisplayObjectContainer
[只读 (read-only)] 指示包含此显示对象的 DisplayObjectContainer 对象。
DisplayObject
 Inheritedprototype : Object
[静态] 对类或函数对象的原型对象的引用。
Object
  restrict : String
指示用户可输入到文本字段中的字符集。
TextField
 Inheritedroot : DisplayObject
[只读 (read-only)] 对于加载的 SWF 文件中的显示对象,root 属性是此 SWF 文件所表示的显示列表树结构部分中的顶级显示对象。
DisplayObject
 Inheritedrotation : Number
指示 DisplayObject 实例距其原始方向的旋转程度,以度为单位。
DisplayObject
 InheritedrotationX : Number
指示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 x 轴旋转(以度为单位)。
DisplayObject
 InheritedrotationY : Number
指示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 y 轴旋转(以度为单位)。
DisplayObject
 InheritedrotationZ : Number
指示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 z 轴旋转(以度为单位)。
DisplayObject
 Inheritedscale9Grid : Rectangle
当前有效的缩放网格。
DisplayObject
 InheritedscaleX : Number
指示从注册点开始应用的对象的水平缩放比例(百分比)。
DisplayObject
 InheritedscaleY : Number
指示从对象注册点开始应用的对象的垂直缩放比例(百分比)。
DisplayObject
 InheritedscaleZ : Number
指示从对象的注册点开始应用的对象的深度缩放比例(百分比)。
DisplayObject
  scrollH : int
当前水平滚动位置。
TextField
 InheritedscrollRect : Rectangle
显示对象的滚动矩形范围。
DisplayObject
  scrollV : int
文本在文本字段中的垂直位置。
TextField
  selectable : Boolean
一个布尔值,指示文本字段是否可选。
TextField
  selectionBeginIndex : int
[只读 (read-only)] 当前所选内容中第一个字符从零开始的字符索引值。
TextField
  selectionEndIndex : int
[只读 (read-only)] 当前所选内容中最后一个字符从零开始的字符索引值。
TextField
  sharpness : Number
此文本字段中字型边缘的清晰度。
TextField
 Inheritedstage : Stage
[只读 (read-only)] 显示对象的舞台。
DisplayObject
  styleSheet : StyleSheet
将样式表附加到文本字段。
TextField
 InheritedtabEnabled : Boolean
指定此对象是否遵循 Tab 键顺序。
InteractiveObject
 InheritedtabIndex : int
指定 SWF 文件中的对象按 Tab 键顺序排列。
InteractiveObject
  text : String
作为文本字段中当前文本的字符串。
TextField
  textColor : uint
文本字段中文本的颜色(采用十六进制格式)。
TextField
  textHeight : Number
[只读 (read-only)] 文本的高度,以像素为单位。
TextField
  textWidth : Number
[只读 (read-only)] 文本的宽度,以像素为单位。
TextField
  thickness : Number
此文本字段中字型边缘的粗细。
TextField
 Inheritedtransform : Transform
一个对象,具有与显示对象的矩阵、颜色转换和像素范围有关的属性。
DisplayObject
  type : String
文本字段的类型。
TextField
  useRichTextClipboard : Boolean
指定在复制和粘贴文本时是否同时复制和粘贴其格式。
TextField
 Inheritedvisible : Boolean
显示对象是否可见。
DisplayObject
 Inheritedwidth : Number
指示显示对象的宽度,以像素为单位。
DisplayObject
  wordWrap : Boolean
一个布尔值,指示文本字段是否自动换行。
TextField
 Inheritedx : Number
指示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。
DisplayObject
 Inheritedy : Number
指示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。
DisplayObject
 Inheritedz : Number
指示 DisplayObject 实例相对于 3D 父容器沿 z 轴的 z 坐标位置。
DisplayObject
公共方法
 方法定义方
  
创建新的 TextField 实例。
TextField
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
EventDispatcher
  
将 newText 参数指定的字符串追加到文本字段的文本的末尾。
TextField
 Inherited
将事件调度到事件流中。
EventDispatcher
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
返回一个矩形,该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。
DisplayObject
  
返回一个矩形,该矩形是字符的边框。
TextField
  
在 x 和 y 参数指定的位置返回从零开始的字符索引值。
TextField
  
如果给定一个字符索引,则返回同一段落中第一个字符的索引。
TextField
  
返回给定 id 或已使用 <img> 标签添加到 HTML 格式文本字段中的图像或 SWF 文件的 DisplayObject 引用。
TextField
  
在 x 和 y 参数指定的位置返回从零开始的行索引值。
TextField
  
返回 charIndex 参数指定的字符所在的行的索引值(从零开始)。
TextField
  
getLineLength(lineIndex:int):int
返回特定文本行中的字符数。
TextField
  
返回给定文本行的度量信息。
TextField
  
getLineOffset(lineIndex:int):int
返回 lineIndex 参数指定的行中第一个字符的字符索引。
TextField
  
返回 lineIndex 参数指定的行的文本。
TextField
  
如果给定一个字符索引,则返回包含给定字符的段落的长度。
TextField
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
返回一个矩形,该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界,但不包括形状上的任何笔触。
DisplayObject
  
getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
返回 TextFormat 对象,其中包含 beginIndex 和 endIndex 参数指定的文本范围的格式信息。
TextField
 Inherited
将 point 对象从舞台(全局)坐标转换为显示对象的(本地)坐标。
DisplayObject
 Inherited
将二维点从舞台(全局)坐标转换为三维显示对象的(本地)坐标。
DisplayObject
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
EventDispatcher
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
计算显示对象,以确定它是否与 obj 显示对象重叠或相交。
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
计算显示对象,以确定它是否与 x 和 y 参数指定的点重叠或相交。
DisplayObject
  
isFontCompatible(fontName:String, fontStyle:String):Boolean
[静态] 如果具有指定的 fontName 和 fontStyle(其中的 Font.fontType 为 flash.text.FontType.EMBEDDED)的嵌入字体可用,则将返回 true。
TextField
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
将三维显示对象的(本地)坐标的三维点转换为舞台(全局)坐标中的二维点。
DisplayObject
 Inherited
将 point 对象从显示对象的(本地)坐标转换为舞台(全局)坐标。
DisplayObject
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
EventDispatcher
  
使用 value 参数的内容替换当前所选内容。
TextField
  
replaceText(beginIndex:int, endIndex:int, newText:String):void
使用 newText 参数的内容替换 beginIndex 和 endIndex 参数指定的字符范围。
TextField
 Inherited
设置循环操作动态属性的可用性。
Object
  
setSelection(beginIndex:int, endIndex:int):void
将第一个字符和最后一个字符的索引值(使用 beginIndex 和 endIndex 参数指定)指定的文本设置为所选内容。
TextField
  
setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
将 format 参数指定的文本格式应用于文本字段中的指定文本。
TextField
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
 Inherited
检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。
EventDispatcher
事件
 事件 摘要 定义方
 Inherited[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。EventDispatcher
 Inherited将显示对象添加到显示列表中时调度。DisplayObject
 Inherited在将显示对象直接添加到舞台显示列表或将包含显示对象的子树添加至舞台显示列表中时调度。DisplayObject
  在修改控件值后调度,这与 textInput 事件不同,后者是在修改值之前调度的。TextField
 Inherited当用户从文本上下文菜单中选择“清除”(或“删除”)时调度。InteractiveObject
 Inherited用户在同一 InteractiveObject 上按下并释放用户指针设备的主按钮时调度。InteractiveObject
 Inherited当用户在 AIR 应用程序中选择与此交互式对象相关联的上下文菜单时调度。InteractiveObject
 Inherited当用户激活特定于平台的复制操作的快捷键组合或从文本上下文菜单中选择“复制”时调度。InteractiveObject
 Inherited当用户激活特定于平台的剪切操作的快捷键组合或从文本上下文菜单中选择“剪切”时调度。InteractiveObject
 Inherited[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。EventDispatcher
 Inherited如果 InteractiveObject 的 doubleClickEnabled 标志设置为 true,当用户在该对象上快速连续按下两次并释放指针设备的主按钮时调度。InteractiveObject
 Inherited[播放事件] 播放头进入新帧时调度。DisplayObject
 Inherited[广播事件] 播放头退出当前帧时调度。DisplayObject
 Inherited显示对象获得焦点后调度。InteractiveObject
 Inherited显示对象失去焦点后调度。InteractiveObject
 Inherited[广播事件] 在帧显示对象的构造函数运行之后但在帧脚本运行之前调度。DisplayObject
 Inherited用户按下某个键时调度。InteractiveObject
 Inherited用户尝试使用键盘导航更改焦点时调度。InteractiveObject
 Inherited用户释放某个键时调度。InteractiveObject
  当用户单击启用 HTML 的文本字段中的超链接(其中的 URL 以“event:”开头)时调度。TextField
 Inherited当用户在同一 InteractiveObject 上按下并释放用户指针设备的中间按钮时调度。InteractiveObject
 Inherited当用户在 InteractiveObject 实例上按下指针设备的中间按钮时调度。InteractiveObject
 Inherited当用户在 InteractiveObject 实例上释放指针设备按钮时调度。InteractiveObject
 Inherited当用户在 InteractiveObject 实例上按下指针设备按钮时调度。InteractiveObject
 Inherited用户尝试使用指针设备更改焦点时调度。InteractiveObject
 Inherited用户移动 InteractiveObject 上的指针设备时调度。InteractiveObject
 Inherited用户将指针设备从 InteractiveObject 实例上移开时调度。InteractiveObject
 Inherited用户将指针设备移动到 InteractiveObject 实例上时调度。InteractiveObject
 Inherited当用户在 InteractiveObject 实例上释放指针设备按钮时调度。InteractiveObject
 Inherited当鼠标滚轮滚动到 InteractiveObject 实例上时调度。InteractiveObject
 Inherited当用户释放拖动动作时由拖动启动器 InteractiveObject 调度。InteractiveObject
 Inherited在将拖动对象放置到目标上且已通过对 DragManager.acceptDragDrop() 的调用接受该放置操作时,由目标 InteractiveObject 调度。InteractiveObject
 Inherited当拖动动作进入其边界时由 InteractiveObject 调度。InteractiveObject
 Inherited当拖动动作离开其边界时由 InteractiveObject 调度。InteractiveObject
 Inherited当拖动动作保持在其边界内时,由 InteractiveObject 持续调度。InteractiveObject
 Inherited在拖动操作开始时由在 DragManager.doDrag() 调用中指定为拖动启动器的 InteractiveObject 调度。InteractiveObject
 Inherited在拖动操作期间由在 DragManager.doDrag() 调用中指定为拖动启动器的 InteractiveObject 调度。InteractiveObject
 Inherited当用户激活特定于平台的粘贴操作的快捷键组合或从文本上下文菜单中选择“粘贴”时调度。InteractiveObject
 Inherited将要从显示列表中删除显示对象时调度。DisplayObject
 Inherited在从显示列表中直接删除显示对象或删除包含显示对象的子树时调度。DisplayObject
 Inherited[广播事件] 将要更新和呈现显示列表时调度。DisplayObject
 Inherited当用户在同一 InteractiveObject 上按下并释放用户指针设备的右按钮时调度。InteractiveObject
 Inherited当用户在 InteractiveObject 实例上按下指针设备按钮时调度。InteractiveObject
 Inherited当用户在 InteractiveObject 实例上释放指针设备按钮时调度。InteractiveObject
 Inherited用户将指针设备从 InteractiveObject 实例上移开时调度。InteractiveObject
 Inherited用户将指针设备移动到 InteractiveObject 实例上时调度。InteractiveObject
  用户滚动后由 TextField 对象调度。TextField
 Inherited当用户激活特定于平台的全选操作的快捷键组合或从文本上下文菜单中选择“全选”时调度。InteractiveObject
 Inherited对象的 tabChildren 标志值发生更改时调度。InteractiveObject
 Inherited对象的 tabEnabled 标志发生更改时调度。InteractiveObject
 Inherited对象的 tabIndex 属性值发生更改时调度。InteractiveObject
  用户输入一个或多个文本字符时,Flash Player 将调度 textInput 事件。TextField
属性详细信息
alwaysShowSelection属性
alwaysShowSelection:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

如果设置为 true 且文本字段没有焦点,Flash Player 将以灰色突出显示文本字段中的所选内容。如果设置为 false 且文本字段没有焦点,则 Flash Player 不会突出显示文本字段中的所选内容。

默认值为 false.



实现
    public function get alwaysShowSelection():Boolean
    public function set alwaysShowSelection(value:Boolean):void

另请参见


示例
编译并运行下面的文件。在运行此文件时,拖动以分别选择两个文本字段中的文本,注意在您选择两个文本字段中的文本(更改焦点)时,突出显示的所选内容之间的区别:
package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldType;

    public class TextField_alwaysShowSelection extends Sprite {
        public function TextField_alwaysShowSelection() {
            var label1:TextField = createCustomTextField(0, 20, 200, 20);
            label1.text = "This text is selected.";
            label1.setSelection(0, 9);
            label1.alwaysShowSelection = true;

            var label2:TextField = createCustomTextField(0, 50, 200, 20);
            label2.text = "Drag to select some of this text.";
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x; result.y = y;
            result.width = width; result.height = height;
            addChild(result);
            return result;
        }
    }
}
antiAliasType属性 
antiAliasType:String  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

用于此文本字段的消除锯齿类型。将 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  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

控制文本字段的自动大小调整和对齐。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

引发
ArgumentError — 指定的 autoSize 不是 flash.text.TextFieldAutoSize 的成员。

另请参见

background属性 
background:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 false.



实现
    public function get background():Boolean
    public function set background(value:Boolean):void

另请参见

backgroundColor属性 
backgroundColor:uint  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void

另请参见

border属性 
border:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 false.



实现
    public function get border():Boolean
    public function set border(value:Boolean):void

另请参见

borderColor属性 
borderColor:uint  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get borderColor():uint
    public function set borderColor(value:uint):void

另请参见

bottomScrollV属性 
bottomScrollV:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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



实现
    public function get bottomScrollV():int

另请参见

caretIndex属性 
caretIndex:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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



实现
    public function get caretIndex():int

另请参见


示例
在此示例中,创建了一个 TextField 实例,并用文本填充该实例。分配了一个事件侦听器,以便在用户单击 TextField 时,调用 printCursorPosition 方法。在这种情况下,将输出 caretIndexselectionBeginIndexselectionEndIndex 属性的值。

运行此示例并尝试在 TextField 中单击以选择文本。然后在字段中单击,但不选择文本。如果在文本中单击但不进行选择,caretIndex 属性将指示在何处出现插入点,而 selectionBeginIndexselectionEndIndex 属性则等于 caretIndex 属性值。

package {
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import flash.text.TextField;
    import flash.text.TextFieldType;

    public class TextField_caretIndex extends Sprite {
        public function TextField_caretIndex() {
            var tf:TextField = createCustomTextField(10, 10, 100, 100);
            tf.wordWrap = true;
            tf.type = TextFieldType.INPUT;
            tf.text = "Click in this text field. Compare the difference between clicking without selecting versus clicking and selecting text.";
            tf.addEventListener(MouseEvent.CLICK, printCursorPosition);
        }

        private function printCursorPosition(event:MouseEvent):void {
            var tf:TextField = TextField(event.target);
            trace("caretIndex:", tf.caretIndex);
            trace("selectionBeginIndex:", tf.selectionBeginIndex);
            trace("selectionEndIndex:", tf.selectionEndIndex);
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            addChild(result);
            return result;
        }
    }
}
condenseWhite属性 
condenseWhite:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

一个布尔值,指定是否删除具有 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

另请参见


示例
下面显示将 condenseWhite 设置为 false 和将其设置为 true 之间的区别:
package {
    import flash.display.Sprite;
    import flash.text.TextField;

    public class TextField_condenseWhite extends Sprite {
        public function TextField_condenseWhite() {
            var tf1:TextField = createCustomTextField(0, 0, 200, 50);
            tf1.condenseWhite = false;
            tf1.htmlText = "keep    on\n\ttruckin'";
            
            var tf2:TextField = createCustomTextField(0, 120, 200, 50);
            tf2.condenseWhite = true;
            tf2.htmlText = "keep    on\n\ttruckin'";
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            result.border = true;
            addChild(result);
            return result;
        }
    }
}
defaultTextFormat属性 
defaultTextFormat:TextFormat  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

指定应用于新插入文本(例如,用户输入的文本或使用 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

引发
Error — 此方法不能用于具有样式表的文本字段。

另请参见

displayAsPassword属性 
displayAsPassword:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 false.



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

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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

默认值为 false.



实现
    public function get embedFonts():Boolean
    public function set embedFonts(value:Boolean):void

另请参见

gridFitType属性 
gridFitType:String  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

用于此文本字段的网格固定类型。仅在文本字段的 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 设置通常适合右对齐或居中的动态文本,有时,为了在动画与文本品质之间达到一种平衡,也可使用此设置。

默认值为 pixel.



实现
    public function get gridFitType():String
    public function set gridFitType(value:String):void

另请参见


示例
下面的示例显示具有不同 gridFitType 属性设置的三个文本字段。在使用此示例时,请注意前两行在清晰度方面的差异。还要注意用于左对齐文本的 GridFitType.PIXEL 和用于右对齐文本的 GridFitType.SUBPIXEL 的最佳用法。
package
{
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFormat;
    import flash.text.TextFieldAutoSize;
    import flash.text.AntiAliasType;
    import flash.text.GridFitType;

    public class gridFitTypeExample extends Sprite
    {
        public function gridFitTypeExample()
        {
    var format1:TextFormat = new TextFormat();
    format1.font="Arial";
    format1.size=12;

    var tf1:TextField = createCustomTextField(0,0,format1,"NONE",TextFieldAutoSize.LEFT,GridFitType.NONE);
    
    var tf2:TextField = createCustomTextField(0,30,format1,"PIXEL",TextFieldAutoSize.LEFT,GridFitType.PIXEL);

    var tf3:TextField = createCustomTextField(300,60,format1,"SUBPIXEL",TextFieldAutoSize.RIGHT,GridFitType.SUBPIXEL);

        }
        private function createCustomTextField(x:Number,y:Number,fm:TextFormat,tl:String,tfs:String,gft:String):TextField 
        {
            var result:TextField = new TextField();
            result.x=x;
            result.y=y;
            result.embedFonts=true;
            result.antiAliasType=AntiAliasType.ADVANCED;
            result.text="This text uses a gridFitType of " + tl;
            result.autoSize=tfs;
        result.gridFitType=gft;
            result.setTextFormat(fm);
            addChild(result);
            return result;
        }
    }
}
htmlText属性 
htmlText:String  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

包含文本字段内容的 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

另请参见


示例
下例创建一个名为 tf1 的 TextField,并将 HTML 格式的字符串赋给其 text 属性。当跟踪其 htmlText 属性时,输出为 HTML 格式的字符串,带有由 Flash Player 自动添加的其它标签(如 <P> 和 <FONT>)。当跟踪 text 属性的值时,将显示不带 HTML 标签的无格式字符串。

为了进行比较,我们对另一个名为 tf2 的 TextField 对象执行了同样的步骤,并在设置 tf2htmlText 属性之前将 StyleSheet 对象赋给它的 styleSheet 属性。在这种情况下,当跟踪 htmlText 属性时,它只包括最初赋给 htmlText 属性的 HTML 文本,说明 Flash Player 没有添加其它标签。

package {
    import flash.display.Sprite;
    import flash.text.StyleSheet;
    import flash.text.TextField;

    public class TextField_text extends Sprite {
        public function TextField_text() {
            var tf1:TextField = createCustomTextField(10, 10, 400, 22);
            tf1.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";

            // htmlText: <P ALIGN="LEFT"><FONT FACE="Times New Roman" SIZE="12" COLOR="#000000" LETTERSPACING="0" KERNING="0"><b>Lorem ipsum dolor sit amet.</b></FONT></P>
            trace("htmlText: " + tf1.htmlText);
            // text: Lorem ipsum dolor sit amet.
            trace("text: " + tf1.text);
            
            var tf2:TextField = createCustomTextField(10, 50, 400, 22);
            tf2.styleSheet = new StyleSheet();
            tf2.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";
            // htmlText: <b>Lorem ipsum dolor sit amet.</b>
            trace("htmlText: " + tf2.htmlText);
            // text: Lorem ipsum dolor sit amet.
            trace("text: " + tf2.text);
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            addChild(result);
            return result;
        }
    }
}
length属性 
length:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



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

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 0.



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

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

scrollH 的最大值。



实现
    public function get maxScrollH():int

另请参见

maxScrollV属性 
maxScrollV:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

scrollV 的最大值。



实现
    public function get maxScrollV():int

另请参见

mouseWheelEnabled属性 
mouseWheelEnabled:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



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

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 false.



实现
    public function get multiline():Boolean
    public function set multiline(value:Boolean):void

另请参见

numLines属性 
numLines:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get numLines():int

另请参见

restrict属性 
restrict:String  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

指示用户可输入到文本字段中的字符集。如果 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";

默认值为 null.



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

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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

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



实现
    public function get scrollH():int
    public function set scrollH(value:int):void

另请参见

scrollV属性 
scrollV:int  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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



实现
    public function get scrollV():int
    public function set scrollV(value:int):void

另请参见

selectable属性 
selectable:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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

默认值为 true.



实现
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void

另请参见


示例
下面的示例创建两个动态文本字段:一个文本字段的 selectable 属性设置为 true,另一个文本字段的 selectable 属性设置为 false。在使用此示例时,请尝试用鼠标或键盘在这些字段中选择文本。
package
{
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;

    public class selectableExample extends Sprite
    {
        public function selectableExample()
        {
    var tf1:TextField = createCustomTextField(10, 10);
    tf1.text="This text can be selected";
    tf1.selectable=true;

    var tf2:TextField = createCustomTextField(10, 30);
    tf2.text="This text cannot be selected";
    tf2.selectable=false;
        }

        private function createCustomTextField(x:Number, y:Number):TextField 
       {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.autoSize=TextFieldAutoSize.LEFT;
            addChild(result);
            return result;
        }
    }
}
selectionBeginIndex属性 
selectionBeginIndex:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get selectionBeginIndex():int

另请参见


示例
在此示例中,创建了一个 TextField 实例,并用文本填充该实例。分配了一个事件侦听器,以便在用户单击 TextField 时,调用 printCursorPosition 方法。在这种情况下,将输出 caretIndexselectionBeginIndexselectionEndIndex 属性的值。

运行此示例并尝试在 TextField 中单击以选择文本。然后在字段中单击,但不选择文本。如果在文本中单击但不进行选择,caretIndex 属性将指示在何处出现插入点,而 selectionBeginIndexselectionEndIndex 属性则等于 caretIndex 属性值。

package {
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import flash.text.TextField;
    import flash.text.TextFieldType;

    public class TextField_caretIndex extends Sprite {
        public function TextField_caretIndex() {
            var tf:TextField = createCustomTextField(10, 10, 100, 100);
            tf.wordWrap = true;
            tf.type = TextFieldType.INPUT;
            tf.text = "Click in this text field. Compare the difference between clicking without selecting versus clicking and selecting text.";
            tf.addEventListener(MouseEvent.CLICK, printCursorPosition);
        }

        private function printCursorPosition(event:MouseEvent):void {
            var tf:TextField = TextField(event.target);
            trace("caretIndex:", tf.caretIndex);
            trace("selectionBeginIndex:", tf.selectionBeginIndex);
            trace("selectionEndIndex:", tf.selectionEndIndex);
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            addChild(result);
            return result;
        }
    }
}
selectionEndIndex属性 
selectionEndIndex:int  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get selectionEndIndex():int

另请参见


示例
在此示例中,创建了一个 TextField 实例,并用文本填充该实例。分配了一个事件侦听器,以便在用户单击 TextField 时,调用 printCursorPosition 方法。在这种情况下,将输出 caretIndexselectionBeginIndexselectionEndIndex 属性的值。

运行此示例并尝试在 TextField 中单击以选择文本。然后在字段中单击,但不选择文本。如果在文本中单击但不进行选择,caretIndex 属性将指示在何处出现插入点,而 selectionBeginIndexselectionEndIndex 属性则等于 caretIndex 属性值。

package {
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import flash.text.TextField;
    import flash.text.TextFieldType;

    public class TextField_caretIndex extends Sprite {
        public function TextField_caretIndex() {
            var tf:TextField = createCustomTextField(10, 10, 100, 100);
            tf.wordWrap = true;
            tf.type = TextFieldType.INPUT;
            tf.text = "Click in this text field. Compare the difference between clicking without selecting versus clicking and selecting text.";
            tf.addEventListener(MouseEvent.CLICK, printCursorPosition);
        }

        private function printCursorPosition(event:MouseEvent):void {
            var tf:TextField = TextField(event.target);
            trace("caretIndex:", tf.caretIndex);
            trace("selectionBeginIndex:", tf.selectionBeginIndex);
            trace("selectionEndIndex:", tf.selectionEndIndex);
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            addChild(result);
            return result;
        }
    }
}
sharpness属性 
sharpness:Number  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 0.



实现
    public function get sharpness():Number
    public function set sharpness(value:Number):void

另请参见


示例
下面的示例显示更改 TextField 对象的 sharpness 属性所产生的效果。您需要嵌入字体并将 antiAliasType 属性设置为 ADVANCED
package
{
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;
    import flash.text.AntiAliasType;
    import flash.text.GridFitType;
    import flash.text.TextFormat;

    public class sharpnessExample extends Sprite
    {
        public function sharpnessExample()
        {
    var format1:TextFormat = new TextFormat();
    format1.font="Arial";
    format1.size=24;
    var lTxt:String = "The quick brown fox";

    var tf1:TextField=createCustomTextField(0,lTxt,format1,-400);
    var tf2:TextField=createCustomTextField(30,lTxt,format1,0);
    var tf3:TextField=createCustomTextField(60,lTxt,format1,400);
        }

        private function createCustomTextField(y:Number,fldTxt:String,format:TextFormat,fldSharpness:Number):TextField 
       {
            var result:TextField = new TextField();
            result.y=y;
            result.text=fldTxt;
            result.embedFonts=true;
            result.autoSize=TextFieldAutoSize.LEFT;
            result.antiAliasType=AntiAliasType.ADVANCED;
            result.gridFitType=GridFitType.PIXEL;
            result.sharpness=fldSharpness;
            result..setTextFormat(format);
            addChild(result);
            return result;
        }
    }
}
styleSheet属性 
styleSheet:StyleSheet  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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

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



实现
    public function get styleSheet():StyleSheet
    public function set styleSheet(value:StyleSheet):void

另请参见


示例
下面的示例定义一个简单的 StyleSheet 对象并为其分配一个包含 HTML 内容的文本字段。在设置内容之前设置 stylesheet 属性。
package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.StyleSheet;

    public class TextStylesheetExample extends Sprite {
        var myLabel:TextField = new TextField();
        var labelText:String = "Hello world.";
        var newStyle:StyleSheet = new StyleSheet();

        public function TextStylesheetExample()
       {
            var styleObj:Object = new Object();
            styleObj.fontWeight = "bold";
            styleObj.color = "#660066";
            newStyle.setStyle(".defStyle", styleObj);

            myLabel.styleSheet=newStyle;
            myLabel.htmlText=labelText;
            addChild(myLabel);
        }
    }
}
text属性 
text:String  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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



实现
    public function get text():String
    public function set text(value:String):void

另请参见


示例
下例创建一个名为 tf1 的 TextField,并将 HTML 格式的字符串赋给其 text 属性。当跟踪其 htmlText 属性时,输出为 HTML 格式的字符串,带有由 Flash Player 自动添加的其它标签(如 <P> 和 <FONT>)。当跟踪 text 属性的值时,将显示不带 HTML 标签的无格式字符串。

为了进行比较,我们对另一个名为 tf2 的 TextField 对象执行了同样的步骤,并在设置 tf2htmlText 属性之前将 StyleSheet 对象赋给它的 styleSheet 属性。在这种情况下,当跟踪 htmlText 属性时,它只包括最初赋给 htmlText 属性的 HTML 文本,说明 Flash Player 没有添加其它标签。

package {
    import flash.display.Sprite;
    import flash.text.StyleSheet;
    import flash.text.TextField;

    public class TextField_text extends Sprite {
        public function TextField_text() {
            var tf1:TextField = createCustomTextField(10, 10, 400, 22);
            tf1.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";

            // htmlText: <P ALIGN="LEFT"><FONT FACE="Times New Roman" SIZE="12" COLOR="#000000" LETTERSPACING="0" KERNING="0"><b>Lorem ipsum dolor sit amet.</b></FONT></P>
            trace("htmlText: " + tf1.htmlText);
            // text: Lorem ipsum dolor sit amet.
            trace("text: " + tf1.text);
            
            var tf2:TextField = createCustomTextField(10, 50, 400, 22);
            tf2.styleSheet = new StyleSheet();
            tf2.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";
            // htmlText: <b>Lorem ipsum dolor sit amet.</b>
            trace("htmlText: " + tf2.htmlText);
            // text: Lorem ipsum dolor sit amet.
            trace("text: " + tf2.text);
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            addChild(result);
            return result;
        }
    }
}
textColor属性 
textColor:uint  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 0 (0x000000).



实现
    public function get textColor():uint
    public function set textColor(value:uint):void

示例
下面的 ActionScript 创建一个 TextField 对象,并将其 textColor 属性更改为 red (0xFF0000)。
package {
    import flash.display.Sprite;
    import flash.text.TextField;

    public class TextField_textColor extends Sprite {
        public function TextField_textColor() {
            var tf:TextField = createCustomTextField(10, 10, 100, 300);
            tf.text = "This will be red text";
            tf.textColor = 0xFF0000;            
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            addChild(result);
            return result;
        }
    }
}
textHeight属性 
textHeight:Number  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get textHeight():Number

另请参见


示例
下例创建一个 TextField 对象,并为其分配文本。trace 语句显示 textWidthtextHeight 属性的值。为了进行比较,还会显示 widthheight 属性。(请注意,看到的 textHeighttextWidth 值可能会有所不同,这取决于计算机上所用的字体)。
package {
    import flash.display.Sprite;
    import flash.text.TextField;

    public class TextField_textHeight extends Sprite {
        public function TextField_textHeight() {
            var tf:TextField = createCustomTextField(10, 10, 100, 150);
            tf.text = "Sample text";
            
            trace("textWidth: " + tf.textWidth); // textWidth: 55.75
            trace("textHeight: " + tf.textHeight); // textHeight: 13.450000000000001
            trace("width: " + tf.width); // width: 100
            trace("height: " + tf.height); // height: 150
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            result.border = true;
            result.background = true;
            addChild(result);
            return result;
        }
    }
}
textWidth属性 
textWidth:Number  [只读 (read-only)]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get textWidth():Number

另请参见


示例
下例创建一个 TextField 对象,并为其分配文本。trace 语句显示 textWidthtextHeight 属性的值。为了进行比较,还会显示 widthheight 属性。(请注意,看到的 textHeighttextWidth 值可能会有所不同,这取决于计算机上所用的字体)。
package {
    import flash.display.Sprite;
    import flash.text.TextField;

    public class TextField_textHeight extends Sprite {
        public function TextField_textHeight() {
            var tf:TextField = createCustomTextField(10, 10, 100, 150);
            tf.text = "Sample text";
            
            trace("textWidth: " + tf.textWidth); // textWidth: 55.75
            trace("textHeight: " + tf.textHeight); // textHeight: 13.450000000000001
            trace("width: " + tf.width); // width: 100
            trace("height: " + tf.height); // height: 150
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            result.border = true;
            result.background = true;
            addChild(result);
            return result;
        }
    }
}
thickness属性 
thickness:Number  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

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

默认值为 0.



实现
    public function get thickness():Number
    public function set thickness(value:Number):void

另请参见


示例
下面的示例显示更改 TextField 对象的 thickness 属性所产生的效果。您需要嵌入字体并将 antiAliasType 属性设置为 ADVANCED
package
{
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;
    import flash.text.AntiAliasType;
    import flash.text.GridFitType;
    import flash.text.TextFormat;

    public class thicknessExample extends Sprite
    {
        public function thicknessExample()
        {
    var format1:TextFormat = new TextFormat();
    format1.font="Arial";
    format1.size=24;
    var lTxt:String = "The quick brown fox";

    var tf1:TextField=createCustomTextField(0,lTxt,format1,-200);
    var tf2:TextField=createCustomTextField(30,lTxt,format1,0);
    var tf3:TextField=createCustomTextField(60,lTxt,format1,200);
        }

        private function createCustomTextField(y:Number,fldTxt:String,format:TextFormat,fldThickness:Number):TextField 
       {
            var result:TextField = new TextField();
            result.y=y;
            result.text=fldTxt;
            result.embedFonts=true;
            result.autoSize=TextFieldAutoSize.LEFT;
            result.antiAliasType=AntiAliasType.ADVANCED;
            result.gridFitType=GridFitType.PIXEL;
            result.thickness=fldThickness;
            result.setTextFormat(format);
            addChild(result);
            return result;
        }
    }
}
type属性 
type:String  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

默认值为 dynamic.



实现
    public function get type():String
    public function set type(value:String):void

引发
ArgumentError — 指定的 type 不是 flash.text.TextFieldType 的成员。

另请参见


示例
下例创建两个文本字段:tfDynamictfInput。文本输入到两个文本字段中。但是,tfDynamic 将其 type 属性设置为 TextFieldType.DYNAMIC,而 tfInput 将其 type 属性设置为 TextFieldType.INPUT,所以用户可以修改 tfInput 中的文本,但只能查看 tfDynamic 中的文本。
package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldType;

    public class TextField_type extends Sprite {
        public function TextField_type() {
            var tfDynamic:TextField = createCustomTextField(10, 10, 100, 20);
            tfDynamic.type = TextFieldType.DYNAMIC;
            tfDynamic.text = "hello";

            var tfInput:TextField = createCustomTextField(10, 45, 100, 20);
            tfInput.type = TextFieldType.INPUT;
            tfInput.text = "world";
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            result.background = true;
            result.border = true;
            addChild(result);
            return result;
        }
    }
}
useRichTextClipboard属性 
useRichTextClipboard:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get useRichTextClipboard():Boolean
    public function set useRichTextClipboard(value:Boolean):void

示例
此示例创建一个输入文本字段 (tf1) 和两个动态文本字段(tf2tf3)。代码为每个动态文本字段分配一个 TextFormat 对象(Courier Bold 字体)。tf2 文本字段的 useRichTextClipboard 属性设置为 falsetf3 文本字段的 useRichTextClipboard 属性设置为 true。在从 tf2 文本字段复制文本并将其粘贴到 tf1 文本字段中时,粘贴的文本不包括格式。在从 tf3 文本字段(useRichTextClipboard 设置为 true)复制文本并将其粘贴到 tf1 文本字段中时,粘贴的文本包括格式。
package
{
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldType;
    import flash.text.TextFormat;

    public class useRichTextClipboard extends Sprite
    {
        public function useRichTextClipboard()
        {
    var format1:TextFormat = new TextFormat();
    format1.font="Courier";
    format1.bold=true;

    var tf1:TextField = createCustomTextField(10, 10, 200, 20);
    tf1.type=TextFieldType.INPUT;
    tf1.useRichTextClipboard=true;

    var tf2:TextField = createCustomTextField(220, 10, 200, 20);
    tf2.text="1.Text loses format";
    tf2.setTextFormat(format1);
    tf2.useRichTextClipboard=false;

    var tf3:TextField = createCustomTextField(220, 50, 200, 20);
    tf3.text="2.Text includes format";
    tf3.setTextFormat(format1);
    tf3.useRichTextClipboard=true;
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField 
       {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            result.background = true;
            result.border = true;
            addChild(result);
            return result;
        }
    }
}
wordWrap属性 
wordWrap:Boolean  [读写]

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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



实现
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void

示例
下面显示将 wordWrap 属性设置为 true 和将其设置为 false 之间的区别。创建两个 TextField 实例,它们的内容对于它们的宽度来说太大。第一个(名为 tfWrap)的 wordWrap 属性设置为 true;第二个 (tfNoWrap) 的此属性设置为 false
package {
    import flash.display.Sprite;
    import flash.text.TextField;

    public class TextField_wordWrap extends Sprite {
        public function TextField_wordWrap() {
            var tfWrap:TextField = createCustomTextField(10, 10, 100, 100);
            tfWrap.wordWrap = true;
            tfWrap.text = "(wordWrap = true):\nThis is very long text that will certainly extend beyond the width of this text field";

            var tfNoWrap:TextField = createCustomTextField(10, 150, 100, 100);
            tfNoWrap.wordWrap = false;
            tfNoWrap.text = "(wordWrap = false):\nThis is very long text that will certainly extend beyond the width of this text field";
        }

        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.width = width;
            result.height = height;
            result.background = true;
            result.border = true;
            addChild(result);
            return result;
        }
    }
}
构造函数详细信息
TextField()构造函数
public function TextField()

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

创建新的 TextField 实例。在创建 TextField 实例后,调用父 DisplayObjectContainer 对象的 addChild()addChildAt() 方法可将 TextField 实例添加到显示列表中。

文本字段的默认大小是 100 x 100 个像素。

方法详细信息
appendText()方法
public function appendText(newText:String):void

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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


示例

如果不是周末,下面的示例将显示时间;如果是周末,则显示文本“It's the weekend”。它还计算到某个位置之前的字符数以及文本字段中的行数。

outputText 文本字段被设置为自动适应文本,并使用 autoSize 属性将其调整为左对齐的文本。outputText.text 属性写入第一行内容,并由 appendText() 方法附加其余的内容。(并非必须以 text 属性开头。也可以从一开始就使用 appendText() 方法附加文本。) 第二次设置 text 属性时,将覆盖原始文本。可以使用 += 运算符通过 text 属性附加内容。

if 语句检查日期是否为星期六 (6) 或星期日 (0)。如果不是,toLocaleTimeString() 方法将返回本地时间,它将附加到文本字段内容中。

文本字段的 length 属性用于读取就在调用函数之前的字符数;而属性 numLines 用于计算文本字段中的行数。请注意,在计算行数时将空行计算在内,并在确定长度内容时将空格和换行符 (\n) 计算在内。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;
 
    public class TextField_appendTextExample extends Sprite {
         
        public function TextField_appendTextExample() {
            var outputText:TextField = new TextField();
            var today:Date = new Date();
                
            outputText.x = 10;
            outputText.y = 10;
            outputText.background = true;
            outputText.autoSize = TextFieldAutoSize.LEFT;
 
            outputText.text = "WHAT TIME IS IT?" + "\n\n";
 
            if((today.day == 0) || (today.day == 6)) {
                outputText.appendText("It's the weekend.");
                outputText.appendText("\n\n");
           
            } else {
                outputText.appendText("The time is: ");
                outputText.appendText(today.toLocaleTimeString() + ".\n\n");  
            }

            outputText.appendText("Number of characters including line breaks and spaces so far: ");
            outputText.appendText(outputText.length.toString() + "\n");
            outputText.appendText("Number of lines in the outputText: ");
            outputText.appendText(outputText.numLines.toString());   

            this.addChild(outputText);
        }
    }
}
getCharBoundaries()方法 
public function getCharBoundaries(charIndex:int):Rectangle

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
Rectangle — 一个矩形,具有定义字符边框的 xy 最小值和最大值。

另请参见


示例

在下面的示例中,使用 getCharBoundaries() 方法标记(产生聚光灯照射效果)用户选择的字符。

该类定义了 spotlight Shape 对象,该对象用于在每个所选的字符周围绘制一个矩形。当用户单击 myTextField 文本字段时,将调用 clickHandler() 方法。

clickHandler() 方法中,getCharIndexAtPoint() 方法基于鼠标单击的 localXlocalY 坐标来获取所单击的字符的索引,此坐标相对于包含它的 Sprite。如果该点(鼠标单击)不在任何字符上,getCharIndexAtPoint() 方法将返回 -1。由于文本字段可能比文本大,因此,应检查返回的整数 (index) 以确保用户单击了某个字符。getCharBoundaries() 还使用 index 整数来获取用于保存字符边界的 Rectangle 对象。clear() 方法将清除以前显示的所有 spotlight Shape 对象。将使用返回的 frame 矩形的 x 和 y 坐标,在字符位置生成一个字符宽度和高度边界大小的新矩形,字符位置是相对于 (10, 10) 坐标的偏移。若要产生用聚光灯照射字符的效果,请使用黄色填充 spotlight Shape 对象,并将不透明度设置为 35%,以便能够看到字符。请注意,空格也被视为字符。

package {
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import flash.text.TextField;
    import flash.geom.Rectangle;
    import flash.events.MouseEvent;
    import flash.text.TextFieldAutoSize;
    import flash.display.Shape;

    public class TextField_getCharBoundariesExample extends Sprite
    {
        private var myTextField:TextField = new TextField();    
        private var spotlight:Shape = new Shape();
        
        public function TextField_getCharBoundariesExample() {
            
            myTextField.x = 10;
            myTextField.y = 10; 
            myTextField.border = true;
            myTextField.selectable = false;
            myTextField.autoSize = TextFieldAutoSize.LEFT;
            
            myTextField.text = "Selected a character from this text by clicking on it."

            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
            
            this.addChild(myTextField);    
            this.addChild(spotlight);
         }

        private function clickHandler (e:MouseEvent):void {
            var index:int = myTextField.getCharIndexAtPoint(e.localX, e.localY);
 
            if (index != -1) {
                 var frame:Rectangle = myTextField.getCharBoundaries(index);

                spotlight.graphics.clear();    
                spotlight.graphics.beginFill(0xFFFF00, .35);
                spotlight.graphics.drawRect((frame.x + 10), (frame.y + 10), frame.width, frame.height);            
                spotlight.graphics.endFill();
            }
        } 
    }
}
getCharIndexAtPoint()方法 
public function getCharIndexAtPoint(x:Number, y:Number):int

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

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

示例

在下面的示例中,当用户单击某个字符时,将在另一个文本字段中的文本上面回显该字符。

第一个文本字段用于保存用户将要选择的文本。为了确保单击该文本而没有将其选定,请将 selectable 属性设置为 false。当用户单击 firstTextField 文本字段时,将调用 clickHandler() 方法。

clickHandler() 方法中,getCharIndexAtPoint() 方法基于鼠标单击的 localXlocalY 坐标来返回字符的索引。由于文本字段可能比文本大,因此,应检查返回整数 (index) 以确保用户单击了某个字符。(如果该点(鼠标单击)不在某个字符上,getCharIndexAtPoint() 方法将返回 -1。) 鼠标坐标用于设置显示回显字符的新文本字段的坐标。第二个文本字段中的字符颜色设置为红色。最后,第二个字段中的文本设置为选定的字符,它是使用 charAt() 方法检索的。请注意,如果使用 text 属性而不是 appendText() 方法,则会覆盖第二个文本字段中的字符,而不是进行附加。

package {
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import flash.text.TextField;
    import flash.geom.Rectangle;
    import flash.events.MouseEvent;
    import flash.text.TextFieldAutoSize;
    
    public class TextField_getCharIndexAtPointExample extends Sprite {
        private var firstTextField:TextField = new TextField();    
        private var secondTextField:TextField = new TextField();
        
        public function TextField_getCharIndexAtPointExample() {

            firstTextField.x = 100;
            firstTextField.y = 100; 
            firstTextField.width = 260;
            firstTextField.height = 20;
            firstTextField.border = true;
            firstTextField.background = true;
            firstTextField.selectable = false;
            
            firstTextField.text = "Selected a character from this text by clicking on it."

            firstTextField.addEventListener(MouseEvent.CLICK, clickHandler);

            this.addChild(firstTextField);    
            this.addChild(secondTextField);
         }

        private function clickHandler (e:MouseEvent):void {
            var index:int = firstTextField.getCharIndexAtPoint(e.localX, e.localY);

            if (index != -1) {
                secondTextField.x = mouseX;
                secondTextField.y =  70;
                secondTextField.border = true;
                secondTextField.selectable = false;
                secondTextField.background = true;
                secondTextField.textColor = 0xFF0000;
                secondTextField.autoSize = TextFieldAutoSize.LEFT;
                secondTextField.text = firstTextField.text.charAt(index);    
            }
        } 
    }
}
getFirstCharInParagraph()方法 
public function getFirstCharInParagraph(charIndex:int):int

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
int — 同一段落中从零开始的第一个字符索引值。

引发
RangeError — 指定的字符索引超出范围。

示例

在下面的示例中,为文本字段内容应用了段落格式。当用户单击段落时,将右对齐段落文本;当用户再次单击段落时,将恢复为原始(默认)格式(左对齐)。

在构造函数中,将 myTextField 文本字段设置为文本换行。getTextFormat 方法返回文本字段内容中的第一个字符的原始格式,此格式放置在 originalFormat TextFormat 对象中。还定义了一个新的 TextFormat 对象 (newFormat),并将其 align 属性指定为右对齐。当用户单击文本字段时,将调用 clickHandler() 方法。

clickHandler() 方法中,getCharIndexAtPoint() 方法基于鼠标单击的 localXlocalY 坐标来返回字符的索引。第一条 if 语句检查以确定用户是否已单击了某个字符。通过使用由 getCharIndexAtPoint() 方法返回的 clickIndex 整数,getFirstCharInParagraph() 方法将返回用户单击的段落中的第一个字符的索引。段落中的最后一个字符的索引是使用以下方法确定的:将段落中的第一个字符的索引与段落长度(使用 getParagraphLength() 方法)相加,然后减去最后一个字符 (\n)。第二条 if 语句检查段落中的第一个字符的格式。如果其对齐方式值与原始格式(左对齐)相同,则将新格式应用于段落中的所有字符。否则,将段落格式重新设置为原始格式。对齐方式以及格式(如缩进、项目符号、Tab 停靠位、左和右边距)都是用于段落的格式。请注意,在使用自动换行或换行符后,如果没有为 setTextFormat() 方法定义 endIndex 参数,该格式仅适用于段落的第一行。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.events.MouseEvent;
    import flash.text.TextFormat;
    import flash.text.TextFormatAlign;

    public class TextField_getFirstCharInParagraphExample extends Sprite
    {
        private var myTextField:TextField = new TextField();
        private var originalFormat:TextFormat = new TextFormat();
        private var newFormat:TextFormat = new TextFormat(); 
        
        public function TextField_getFirstCharInParagraphExample() {
            myTextField.x = 10;
            myTextField.y = 10; 
            myTextField.border = true;
            myTextField.wordWrap = true;
            myTextField.width = 300;
            myTextField.height = 300; 
            myTextField.background = true;
             
            myTextField.appendText("The TextField class is used to create display objects for "
                        + "text display and input. All dynamic and input text fields in a SWF file " 
                        + "are instances of the TextField class. You can use the TextField class "
                        + "to perform low-level text rendering. However, in Flex, you typically use "
                        + "the Label, Text, TextArea, and TextInput controls to process text. "  
                        + "You can give a text field an instance name in the Property inspector "
                        + "and use the methods and properties of the TextField class to manipulate it with ActionScript. "
                        + "TextField instance names are displayed in the Movie Explorer and in the Insert "
                        + "Target Path dialog box in the Actions panel.\n\n"  
                        + "To create a text field dynamically, use the TextField constructor.\n\n"
                        + "The methods of the TextField class let you set, select, and manipulate "  
                        + "text in a dynamic or input text field that you create during authoring or at runtime.\n\n");

            originalFormat = myTextField.getTextFormat(0);

            newFormat.align = TextFormatAlign.RIGHT;

            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
  
            this.addChild(myTextField);
        }

        private function clickHandler(e:MouseEvent):void {
            var clickIndex:int = myTextField.getCharIndexAtPoint(e.localX, e.localY);
                  
            if(clickIndex != -1) {
                var paragraphFirstIndex:int = myTextField.getFirstCharInParagraph(clickIndex);
                var paragraphEndIndex:int = paragraphFirstIndex + ((myTextField.getParagraphLength(clickIndex) - 1));
            
                if (myTextField.getTextFormat(paragraphFirstIndex).align == originalFormat.align) {
                     myTextField.setTextFormat(newFormat, paragraphFirstIndex, paragraphEndIndex);
                }else {
                     myTextField.setTextFormat(originalFormat, paragraphFirstIndex, paragraphEndIndex);
                }
            } 
        }
    }
}
getImageReference()方法 
public function getImageReference(id:String):DisplayObject

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

返回给定 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

另请参见


示例

在下面的示例中,当单击文本字段时,字段中的图像将被设置为 25% 不透明度,并从其原始方向旋转 90 度。以后,每次单击时,该图像将继续旋转。

此图像 (image.jpg) 是通过 HTML 包括的。(此处,假定图像文件位于与 SWF 文件相同的目录中。) 若要使用 getImageReference() 方法访问该图像,您需要为 img 标签定义 id 属性。htmlText 属性用于包括 HTML 格式的字符串内容。当用户单击 myTextField 文本字段时,将调用 clickHandler() 方法。

clickHandler() 方法中,getImageReference() 方法将对图像的引用作为 DisplayObject 返回。可以使用此引用来处理图像,就像任何 DisplayObject 对象一样。此处,设置了 alpha(透明度)和 rotation 属性。还可以使用 transform 属性访问显示对象的矩阵、颜色转换和像素范围。另请注意,需要导入 flash.display.DisplayObject

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.events.Event;
    import flash.events.MouseEvent;
    import flash.display.DisplayObject;
    
    import flash.text.TextFieldAutoSize;
    
    public class TextField_getImageReferenceExample extends Sprite
    {
        private var myTextField:TextField = new TextField();
        
        public function TextField_getImageReferenceExample()
        {
            var myText1:String = "<p>Here is an image we want to mainpulate: <img src='image.jpg' id='testimage'></p>";

            myTextField.x = 10;
            myTextField.y = 10;
            myTextField.width = 250;
            myTextField.height = 250;
            myTextField.background = true;
            myTextField.border = true;
            myTextField.border = true;
            myTextField.multiline = true;

            myTextField.htmlText = myText1;
            
            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
            
            this.addChild(myTextField);
        }
 
        private function clickHandler(e:MouseEvent):void {
            var imageRef:DisplayObject = myTextField.getImageReference("testimage");
 
            imageRef.rotation += 90;
            imageRef.x = 125;
            imageRef.y = 125;
            imageRef.alpha = 0.25;      
        }
    }
}
getLineIndexAtPoint()方法 
public function getLineIndexAtPoint(x:Number, y:Number):int

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

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

示例

在下面的示例中,当用户从莎士比亚的十四行诗中选择一行时,则会将其复制(附加)到新文本字段中。

在构造函数中,将 poem 文本字段设置为不换行(因为它是一首诗)。还使用 autoSize 属性将文本设置为自动适应,并让其调整为左对齐的文本; 并将 poemCopy 文本字段放在 poem 文本字段下面。当用户单击诗歌的某一行时,将调用 clickHandler() 方法。

clickHandler() 方法中,getLineIndexAtPoint() 方法基于鼠标单击的 localXlocalY 坐标返回用户已单击的位置的行索引。(由于原始诗歌适合此处的文本字段大小,因此,不需要检查由 getCharIndexAtPoint() 方法引发的超出范围错误 (RangeError)。) 接下来,使用行索引获取该行的内容(作为 getLineText() 方法中的字符串),然后将其附加到 poemCopy 文本字段内容中。可以连续进行复制,但在某一时刻后,文本将超出可查看的 poemCopy 文本字段范围之外。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.events.MouseEvent;
    import flash.text.TextFormat;
    import flash.text.TextFieldAutoSize;

    public class TextField_getLineIndexAtPointExample extends Sprite {
        private var poem:TextField = new TextField();
        private var poemCopy:TextField = new TextField();
        
        public function TextField_getLineIndexAtPointExample() {
            poem.border = true;
            poem.autoSize = TextFieldAutoSize.LEFT;
            poem.x = 10;
            poem.wordWrap = false;

            poemCopy.height = 250;
            poemCopy.width = 270;
            poemCopy.y = 230;
            poemCopy.x = 10;
            poemCopy.background = true;
            poemCopy.border = true;
            poemCopy.wordWrap = false;
            
            poem.appendText("Let me not to the marriage of true minds\n"
                              + "Admit impediments. love is not love\n"
                              + "Which alters when it alteration finds\n"
                              + "Or bends with the remover to remove:\n"
                              + "O no! it is an ever-fixed mark\n" 
                              + "That looks on tempests and is never shaken;\n"
                              + "It is the star to every wandering bark,\n"
                              + "Whose worth's unknown, although his height be taken.\n"
                              + "Love's not Time's fool, though rosy lips and cheeks\n"
                              + "Within his bending sickle's compass come:\n"
                              + "Love alters not with his brief hours and weeks,\n"
                              + "But bears it out even to the edge of doom.\n"
                              + "If this be error and upon me proved,\n"
                              + "I never writ, nor no man ever loved.");

           poem.addEventListener(MouseEvent.CLICK, clickHandler); 

           this.addChild(poem); 
           this.addChild(poemCopy);
        }
    
        private function clickHandler(e:MouseEvent):void {
                var index:int = poem.getLineIndexAtPoint(e.localX, e.localY);
                var s:String;

                s = poem.getLineText(index);
                poemCopy.appendText(s + "\n");
        }
    }
}
getLineIndexOfChar()方法 
public function getLineIndexOfChar(charIndex:int):int

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
int — 从零开始的行索引值。

引发
RangeError — 指定的字符索引超出范围。

示例

在下面的示例中,getLineIndexOfChar() 方法返回文本字段中的第 100 个和第 500 个字符的行号。

我们将 myTextField 文本字段定义为换行并调整为左对齐的文本。getLineIndexOfChar() 方法返回指定的字符索引(100 和 500)的行索引。然后,将此信息附加到段落后面。请注意,由于行索引从 0 开始,因此,将行索引 (index) 增加 1 可得出行号。另外,如果调整显示方式,行号可能会发生改变,但此处的信息保持不变,因为只调用一次该方法。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;

    public class TextField_getLineIndexOfCharExample extends Sprite 
    {
        public function TextField_getLineIndexOfCharExample()
        {
            var myTextField:TextField = new TextField();
            
            myTextField.x = 10;
            myTextField.y = 10;
            myTextField.width = 200;
            myTextField.background = true;  
            myTextField.border = true;
            myTextField.wordWrap = true;
            myTextField.autoSize = TextFieldAutoSize.LEFT;

            myTextField.appendText("The TextField class is used to create display objects for "
                + "text display and input. All dynamic and input text fields in a SWF file" 
                + "are instances of the TextField class. You can use the TextField class "
                + "to perform low-level text rendering. However, in Flex, you typically use "
                + "the Label, Text, TextArea, and TextInput controls to process text. "  
                + "You can give a text field an instance name in the Property inspector "
                + "and use the methods and properties of the TextField class to manipulate it with ActionScript. "
                + "TextField instance names are displayed in the Movie Explorer and in the Insert "
                + "Target Path dialog box in the Actions panel.\n\n");

            var index:int = myTextField.getLineIndexOfChar(100);
            myTextField.appendText("100th character is in line: " +  (index + 1) + "\n");
            index = myTextField.getLineIndexOfChar(500);
            myTextField.appendText("500th character is in line: " + (index + 1));

            this.addChild(myTextField);
        }
    }
}
getLineLength()方法 
public function getLineLength(lineIndex:int):int

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
int — 行中的字符数。

引发
RangeError — 指定的行号超出范围。

示例

在下面的示例中,当用户选择某一行后,将在单独的文本字段中显示其行长度(字符数)。

为了便于说明,我们将 myTextField 文本字段(显示将要计算的文本)设置为 INPUT,这意味着用户可以实际更改行,或者在行之间或结尾处添加行。(通过使用换行符 (\n),在最后一行的结尾处创建了一个空行。) 在 myTextField 文本字段下面设置了 countLines 文本字段(其中显示行长度的计算结果),但无法选择该字段中的文本。当用户单击 myTextField 文本字段中的某一行时,将调用 clickHandler() 方法。

clickHandler() 方法中,getLineIndexAtPoint() 方法通过使用鼠标单击的 localXlocalY 坐标来返回用户所单击的位置的行索引。if 语句检查以确定用户是否已单击了某个字符。如果是,getLineLength() 方法将使用行索引返回行中的字符数。请注意,行之间的空行包含第二个换行符 (\n) 并计为 1 个字符;而最后一行后面的空行计为 0 个字符。空格也计为一个字符。用户可以编写新的行或更改某一行,也可以单击某一行以获取其字符数。如果使用文本换行并调整屏幕大小,行索引可能会发生变化。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldType;
    import flash.events.Event;
    import flash.events.MouseEvent;

    public class TextField_getLineLengthExample extends Sprite {
        private var myTextField:TextField = new TextField();
        private var countLines:TextField = new TextField();  

        public function TextField_getLineLengthExample() {
            myTextField.x = 10;
            myTextField.y = 10;
            myTextField.width = 350;
            myTextField.height = 150;
            myTextField.background = true;
            myTextField.border = true;
            myTextField.type = TextFieldType.INPUT;
            
            myTextField.appendText("Click on the lines to count its number of characters:\n\n");
            myTextField.appendText("This is a short line.\n");
            myTextField.appendText("This is a longer line than the last line.\n\n");
            myTextField.appendText("This one is even longer than the one before. It has two sentences.\n");

            this.addChild(myTextField);

            countLines.border = true;
            countLines.x = 10;
            countLines.y = 180;
            countLines.height = 30;
            countLines.width = 200;
            countLines.background = true;
            countLines.selectable = false;

           this.addChild(countLines);    

            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
        }

        private function clickHandler(e:MouseEvent):void {
            var index:int = myTextField.getLineIndexAtPoint(e.localX, e.localY);
        
            if (index != -1) {
            var lenght:int = myTextField.getLineLength(index);

            countLines.text = "Number of characters in the line is: " + lenght.toString();
            }
        }
    }
}
getLineMetrics()方法 
public function getLineMetrics(lineIndex:int):TextLineMetrics

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
TextLineMetrics — 一个 TextLineMetrics 对象。

引发
RangeError — 指定的行号超出范围。

另请参见


示例

下面的示例显示两个不同格式的文本行的某些行度量值。

附加的文本选自 Walt Whitman 的诗歌 Song of Myself 中的两行。使用了一个新的 TextFormat 对象 (newFormat) 来设置第二行的格式。第一行保留默认格式。getLineMetrics() 方法返回特定行的 TextLineMetrics 对象。(行索引从 0 开始。) 通过分别使用第 1 行和第 2 行的 metrics1metrics2 TextLineMetrics 对象,可以检索并显示这两行的 ascent、descent、height 和 weight 值。结果数字将转换为字符串,而不进行舍入。请注意,该值用于行而不是特定字符。它反映了某一行的字符范围。例如,如果某一行中包含各种具有不同高度格式的字符,则由高度最高的字符确定该值。这也意味着,如果其中一个字符的格式发生变化,某些度量值也可能会发生变化。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextLineMetrics;
    import flash.text.TextFieldAutoSize;
    import flash.text.AntiAliasType;
    import flash.text.TextFormat;
 
    public class TextField_getLineMetricsExample extends Sprite {

        public function TextField_getLineMetricsExample() {
            var myTextField:TextField = new TextField();
            var newFormat:TextFormat = new TextFormat(); 

            myTextField.x = 10;
            myTextField.y = 10;
            myTextField.background = true;
            myTextField.wordWrap = false;
            myTextField.autoSize = TextFieldAutoSize.LEFT;
            
            myTextField.appendText("A child said What is the grass? fetching it to me with full hands;\n");
            myTextField.appendText("How could I answer the child? I do not know what it is any more than he.\n\n");

            newFormat.size = 14;
            newFormat.font = "Arial";
            newFormat.italic = true;
            myTextField.setTextFormat(newFormat, 67, 139);
               
            var metrics1:TextLineMetrics = myTextField.getLineMetrics(0);
             
            myTextField.appendText("Metrics ascent for the line 1 is: " + metrics1.ascent.toString() + "\n");
            myTextField.appendText("Metrics descent is: " + metrics1.descent.toString() + "\n");
            myTextField.appendText("Metrics height is: " + metrics1.height.toString() + "\n"); 
            myTextField.appendText("Metrics width is: " + metrics1.width.toString() + "\n\n");

            var metrics2:TextLineMetrics = myTextField.getLineMetrics(1);
             
            myTextField.appendText("Metrics ascent for the line 2 is: " + metrics2.ascent.toString() + "\n");
            myTextField.appendText("Metrics descent is: " + metrics2.descent.toString() + "\n");
            myTextField.appendText("Metrics height is: " + metrics2.height.toString() + "\n"); 
            myTextField.appendText("Metrics width is: " + metrics2.width.toString() + "\n");

            addChild(myTextField);
        }
    }
}
getLineOffset()方法 
public function getLineOffset(lineIndex:int):int

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
int — 行中第一个字符的索引值(从零开始)。

引发
RangeError — 指定的行号超出范围。

示例

下面的示例检查第 4 行中的第一个字符,如果调整了屏幕(和文本字段)大小,该字符将会发生变化。

我们将 myTextField 文本字段设置为自动换行。countField 文本字段将显示第 4 行中的第一个字符。当用户单击 myTextField 文本字段时,将调用 clickHandler() 方法。

clickHandler() 方法中,getLineOffset() 方法返回行索引 3(第 4 个文本行)中的第一个字符的索引。(第 1 行包含索引 0。) 我们使用 charAt() 方法以及第 4 行中的第一个字符的索引来获取字符; 并通过 countField 文本字段的 text 属性使用此信息更新 countField 文本字段内容。使用 countField.text 属性意味着,每次单击后,将会覆盖 countField 文本字段的内容。如果用户调整了显示方式,内容将会换行,第 4 行中的第一个字符可能会发生变化。通过再次单击 myTextField 字段,将使用第 4 行中的第一个字符(新字符)更新 countField 文本字段的内容。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.events.MouseEvent;

    public class TextField_getLineOffsetExample extends Sprite {
        private var myTextField:TextField = new TextField();
        private var countField:TextField = new TextField();
        
        public function TextField_getLineOffsetExample() {
            myTextField.x = 10;
            myTextField.y = 10;
            myTextField.width = 150;
            myTextField.height = 300;
            myTextField.background = true;
            myTextField.border = true;
            myTextField.wordWrap = true;

            countField.height = 20;
            countField.width = 200;
            countField.x = 10;
            countField.y = 320;
            countField.selectable = false;
            
            myTextField.appendText("The TextField class is used to create display objects for "
                        + "text display and input. All dynamic and input text fields in a SWF file " 
                        + "are instances of the TextField class. You can use the TextField class "
                        + "to perform low-level text rendering. However, in Flex, you typically use "
                        + "the Label, Text, TextArea, and TextInput controls to process text. "  
                        + "You can give a text field an instance name in the Property inspector "
                        + "and use the methods and properties of the TextField class to manipulate it with ActionScript.");

            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
        
            this.addChild(myTextField);
            this.addChild(countField);
        }
    
            private function clickHandler(e:MouseEvent):void {
                var c:String;
                var index:int;
                
                index = myTextField.getLineOffset(3);
                c = myTextField.text.charAt(index);
                countField.text = "The first character of line 4 is: " + c;
            }
    }
}
getLineText()方法 
public function getLineText(lineIndex:int):String

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
String — 指定行中包含的文本字符串。

引发
RangeError — 指定的行号超出范围。

示例

在下面的示例中,将查找并显示在莎士比亚的十四行诗中使用“love”一词的所有实例的行号。

我们将 poem 文本字段设置为自动适应文本并调整为左对齐的文本; 并将 wordWrap 属性设置为 false,诗歌不会换行(但通常是在使用 autoSize 属性时),因而不会出现问题。for 循环使用文本字段的 numLines 属性循环访问十四行诗中的各行。getLineText() 方法将行内容作为字符串返回。(请注意,numLines 属性从第 1 行开始返回行数;而对于 getLineText() 方法,行号从 0 开始。) 通过使用正则表达式模式 (/love/i),if 语句查找词的任何子字符串(大写或小写)。如果找到该模式,search 方法将返回第一个匹配的子字符串的索引,否则,它返回 -1(如果不匹配)。然后,将找到“love”一词的行号 ((i + 1)) 放在字符串 lineResult 中。只要另一个参数是字符串 (" "),此字符串方法就会将数字参数 ((i + 1)) 转换为字符串。搜索的行结果将包含具有“loved”或“Love's”一词的行。如果字符串“Love was found in lines:”是在 for 循环之前附加的,则也会包括此行中的“Love”一词。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;
    import flash.utils.Timer;
    import flash.events.TimerEvent;
 
    public class TextField_getLineTextExample extends Sprite {
           
        public function TextField_getLineTextExample() {
           var poem:TextField = new TextField();
           var lineResult:String = ""; 
           var pattern:RegExp = /love/i;

            poem.x = 10;
            poem.y = 10;
            poem.background = true;
            poem.wordWrap = false;
            poem.autoSize = TextFieldAutoSize.LEFT;
            
            poem.text = "Let me not to the marriage of true minds\n"
                              + "Admit impediments. love is not love\n"
                              + "Which alters when it alteration finds\n"
                              + "Or bends with the remover to remove:\n"
                              + "O no! it is an ever-fixed mark\n" 
                              + "That looks on tempests and is never shaken;\n"
                              + "It is the star to every wandering bark,\n"
                              + "Whose worth's unknown, although his height be taken.\n"
                              + "Love's not Time's fool, though rosy lips and cheeks\n"
                              + "Within his bending sickle's compass come:\n"
                              + "Love alters not with his brief hours and weeks,\n"
                              + "But bears it out even to the edge of doom.\n"
                              + "If this be error and upon me proved,\n"
                              + "I never writ, nor no man ever loved.\n\n";

            for (var i:int = 0; i < poem.numLines; i++) {

                var s:String = poem.getLineText(i);
                        
                if(s.search(pattern) != -1) {
                    lineResult += (i + 1) + " ";
                }
            }

            poem.appendText("Love was found in lines: " + lineResult);
             
            this.addChild(poem);                      
        }
    }
}
getParagraphLength()方法 
public function getParagraphLength(charIndex:int):int

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

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

参数

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

返回
int — 返回段落中的字符数。

引发
RangeError — 指定的字符索引超出范围。

另请参见


示例

在下面的示例中,当用户选择某个段落时,将在单独的文本字段中显示段落长度和段落中的“s”字符数。

myTextField 文本字段显示用户将选择的段落。当用户单击该文本字段时,将调度 MouseEvent.CLICK 事件并调用 clickHandler() 方法。段落长度和“s”字符数将显示在 countField 文本字段中,该字段位于 myTextField 文本字段下面。

clickHandler() 方法中,getCharIndexAtPoint() 方法基于鼠标单击的 localXlocalY 坐标来返回字符的索引。第一条 if 语句检查以确定用户是否已单击了某个字符。getFirstCharInParagraph() 方法使用此索引返回相同段落中的第一个字符的索引。可以将 getParagraphLength() 方法返回的段落长度与段落中第一个字符的索引配合使用来确定段落结尾的索引。for 循环将循环访问段落以查找“s”字符数。

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.events.MouseEvent;

    public class TextField_getParagraphLengthExample extends Sprite {
        private var myTextField:TextField = new TextField();
        private var countField:TextField = new TextField();

        public function TextField_getParagraphLengthExample() {
            myTextField.x = 10;
            myTextField.y = 10;
            myTextField.background = true;
            myTextField.border = true;
            myTextField.wordWrap = true;
            myTextField.width = 300;
            myTextField.height = 280;
            
            myTextField.appendText("The TextField class is used to create display objects for "
                        + "text display and input. All dynamic and input text fields in a SWF file" 
                        + "are instances of the TextField class. You can use the TextField class "
                        + "to perform low-level text rendering. However, in Flex, you typically use "
                        + "the Label, Text, TextArea, and TextInput controls to process text. "  
                        + "You can give a text field an instance name in the Property inspector "
                        + "and use the methods and properties of the TextField class to manipulate it with ActionScript. "
                        + "TextField instance names are displayed in the Movie Explorer and in the Insert "
                        + "Target Path dialog box in the Actions panel.\n\n"  
                        + "To create a text field dynamically, use the TextField() constructor.\n\n"
                        + "The methods of the TextField class let you set, select, and manipulate "  
                        + "text in a dynamic or input text field that you create during authoring or at runtime.");

            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
            
            countField.x = 10;
            countField.y = 300;
            countField.height = 50;
            countField.width = 250;
            countField.background = true;
            countField.selectable = false;

            this.addChild(myTextField);
            this.addChild(countField);
        }

        private function clickHandler(e:MouseEvent):void {
            var index:int = myTextField.getCharIndexAtPoint(e.localX, e.localY);
            
            if(index != -1) {
                var beginParag:int = myTextField.getFirstCharInParagraph(index);
                var paragLength:int = myTextField.getParagraphLength(index);
                var endParag:int = beginParag + paragLength;
                var sCount:uint = 0;

                for (var i:int = beginParag; i <= endParag; i++) {
                    if ((myTextField.text.charAt(i) == "s") || (myTextField.text.charAt(i) == "S")) {
                        sCount++; 
                    }

                countField.text = "Paragraph length is: " + paragLength.toString() + "\n" 
                        + "Number of 's' characters in the paragraph: " + sCount.toString();
                }
            }
        }
    }
}
getTextFormat()方法 
public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat

语言版本: ActionScript 3.0
运行时版本: AIR 1.0 Flash Player 9

返回 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 的文本。

返回