TLFTextField  - AS3 Flash

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

示例：

		package 
		{
		    import flash.display.Sprite;
		    import fl.text.TLFTextField;
		    import flash.text.TextFieldType;
		
    	    public class TLFTextField_alwaysShowSelection extends Sprite 
		    {
		
		        public function TLFTextField_alwaysShowSelection() 
		        {
		            var label1:TLFTextField = createTLFTextField(0, 20, 200, 20);
		            label1.text = "This text is selected.";
		            label1.setSelection(0, 9);
		            label1.alwaysShowSelection = true;
		
		            var label2:TLFTextField = createTLFTextField(0, 50, 200, 20);
		            label2.text = "Drag to select some of this text.";
		        }
		
		        private function createTLFTextField(x:Number, y:Number, width:Number, height:Number):TLFTextField 
		        {
		            var result:TLFTextField = new TLFTextField();
		            result.x = x; 
		            result.y = y;
		            result.width = width; 
		            result.height = height;
		            addChild(result);
		            return result;
		        }
		    }
		}
		

默认值为 false。

相关 API 元素

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

要设置此属性的值，请使用下列字符串值：

默认值为 flash.text.AntiAliasType.NORMAL。

相关 API 元素

控制文本字段的自动大小调整和对齐。TextFieldAutoSize 常数的可接受值为 TextFieldAutoSize.NONE（默认值）、TextFieldAutoSize.LEFT、TextFieldAutoSize.RIGHT 和 TextFieldAutoSize.CENTER。

如果 autoSize 设置为 TextFieldAutoSize.NONE（默认值），则不会进行调整。

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

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

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

相关 API 元素

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

默认值为 false。

相关 API 元素

指定文本字段背景的 alpha 值。背景的 alpha 可以设置为 0（完全透明）和 1（完全不透明）之间的任意值。即使在当前没有背景，也可以检索或设置此属性，但仅当文本字段已将 background 属性设置为 true 时，alpha 效果才可见。

默认值为 1.0。

相关 API 元素

指定文本字段背景的颜色。即使当前没有背景，也可检索或设置此属性，但只有当文本字段已将 background 属性设置为 true 时，才可以看到颜色。

默认值为 0xFFFFFF (white)。

相关 API 元素

指定线位置的垂直或水平行进。将行按照从上至下（BlockProgression.TB，用于水平文本行）或从右至左（BlockProgression.RL，用于垂直文本行）的顺序放置。

合法值为 flashx.textLayout.formats.BlockProgression.RL、flashx.textLayout.formats.BlockProgression.TB 和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性将从一个祖代继承值。如果没有祖代设置此属性，则其值为 TB。

默认值为 undefined (indicates not set)。

相关 API 元素

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

默认值为 false。

相关 API 元素

指定边框的 Alpha 值。边框的 alpha 可以设置为 0（完全透明）和 1（完全不透明）之间的任意值。即使当前没有边框，也可以检索或设置此属性，但仅当文本字段已将 border 属性设置为 true 时，alpha 效果才可见。

默认值为 1.0。

相关 API 元素

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

相关 API 元素

指定边框的宽度。边框的宽度可以设置为 1 和 100 之间的任意值。即使在当前没有边框，也可以检索或设置此属性，但仅当文本字段的 border 属性设置为 true 时，宽度才可见。

计算文本字段的宽度或高度时，将考虑边框的宽度。要获取不带边框的文本容器的宽度或高度，请从宽度或高度值中减去两次 borderWidth。

例如，txtHeight = tlf.height - (2 tlf.borderwidth);。

默认值为 1。

相关 API 元素

一个整数（从 1 开始的索引），表示指定文本字段中当前可以看到的最后一行。可将文本字段看作文本块上的一个窗口。scrollV 属性是窗口中第一个可见行的基于 1 的索引，bottomScroll 是窗口中的最后一个可见行。

当前可以看到文本字段中 scrollV 和 bottomScrollV 表示的行之间的所有文本。

