パッケージflash.text
public class TextField
継承TextField Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
SubclassesFlexTextField

TextField クラスは、テキストの表示と入力用の表示オブジェクトを作成するために使用されます。SWF ファイルのすべてのダイナミックテキストフィールドおよびテキスト入力フィールドは、TextField クラスのインスタンスです。TextField クラスを使用すると、低レベルでのテキストレンダリングが可能になります。ただし、Flex では一般的に Label、Text、TextArea、TextInput コントロールを使用して、テキスト処理を行います。プロパティインスペクタを使用して、テキストフィールドにインスタンス名を付けることができます。また、TextField クラスのメソッドとプロパティを使用して、ActionScript でテキストフィールドを操作できます。TextField インスタンスの名前は、ムービーエクスプローラに表示されます。[アクション] パネルの [ターゲットパスの挿入] ダイアログボックスにも表示されます。

テキストフィールドを動的に作成する場合は、TextField() コンストラクタを使用します。

TextField クラスのメソッドを使用すると、オーサリング時または実行時に作成したダイナミックテキストフィールドやテキスト入力フィールドにテキストを設定、選択、および操作できます。

ActionScript には、テキストを実行時にフォーマットする方法がいくつも用意されています。TextFormat クラスでは、TextField オブジェクトの文字フォーマットと段落フォーマットを設定できます。TextField.styleSheet プロパティおよび StyleSheet クラスを使用して、テキストフィールドに CSS (Cascading Style Sheet) スタイルを適用できます。CSS を使用すると、ビルトイン HTML タグのスタイル設定、新しいフォーマットタグの定義、またはスタイルの適用を行うことができます。HTML 形式のテキスト (CSS スタイルを使用している場合も可) をテキストフィールドに直接割り当てることができます。テキストフィールドに割り当てる HTML テキストに埋め込みメディア (ムービークリップ、SWF ファイル、GIF ファイル、PNG ファイル、および JPEG ファイル) を含めることができます。この場合テキストは、Web ブラウザ上で HTML ドキュメントの埋め込みメディアの周りをテキストが囲むのと同じように、埋め込みメディアの周りを囲みます。

Flash Player では、テキストのフォーマットに利用できる HTML タグのサブセットをサポートしています。htmlText プロパティの説明の、サポートされている HTML タグのリストを参照してください。

例の表示

関連項目

flash.text.TextFormat
flash.text.StyleSheet
表示アーキテクチャについて
テキストの操作


パブリックプロパティ
 プロパティ定義
 InheritedaccessibilityProperties : AccessibilityProperties
この表示オブジェクトの現在のアクセシビリティオプションです。
DisplayObject
 Inheritedalpha : Number
指定されたオブジェクトのアルファ透明度値を示します。
DisplayObject
  alwaysShowSelection : Boolean
true に設定され、テキストフィールドにフォーカスがない場合、テキストフィールド内の選択内容は灰色でハイライト表示されます。
TextField
  antiAliasType : String
このテキストフィールドに使用されるアンチエイリアス処理のタイプです。
TextField
  autoSize : String
テキストフィールドの自動的な拡大・縮小および整列を制御します。
TextField
  background : Boolean
テキストフィールドに背景の塗りがあるかどうかを指定します。
TextField
  backgroundColor : uint
テキストフィールドの背景の色です。
TextField
 InheritedblendMode : String
使用するブレンドモードを指定する BlendMode クラスの値です。
DisplayObject
  border : Boolean
テキストフィールドに境界線があるかどうかを指定します。
TextField
  borderColor : uint
テキストフィールドの境界線の色です。
TextField
  bottomScrollV : int
[read-only] 指定されたテキストフィールドの現在の表示範囲で最終行を示す整数です (1 から始まるインデックス)。
TextField
 InheritedcacheAsBitmap : Boolean
true に設定されている場合、表示オブジェクトの内部ビットマップ表現が Flash Player にキャッシュされます。
DisplayObject
  caretIndex : int
[read-only] カーソル (キャレット) 位置のインデックスです。
TextField
  condenseWhite : Boolean
