TLFTextField  - AS3 Flash

true に設定され、テキストフィールドにフォーカスがない場合、テキストフィールド内の選択内容は明るい青色でハイライト表示されます。false に設定され、テキストフィールドにフォーカスがない場合、テキストフィールド内の選択内容はハイライト表示されません。

例：

		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 エレメント

テキストフィールドの背景のアルファ値を指定します。背景のアルファ値には、0（透明）～1（ベタ塗り）の範囲の任意の値を設定できます。このプロパティは、現在背景がない場合でも取得または設定できます。ただし、背景のアルファ効果が表示されるのは、テキストフィールドの background プロパティが true に設定されている場合のみです。

デフォルト値： 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 エレメント

境界線のアルファ値を指定します。境界線のアルファ値には、0（透明）～1（ベタ塗り）の範囲の任意の値を設定できます。このプロパティは、現在境界線がない場合でも取得または設定できます。ただし、境界線のアルファ効果が表示されるのは、テキストフィールドの background プロパティが true に設定されている場合のみです。

デフォルト値： 1.0。

関連する API エレメント

テキストフィールドの境界線の色を指定します。デフォルト値は 0x000000（黒）です。このプロパティは、現在境界線がない場合でも取得または設定できます。ただし、境界線の色が表示されるのはテキストフィールドの border プロパティが true に設定されている場合のみです。

関連する API エレメント

境界線の太さを指定します。境界線の太さには、1 ～100 の範囲の任意の値を設定できます。このプロパティは、現在境界線がない場合でも取得または設定できます。ただし、境界線の幅（太さ）が表示されるのは、テキストフィールドの border プロパティが true に設定されている場合のみです。

境界線の太さは、テキストフィールドの幅または高さを計算するときに考慮されます。テキストコンテナの幅または高さから境界線の太さ分を除いた値を求めるには、幅または高さの値から borderWidth を 2 倍した値を減算します。

例えば、txtHeight = tlf.height - (2 tlf.borderwidth); のようになります。

デフォルト値： 1。

関連する API エレメント

指定されたテキストフィールドに現在表示されている一番下の行を示す整数です（1 から始まるインデックス）。テキストフィールドは、テキストのブロックにかぶせたウィンドウのようなものです。scrollV プロパティは、そのウィンドウに表示されている先頭行を示すインデックス（1 から始まるインデックス）であり、bottomScroll はウィンドウの最後の行を示すインデックスです。

scrollV と bottomScrollV で示される行の間のすべてのテキストが、テキストフィールドに現在表示されています。

関連する API エレメント

カーソル（キャレット）位置のインデックスです。カーソルが表示されていない場合、この値は、フォーカスをフィールドに戻した場合にカーソルが表示される位置を示します。通常は、カーソルの最後の位置を示します。フィールドにフォーカスがなかった場合は 0 になります。

選択範囲のインデックスは 0 から始まります。つまり、最初の位置は 0、2 番目の位置は 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 の int です。

カスケード時に定義されていない場合、このプロパティの値は 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 プロパティは、TLF マークアップ、または htmlText プロパティで設定されたテキストにのみ影響し、text プロパティで設定されたテキストには影響しません。text プロパティでテキストを設定した場合、condenseWhite は無視されます。

condenseWhite を true に設定した場合は、テキストフィールド内で改行を指定するときに <br> や <p> といった標準の HTML タグを使用します。

htmlText プロパティまたは tlfMarkup プロパティを設定する前に、condenseWhite プロパティを設定します。

次の例では、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 である場合は、デバイスフォントを使用してテキストフィールドをレンダリングします。

テキストフィールドの embedFonts プロパティを true に設定する場合、テキストフィールドに適用される TextFormat オブジェクトの font プロパティを使用して、そのテキストのフォントを指定する必要があります。指定したフォントが SWF ファイルに埋め込まれていない場合、テキストは代替フォントで表示されます。

デフォルト値： false。

関連する API エレメント

