flash.text.TextField (Flex™ 2 リファレンスガイド)

	プロパティ	定義
		accessibilityProperties : AccessibilityProperties この表示オブジェクトの現在のアクセシビリティオプションです。	DisplayObject
		alpha : Number 指定されたオブジェクトのアルファ透明度値を示します。	DisplayObject
		alwaysShowSelection : Boolean `true` に設定され、テキストフィールドにフォーカスがない場合、テキストフィールド内の選択内容は灰色でハイライト表示されます。	TextField
		antiAliasType : String このテキストフィールドに使用されるアンチエイリアス処理のタイプです。	TextField
		autoSize : String テキストフィールドの自動的な拡大・縮小および整列を制御します。	TextField
		background : Boolean テキストフィールドに背景の塗りがあるかどうかを指定します。	TextField
		backgroundColor : uint テキストフィールドの背景の色です。	TextField
		blendMode : String 使用するブレンドモードを指定する BlendMode クラスの値です。	DisplayObject
		border : Boolean テキストフィールドに境界線があるかどうかを指定します。	TextField
		borderColor : uint テキストフィールドの境界線の色です。	TextField
		bottomScrollV : int [read-only] 指定されたテキストフィールドの現在の表示範囲で最終行を示す整数です (1 から始まるインデックス)。	TextField
		cacheAsBitmap : Boolean `true` に設定されている場合、表示オブジェクトの内部ビットマップ表現が Flash Player にキャッシュされます。	DisplayObject
		caretIndex : int [read-only] カーソル (キャレット) 位置のインデックスです。	TextField
		condenseWhite : Boolean HTML テキストを持つテキストフィールド内の余分な空白 (スペース、改行など) を削除するかどうかを指定するブール値です。	TextField
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		contextMenu : ContextMenu このオブジェクトに関連付けられたコンテキストメニューを指定します。	InteractiveObject
		defaultTextFormat : TextFormat 新しく挿入するテキスト (`replaceSelectedText()` メソッドで挿入したテキストまたはユーザーが入力したテキストなど) に適用するフォーマットを指定します。	TextField
		displayAsPassword : Boolean テキストフィールドがパスワードテキストフィールドであるかどうかを指定します。	TextField
		doubleClickEnabled : Boolean オブジェクトが `doubleClick` イベントを受け取るかどうかを指定します。	InteractiveObject
		embedFonts : Boolean 埋め込みフォントのアウトラインを使ってレンダリングするかどうかを指定します。	TextField
		filters : Array 表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。	DisplayObject
		focusRect : Object このオブジェクトがフォーカス矩形を表示するかどうかを指定します。	InteractiveObject
		gridFitType : String このテキストフィールドに使用されるグリッドフィッティングのタイプです。	TextField
		height : Number 表示オブジェクトの高さを示します (ピクセル単位)。	DisplayObject
		htmlText : String テキストフィールドの内容を HTML で示します。	TextField
		length : int [read-only] テキストフィールド内の文字数です。	TextField
		loaderInfo : LoaderInfo この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo オブジェクトを返します。	DisplayObject
		mask : DisplayObject 呼び出し元の表示オブジェクトは、指定された `mask` オブジェクトによってマスクされます。	DisplayObject
		maxChars : int ユーザーが入力するときに、テキストフィールドに入る最大の文字数です。	TextField
		maxScrollH : int [read-only] `scrollH` の最大値です。	TextField
		maxScrollV : int [read-only] `scrollV` の最大値です。	TextField
		mouseEnabled : Boolean このオブジェクトがマウスメッセージを受け取るかどうかを指定します。	InteractiveObject
		mouseWheelEnabled : Boolean 複数行にわたるテキストフィールドで、ユーザーがテキストフィールドをクリックしてホイールを回転させると、自動的にスクロールするかどうかを示すブール値です。	TextField
		mouseX : Number マウス位置の x 座標を示します (ピクセル単位)。	DisplayObject
		mouseY : Number マウス位置の y 座標を示します (ピクセル単位)。	DisplayObject
		multiline : Boolean テキストフィールドが複数行テキストフィールドであるかどうかを示します。	TextField
		name : String DisplayObject のインスタンス名を示します。	DisplayObject
		numLines : int [read-only] 複数行テキストフィールド内のテキスト行の数を定義します。	TextField
		opaqueBackground : Object 表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。	DisplayObject
		parent : DisplayObjectContainer この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。	DisplayObject
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		restrict : String ユーザーがテキストフィールドに入力できる文字を指定します。	TextField
		root : DisplayObject ロードされた SWF ファイル内の表示オブジェクトの場合、`root` プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。	DisplayObject
		rotation : Number DisplayObject インスタンスの元の位置からの回転角を度単位で示します。	DisplayObject
		scale9Grid : Rectangle 現在有効な拡大 / 縮小グリッドです。	DisplayObject
		scaleX : Number 基準点から適用されるオブジェクトの水平スケール (`percentage`) を示します。	DisplayObject
		scaleY : Number オブジェクトの基準点から適用されるオブジェクトの垂直スケール (`percentage`) を示します。	DisplayObject
		scrollH : int 現在の水平スクロール位置です。	TextField
		scrollRect : Rectangle 表示オブジェクトのスクロール矩形の境界。	DisplayObject
		scrollV : int テキストフィールドのテキストの垂直座標です。	TextField
		selectable : Boolean テキストフィールドが選択可能であるかどうかを示すブール値です。	TextField
		selectionBeginIndex : int [read-only] 現在の選択範囲の最初の文字を示す 0 ベースのインデックス値です。	TextField
		selectionEndIndex : int [read-only] 現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。	TextField
		sharpness : Number このテキストフィールド内の文字エッジのシャープネスです。	TextField
		stage : Stage 表示オブジェクトのステージ。	DisplayObject
		styleSheet : StyleSheet テキストフィールドにスタイルシートを関連付けます。	TextField
		tabEnabled : Boolean このオブジェクトがタブ順序序に含まれるかどうかを指定します。	InteractiveObject
		tabIndex : int SWF ファイル内のオブジェクトのタブ順を指定します。	InteractiveObject
		text : String テキストフィールド内の現在のテキストであるストリングです。	TextField
		textColor : uint テキストフィールドのテキストの色です (16 進数形式)。	TextField
		textHeight : Number [read-only] テキストの高さです (ピクセル単位)。	TextField
		textWidth : Number [read-only] テキストの幅です (ピクセル単位)。	TextField
		thickness : Number このテキストフィールド内の文字エッジの太さです。	TextField
		transform : Transform 表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクト。	DisplayObject
		type : String テキストフィールドのタイプです。	TextField
		useRichTextClipboard : Boolean テキストと共にテキストのフォーマットをコピー & ペーストするかどうかを指定します。	TextField
		visible : Boolean 表示オブジェクトが可視かどうかを示します。	DisplayObject
		width : Number 表示オブジェクトの幅を示します (ピクセル単位)。	DisplayObject
		wordWrap : Boolean テキストフィールドのテキストを折り返すかどうかを示すブール値です。	TextField
		x : Number 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。	DisplayObject
		y : Number 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。	DisplayObject

	メソッド	定義
		TextField() 新しい TextField インスタンスを作成します。	TextField
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void リスナーがイベントの通知を受け取るように、イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録します。	EventDispatcher
		appendText(newText:String):void `newText` パラメータで指定されたストリングを、テキストフィールドのテキストの最後に付加します。	TextField
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		getBounds(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
		getRect(targetCoordinateSpace:DisplayObject):Rectangle シェイプ上の線を除き、`targetCoordinateSpace` パラメータによって定義された座標系に基づいて、表示オブジェクトの境界を定義する矩形を返します。	DisplayObject
		getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat `beginIndex` および `endIndex` パラメータで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクトを返します。	TextField
		globalToLocal(point:Point):Point `point` オブジェクトをステージ (グローバル) 座標から表示オブジェクトの (ローカル) 座標に変換します。	DisplayObject
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指定されたプロパティがオブジェクトに定義されているかどうかを示します。	Object
		hitTestObject(obj:DisplayObject):Boolean 表示オブジェクトを評価して、`obj` 表示オブジェクトと重複または交差するかどうかを調べます。	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean 表示オブジェクトを評価して、`x` および `y` パラメータで指定されたポイントと重複または交差するかどうかを調べます。	DisplayObject
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		localToGlobal(point:Point):Point `point` オブジェクトを表示オブジェクトの (ローカル) 座標からステージ (グローバル) 座標に変換します。	DisplayObject
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(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
		setPropertyIsEnumerable(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
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

一覧	定義
activate	Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
added	表示オブジェクトが表示リストに追加されたときに送出されます。	DisplayObject
addedToStage	表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの追加により、ステージ上の表示リストに追加されたときに送出されます。	DisplayObject
change	コントロールの値が変更された後に送出されます。	TextField
click	ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを押して離すと送出されます。	InteractiveObject
deactivate	Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
doubleClick	オブジェクトの `doubleClickEnabled` フラグが `true` に設定されている場合には、ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを 2 回続けてすばやく押して離すと送出されます。	InteractiveObject
enterFrame	再生ヘッドが新しいフレームに入るときに送出されます。	DisplayObject
focusIn	表示オブジェクトがフォーカスを取得した後に送出されます。	InteractiveObject
focusOut	表示オブジェクトがフォーカスを失った後に送出されます。	InteractiveObject
keyDown	ユーザーがキーを押したときに送出されます。	InteractiveObject
keyFocusChange	ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。	InteractiveObject
keyUp	ユーザーがキーを離したときに送出されます。	InteractiveObject
link	HTML が有効になっているテキストフィールドのハイパーリンクをユーザーがクリックしたときに送出されます (URL は "event:" で始まります)。	TextField
mouseDown	Flash Player ウィンドウの InteractiveObject インスタンスの上で、ユーザーがポインティングデバイスのボタンを押したときに送出されます。	InteractiveObject
mouseFocusChange	ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。	InteractiveObject
mouseMove	InteractiveObject の上で、ユーザーがポインティングデバイスを移動させたときに送出されます。	InteractiveObject
mouseOut	ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。	InteractiveObject
mouseOver	ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスに、ポインティングデバイスを合わせたときに送出されます。	InteractiveObject
mouseUp	ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスの上でポインティングデバイスのボタンを離したときに送出されます。	InteractiveObject
mouseWheel	Flash Player ウィンドウの InteractiveObject インスタンスの上で、マウスホイールを回転させたときに送出されます。	InteractiveObject
removed	表示オブジェクトが表示リストから削除されようとしているときに送出されます。	DisplayObject
removedFromStage	表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの削除により、表示リストから削除されようとしているときに送出されます。	DisplayObject
render	表示リストが更新およびレンダリングされようとしているときに送出されます。	DisplayObject
rollOut	ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。	InteractiveObject
rollOver	ユーザーが InteractiveObject インスタンスにポインティングデバイスを合わせたときに送出されます。	InteractiveObject
scroll	ユーザーがスクロールした後に、TextField オブジェクトによって送出されます。	TextField
tabChildrenChange	オブジェクトの `tabChildren` フラグの値が変更されたときに送出されます。	InteractiveObject
tabEnabledChange	オブジェクトの `tabEnabled` フラグが変更されたときに送出されます。	InteractiveObject
tabIndexChange	オブジェクトの `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

関連項目

flash.display.Stage.focus

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 ポイントより大きいフォントに対して高度なアンチエイリアスを使用することはお勧めしません。

ストリング値	内容
`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.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 に設定した場合、テキストフィールドの下側だけが伸縮し、左右両側は固定されたままになります。

実装
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

関連項目

flash.text.TextField.backgroundColor

backgroundColor

プロパティ

backgroundColor:uint [read-write]

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

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

関連項目

flash.text.TextField.background

border

プロパティ

border:Boolean [read-write]

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

デフォルト値false.

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

関連項目

flash.text.TextField.borderColor

borderColor

プロパティ

borderColor:uint [read-write]

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

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

関連項目

flash.text.TextField.border

bottomScrollV

プロパティ

bottomScrollV:int [read-only]

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

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

実装
public function get bottomScrollV():int

関連項目

flash.text.TextField.scrollV

caretIndex

プロパティ

caretIndex:int [read-only]

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

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

実装
public function get caretIndex():int

condenseWhite

プロパティ

condenseWhite:Boolean [read-write]

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

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

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

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

関連項目

flash.text.TextField.htmlText

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

関連項目

Font.enumerateFonts()

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 と見なされます。 `event`—`event` 属性を使用して、ユーザーがハイパーリンクをクリックしたときに送出される `link` TextEvent の `text` プロパティを指定します。1 つの例として `event:myEvent` があります。ユーザーがこのハイパーリンクをクリックすると、テキストフィールドは `text` プロパティを `"myEvent"` に設定して `link` TextEvent を送出します。 `target`—ページをロードする先のターゲットウィンドウの名前を指定します。オプションには、`_self`、`_blank`、`_parent`、および `_top` があります。`_self` オプションは現在のウィンドウ内の現在のフレームを指定します。`_blank` は新しいウィンドウを指定します。`_parent` は現在のフレームの親を指定します。`_top` は現在のウィンドウ内のトップレベルのフレームを指定します。リンクイベントを使用すると、リンクで URL を開くのではなく、SWF ファイルの ActionScript 関数を実行することができます。また、スタイルシートを使用すると、アンカータグに `a:link`、`a: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 ファイル、またはムービークリップのピクセル単位の高さです。 `align`—テキストフィールド内の埋め込みイメージの水平整列を指定します。有効な値は、`left` および `right` です。デフォルト値は `left` です。 `hspace`—イメージの周りの水平方向の空白の量 (テキストが表示されない領域) を指定します。デフォルト値は 8 です。 `vspace`—イメージの周りの垂直方向の空白の量 (テキストが表示されない領域) を指定します。デフォルト値は 8 です。 `id`—埋め込みイメージファイル、SWF ファイル、またはムービークリップを含むムービークリップインスタンスの名前 (Flash Player が作成したもの) を指定します。これは、ActionScript を使用して、埋め込みコンテンツを制御するときに役立ちます。 `checkPolicyFile`—イメージのドメインに関連付けられたサーバー上のクロスドメインポリシーファイルを Flash Player が確認することを指定します。クロスドメインポリシーファイルが存在する場合、ファイルに記載されているドメイン内の SWF ファイルは、ロードされたイメージのデータにアクセスできます。たとえば、このイメージを `source` パラメータとして `BitmapData.draw()` メソッドを呼び出すことによってアクセスします。詳細については、『ActionScript 3.0 のプログラミング』の「Flash Player セキュリティ」の章を参照してください。 Flash はテキストフィールドに埋め込まれたメディアをフルサイズで表示します。埋め込むメディアのサイズを指定するには、`<img>` タグの `height` 属性と `width` 属性を使用します。一般に、テキストフィールドに埋め込まれたイメージは、`<img>` タグの次の行に表示されます。ただし、`<img>` タグがテキストフィールドの最初の文字であった場合、イメージはテキストフィールドの最初の行に表示されます。
イタリックタグ	`<i>` タグは、指定されたテキストをイタリックで表示します。イタリック体を利用できるフォントで使用する必要があります。
リスト項目タグ	`<li>` タグは、タグが囲んでいるテキストの最初に箇条書き記号を配置します。メモ : 番号付きリストタグと番号なしリストタグ (`<ol>` と `<ul>`) は Flash Player で認識されないため、これらのタグによって一覧のレンダリング方法が変更されることはありません。すべての一覧に番号は付かず、すべてのリストアイテムに箇条書き記号が使用されます。
段落タグ	`<p>` タグは新しい段落を作成します。このタグを使用するには、テキストフィールドを複数行テキストフィールドに設定する必要があります。 `<p>` タグは、次の属性をサポートします。 align—段落内のテキストの整列を指定します。有効な値は、`left`、`right`、`justify`、および `center` です。 class—flash.text.StyleSheet オブジェクトで定義される CSS スタイルクラスを指定します。
範囲タグ	`<span>` タグは、CSS テキストスタイルでのみ使用できます。次の属性をサポートします。 class—flash.text.StyleSheet オブジェクトで定義される CSS スタイルクラスを指定します。
テキストフォーマットタグ	`<textformat>` タグでは、行間、インデント、マージン、タブストップなどを含む、テキストフィールド内にある TextFormat クラスの段落フォーマットプロパティの一部を使用できます。`<textformat>` タグは、ビルトイン HTML タグと組み合わせることができます。 `<textformat>` タグの属性は次のとおりです。 `blockindent`—ブロックのインデントをポイント単位で指定します。`TextFormat.blockIndent` に相当します。 `indent`—左マージンから段落の先頭文字までのインデントを指定します。`TextFormat.indent` に相当します。正の数と負の数の両方を使用できます。 `leading`—行間の垂直の行送りを指定します。`TextFormat.leading` に相当します。正の数と負の数の両方を使用できます。 `leftmargin`—段落の左マージンをポイント単位で指定します。`TextFormat.leftMargin` に相当します。 `rightmargin`—段落の右マージンをポイント単位で指定します。`TextFormat.rightMargin` に相当します。 `tabstops`—カスタムタブストップを負以外の整数の配列として指定します。`TextFormat.tabStops` に相当します。
下線タグ	`<u>` タグが指定されたテキストには下線が表示されます。

Flash Player では、次の HTML エンティティがサポートされています。

エンティティ	内容
<	< (より小さい)
>	> (より大きい)
&	& (アンパサンド)
"	" (二重引用符)
'	' (アポストロフィ、一重引用符)

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

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

length

プロパティ

length:int [read-only]

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

実装
public function get length():int

maxChars

プロパティ

maxChars:int [read-write]

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

デフォルト値0.

実装
public function get maxChars():int
public function set maxChars(value:int):void

maxScrollH

プロパティ

maxScrollH:int [read-only]

scrollH の最大値です。

実装
public function get maxScrollH():int

関連項目

flash.text.TextField.scrollH

maxScrollV

プロパティ

maxScrollV:int [read-only]

scrollV の最大値です。

実装
public function get maxScrollV():int

関連項目

flash.text.TextField.scrollV

mouseWheelEnabled

プロパティ

mouseWheelEnabled:Boolean [read-write]

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

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

multiline

プロパティ

multiline:Boolean [read-write]

テキストフィールドが複数行テキストフィールドであるかどうかを示します。値が true である場合は複数行テキストフィールド、値が false である場合は単一行テキストフィールドです。

デフォルト値false.

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

関連項目

numLines

プロパティ

numLines:int [read-only]

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

実装
public function get numLines():int

関連項目

multiline
wordWrap

restrict

プロパティ

restrict:String [read-write]

ユーザーがテキストフィールドに入力できる文字を指定します。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 = " -~";

デフォルト値ヌル (null).

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

scrollH

プロパティ

scrollH:int [read-write]

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

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

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

実装
public function get scrollH():int
public function set scrollH(value:int):void

scrollV

プロパティ

scrollV:int [read-write]

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

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

実装
public function get scrollV():int
public function set scrollV(value:int):void

selectable

プロパティ

selectable:Boolean [read-write]

テキストフィールドが選択可能であるかどうかを示すブール値です。値 true は、テキストが選択可能であることを示します。selectable プロパティを使用することで、テキストフィールドが選択可能かどうかを指定できますが、編集可能かどうかは指定できません。ダイナミックテキストフィールドは、編集可能でない場合でも選択可能にすることができます。ダイナミックテキストフィールドが選択可能でない場合、ユーザーはフィールド内のテキストを選択できません。

selectable を false に設定すると、テキストフィールド内のテキストはマウスやキーボードからの選択コマンドに応答しなくなり、[コピー] コマンドを使用してテキストをコピーすることができなくなります。selectable を true に設定すると、テキストフィールド内のテキストはマウスやキーボードを使用して選択できるようになり、[コピー] コマンドを使用してテキストをコピーできるようになります。テキスト入力フィールドではなくダイナミックテキストフィールドの場合でも、この方法でテキストを選択できます。

デフォルト値true.

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

selectionBeginIndex

プロパティ

selectionBeginIndex:int [read-only]

現在の選択範囲の最初の文字を示す 0 ベースのインデックス値です。最初の文字が 0、2 番目の文字が 1 です (以下同様)。テキストが選択されていない場合、このプロパティは caretIndex の値になります。

実装
public function get selectionBeginIndex():int

selectionEndIndex

プロパティ

selectionEndIndex:int [read-only]

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

実装
public function get selectionEndIndex():int

sharpness

プロパティ

sharpness:Number [read-write]

このテキストフィールド内の文字エッジのシャープネスです。このプロパティは、テキストフィールドの flash.text.AntiAliasType プロパティが flash.text.AntiAliasType.ADVANCED に設定されている場合にのみ適用されます。sharpness の範囲は -400 ～ 400 の数値です。sharpness をこの範囲外の値に設定しようとすると、このプロパティは範囲内の最も近い値 (-400 または 400) に設定されます。

デフォルト値0.

実装
public function get sharpness():Number
public function set sharpness(value:Number):void

styleSheet

プロパティ

styleSheet:StyleSheet [read-write]

テキストフィールドにスタイルシートを関連付けます。スタイルシートの作成の詳細については、StyleSheet クラスおよび『ActionScript 3.0 のプログラミング』を参照してください。

テキストフィールドに関連付けられているスタイルシートは、いつでも変更することができます。使用されているスタイルシートを変更すると、テキストフィールドは新しいスタイルシートを使用して再描画されます。スタイルシートを null または undefined に設定すると、そのスタイルシートを削除できます。使用されているスタイルシートを削除すると、テキストフィールドはスタイルシートを使用せずに再描画されます。

メモ : スタイルシートを削除すると、TextField.text および TextField.htmlText の内容は両方とも、スタイルシートで以前に適用されたフォーマットを組み込むように変更されます。TextField.htmlText の元の内容をフォーマットなしで保存するには、スタイルシートを削除する前に変数にその値を保存します。

実装
public function get styleSheet():StyleSheet
public function set styleSheet(value:StyleSheet):void

関連項目

flash.text.StyleSheet

text

プロパティ

text:String [read-write]

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

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

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

関連項目

flash.text.TextField.htmlText

textColor

プロパティ

textColor:uint [read-write]

テキストフィールドのテキストの色です (16 進数形式)。16 進数カラーシステムでは、6 桁の数値を使って色の値を示します。1 つの桁で、16 種類の値 (文字) を指定できます。値の範囲は、0 ～ 9、A ～ F です。たとえば、黒は (0x000000)、白は (0xFFFFFF) です。

デフォルト値0 (0x000000).

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

textHeight

プロパティ

textHeight:Number [read-only]

テキストの高さです (ピクセル単位)。

実装
public function get textHeight():Number

関連項目

flash.text.TextField.textWidth

textWidth

プロパティ

textWidth:Number [read-only]

テキストの幅です (ピクセル単位)。

実装
public function get textWidth():Number

関連項目

flash.text.TextField.textHeight

thickness

プロパティ

thickness:Number [read-write]

このテキストフィールド内の文字エッジの太さです。このプロパティは、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

type

プロパティ

type:String [read-write]

テキストフィールドのタイプです。次の TextFieldType 定数のいずれかです。TextFieldType.DYNAMIC はダイナミックテキストフィールドを指定します。このフィールドはユーザーが編集できません。TextFieldType.INPUT はテキスト入力フィールドを指定します。このフィールドはユーザーが編集できます。

デフォルト値ダイナミック.

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

Throws

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

関連項目

flash.text.TextFieldType

useRichTextClipboard

プロパティ

useRichTextClipboard:Boolean [read-write]

テキストと共にテキストのフォーマットをコピー & ペーストするかどうかを指定します。true に設定されている場合、テキストフィールド間でコピー & ペーストを行うと、Flash Player によってフォーマット (行揃え、ボールド、イタリックなど) もコピー & ペーストされます。コピー & ペースト手順のコピー元とペースト先のテキストフィールドの両方で、useRichTextClipboard が true に設定されている必要があります。デフォルト値は false です。

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

wordWrap

プロパティ

wordWrap:Boolean [read-write]

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

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

コンストラクタの詳細

TextField

()

コンストラクタ

public 関数 TextField()

新しい TextField インスタンスを作成します。TextField インスタンスの作成後、親 DisplayObjectContainer オブジェクトの addChild() メソッドまたは addChildAt() メソッドを呼び出し、TextField インスタンスを表示リストに追加します。

テキストフィールドのデフォルトサイズは 100×100 ピクセルです。

メソッドの詳細

appendText

()

メソッド

public function appendText(newText:String):void

newText パラメータで指定されたストリングを、テキストフィールドのテキストの最後に付加します。このメソッドは、text プロパティに追加割り当て (+=) に割り当てるより効率の良い方法です (someTextField.text += moreText など)。大きなコンテンツが入っているテキストフィールドでは特に効率的です。

パラメータ

newText:String — 既存のテキストに追加するストリングです。

getCharBoundaries

()

メソッド

public function getCharBoundaries(charIndex:int):Rectangle

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

パラメータ

charIndex:int — 文字の 0 ベースのインデックス値です。つまり、第 1 の位置は 0、第 2 の位置は 1、以下同様です。

戻り値

Rectangle — 文字の境界ボックスを定義する x および y の最小値と最大値を定義する矩形です。

関連項目

flash.geom.Rectangle

getCharIndexAtPoint

()

メソッド

public function getCharIndexAtPoint(x:Number, y:Number):int

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

パラメータ

	`x:Number` — 文字の x 座標です。

	`y:Number` — 文字の y 座標です。

戻り値

int — 文字の 0 ベースのインデックス値です。つまり、第 1 の位置は 0、第 2 の位置は 1、以下同様です。どの文字にもポイントがない場合は -1 を返します。

getFirstCharInParagraph

()

メソッド

public function getFirstCharInParagraph(charIndex:int):int

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

パラメータ

charIndex:int — 文字の 0 ベースのインデックス値です。つまり、第 1 の文字は 0、第 2 の文字は 1、以下同様です。

戻り値

int — 同じ段落内の最初の文字を示す 0 ベースのインデックス値です。

スロー

RangeError — 指定された文字インデックスは範囲外です。

getImageReference

()

メソッド

public function getImageReference(id:String):DisplayObject

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

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

パラメータ

id:String — 一致する id です (<img> タグの id 属性内)。

戻り値

DisplayObject — 一致する id 属性をテキストフィールドの <img> タグ内に持つイメージまたは SWF ファイルに対応する表示オブジェクトです。外部ソースからロードされたメディアの場合、このオブジェクトは Loader オブジェクトであり、いったんロードされると、メディアオブジェクトはその Loader オブジェクトの子になります。SWF ファイルに埋め込まれたメディアの場合、これはロードされたオブジェクトです。一致する id を持つ <img> タグがない場合、メソッドは null を返します。

関連項目

htmlText

getLineIndexAtPoint

()

メソッド

public function getLineIndexAtPoint(x:Number, y:Number):int

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

パラメータ

	`x:Number` — 行の x 座標です。

	`y:Number` — 行の y 座標です。

戻り値

int — 行の 0 ベースのインデックス値です。つまり、第 1 の行は 0、第 2 の行は 1、以下同様です。どの行にもポイントがない場合は -1 を返します。

getLineIndexOfChar

()

メソッド

public function getLineIndexOfChar(charIndex:int):int

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

パラメータ

charIndex:int — 文字の 0 ベースのインデックス値です。つまり、第 1 の文字は 0、第 2 の文字は 1、以下同様です。

戻り値

int — 行の 0 ベースのインデックス値です。

スロー

RangeError — 指定された文字インデックスは範囲外です。

getLineLength

()

メソッド

public function getLineLength(lineIndex:int):int

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

パラメータ

lineIndex:int — 長さが必要な行番号です。

戻り値

int — 行内の文字数です。

スロー

RangeError — 指定した行番号は範囲外です。

getLineMetrics

()

メソッド

public function getLineMetrics(lineIndex:int):TextLineMetrics

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

パラメータ

lineIndex:int — メトリック情報が必要な行番号です。

戻り値

TextLineMetrics — TextLineMetrics オブジェクトです。

スロー

RangeError — 指定した行番号は範囲外です。

getLineOffset

()

メソッド

public function getLineOffset(lineIndex:int):int

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

パラメータ

lineIndex:int — 行の 0 ベースのインデックス値です。つまり、第 1 の行は 0、第 2 の行は 1、以下同様です。

戻り値

int — 行の最初の文字を示す 0 ベースのインデックス値です。

スロー

RangeError — 指定した行番号は範囲外です。

getLineText

()

メソッド

public function getLineText(lineIndex:int):String

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

パラメータ

lineIndex:int — 行の 0 ベースのインデックス値です。つまり、第 1 の行は 0、第 2 の行は 1、以下同様です。

戻り値

String — 指定された行に含まれるテキストストリングです。

スロー

RangeError — 指定した行番号は範囲外です。

getParagraphLength

()

メソッド

public function getParagraphLength(charIndex:int):int

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

パラメータ

charIndex:int — 文字の 0 ベースのインデックス値です。つまり、第 1 の文字は 0、第 2 の文字は 1、以下同様です。

戻り値

int — 段落内の文字数を返します。

スロー

RangeError — 指定された文字インデックスは範囲外です。

getTextFormat

()

メソッド

public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat

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

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

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

使用方法	内容
`my_textField.getTextFormat()`	テキストフィールド内すべてのテキストに関するフォーマット情報を含む TextFormat オブジェクトを返します。テキストフィールド内のすべてのテキストに共通するプロパティのみが結果の TextFormat オブジェクトに設定されます。混在型のプロパティ (テキストに複数の異なる値が混在する場合) は、その値が `null` に設定されます。
`my_textField.getTextFormat(beginIndex:Number)`	`beginIndex` の位置の文字のテキストフォーマットのコピーを含む TextFormat オブジェクトを返します。
`my_textField.getTextFormat(beginIndex:Number,endIndex:Number)`	`beginIndex` から `endIndex` までの範囲のテキストに関するフォーマット情報を含む TextFormat オブジェクトを返します。指定された範囲内のすべてのテキストに共通するプロパティのみが結果の TextFormat オブジェクトに設定されます。混在型のプロパティ (範囲内に複数の異なる値が混在する場合) は、その値が `null` に設定されます。

パラメータ

	`beginIndex:int` (default = `-1`) — オプション。テキストフィールド内のテキスト範囲の開始位置を指定する整数です。

	`endIndex:int` (default = `-1`) — オプション。テキストフィールド内のテキスト範囲の終了位置を指定する整数です。

戻り値

TextFormat — 指定されたテキストのフォーマットプロパティを表す TextFormat オブジェクトです。

スロー

RangeError — 指定された beginIndex または endIndex は範囲外です。

replaceSelectedText

()

メソッド

public function replaceSelectedText(value:String):void

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

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

メモ : このメソッドは、テキストフィールドにスタイルシートが適用されていると機能しません。

パラメータ

value:String — 現在選択されているテキストを置き換えるストリングです。

スロー

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

関連項目

flash.display.Stage.focus

replaceText

()

メソッド

public function replaceText(beginIndex:int, endIndex:int, newText:String):void

beginIndex パラメータと endIndex パラメータで指定された文字範囲を、newText パラメータの内容に置き換えます。

メモ : このメソッドは、テキストフィールドにスタイルシートが適用されていると機能しません。

パラメータ

	`beginIndex:int` — 置換範囲の開始位置の 0 ベースのインデックス値です。

	`endIndex:int` — 置換範囲の終了位置の 0 ベースのインデックス値です。

	`newText:String` — 指定された文字範囲の置き換えに使用されるテキストです。

スロー

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

setSelection

()

メソッド

public function setSelection(beginIndex:int, endIndex:int):void

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

パラメータ

	`beginIndex:int` — 選択範囲の先頭の文字の 0 ベースのインデックス値です。たとえば、先頭の文字が 0 で、2 番目の文字が 1 です (以下同様)。

	`endIndex:int` — 選択範囲の最後の文字を示す 0 ベースのインデックス値です。

setTextFormat

()

メソッド

public function setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void

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

メモ : このメソッドは、テキストフィールドにスタイルシートが適用されていると機能しません。

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

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

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

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

パラメータ

format:TextFormat — 文字と段落のフォーマット情報を含む TextFormat オブジェクトです。

beginIndex:int (default = -1) — 必要なテキスト範囲の最初の文字を指定する 0 ベースのインデックス位置です。

endIndex:int (default = -1) — 必要なテキスト範囲の最初の文字を指定する 0 ベースのインデックス位置です。

使用方法	内容
`my_textField.setTextFormat(textFormat:TextFormat)`	`textFormat` のプロパティをテキストフィールドのすべてのテキストに適用します。
`my_textField.setTextFormat(textFormat:TextFormat, beginIndex:int)`	`textFormat` のプロパティを `beginIndex` 位置で始まるテキストに適用します。
`my_textField.setTextFormat(textFormat:TextFormat, beginIndex:int, endIndex:int)`	`textFormat` パラメータのプロパティを `beginIndex` 位置から `endIndex` 位置までのテキスト範囲に適用します。

スロー

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

	`RangeError` — 指定された `beginIndex` または `endIndex` は範囲外です。

イベントの詳細

change

event

イベントオブジェクトの型: flash.events.Event
Event.type property = flash.events.Event.CHANGE

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

change イベントオブジェクトの type プロパティの値を定義します。

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

プロパティ	値
`bubbles`	`true`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	値が変更されたオブジェクトです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。

link

event

イベントオブジェクトの型: flash.events.TextEvent
TextEvent.type property = flash.events.TextEvent.LINK

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

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

link イベントオブジェクトの type プロパティの値を定義します。

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

プロパティ	値
`bubbles`	`true`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	クリックされたハイパーリンクを含むテキストフィールドです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。
`text`	"event:" の後の URL の残りの部分は、

scroll

event

イベントオブジェクトの型: flash.events.Event
Event.type property = flash.events.Event.SCROLL

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

scroll イベントオブジェクトの type プロパティの値を定義します。

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

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	スクロールされた TextField オブジェクトです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。

textInput

event

イベントオブジェクトの型: flash.events.TextEvent
TextEvent.type property = flash.events.TextEvent.TEXT_INPUT

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

textInput イベントオブジェクトの type プロパティの値を定義します。

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

プロパティ	値
`bubbles`	`true`
`cancelable`	`true`。`preventDefault()` メソッドを呼び出してデフォルトの動作を取り消します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	文字が入力されるテキストフィールドです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。
`text`	ユーザーが入力した文字または文字の連続です。

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class TextField	プロパティ \| メソッド \| イベント

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