HTML テキストを持つテキストフィールド内の余分な空白 (スペース、改行など) を削除するかどうかを指定するブール値です。
TextField
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcontextMenu : ContextMenu
このオブジェクトに関連付けられたコンテキストメニューを指定します。
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
この表示オブジェクトが属するファイルのロード情報を含む 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
複数行にわたるテキストフィールドで、ユーザーがテキストフィールドをクリックしてホイールを回転させると、自動的にスクロールするかどうかを示すブール値です。
TextField
 InheritedmouseX : Number
マウス位置の x 座標を示します (ピクセル単位)。
DisplayObject
 InheritedmouseY : Number
マウス位置の y 座標を示します (ピクセル単位)。
DisplayObject
  multiline : Boolean
テキストフィールドが複数行テキストフィールドであるかどうかを示します。
TextField
 Inheritedname : String
DisplayObject のインスタンス名を示します。
DisplayObject
  numLines : int
[read-only] 複数行テキストフィールド内のテキスト行の数を定義します。
TextField
 InheritedopaqueBackground : Object
表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。
DisplayObject
 Inheritedparent : DisplayObjectContainer
この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。
DisplayObject
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  restrict : String
ユーザーがテキストフィールドに入力できる文字を指定します。
TextField
 Inheritedroot : DisplayObject
ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。
DisplayObject
 Inheritedrotation : Number
DisplayObject インスタンスの元の位置からの回転角を度単位で示します。
DisplayObject
 Inheritedscale9Grid : Rectangle
現在有効な拡大 / 縮小グリッドです。
DisplayObject
 InheritedscaleX : Number
基準点から適用されるオブジェクトの水平スケール (percentage) を示します。
DisplayObject
 InheritedscaleY : Number
オブジェクトの基準点から適用されるオブジェクトの垂直スケール (percentage) を示します。
DisplayObject
  scrollH : int
現在の水平スクロール位置です。
TextField
 InheritedscrollRect : Rectangle
表示オブジェクトのスクロール矩形の境界。
DisplayObject
  scrollV : int
テキストフィールドのテキストの垂直座標です。
TextField
  selectable : Boolean
テキストフィールドが選択可能であるかどうかを示すブール値です。
TextField
  selectionBeginIndex : int
[read-only] 現在の選択範囲の最初の文字を示す 0 ベースのインデックス値です。
TextField
  selectionEndIndex : int
[read-only] 現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。
TextField
  sharpness : Number
このテキストフィールド内の文字エッジのシャープネスです。
TextField
 Inheritedstage : Stage
表示オブジェクトのステージ。
DisplayObject
  styleSheet : StyleSheet
テキストフィールドにスタイルシートを関連付けます。
TextField
 InheritedtabEnabled : Boolean
このオブジェクトがタブ順序に含まれるかどうかを指定します。
InteractiveObject
 InheritedtabIndex : int
SWF ファイル内のオブジェクトのタブ順序を指定します。
InteractiveObject
  text : String
テキストフィールド内の現在のテキストであるストリングです。
TextField
  textColor : uint
テキストフィールドのテキストの色です (16 進数形式)。
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
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。
DisplayObject
 Inheritedy : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。
DisplayObject
パブリックメソッド
 メソッド定義
  TextField()
新しい TextField インスタンスを作成します。
TextField
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  appendText(newText:String):void
newText パラメータで指定されたストリングを、TextField のテキストの最後に付加します。
TextField
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 InheritedgetBounds(targetCoordinateSpace:DisplayObject):Rectangle
targetCoordinateSpace オブジェクトの座標系を基準にして、表示オブジェクトの領域を定義する矩形を返します。
DisplayObject
  getCharBoundaries(charIndex:int):Rectangle
文字の境界ボックスである矩形を返します。
TextField
  getCharIndexAtPoint(x:Number, y:Number):int
x および y パラメータで指定されたポイントにある文字のインデックス値 (0 から始まる) を返します。
TextField
  getFirstCharInParagraph(charIndex:int):int
文字インデックスを指定すると、同じ段落内の最初の文字のインデックスを返します。
TextField
  getImageReference(id:String):DisplayObject
<img> タグを使用して HTML フォーマットのテキストフィールドに追加されたイメージまたは SWF ファイルについて、指定された id の DisplayObject 参照を返します。
TextField
  getLineIndexAtPoint(x:Number, y:Number):int