コンテナ内の最初の行のベースライン位置を指定します。このプロパティがどのベースラインを参照するかは、コンテナレベルのロケールにより異なります。これは、日本語と中国語で TextBaseline.IDEOGRAPHIC_BOTTOM、他のすべての言語で TextBaseline.ROMAN となります。コンテナの上部のインセット（blockProgression が RL の場合は右側のインセット）から 1 行目のベースラインへのオフセットの値には、BaselineOffset.ASCENT（行のアセント）、BaselineOffset.LINE_HEIGHT（1 行目の高さ）、または絶対距離を指定する任意の固定数値を指定できます。BaselineOffset.AUTO に指定すると、行のアセントとコンテナの上部のインセットが揃えられます。

有効な値は、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.text.GridFitType プロパティでは、次のストリング値を使用できます。

デフォルト値： flash.text.GridFitType.PIXEL。

関連する API エレメント

テキストフィールドの内容を HTML で表します。

TLFTextField インスタンスでは、次の HTML タグをサポートしています。

Flash ではまた、&（ASCII のアンパサンド）や €（Unicode の € シンボル）など、文字コードの明示的な指定もサポートされています。

関連する API エレメント

テキストフィールド内の文字数です。タブ（\t）などの文字も 1 文字としてカウントされます。

ユーザーが入力するときに、テキストフィールドに入力できる最大の文字数です。スクリプトは maxChars の許容数を超えるテキストを挿入できます。maxChars プロパティで指定されるのは、ユーザーが入力できるテキストの量だけです。このプロパティの値が 0 である場合、ユーザーが入力できるテキストの量には制限がありません。

デフォルト値： 0。

scrollH の最大値です。

関連する API エレメント

scrollV の最大値です。

関連する API エレメント

複数行にわたるテキストフィールドで、ユーザーがテキストフィールドをクリックしてホイールを回転させると、自動的にスクロールするかどうかを示すブール値です。このプロパティは、マウスホイールでテキストフィールドをスクロールしない場合や、テキストフィールドのスクロールを独自に実装する場合に便利です。

デフォルト値： true。

テキストフィールドが複数行テキストフィールドであるかどうかを示します。値が true である場合は複数行テキストフィールド、値が false である場合は単一行テキストフィールドです。TextFieldType.INPUT タイプのフィールドでは、multiline の値によって、Enter キーで改行されるかどうかが決定されます（値が false の場合 Enter キーは無視されます）。TextField の multiline の値が false に設定されている場合、テキストをこのフィールドに貼り付けると、改行は削除されます。

デフォルト値： false。

関連する API エレメント

複数行テキストフィールド内のテキスト行の数を定義します。wordWrap プロパティが true に設定されている場合、テキストが折り返されると行数は増えます。

関連する API エレメント

下部のインセット（ピクセル単位）です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。コンテナの下端とテキストの間のスペースです。 値は数値で指定します。

複数列を含むスクロール可能なコンテナ内の横書きの場合、1 列目とそれに続く列にはコンテナの最下部に空白スペースとしてパディングが表示されますが、最後の列にテキストがすべて収まらない場合、パディングを表示するにはスクロールする必要があります。

有効な値は、0 ～ 1000 の数値および flashx.textLayout.formats.FormatValue.INHERIT です。

カスケード時に定義されていない場合、このプロパティの値は 0 になります。

デフォルト値： undefined (indicates not set)。

関連する API エレメント

左側のインセット（ピクセル単位）です（カスケード時に定義されていない場合、デフォルトの値が採用されます）。コンテナの左端とテキストの間のスペースです。 値は数値で指定します。

複数列を含むスクロール可能なコンテナ内の縦書きの場合、1 列目とそれに続く列にはコンテナの末尾に空白スペースとしてパディングが表示されますが、最後の列にテキストがすべて収まらない場合、パディングを表示するにはスクロールする必要があります。

有効な値は、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 の最大値です。行ベースの maxScrollV プロパティとは異なり、pixelMaxScrollV の単位はピクセルです。