相关 API 元素

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

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

示例：

		package 
		{
			import flash.display.Sprite;
			import flash.events.MouseEvent;
			import fl.text.TLFTextField;
			import flash.text.TextFieldType;
		
			public class TLFTextField_caretIndex extends Sprite 
			{
				public function TLFTextField_caretIndex() 
				{
					var tlf:TLFTextField = createTLFTextField(10, 10, 100, 100);
					tlf.wordWrap = true;
					tlf.type = TextFieldType.INPUT;
					tlf.text = "Click in this text field. Compare the difference between clicking without selecting versus clicking and selecting text.";
					tlf.addEventListener(MouseEvent.CLICK, printCursorPosition);
				}
		
				private function printCursorPosition(event:MouseEvent):void 
				{
					var tlf:TLFTextField = TLFTextField(event.currentTarget);
					trace("caretIndex:", tlf.caretIndex);
					trace("selectionBeginIndex:", tlf.selectionBeginIndex);
					trace("selectionEndIndex:", tlf.selectionEndIndex);
				}
		
				private function createTLFTextField(x:Number, y:Number, width:Number, height:Number):TLFTextField 
				{
					var result:TLFTextField = new TLFTextField();
					result.x = x;
					result.y = y;
					result.width = width;
					result.height = height;
					addChild(result);
					return result;
				}
			}
		}		 
		

相关 API 元素

文本列数（如果在层叠期间未定义，则使用默认值）。该列数会覆盖其它列设置。该值是一个整数，如果未指定，则为 FormatValue.AUTO。如果未指定 columnCount，则系统使用 columnWidth 创建容器可容纳的尽可能多的列。

合法字符串值为 flashx.textLayout.formats.FormatValue.AUTO、flashx.textLayout.formats.FormatValue.INHERIT 及从 1 到 50 范围内的整数。

如果在层叠期间未定义，则此属性值为 AUTO。

默认值为 undefined (indicates not set)。

相关 API 元素

指定要在列之间留出的装订线空间量（以像素为单位），如果在层叠期间未定义，则使用默认值。

合法值为 0 到 1000 范围内的数字和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性值为 20。

默认值为 undefined (indicates not set)。

相关 API 元素

列宽（以像素为单位）（如果在层叠期间未定义，则使用默认值）。如果指定了列宽而没有指定列数，则 TextLayout 将根据容器宽度和 columnGap 设置，尽可能多地创建具有该宽度的列。在最后一个列之后将留出任意空格。该值是一个数字。

合法值为字符串 flashx.textLayout.formats.FormatValue.AUTO、flashx.textLayout.formats.FormatValue.INHERIT，和 0 到 8000 范围内的数字。

如果在层叠期间未定义，则此属性值为 AUTO。

默认值为 undefined (indicates not set)。

相关 API 元素

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

如果 condenseWhite 设置为 true，请使用标准 HTML 标记（如 <br> 和 <p>）将换行符放在文本字段中。

请先设置 condenseWhite 属性，再设置 htmlText 属性或 tlfMarkup 属性。

下面的示例演示了如何使用 condenseWhite 属性从 tlfMarkup 内容中删除额外空白：

		 import fl.text.TLFTextField;
		 
		 var my_tlf:TLFTextField = new TLFTextField();
		 my_tlf.autoSize = 'left';
		 
		 // This line removes white space from tlfMarkup
		 my_tlf.condenseWhite = true;
		 
		 addChild(my_tlf);
		 
		 var my_markup:String =   '<TextFlow xmlns="http://ns.adobe.com/textLayout/2008">'
		 					+ '	<p>'
		 					+ '		<span>Here is the first span.</span>'
		 					+ ' 	       \n'
		 					+ '		<span>And here is the second span.</span>'
		 					+ '	</p>'
		 					+ '</TextFlow>';
		 					
		 my_tlf.tlfMarkup = my_markup;
		 