x および y パラメータで指定されたポイントにある行のインデックス値 (0 から始まる) を返します。
TextField
  getLineIndexOfChar(charIndex:int):int
charIndex パラメータで指定された文字を含む行のインデックス値 (0 から始まる) を返します。
TextField
  getLineLength(lineIndex:int):int
特定のテキスト行内の文字数を返します。
TextField
  getLineMetrics(lineIndex:int):TextLineMetrics
指定されたテキスト行に関するメトリック情報を返します。
TextField
  getLineOffset(lineIndex:int):int
lineIndex パラメータで指定された行の最初の文字の文字インデックスを返します。
TextField
  getLineText(lineIndex:int):String
lineIndex パラメータで指定された行のテキストを返します。
TextField
  getParagraphLength(charIndex:int):int
文字インデックスを指定すると、指定された文字を含む段落の長さを返します。
TextField
 InheritedgetRect(targetCoordinateSpace:DisplayObject):Rectangle
シェイプ上の線を除き、targetCoordinateSpace パラメータによって定義された座標系に基づいて、表示オブジェクトの境界を定義する矩形を返します。
DisplayObject
  getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
beginIndex および endIndex パラメータで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクトを返します。
TextField
 InheritedglobalToLocal(point:Point):Point
point オブジェクトをステージ (グローバル) 座標から表示オブジェクトの (ローカル) 座標に変換します。
DisplayObject
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedhitTestObject(obj:DisplayObject):Boolean
表示オブジェクトを評価して、obj 表示オブジェクトと重複または交差するかどうかを調べます。
DisplayObject
 InheritedhitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
表示オブジェクトを評価して、x および y パラメータで指定されたポイントと重複または交差するかどうかを調べます。
DisplayObject
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedlocalToGlobal(point:Point):Point
point オブジェクトを表示オブジェクトの (ローカル) 座標からステージ (グローバル) 座標に変換します。
DisplayObject
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  replaceSelectedText(value:String):void
現在の選択内容を value パラメータの内容に置き換えます。
TextField
  replaceText(beginIndex:int, endIndex:int, newText:String):void
beginIndex パラメータと endIndex パラメータで指定された文字範囲を、newText パラメータの内容に置き換えます。
TextField
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  setSelection(beginIndex:int, endIndex:int):void
最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します。最初の文字と最後の文字のインデックス値は、beginIndex および endIndex パラメータを使用して指定されています。
TextField
  setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
format パラメータで指定したテキストフォーマットを、テキストフィールド内の指定されたテキストに適用します。
TextField
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント一覧定義
 Inheritedactivate Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。DisplayObject
 Inheritedadded 表示オブジェクトが表示リストに追加されたときに送出されます。DisplayObject
  change コントロールの値が変更された後に送出されます。TextField
 Inheritedclick ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを押して離すと送出されます。InteractiveObject
 Inheriteddeactivate Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。DisplayObject
 InheriteddoubleClick オブジェクトの doubleClickEnabled フラグが true に設定されている場合には、ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを 2 回続けてすばやく押して離すと送出されます。InteractiveObject
 InheritedenterFrame 再生ヘッドが新しいフレームに入るときに送出されます。DisplayObject
 InheritedfocusIn 表示オブジェクトがフォーカスを取得した後に送出されます。InteractiveObject
 InheritedfocusOut 表示オブジェクトがフォーカスを失った後に送出されます。InteractiveObject
 InheritedkeyDown ユーザーがキーを押したときに送出されます。InteractiveObject
 InheritedkeyFocusChange ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。InteractiveObject
 InheritedkeyUp ユーザーがキーを離したときに送出されます。InteractiveObject
  link HTML が有効になっているテキストフィールドのハイパーリンクをユーザーがクリックしたときに送出されます (URL は "event:" で始まります)。TextField
 InheritedmouseDown Flash Player ウィンドウの InteractiveObject インスタンスの上で、ユーザーがポインティングデバイスのボタンを押したときに送出されます。InteractiveObject
 InheritedmouseFocusChange ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。InteractiveObject
 InheritedmouseMove InteractiveObject の上で、ユーザーがポインティングデバイスを動かしたときに送出されます。InteractiveObject
 InheritedmouseOut ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 InheritedmouseOver ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスに、ポインティングデバイスを合わせたときに送出されます。InteractiveObject
 InheritedmouseUp ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスの上でポインティングデバイスのボタンを離したときに送出されます。InteractiveObject
 InheritedmouseWheel Flash Player ウィンドウの InteractiveObject インスタンスの上で、マウスホイールを回転させたときに送出されます。InteractiveObject
 Inheritedremoved 表示オブジェクトが表示リストから削除されようとしているときに送出されます。DisplayObject
 Inheritedrender 表示リストが更新およびレンダリングされようとしているときに送出されます。DisplayObject
 InheritedrollOut ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 InheritedrollOver ユーザーが InteractiveObject インスタンスにポインティングデバイスを合わせたときに送出されます。InteractiveObject
  scroll ユーザーがスクロールしたに、TextField オブジェクトによって送出されます。TextField
 InheritedtabChildrenChange オブジェクトの tabChildren フラグの値が変更されたときに送出されます。InteractiveObject
 InheritedtabEnabledChange オブジェクトの tabEnabled フラグが変更されたときに送出されます。InteractiveObject
 InheritedtabIndexChange オブジェクトの tabIndex プロパティの値が変更されたときに送出されます。InteractiveObject
  textInput Flash Player では、ユーザーがテキストの文字を入力したときに textInput イベントを送出します。TextField