テキストフィールド内のテキストの垂直位置（ピクセル単位）です。行ベースの scrollV とは異なります。pixelScrollV プロパティは、特定の位置に textField をスムーズにスクロールする場合に便利です。

関連する API エレメント

ユーザーがテキストフィールドに入力できる文字のセットを指定します。restrict プロパティの値が null である場合は、任意の文字を入力できます。restrict プロパティの値が空のストリングである場合は、いずれの文字も入力できません。restrict プロパティの値が文字のストリングである場合は、そのストリング内の文字のみをテキストフィールドに入力できます。ストリングは左から右へスキャンされます。ハイフン（-）文字を使用して、範囲を指定できます。制限されるのはユーザー入力のみです。スクリプトは任意のテキストをテキストフィールドに入力できます。このプロパティは、プロパティインスペクターの埋め込みフォントのオプションと同期しません。

ストリングがキャレット（^）文字で始まる場合、そのストリングに含まれる文字を除いて、すべての文字を入力できます。ストリングがキャレット（^）文字以外で始まる場合は、そのストリングに含まれる文字のみを入力できます。

次の例では、大文字、スペース、および数値のみをテキストフィールドに入力できます。

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

次の例では、小文字を除くすべての文字を入力できます。

		 my_txt.restrict = "^a-z";
		 

円記号を使用して ^ または - のリテラルを入力できます。許容される円記号のシーケンスは \-、\^、または \\ です。円記号をストリングの 1 文字として実際に使用するには、ActionScript で指定するときに円記号を 2 つ続けて指定する必要があります。例えば、次のコードで表されているのはダッシュ（-）とキャレット（^）のみです。

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

ストリング内では任意の場所で ^ を使用し、入力できる文字と除外する文字を切り替えることができます。次のコードでは、大文字のみを入力できます。ただし、大文字の Q を除きます。

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

¥u エスケープシーケンスを使用して restrict ストリングを作成できます。次のコードでは、ASCII 32（スペース）から ASCII 126（チルダ）までの文字のみを入力できます。

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

デフォルト値： null。

現在の水平スクロール位置です。scrollH プロパティが 0 である場合、テキストは水平にスクロールされません。このプロパティの値は、水平位置をピクセル単位で表す整数です。

垂直スクロールの単位は行数ですが、水平スクロールの単位はピクセル数です。水平スクロールをピクセル単位で指定するのは、一般的に使用されるフォントのほとんどがプロポーショナルフォントであり、文字の幅が一定でないためです。垂直スクロールの場合は、通常、1 行のテキストの一部だけ表示されるよりも行全体が表示されることが好まれるため、行単位でスクロールします。1 行の中に複数のフォントが存在する場合でも、使用されている最大のフォントに合わせて行の高さが調整されます。

注意：scrollH プロパティは、scrollV 垂直スクロールプロパティのように 1 から始まるのではなく、0 から始まります。

関連する API エレメント

テキストフィールドのテキストの垂直位置です。scrollV プロパティは、長い文節内の特定の段落にユーザーを誘導したり、スクロールテキストフィールドを作成する場合に便利です。

水平スクロールの単位はピクセル数ですが、垂直スクロールの単位は行数です。表示される最初の行がテキストフィールド内の最初の行の場合、scrollV は 1 に設定されます。0 ではありません。水平スクロールをピクセル単位で指定するのは、フォントのほとんどがプロポーショナルフォントであり、文字の幅が一定でないためです。垂直スクロールの場合は、通常、1 行のテキストの一部だけ表示されるよりも行全体が表示されることが好まれるため、行単位でスクロールします。1 行の中に複数のフォントが存在する場合でも、使用されている最大のフォントに合わせて行の高さが調整されます。

関連する API エレメント

テキストフィールドが選択可能であるかどうかを示すブール値です。値 true は、テキストが選択可能であることを示します。selectable プロパティを使用することで、テキストフィールドが選択可能かどうかを指定できますが、編集可能かどうかは指定できません。クラシックダイナミックテキストフィールドまたは入力テキストフィールドとは異なり、編集可能な TLF テキストフィールドは、必ず選択可能になります。このプロパティが false に設定されており、入力タイプが "ダイナミック" として設定されている場合、ユーザーはこのテキストを選択できません。

