TextField クラス

[内容]

　　テキストの入力と表示用のクラスです．なお，日本語のテキストはユニコード（ UTF-8 ）で記述しておく必要があります．

継承：　TextField → InteractiveObject → DisplayObject → EventDispatcher → Object

[プロパティ]

• alwaysShowSelection : Boolean
  　　true に設定されると，テキストフィールドにフォーカスがない場合でも，テキストフィールド内の選択内容は灰色でハイライト表示される

• antiAliasType : String
  　　アンチエイリアス処理のタイプ（ AntiAliasType.NORMAL，AntiAliasType.ADVANCED ）

• autoSize : String
  　　自動的な拡大・縮小および整列を制御（ TextFieldAutoSize.NONE (デフォルト)，TextFieldAutoSize.LEFT，TextFieldAutoSize.RIGHT，および，TextFieldAutoSize.CENTER ）

• background : Boolean
  　　背景の塗りつぶしの有無

• backgroundColor : uint
  　　背景の色（ background が true のときだけ有効）

• border : Boolean
  　　境界線の有無

• borderColor : uint
  　　境界線の色

• bottomScrollV : int
  　　現在の表示範囲で最終行を示す整数です（ 1 から始まるインデックス）

• caretIndex : int
  　　カーソル位置のインデックス

• condenseWhite : Boolean
  　　余分な空白 (スペース，改行など) を削除するか否か

• defaultTextFormat : TextFormat
  　　新しく挿入するテキストに適用するフォーマットを指定

• displayAsPassword : Boolean
  　　パスワードテキストフィールドであるか否か

• embedFonts : Boolean
  　　埋め込みフォントのアウトラインを使用してレンダリングするか否か

• gridFitType : String
  　　グリッドフィッティングのタイプ（ GridFitType.NONE，GridFitType.PIXEL，GridFitType.SUBPIXEL ）．AntiAliasType プロパティが AntiAliasType.ADVANCED に設定されている場合にのみ適用される．

• htmlText : String
  　　HTML で表示

• length : int
  　　文字数

• maxChars : int
  　　入力できる最大の文字数． 0 である場合には制限なし．

• maxScrollH : int
  　　scrollH の最大値

• maxScrollV : int
  　　scrollV の最大値

• mouseWheelEnabled : Boolean
  　　複数行にわたるテキストフィールドにおいて，テキストフィールドをクリックしてホイールを回転させたとき自動的にスクロールするか否か

• multiline : Boolean
  　　複数行テキストフィールドであるか否か

• numLines : int
  　　テキスト行の数

• restrict : String
  　　入力できる文字のセット（例： my_txt.restrict = "A-Z 0-9"; ）

• scrollH : int
  　　現在の水平スクロール位置

• scrollV : int
  　　テキストの垂直位置

• selectable : Boolean
  　　選択可能であるか否か

• selectionBeginIndex : int
  　　選択範囲の最初の文字を示す 0 から始まるインデックス値

• selectionEndIndex : int
  　　現在の選択範囲における最後の文字を示す 0 から始まるインデックス値

• sharpness : Number
  　　文字エッジのシャープネス．AntiAliasType プロパティが AntiAliasType.ADVANCED に設定されている場合にのみ適用される（ -400 ～ 400 ）．

• styleSheet : StyleSheet
  　　スタイルシート

• text : String
  　　現在のテキスト

• textColor : uint
  　　テキストの色

• textHeight : Number
  　　テキストの高さ

• textWidth : Number
  　　テキストの幅

• thickness : Number
  　　文字エッジの太さ

• type : String
  　　タイプ（ TextFieldType.DYNAMIC： 編集不可能，TextFieldType.INPUT： 編集可能）

• useRichTextClipboard : Boolean
  　　テキストと共にテキストのフォーマットをコピー & ペーストするか否か

• wordWrap : Boolean
  　　テキストを折り返すか否か

[メソッド]

• TextField()
  　　コンストラクタ

• appendText(newText:String):void
  　　指定されたストリングを最後に付加

• getCharBoundaries(charIndex:int):Rectangle
  　　文字の境界ボックスである矩形