プロパティの詳細
alwaysShowSelectionプロパティ
alwaysShowSelection:Boolean  [read-write]

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

デフォルト値false.

実装
    public function get alwaysShowSelection():Boolean
    public function set alwaysShowSelection(value:Boolean):void

関連項目



次のファイルをコンパイルして実行します。ファイルを実行するとき、 2 つのテキストフィールドのそれぞれのテキストを選択してドラッグすると、 2 つのテキストフィールドでテキストを選択するときのハイライト表示される選択内容の違いがわかります (フォーカスの変更)。

    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 = createTextField(0, 20, 200, 20);
            label1.text = "This text is selected.";
            label1.setSelection(0, 9);
            label1.alwaysShowSelection = true;

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

        private function createTextField(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  [read-write]

このテキストフィールドに使用されるアンチエイリアス処理のタイプです。このプロパティには、flash.text.AntiAliasType 定数を使用します。この設定は、フォントが埋め込まれている (embedFonts プロパティが true に設定されている) 場合にのみ制御できます。デフォルト設定は、flash.text.AntiAliasType.ADVANCED です。

このプロパティの値を設定するには、次のストリング値を使用します。

ストリング値 説明
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  [read-write]

テキストフィールドの自動的な拡大・縮小および整列を制御します。TextFieldAutoSize 定数の有効な値は次のとおりです。TextFieldAutoSize.NONE (デフォルト)、TextFieldAutoSize.LEFTTextFieldAutoSize.RIGHT、および TextFieldAutoSize.CENTER

autoSizeTextFieldAutoSize.NONE (デフォルト値) に設定されていると、サイズ変更は行われません。

autoSizeTextFieldAutoSize.LEFT に設定すると、テキストは左揃えテキストとして扱われます。つまり、テキストフィールドの左マージンが固定され、テキストフィールドの単一行の右マージンのみが伸縮します。テキストに改行 ("\n" または "\r" など) が含まれる場合、テキストの次の行が収まるようにフィールドの下側も拡張されます。wordWraptrue に設定した場合、テキストフィールドの下側だけが伸縮し、右側は固定されたままになります。

autoSizeTextFieldAutoSize.RIGHT に設定すると、テキストは右揃えテキストとして扱われます。つまり、テキストフィールドの右マージンが固定され、テキストフィールドの単一行の左マージンのみが伸縮します。テキストに改行 ("\n" または "\r" など) が含まれる場合、テキストの次の行が収まるようにフィールドの下側も拡張されます。wordWraptrue に設定した場合、テキストフィールドの下側だけが伸縮し、左側は固定されたままになります。

autoSizeTextFieldAutoSize.CENTER に設定すると、テキストは中央揃えテキストとして扱われます。つまり、テキストフィールドの単一行のサイズ変更を行うと、左右両マージンが均等に伸縮されます。テキストに改行 ("\n" または "\r" など) が含まれる場合、テキストの次の行が収まるようにフィールドの下側も拡張されます。wordWraptrue に設定した場合、テキストフィールドの下側だけが伸縮し、左右両側は固定されたままになります。

実装
    public function get autoSize():String
    public function set autoSize(value:String):void

Throws
ArgumentError — 指定された autoSize は、flash.text.TextFieldAutoSize のメンバーではありません。

関連項目

backgroundプロパティ 
background:Boolean  [read-write]

テキストフィールドに背景の塗りがあるかどうかを指定します。true である場合、テキストフィールドに背景の塗りがあります。false である場合、テキストフィールドには背景の塗りがありません。backgroundColor プロパティを使用して、テキストフィールドの背景色を設定します。

デフォルト値false.

実装
    public function get background():Boolean
    public function set background(value:Boolean):void

関連項目

backgroundColorプロパティ 
backgroundColor:uint  [read-write]

テキストフィールドの背景の色です。デフォルト値は 0xFFFFFF (白) です。このプロパティは、現在背景がない場合でも取得または設定できます。ただし、背景の色が表示されるのはテキストフィールドの background プロパティが true に設定されている場合のみです。

実装
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void

関連項目

borderプロパティ 
border:Boolean  [read-write]

テキストフィールドに境界線があるかどうかを指定します。true である場合、テキストフィールドに境界線があります。false である場合、テキストフィールドに境界線がありません。borderColor プロパティを使用して、境界線の色を設定します。

デフォルト値false.

実装
    public function get border():Boolean
    public function set border(value:Boolean):void

関連項目

borderColorプロパティ 
borderColor:uint  [read-write]

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

実装
    public function get borderColor():uint
    public function set borderColor(value:uint):void

関連項目

bottomScrollVプロパティ 
bottomScrollV:int  [read-only]

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

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

実装
    public function get bottomScrollV():int

関連項目

caretIndexプロパティ 
caretIndex:int  [read-only]

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

選択範囲のインデックスはゼロから始まります。つまり、第 1 の位置は 0、第 2 の位置は 1、以下同様です。

実装
    public function get caretIndex():int

関連項目



この例では、TextField インスタンスを作成し、テキストを格納します。 ユーザーが TextField をクリックすると printCursorPosition メソッドが呼び出されるように、イベントリスナーが割り当てられています。この場合、 caretIndexselectionBeginIndex および selectionEndIndex プロパティの値が出力されます。

この例を実行し、TextField をクリックしてテキストの選択を試みます。次に、 テキストを選択しないでフィールドをクリックします。選択しないでテキストをクリックした場合、 caretIndex プロパティはカーソルが表示される位置を示し、 selectionBeginIndex selectionEndIndex プロパティは 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 = createTextField(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 createTextField(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  [read-write]

HTML テキストを持つテキストフィールド内の余分な空白 (スペース、改行など) を削除するかどうかを指定するブール値です。デフォルト値は false です。condenseWhite プロパティは、text プロパティではなく htmlText プロパティで設定されたテキストにのみ影響します。text プロパティでテキストを設定した場合、condenseWhite は無視されます。

condenseWhitetrue に設定した場合は、テキストフィールド内で改行を指定するときに <BR><P> などの標準の HTML コマンドを使用する必要があります。

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

実装
    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 = createTextField(0, 0, 200, 50);
            tf1.condenseWhite = false;
            tf1.htmlText = "keep    on\n\ttruckin'";
            
            var tf2:TextField = createTextField(0, 120, 200, 50);
            tf2.condenseWhite = true;
            tf2.htmlText = "keep    on\n\ttruckin'";
        }

        private function createTextField(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  [read-write]

新しく挿入するテキスト (replaceSelectedText() メソッドで挿入したテキストまたはユーザーが入力したテキストなど) に適用するフォーマットを指定します。

defaultTextFormat プロパティにアクセスすると、すべてのプロパティが定義された TextFormat オブジェクトが返されます。null のプロパティはありません。

実装
    public function get defaultTextFormat():TextFormat
    public function set defaultTextFormat(value:TextFormat):void

Throws
Error — このメソッドは、スタイルシートを使用するテキストフィールドに対しては使用できません。

関連項目

displayAsPasswordプロパティ 
displayAsPassword:Boolean  [read-write]

テキストフィールドがパスワードテキストフィールドであるかどうかを指定します。このプロパティの値が true である場合、テキストフィールドはパスワードテキストフィールドとして扱われ、入力された文字は実際の文字の代わりにアスタリスクで隠されます。false である場合、テキストフィールドはパスワードテキストフィールドとして扱われません。パスワードモードを有効にすると、[カット] コマンドと [コピー] コマンド、およびそれに対応するキーボードショートカットが機能しなくなります。このセキュリティ機能により、ユーザーの不在時にキーボードショートカットを使用して悪質なユーザーがパスワードを盗むことを防止できます。

デフォルト値false.

実装
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void
embedFontsプロパティ 
embedFonts:Boolean  [read-write]

埋め込みフォントのアウトラインを使ってレンダリングするかどうかを指定します。false である場合は、デバイスフォントを使用してテキストフィールドをレンダリングします。

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

デフォルト値false.

実装
    public function get embedFonts():Boolean
    public function set embedFonts(value:Boolean):void

関連項目

gridFitTypeプロパティ 
gridFitType:String  [read-write]

このテキストフィールドに使用されるグリッドフィッティングのタイプです。このプロパティは、テキストフィールドの flash.text.AntiAliasType プロパティが flash.text.AntiAliasType.ADVANCED に設定されている場合にのみ適用されます。

使用されるグリッドフィッティングのタイプによって、太い水平線と垂直線がピクセルグリッドまたはサブピクセルグリッドに合わされるか合わされないかが決定されます。

flash.text.GridFitType プロパティでは、次のストリング値を使用できます。

ストリング値 説明
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.ADVANCED に設定する必要があります。flash.text.GridFitType.SUBPIXEL 設定は、右揃えまたは中央揃えのダイナミックテキストに適した設定で、アニメーション品質とテキスト品質のバランスを取るのに便利です。

デフォルト値pixel.

実装
    public function get gridFitType():String
    public function set gridFitType(value:String):void

関連項目

htmlTextプロパティ 
htmlText:String  [read-write]

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

Flash Player では、次の HTML タグがサポートされています。

タグ 説明
アンカータグ <a> タグは、ハイパーリンクを作成し、次の属性をサポートします。
  • href—URL は、ページをロードしている SWF ファイルの場所に対して絶対的でも相対的でもかまいません。URL への絶対的な参照の例としては http://www.adobe.com が、相対的な参照の例としては /index.html が挙げられます。絶対 URL には先頭に http:// を付けます。それがない場合は、相対 URL と見なされます。
  • eventevent 属性を使用して、ユーザーがハイパーリンクをクリックしたときに送出される link TextEvent の text プロパティを指定します。1 つの例として event:myEvent があります。ユーザーがこのハイパーリンクをクリックすると、テキストフィールドは text プロパティを "myEvent" に設定して link TextEvent を送出します。
  • target—ページをロードする先のターゲットウィンドウの名前を指定します。オプションには、_self_blank_parent、および _top があります。_self オプションは現在のウィンドウ内の現在のフレームを指定します。_blank は新しいウィンドウを指定します。_parent は現在のフレームの親を指定します。_top は現在のウィンドウ内のトップレベルのフレームを指定します。

リンクイベントを使用すると、リンクで URL を開くのではなく、SWF ファイルの ActionScript 関数を実行することができます。

また、スタイルシートを使用すると、アンカータグに a:linka:hover、および a:active の各スタイルを定義できます。

ボールドタグ <b> タグは、テキストをボールドとしてレンダリングします。ボールド体を利用できるフォントで使用する必要があります。
ブレークタグ <br> タグは、テキストフィールドに改行を作成します。このタグを使用するには、テキストフィールドを複数行テキストフィールドに設定する必要があります。
フォントタグ <font> タグは、テキストを表示するフォントまたはフォントリストを指定します。フォントタグは、次の属性をサポートします。
  • color—16 進数のカラー (#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 ファイル、またはムービークリップのピクセル単位の高さです。