selectable を false に設定すると、テキストフィールド内のテキストはマウスやキーボードからの選択コマンドに応答しなくなり、「コピー」コマンドを使用してテキストをコピーすることができなくなります。selectable を true に設定すると、テキストフィールド内のテキストはマウスやキーボードを使用して選択できるようになり、「コピー」コマンドを使用してテキストをコピーできるようになります。

デフォルト値： true。

関連する API エレメント

現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。例えば、最初の文字が 0、次の文字が 1 と続きます（以下同様）。テキストが選択されていない場合、このプロパティは caretIndex の値になります。

関連する API エレメント

現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。例えば、最初の文字が 0、次の文字が 1 と続きます（以下同様）。テキストが選択されていない場合、このプロパティは caretIndex の値になります。

関連する API エレメント

シャープネスは TLF TextField には適用されません。値を指定してもすべて無視され、常に 0 が返されます。

TLF TextField のスタイルシートです。

テキストフィールド内の現在のテキストであるストリングです。行は復帰文字（'\r'、ASCII 13）で区切られます。このプロパティは、HTML タグが付いていない、テキストフィールド内のフォーマットなしのテキストを示します。

HTML フォーム内のテキストを取得するには、htmlText プロパティを使用します。

関連する API エレメント

テキストフィールドのテキストの色です（16 進数形式）。16 進数カラーシステムでは、6 桁の数値を使用して色の値を示します。1 つの桁で、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 エレメント

太さのプロパティは TLF TextField には適用されません。値を指定してもすべて無視され、常に 0 が返されます。

TLF テキストフィールド内のテキストの TLM マークアップを設定または取得します。

マークアップ仕様は、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 エレメント

テキストフィールドのテキストを折り返すかどうかを示すブール値です。wordWrap の値が true の場合はテキストフィールドのテキストを折り返し、false の場合は折り返しません。

デフォルト値： false。

関連する API エレメント

TLFTextField オブジェクトのコンストラクターです。TextField クラスを使用してテキストフィールドを作成する場合と同じ方法で、ただし、コンストラクターは TLFTextField() を使用し、TLFTextField オブジェクトを作成します。次に実際の使用例を示します。

		 var myTLFTextField:TLFTextField = new TLFTextField();
		 

関連する API エレメント

newText パラメーターで指定されたストリングを、テキストフィールドのテキストの最後に付加します。大量の内容が含まれるテキストフィールドの場合は特に、このメソッドを使用するほうが、付加の指定（+=）を text プロパティに加える（someTextField.text += moreText など）よりも効率的です。

パラメーター

パラメーター

文字の境界ボックスである矩形を返します。

パラメーター

関連する API エレメント

x および y パラメーターで指定されたポイントにある文字の 0 から始まるインデックス値を返します。

パラメーター

文字インデックスを指定すると、同じ段落内の最初の文字のインデックスを返します。

パラメーター

指定された id の DisplayObject 参照を返します。<img> タグを使用して HTML フォーマットのテキストフィールドに追加されたイメージまたは SWF ファイルに関するものです。<img> タグは次の書式をとります。

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

パラメーター

関連する API エレメント

x および y パラメーターで指定されたポイントにある行の 0 から始まるインデックス値を返します。

パラメーター

charIndex パラメーターで指定された文字を含む行の 0 から始まるインデックス値を返します。

パラメーター

特定のテキスト行内の文字数を返します。

パラメーター

指定されたテキスト行に関するメトリック情報を返します。

パラメーター

関連する API エレメント

lineIndex パラメーターで指定された行の最初の文字の文字インデックスを返します。

パラメーター

lineIndex パラメーターで指定された行のテキストを返します。

パラメーター