默认值为 false。

相关 API 元素

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

相关 API 元素

指定文本在文本块中的默认双向嵌入级别。从左到右的阅读顺序，如在拉丁风格的文本中，或者从右到左的阅读顺序，如阿拉伯语或希伯来语。此属性还影响在容器级别应用时列的方向。与文本一样，列可以为从左到右或从右到左排列。下面给出了一些示例：

合法值为 flashx.textLayout.formats.Direction.LTR、flashx.textLayout.formats.Direction.RTL 和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性将从一个祖代继承值。如果没有祖代设置此属性，则其值为 LTR。

默认值为 undefined (indicates not set)。

相关 API 元素

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

默认值为 false。

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

如果将文本字段的 embedFonts 属性设置为 true，则必须使用应用于该文本字段的 TextFormat 对象的 font 属性来指定该文本的字体。如果指定的字体未嵌入 SWF 文件，将以 fall back 字体显示文本。

默认值为 false。

相关 API 元素

指定容器中第一行的基线位置。该属性引用的基线取决于容器级别的区域设置。对于日语和中文，为 TextBaseline.IDEOGRAPHIC_BOTTOM；对于所有其它语言，为 TextBaseline.ROMAN。从容器顶部边界（如果 blockProgression 是 RL 则为右侧边界）到第一行的基线之间的偏移可以是 BaselineOffset.ASCENT，表示等于行的 ascent（文本顶端或右端到基线的距离），也可以是 BaselineOffset.LINE_HEIGHT，表示等于第一行的高度，或者是任何固定值数字，用于指定绝对距离。BaselineOffset.AUTO 可将行的 ascent 与容器顶部边界对齐。

合法值为字符串 flashx.textLayout.formats.BaselineOffset.AUTO、flashx.textLayout.formats.BaselineOffset.ASCENT、flashx.textLayout.formats.BaselineOffset.LINE_HEIGHT、flashx.textLayout.formats.FormatValue.INHERIT 和 0 到 1000 范围内的数字。

如果在层叠期间未定义，则此属性将从一个祖代继承值。如果没有祖代设置此属性，则其值为 AUTO。

默认值为 undefined (indicates not set)。

相关 API 元素

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

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

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

默认值为 flash.text.GridFitType.PIXEL。

相关 API 元素

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

TLFTextField 实例支持以下 HTML 标签：

Flash 还支持显式字符代码，如 &（ASCII 和号）和 €（Unicode € 符号）。

相关 API 元素

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

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

默认值为 0。

scrollH 的最大值。

相关 API 元素

scrollV 的最大值。

相关 API 元素

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

默认值为 true。

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

默认值为 false。

相关 API 元素

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

相关 API 元素

底部边界（以像素为单位）（如果在层叠期间未定义，则使用默认值）。容器底部边缘与文本之间的空间。该值是一个数字。

对于水平文本，在含有多个列的可滚动容器中，第一列和后续列将填充部分显示为容器底部的空白，但是对于最后一列，如果文本没有完全填充，可能必须进行滚动才能看到填充。

合法值为 0 到 1000 范围内的数字和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性值为 0。

默认值为 undefined (indicates not set)。

相关 API 元素

左边边界（以像素为单位）（如果在层叠期间未定义，则使用默认值）。容器左边缘与文本之间的空间。该值是一个数字。

对于垂直文本，在含有多个列的可滚动容器中，第一列和后续列将填充部分显示为容器末尾的空白，但是对于最后一列，如果文本没有完全填充，可能必须进行滚动才能看到填充。

合法值为 0 到 1000 范围内的数字和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性值为 0。

默认值为 undefined (indicates not set)。

相关 API 元素

右边边界（以像素为单位）（如果在层叠期间未定义，则使用默认值）。容器右边缘与文本之间的空间。该值是一个数字。

合法值为 0 到 1000 范围内的数字和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性值为 0。

默认值为 undefined (indicates not set)。

相关 API 元素