• getCharIndexAtPoint(x:Number, y:Number):int
  　　x および y で指定された点にある文字の 0 から始まるインデックス値

• getFirstCharInParagraph(charIndex:int):int
  　　文字インデックスを指定すると，同じ段落内の最初の文字のインデックス

• getImageReference(id:String):DisplayObject
  　　指定された id の表示オブジェクト( <img> 要素で指定されたもの，または，SWF ファイルに関するもの）

• getLineIndexAtPoint(x:Number, y:Number):int
  　　x および y で指定された点にある行の 0 から始まるインデックス値

• getLineIndexOfChar(charIndex:int):int
  　　charIndex で指定された文字を含む行の 0 から始まるインデックス値

• getLineLength(lineIndex:int):int
  　　指定された行内の文字数

• getLineMetrics(lineIndex:int):TextLineMetrics
  　　指定されたテキスト行に関するメトリック情報

• getLineOffset(lineIndex:int):int
  　　指定された行の最初の文字の文字インデックス

• getLineText(lineIndex:int):String
  　　指定された行のテキスト

• getParagraphLength(charIndex:int):int
  　　指定された文字を含む段落の長さ

• getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
  　　パラメータで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクト．指定された範囲内のすべてのテキストに共通するプロパティのみが結果の TextFormat オブジェクトに設定さる．なお，範囲を指定しないとすべてのテキストが対象となる．

• replaceSelectedText(value:String):void
  　　現在の選択内容を value の内容に置換

• replaceText(beginIndex:int, endIndex:int, newText:String):void
  　　指定された範囲の内容を newText の内容に置換（テキストフィールドにスタイルシートが適用されていると機能しない）

• setSelection(beginIndex:int, endIndex:int):void
  　　指定されたテキストを選択済みに設定

• setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
  　　指定した TextFormat を，指定されたテキストに適用．範囲を指定しないとすべてのテキストに適用される．なお．テキストフィールドにスタイルシートが適用されていると機能しない．

[イベント]

• change　Event.CHANGE
  　　コントロールの値が変更された後に送出（例： テキストを入力すると，キーストロークのたびに change イベントが送出）

• link　TextEvent.LINK
  　　HTML が有効になっているテキストフィールドにおいて，URL が "event:" で始まるハイパーリンクをユーザーがクリックしたときに送出

• scroll　Event.SCROLL
  　　スクロールを行ったときに送出

• textInput　TextEvent.TEXT_INPUT
  　　テキストの文字を入力すると送出

[使用例]

1. 以下に示すのは，「TextField の使用例」と，そのプログラム（ TextField_e.as ）です

   package
   {
   	import flash.display.Sprite;
   	import flash.text.TextField;
   	import flash.text.TextFieldType;
   	import flash.text.TextFormat;
   	import flash.text.TextFormatAlign;
   
   	[SWF(backgroundColor="0xeeffee", width="300", height="200", frameRate="30")]
   
   	public class TextField_e extends Sprite
   	{
   		public function TextField_e()
   		{
   			init();
   		}
   		
   		private function init():void
   		{
   			var msg : TextField = new TextField();
   			msg.text = "何か入力して！";
   			msg.width = 150;
   			msg.height = 25;
   			msg.x = 75;
   			msg.y = 25;
   			msg.type = TextFieldType.DYNAMIC;
   			var tf_msg : TextFormat = new TextFormat();
   			tf_msg.size = 20;
   			tf_msg.align = TextFormatAlign.CENTER;
   			msg.setTextFormat(tf_msg);
   			addChild(msg);
   
   			var tx : TextField = new TextField();
   			tx.width = 250;
   			tx.height = 100;
   			tx.x = 25;
   			tx.y = 75;
   			tx.type = TextFieldType.INPUT;
   			tx.background = true;
   			tx.backgroundColor = 0xffffff;
   			tx.border = true;
   			tx.borderColor = 0x00ff00;
   			tx.multiline = true;
   			var tf : TextFormat = new TextFormat();
   			tf.size = 30;
   			tx.defaultTextFormat = tf;
   			addChild(tx);
   		}
   	}
   }
   			

[参照]

TextFormat クラス， TextLineMetrics クラス