文字インデックスを指定すると、指定された文字を含む段落の長さを返します。この長さは、渡された文字インデックスからではなく、段落内の最初の文字からの相対的な長さです。つまり、getFirstCharInParagraph() によって返される長さと同じになります。

パラメーター

関連する API エレメント

beginIndex および endIndex パラメーターで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクトを返します。指定されたテキスト全体に共通するプロパティのみが、結果の TextFormat オブジェクトに設定されます。混在型のプロパティ（テキストの位置によって異なる値が指定されている場合）は、その値が null に設定されます。

これらのパラメーターに値を指定しない場合、このメソッドはテキストフィールド内のすべてのテキストに適用されます。

次の表に、使用できる 3 つのシンタックスを示します。

パラメーター

関連する API エレメント

指定された fontName および fontStyle で使用できる埋め込みフォントがあり、Font.fontType が flash.text.FontType.EMBEDDED_CFF の場合には、ture を返します。Flash Player 10 以降では、2 種類の埋め込みフォントを SWF ファイルに表示できます。FontType.EMBEDDED フォントは TextField オブジェクトでのみ使用され、FontType.EMBEDDED_CFF は TLFTextField クラスおよび flash.text.engine クラスでのみ使用されます。この 2 種類の埋め込みフォントは、fontType プロパティ（Font クラスのプロパティ）（enumerateFonts() 関数で返される）で区別されます。

TLFTextField は EMBEDDED タイプのフォントを使用できません。embedFonts が true に設定され、指定された名前およびスタイルで実行時に使用可能なフォントのタイプが EMBEDDED のみである場合は、Flash Player は、代替フォントでテキストを表示します。

同じ名前とスタイルで EMBEDDED フォントと EMBEDDED_CFF フォントの両方を使用できる場合は、EMBEDDED_CFF フォントが選択され、テキストは EMBEDDED_CFF フォントで表示されます。

パラメーター

関連する API エレメント

現在の選択内容を value パラメーターの内容に置き換えます。テキストは、現在のデフォルトの文字フォーマットとデフォルトの段落フォーマットを使用して、現在の選択内容の位置に挿入されます。テキストは HTML として扱われません。

replaceSelectedText() メソッドを使用すると、他の部分のテキストの文字フォーマットおよび段落フォーマットを損なわずにテキストを挿入および削除できます。

パラメーター

関連する API エレメント

beginIndex パラメーターと endIndex パラメーターで指定された文字範囲を、newText パラメーターの内容に置き換えます。意図したとおり、beginIndex から endIndex-1 までのテキストが置き換えられます。

パラメーター

最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します。最初の文字と最後の文字のインデックス値は、beginIndex および endIndex パラメーターを使用して指定されます。2 つのパラメーター値が同じ場合、このメソッドは、caretIndex プロパティを設定した場合と同様に挿入ポイントを設定します。

パラメーター

関連する API エレメント

format パラメーターで指定したテキストフォーマットを、テキストフィールド内の指定されたテキストに適用します。format の値は、必要なテキストフォーマットの変更を指定する TextFormat オブジェクトである必要があります。format の null 以外のプロパティのみが、テキストフィールドに適用されます。format で null に設定されているプロパティは適用されません。デフォルトで、新しく作成された TextFormat オブジェクトのプロパティはすべて null に設定されます。

setTextFormat() メソッドは、テキストフィールドの文字の範囲またはテキスト全体に適用するテキストフォーマットを変更します。フォーマットのプロパティをテキストフィールド内のすべてのテキストに適用するには、beginIndex および endIndex に値を指定しないでください。フォーマットのプロパティをテキストの範囲に適用するには、beginIndex および endIndex パラメーターに値を指定します。length プロパティを使用して、インデックス値を指定できます。

TextFormat オブジェクトのフォーマット情報には、文字レベルフォーマットと段落レベルフォーマットの 2 種類があります。テキストフィールド内の各文字にも、フォント名やフォントサイズ、ボールド、イタリックなどの文字固有のフォーマットを設定できます。