顶部边界（以像素为单位）（如果在层叠期间未定义，则使用默认值）。容器顶部边缘与文本之间的空间。该值是一个数字。

合法值为 0 到 1000 范围内的数字和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性值为 0。

默认值为 undefined (indicates not set)。

相关 API 元素

获取或设置用于在密码块中隐藏字符的字符。

pixelScrollV 的最大值。pixelMaxScrollV 的单位为像素，与 maxScrollV 属性不同，后者以行为单位。

文本在文本字段中的垂直位置（以像素为单位），与 scrollV 不同，后者以行为单位。pixelScrollV 属性对于将 textField 平滑滚动到特定位置非常有用。

相关 API 元素

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

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

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

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

相关 API 元素

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

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

相关 API 元素

一个布尔值，表示文本字段是否可选。值 true 表示文本可选。selectable 属性控制文本字段是否可选，而不控制它是否可编辑。与传统的动态文本字段或输入文本字段不同，如果 TLF 文本字段是可编辑的，则它始终是可选的。如果此属性设置为 false，并且输入类型设置为动态，则用户无法选择其文本。

如果 selectable 设置为 false，则文本字段中的文本不响应来自鼠标或键盘的选择命令，并且不能使用“复制”命令复制文本。如果 selectable 设置为 true，则可以使用鼠标或键盘选择文本字段中的文本，并且可以使用“复制”命令复制文本。

默认值为 true。

相关 API 元素

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

相关 API 元素

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

相关 API 元素

Sharpness 不适用于 TLF 文本字段。将忽略提供的任何值，并始终返回零。

TLF 文本字段的样式表。

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

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

相关 API 元素

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

默认值为 0 (0x000000)。

使用此属性将 flashx 包中 TLF 类中的格式设置分配给 TLFTextField 实例。例如：

		 var myFormat:TextLayoutFormat = new TextLayoutFormat();
		 myFormat.textIndent = 8;
		 myFormat.color = 0x336633;
		 myFormat.fontFamily = "Arial, Helvetica, _sans";
		 myFormat.fontSize = 24;
		 
		 var myTextFlow:TextFlow = myTLFTextField.textFlow;
		 myTextFlow.hostFormat = myFormat;
		 

相关 API 元素

文本的高度，以像素为单位。上边距和下边距不计入此值中。

相关 API 元素

文本的宽度，以像素为单位。左边距和右边距不计入此值中。

相关 API 元素

thickness 属性不适用于 TLF 文本字段。将忽略提供的任何值，并始终返回零。

设置或获取 TLF 文本字段中文本的 TLF 标记。

标记规范发布于 http://sourceforge.net/projects/tlf.adobe/files/docs/TLF_2.0_specification.pdf/download。

相关 API 元素

文本字段的类型。以下两个 TextFieldType 常数中的任一个：TextFieldType.DYNAMIC，它指定用户无法编辑的可选 TLF 文本字段，或者 TextFieldType.INPUT ，它指定用户可以编辑可编辑的 TLF 文本字段。

默认值为 dynamic。

相关 API 元素

指定是否将文本格式随文本一起复制到剪贴板。设置为 true 时，Flash Player 会将 tlfMarkup 格式中的格式设置（如，对齐方式、粗体和斜体）复制到剪贴板中。

默认值为 false。

相关 API 元素

垂直对齐或两端对齐（如果在层叠期间未定义，则使用默认值）。确定 TextFlow 元素在容器内如何对齐。

合法值为 flashx.textLayout.formats.VerticalAlign.TOP、flashx.textLayout.formats.VerticalAlign.MIDDLE、flashx.textLayout.formats.VerticalAlign.BOTTOM、flashx.textLayout.formats.VerticalAlign.JUSTIFY 和 flashx.textLayout.formats.FormatValue.INHERIT。

如果在层叠期间未定义，则此属性值为 TOP。

默认值为 undefined (indicates not set)。

相关 API 元素