段落の場合は、段落の最初の文字を調べて段落全体のフォーマット設定を判別します。段落のフォーマット設定には、左インデント、右インデント、一行目インデントなどがあります。

ユーザーによって手作業で挿入されたテキスト、または replaceSelectedText() メソッドを使用して置き換えられたテキストは、テキストの挿入か所に指定されているフォーマットではなく、新しいテキスト用のテキストフィールドのデフォルトフォーマットが適用されます。新しいテキスト用のデフォルトフォーマットを設定するには、defaultTextFormat を使用します。

パラメーター

関連する API エレメント

値が変更される前に送出される textInput イベントとは異なり、コントロールの値が変更された後に送出されます。コントロールがフォーカスを失った後でのみイベントを送出する change イベントの W3C DOM Event Model バージョンとは異なり、change イベントの ActionScript 3.0 バージョンはコントロールが変更されたときに送出されます。例えば、ユーザーがテキストフィールドにテキストを入力すると、キーストロークのたびに change イベントが送出されます。

例：

	 package {
	     import flash.display.Sprite;
         import fl.text.TLFTextField;
         import flash.text.TextFieldType;
         import flash.text.TextFormat;
         import flash.text.TextFormatAlign;
         import flash.events.Event; 
         import flash.events.TextEvent;
     
         public class TLFTextField_Event_changeExample extends Sprite {
             private var inputTLFTextField:TLFTextField = new TLFTextField(); 
             private var headingTLFTextField:TLFTextField = new TLFTextField(); 
             private var newFormat:TextFormat = new TextFormat();
        
             public function TLFTextField_Event_changeExample() {
                 newFormat.bold = true;
                 newFormat.size = 18;
                 newFormat.color = 0xFF0000;
                 newFormat.align = TextFormatAlign.CENTER;
	 
                 headingTLFTextField.defaultTextFormat = newFormat;
                 headingTLFTextField.x = 10;
                 headingTLFTextField.y = 10;
                 headingTLFTextField.background = true;
                 headingTLFTextField.backgroundColor = 0xF5F5DC;
                 headingTLFTextField.selectable = false;
                 this.addChild(headingTLFTextField);
                 headingTLFTextField.height = 30;
                 headingTLFTextField.width = 400;
     
                 inputTLFTextField.x = 10;
                 inputTLFTextField.y = 70;
                 inputTLFTextField.background = true;
                 inputTLFTextField.border = true;
                 inputTLFTextField.maxChars = 40;
                 inputTLFTextField.wordWrap = true;
                 inputTLFTextField.type = TextFieldType.INPUT;
                 this.addChild(inputTLFTextField);
                 inputTLFTextField.height = 20;
                 inputTLFTextField.width = 230;
     
                 inputTLFTextField.addEventListener(Event.CHANGE, changeHandler);
             }
     
             private function changeHandler(e:Event):void {
                 headingTLFTextField.text = inputTLFTextField.text;
             }
         }
     }
	 

このイベントには、次のプロパティがあります。

HTML が有効になっているテキストフィールドで、URL が「event:」で始まるハイパーリンクをユーザーがクリックしたときに送出されます。「event」の後の URL の部分は、LINK イベントの text プロパティ内に配置されます。

注意：デフォルトの動作であるテキストフィールドへのテキストの追加は、Flash Player がイベントを生成するときにのみ発生します。この場合は、ユーザーがテキストを入力しようとするときです。textInput イベントに送信することによってテキストフィールドにテキストを入力することはできません。

このイベントには、次のプロパティがあります。

ユーザーがスクロールした後に、TextField オブジェクトによって送出されます。

このイベントには、次のプロパティがあります。

Flash Player では、ユーザーがテキストの文字を入力したときに textInput イベントを送出します。標準キーボード、IME（入力メソッドエディター）、音声認識システム、書式やスタイルの情報を持たないプレーンテキストのペースト操作など、様々なテキスト入力メソッドによって、このイベントが生成されます。

注意：このイベントは、Delete または Backspace キーについては送出されません。

このイベントには、次のプロパティがあります。