パッケージmx.core
インターフェイスpublic interface IUITextField extends IIMESupport , IFlexModule , IInvalidating , ISimpleStyleClient , IToolTipManagerClient , IUIComponent , IFlexDisplayObject , IFlexDisplayObject , IBitmapDrawable , IEventDispatcher
実装者 UITextField

IUITextField インターフェイスは、UITextField インスタンスの API の基本セットを定義します。



パブリックプロパティ
 プロパティ定義元
 InheritedaccessibilityProperties : AccessibilityProperties
この表示オブジェクトの現在のアクセシビリティオプションです。
IFlexDisplayObject
 Inheritedalpha : Number
指定されたオブジェクトのアルファ透明度値を示します。
IFlexDisplayObject
  alwaysShowSelection : Boolean
ITextField インターフェイスは、flash.display.TextField の API の基本セットを定義します。
IUITextField
  antiAliasType : String
このテキストフィールドに使用されるアンチエイリアス処理のタイプです。
IUITextField
  autoSize : String
テキストフィールドの自動的な拡大 / 縮小および整列を制御します。
IUITextField
  background : Boolean
テキストフィールドに背景の塗りがあるかどうかを指定します。
IUITextField
  backgroundColor : uint
テキストフィールドの背景の色です。
IUITextField
 InheritedbaselinePosition : Number
[読み取り専用] コンポーネントのテキストにおける 1 行目のベースラインの y 座標です。
IUIComponent
 InheritedblendMode : String
使用するブレンドモードを指定する BlendMode クラスの値です。
IFlexDisplayObject
  border : Boolean
テキストフィールドに境界線があるかどうかを指定します。
IUITextField
  borderColor : uint
テキストフィールドの境界線の色です。
IUITextField
  bottomScrollV : int
[読み取り専用] 指定されたテキストフィールドに現在表示されている一番下の行を示す整数です (1 から始まるインデックス)。
IUITextField
 InheritedcacheAsBitmap : Boolean
true に設定されている場合、表示オブジェクトの内部ビットマップ表現が Flash Player または Adobe AIR にキャッシュされます。
IFlexDisplayObject
  caretIndex : int
[読み取り専用] カーソル (キャレット) 位置のインデックスです。
IUITextField
  condenseWhite : Boolean
HTML テキストが含まれるテキストフィールド内の余分な空白(スペース、改行など)を削除するかどうかを指定するブール値です。
IUITextField
  defaultTextFormat : TextFormat
新しく挿入するテキスト (ユーザーが入力したテキストや replaceSelectedText() メソッドで挿入したテキストなど) に適用するフォーマットを指定します。
IUITextField
  displayAsPassword : Boolean
テキストフィールドがパスワードテキストフィールドであるかどうかを指定します。
IUITextField
 Inheriteddocument : Object
このコンポーネントに関連付けられたドキュメントオブジェクトへの参照です。
IUIComponent
  doubleClickEnabled : Boolean
オブジェクトが doubleClick イベントを受け取るかどうかを指定します。
IUITextField
  embedFonts : Boolean
埋め込みフォントのアウトラインを使用してレンダリングするかどうかを指定します。
IUITextField
 Inheritedenabled : Boolean
コンポーネントがユーザーの操作を受け入れることができるかどうかを指定します。
IUIComponent
 InheritedexplicitHeight : Number
コンポーネントの座標として明示的に指定されたコンポーネントの高さ(ピクセル単位)です。
IUIComponent
 InheritedexplicitMaxHeight : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最大の高さ(ピクセル単位)を指定する数値です。
IUIComponent
 InheritedexplicitMaxWidth : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最大の幅(ピクセル単位)を指定する数値です。
IUIComponent
 InheritedexplicitMinHeight : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最小の高さ(ピクセル単位)を指定する数値です。
IUIComponent
 InheritedexplicitMinWidth : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最小の幅(ピクセル単位)を指定する数値です。
IUIComponent
 InheritedexplicitWidth : Number
コンポーネントの座標として明示的に指定されたコンポーネントの幅(ピクセル単位)です。
IUIComponent
 Inheritedfilters : Array
表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。
IFlexDisplayObject
 InheritedfocusPane : Sprite
複数のコンポーネント間で共有され、フォーカス描画のオーバーレイとして使用される単一の Sprite オブジェクトです。
IUIComponent
  focusRect : Object
このオブジェクトがフォーカス矩形を表示するかどうかを指定します。
IUITextField
  gridFitType : String
このテキストフィールドに使用されるグリッドフィッティングのタイプです。
IUITextField
 Inheritedheight : Number
表示オブジェクトの高さを示します (ピクセル単位)。
IFlexDisplayObject
  htmlText : String
テキストフィールドの内容を HTML で表します。
IUITextField
  ignorePadding : Boolean
true の場合、paddingLeft および paddingRight スタイルはコンポーネントのテキストの周囲にスペースを追加しません。
IUITextField
 InheritedimeMode : String
コンポーネントの IME モードです。
IIMESupport
 InheritedincludeInLayout : Boolean
このコンポーネントを親コンテナのレイアウトに含めるかどうかを指定します。
IUIComponent
  inheritingStyles : Object
この UITextField の継承スタイルのチェーンの先頭です。
IUITextField
 InheritedisPopUp : Boolean
コンポーネントがポップアップされたことを示すため、PopUpManager によって true に設定されます。
IUIComponent
  length : int
[読み取り専用] テキストフィールド内の文字数です。
IUITextField
 InheritedloaderInfo : LoaderInfo
[読み取り専用] この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo オブジェクトを返します。
IFlexDisplayObject
 Inheritedmask : DisplayObject
呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。
IFlexDisplayObject
  maxChars : int
ユーザーが入力するときに、テキストフィールドに入る最大の文字数です。
IUITextField
 InheritedmaxHeight : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最大の高さ(ピクセル単位)を指定する数値です。
IUIComponent
  maxScrollH : int
[読み取り専用] scrollH の最大値です。
IUITextField
  maxScrollV : int
[読み取り専用] scrollH の最大値です。
IUITextField
 InheritedmaxWidth : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最大の幅(ピクセル単位)を指定する数値です。
IUIComponent
 InheritedmeasuredHeight : Number
[読み取り専用] このオブジェクトの測定した高さです。
IFlexDisplayObject
 InheritedmeasuredMinHeight : Number
コンポーネントのデフォルトの最小の高さ(ピクセル単位)です。
IUIComponent
 InheritedmeasuredMinWidth : Number
コンポーネントのデフォルトの最小幅(ピクセル単位)です。
IUIComponent
 InheritedmeasuredWidth : Number
[読み取り専用] このオブジェクトの測定した幅です。
IFlexDisplayObject
 InheritedminHeight : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最小の高さ(ピクセル単位)を指定する数値です。
IUIComponent
 InheritedminWidth : Number
[読み取り専用] コンポーネントの座標としてコンポーネントの最小の幅(ピクセル単位)を指定する数値です。
IUIComponent
  mouseEnabled : Boolean
このオブジェクトがマウスメッセージを受け取るかどうかを指定します。
IUITextField
  mouseWheelEnabled : Boolean
複数行にわたるテキストフィールドで、ユーザーがテキストフィールドをクリックしてホイールを回転させると、自動的にスクロールするかどうかを示すブール値です。
IUITextField
 InheritedmouseX : Number
[読み取り専用] マウス位置の x 座標を示します(ピクセル単位)。
IFlexDisplayObject
 InheritedmouseY : Number
[読み取り専用] マウス位置の y 座標を示します(ピクセル単位)。
IFlexDisplayObject
  multiline : Boolean
フィールドが複数行テキストフィールドであるかどうかを示します。
IUITextField
 Inheritedname : String
DisplayObject のインスタンス名を示します。
IFlexDisplayObject
  nestLevel : int
オブジェクト階層におけるこのオブジェクトの深度を表します。
IUITextField
  nonInheritingStyles : Object
この UITextField の非継承スタイルのチェーンの先頭です。
IUITextField
  nonZeroTextHeight : Number
[読み取り専用] textHeight と異なり、これはテキストが空の場合でもゼロ以外の値を返します。
IUITextField
  numLines : int
[読み取り専用] 複数行テキストフィールド内のテキスト行の数を定義します。
IUITextField
 InheritedopaqueBackground : Object
表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。
IFlexDisplayObject
 Inheritedowner : DisplayObjectContainer
通常、このコンポーネントの親コンテナです。
IUIComponent
 Inheritedparent : DisplayObjectContainer
[読み取り専用] この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。
IFlexDisplayObject
 InheritedpercentHeight : Number
コンポーネントの高さを親のサイズに対する比率(パーセンテージ)で指定する数値です。
IUIComponent
 InheritedpercentWidth : Number
コンポーネントの幅を親のサイズに対する比率(パーセンテージ)で指定する数値です。
IUIComponent
  restrict : String
ユーザーがテキストフィールドに入力できる文字のセットを指定します。
IUITextField
 Inheritedroot : DisplayObject
[読み取り専用] 通常、これらのメソッドは IDisplayObject にのみ配置されていますが、下位互換性を保つために、IFlexDisplayObject に直接含める必要があります。そのため、この別個のインクルードファイルにこれらのメソッドを保持する必要があります。
IFlexDisplayObject
 Inheritedrotation : Number
DisplayObject インスタンスの元の位置からの回転角を度単位で示します。
IFlexDisplayObject
 Inheritedscale9Grid : Rectangle
現在有効な拡大 / 縮小グリッドです。
IFlexDisplayObject
 InheritedscaleX : Number
基準点から適用されるオブジェクトの水平スケール(パーセンテージ)を示します。
IFlexDisplayObject
 InheritedscaleY : Number
オブジェクトの基準点から適用されるオブジェクトの垂直スケール(percentage)を示します。
IFlexDisplayObject
  scrollH : int
現在の水平スクロール位置です。
IUITextField
 InheritedscrollRect : Rectangle
表示オブジェクトのスクロール矩形の境界です。
IFlexDisplayObject
  scrollV : int
テキストフィールドのテキストの垂直位置です。
IUITextField
  selectable : Boolean
テキストフィールドが選択可能であるかどうかを示すブール値です。
IUITextField
  selectionBeginIndex : int
[読み取り専用] 現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。
IUITextField
  selectionEndIndex : int
[読み取り専用] 現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。
IUITextField
  sharpness : Number
このテキストフィールド内の文字エッジのシャープネスです。
IUITextField
 Inheritedstage : Stage
[読み取り専用] 表示オブジェクトのステージです。
IFlexDisplayObject
 InheritedstyleName : Object
オブジェクトのスタイル値のソースです。
ISimpleStyleClient
  styleSheet : StyleSheet
テキストフィールドにスタイルシートを関連付けます。
IUITextField
 InheritedsystemManager : ISystemManager
このコンポーネントの SystemManager オブジェクトへの参照です。
IUIComponent
  tabEnabled : Boolean
通常、これらのメソッドは IInteractiveObject にのみ配置されていますが、下位互換性を保つために、その祖先メソッドを IFlexDisplayObject に直接含める必要があります。そのため、ITextField で使用できるように、この別個のインクルードファイルにこれらのメソッドも保持する必要があります。
IUITextField
  tabIndex : int
SWF ファイル内のオブジェクトのタブ順序を指定します。
IUITextField
  text : String
テキストフィールド内の現在のテキストであるストリングです。
IUITextField
  textColor : uint
テキストフィールドのテキストの色です (16 進数形式)。
IUITextField
  textHeight : Number
[読み取り専用] テキストの高さです (ピクセル単位)。
IUITextField
  textWidth : Number
[読み取り専用] テキストの幅です (ピクセル単位)。
IUITextField
  thickness : Number
このテキストフィールド内の文字エッジの太さです。
IUITextField
 InheritedtoolTip : String
このコンポーネントのツールヒントのテキストです。
IToolTipManagerClient
 Inheritedtransform : Transform
表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクトです。
IFlexDisplayObject
 InheritedtweeningProperties : Array
EffectManager によって使用されます。
IUIComponent
  type : String
テキストフィールドのタイプです。
IUITextField
  useRichTextClipboard : Boolean
テキストと共にテキストのフォーマットをコピー&ペーストするかどうかを指定します。
IUITextField
 Inheritedvisible : Boolean
表示オブジェクトが可視かどうかを示します。
IFlexDisplayObject
 Inheritedwidth : Number
表示オブジェクトの幅を示します (ピクセル単位)。
IFlexDisplayObject
  wordWrap : Boolean
テキストフィールドのテキストを折り返すかどうかを示すブール値です。
IUITextField
 Inheritedx : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。
IFlexDisplayObject
 Inheritedy : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。
IFlexDisplayObject
パブリックメソッド
 メソッド定義元
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
IEventDispatcher
  
newText パラメータで指定されたストリングを、テキストフィールドのテキストの最後に付加します。
IUITextField
 Inherited
イベントをイベントフローに送出します。
IEventDispatcher
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
targetCoordinateSpace オブジェクトの座標系を基準にして、表示オブジェクトの領域を定義する矩形を返します。
IFlexDisplayObject
  
文字の境界ボックスである矩形を返します。
IUITextField
  
x および y パラメータで指定された点にある文字の、0 から始まるインデックス値を返します。
IUITextField
 Inherited
明示的に指定された高さを使用するのか、それとも測定された高さを使用するのかを決定するための便利なメソッドです。
IUIComponent
 Inherited
明示的に指定された幅を使用するのか、それとも測定された幅を使用するのかを決定するための便利なメソッドです。
IUIComponent
  
文字インデックスを指定すると、同じ段落内の最初の文字のインデックスを返します。
IUITextField
  
<img> タグを使用して HTML フォーマットのテキストフィールドに追加されたイメージまたは SWF ファイルについて、指定された id の DisplayObject 参照を返します。
IUITextField
  
x および y パラメータで指定された点にある行の 0 から始まるインデックス値を返します。
IUITextField
  
charIndex パラメータで指定された文字を含む行の 0 から始まるインデックス値を返します。
IUITextField
  
getLineLength(lineIndex:int):int
特定のテキスト行内の文字数を返します。
IUITextField
  
指定されたテキスト行に関するメトリック情報を返します。
IUITextField
  
getLineOffset(lineIndex:int):int
lineIndex パラメータで指定された行の最初の文字の文字インデックスを返します。
IUITextField
  
lineIndex パラメータで指定された行のテキストを返します。
IUITextField
  
文字インデックスを指定すると、指定された文字を含む段落の長さを返します。
IUITextField
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
シェイプ上の線を除き、targetCoordinateSpace パラメータによって定義された座標系に基づいて、表示オブジェクトの境界を定義する矩形を返します。
IFlexDisplayObject
  
getStyle(styleProp:String):*
このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。
IUITextField
  
getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
beginIndex パラメータと endIndex パラメータで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクトを返します。
IUITextField
  
このコンポーネントのフォーマット情報を含む UITextFormat オブジェクトを返します。
IUITextField
 Inherited
point オブジェクトをステージ (グローバル) 座標から表示オブジェクトの (ローカル) 座標に変換します。
IFlexDisplayObject
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
IEventDispatcher
 Inherited
表示オブジェクトの境界ボックスを評価して、obj 表示オブジェクトの境界ボックスと重複または交差するかどうかを調べます。
IFlexDisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
表示オブジェクトを評価して、x および y パラメータで指定されたポイントと重複または交差するかどうかを調べます。
IFlexDisplayObject
 Inherited
オブジェクトを初期化します。
IUIComponent
 Inherited
このメソッドを呼び出すと、表示リストがレンダリングされる前に、コンポーネントの validateDisplayList() メソッドが呼び出されます。
IInvalidating
 Inherited
このメソッドを呼び出すと、表示リストがレンダリングされる前にコンポーネントの validateProperties() メソッドが呼び出されます。
IInvalidating
 Inherited
このメソッドを呼び出すと、表示リストがレンダリングされる前に、コンポーネントの validateSize() メソッドが呼び出されます。
IInvalidating
 Inherited
point オブジェクトを表示オブジェクトの (ローカル) 座標からステージ (グローバル) 座標に変換します。
IFlexDisplayObject
 Inherited
このオブジェクトを指定の x および y 座標に移動します。
IFlexDisplayObject
 Inherited
owner プロパティのチェーンが child からこの UIComponent を指定している場合に、true を返します。
IUIComponent
 Inherited
UIComponent オブジェクトを親に対して追加または削除したときに Flex によって呼び出されます。
IUIComponent
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
IEventDispatcher
  
現在の選択内容を value パラメータの内容に置き換えます。
IUITextField
  
replaceText(beginIndex:int, endIndex:int, newText:String):void
beginIndex パラメータと endIndex パラメータで指定された文字範囲を、newText パラメータの内容に置き換えます。
IUITextField
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
このオブジェクトの実際のサイズを設定します。
IFlexDisplayObject
  
テキストのフォントの色を設定します。
IUITextField
  
現在扱っているコンポーネントにフォーカスを設定します。
IUITextField
  
setSelection(beginIndex:int, endIndex:int):void
最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します。最初の文字と最後の文字のインデックス値は、beginIndex パラメータおよび endIndex パラメータを使用して指定されます。
IUITextField
  
setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
format パラメータで指定したテキストフォーマットを、テキストフィールド内の指定されたテキストに適用します。
IUITextField
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
visible プロパティが変更されたときに呼び出されます。
IUIComponent
 Inherited
スタイルプロパティの値が変化したときに呼び出されます。
ISimpleStyleClient
  
truncateToFit(truncationIndicator:String = null):Boolean
コントロールに定義された領域に水平方向に収まるようテキストを切り詰めて、省略記号つまり 3 つのピリオド(...)をテキストに付加します。
IUITextField
 Inherited
必要に応じて、validateProperties()、validateSize() および validateDisplayList() を直ちに呼び出して、このオブジェクトのプロパティとレイアウトを検証および更新します。
IInvalidating
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
IEventDispatcher
プロパティの詳細
alwaysShowSelectionプロパティ
alwaysShowSelection:Boolean

ITextField インターフェイスは、flash.display.TextField の API の基本セットを定義します。



実装
    public function get alwaysShowSelection():Boolean
    public function set alwaysShowSelection(value:Boolean):void
antiAliasTypeプロパティ 
antiAliasType:String

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

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

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

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

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

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

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

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



実装
    public function get autoSize():String
    public function set autoSize(value:String):void
backgroundプロパティ 
background:Boolean

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



実装
    public function get background():Boolean
    public function set background(value:Boolean):void
backgroundColorプロパティ 
backgroundColor:uint

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



実装
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
borderプロパティ 
border:Boolean

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



実装
    public function get border():Boolean
    public function set border(value:Boolean):void
borderColorプロパティ 
borderColor:uint

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



実装
    public function get borderColor():uint
    public function set borderColor(value:uint):void
bottomScrollVプロパティ 
bottomScrollV:int  [読み取り専用]

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

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



実装
    public function get bottomScrollV():int
caretIndexプロパティ 
caretIndex:int  [読み取り専用]

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

選択範囲のインデックスは 0 から始まります。つまり、最初の位置は 0、2 番目の位置は 1 で、以下同様に続きます。



実装
    public function get caretIndex():int
condenseWhiteプロパティ 
condenseWhite:Boolean

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

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

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



実装
    public function get condenseWhite():Boolean
    public function set condenseWhite(value:Boolean):void
defaultTextFormatプロパティ 
defaultTextFormat:TextFormat

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

メモ:setSelection()replaceSelectedText() で置き換える文字を選択する場合は、末尾文字も含めてテキスト全体を選択した場合に限り、defaultTextFormat が適用されます。次に例を示します。

  var my_txt:TextField new TextField();
  my_txt.text = "Flash Macintosh version";
  var my_fmt:TextFormat = new TextFormat();
  my_fmt.color = 0xFF0000;
  my_txt.defaultTextFormat = my_fmt;
  my_txt.setSelection(6,15); // partial text selected - defaultTextFormat not applied
  my_txt.setSelection(6,23); // text selected to end - defaultTextFormat applied
  my_txt.replaceSelectedText("Windows version");
  

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

メモ: このプロパティはテキストフィールドにスタイルシートが適用されていると設定できません。



実装
    public function get defaultTextFormat():TextFormat
    public function set defaultTextFormat(value:TextFormat):void
displayAsPasswordプロパティ 
displayAsPassword:Boolean

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



実装
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void
doubleClickEnabledプロパティ 
doubleClickEnabled:Boolean

オブジェクトが doubleClick イベントを受け取るかどうかを指定します。デフォルト値は false です。これは、InteractiveObject インスタンスがデフォルトでは doubleClick イベントを受け取らないことを意味します。doubleClickEnabled プロパティがtrue に設定される場合、インスタンスはその境界内で doubleClick イベントを受け取ります。InteractiveObject インスタンスの mouseEnabled プロパティもtrue に設定する必要があります。この設定は、オブジェクトが doubleClick イベントを受け取るようにするには必須です。

このプロパティを設定すると、イベントは送出されなくなります。addEventListener() メソッドの使用は、doubleClick イベントのイベントリスナーを追加する場合に必須です。



実装
    public function get doubleClickEnabled():Boolean
    public function set doubleClickEnabled(value:Boolean):void
embedFontsプロパティ 
embedFonts:Boolean

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

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



実装
    public function get embedFonts():Boolean
    public function set embedFonts(value:Boolean):void
focusRectプロパティ 
focusRect:Object

このオブジェクトがフォーカス矩形を表示するかどうかを指定します。truefalse または null の 3 つの値のいずれかを指定できます。true および false の値は、予想されるとおり、フォーカス矩形を表示するかどうかが指定されます。null 値は、このオブジェクトが Stage の stageFocusRect プロパティに従うことを示します。



実装
    public function get focusRect():Object
    public function set focusRect(value:Object):void
gridFitTypeプロパティ 
gridFitType:String

このテキストフィールドに使用されるグリッドフィッティングのタイプです。このプロパティは、テキストフィールドの 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 設定は、右揃えまたは中央揃えのダイナミックテキストに適した設定で、アニメーション品質とテキスト品質のバランスを取るのに便利です。



実装
    public function get gridFitType():String
    public function set gridFitType(value:String):void
htmlTextプロパティ 
htmlText:String

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

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

タグ 説明
アンカータグ <a> タグは、ハイパーリンクを作成し、次の属性をサポートします。
  • target:ページをロードする先のターゲットウィンドウの名前を指定します。オプションには、_self_blank_parent、および _top があります。_self オプションは現在のウィンドウ内の現在のフレームを指定します。_blank は新しいウィンドウを指定します。_parent は現在のフレームの親を指定します。_top は現在のウィンドウ内のトップレベルのフレームを指定します。
  • href:URL または ActionScript link イベントを指定します。URL には、絶対 URL、またはページをロードする SWF ファイルの場所を基準とする相対 URL のいずれかを使用できます。URL への絶対的な参照の例としては http://www.adobe.com、相対的な参照の例としては /index.html が挙げられます。絶対 URL には先頭に http:// を付けます。それがない場合、Flash Player または AIR では相対 URL と見なされます。link イベントを使用すると、リンクで URL を開くのではなく、SWF ファイルの ActionScript 関数を実行することができます。link イベントを指定するには、href 属性で、http スキームではなくイベントスキームを使用します。例では、href="event:myText" が使用されています(href="http://myURL" ではありません)。ユーザーがイベントスキームを含むハイパーテキストリンクをクリックすると、テキストフィールドが link TextEvent を送出します。このイベントの text プロパティは「myText」に設定されます。次に、link TextEvent が送出されると常に実行される 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 ファイル、またはムービークリップのピクセル単位の高さです。
  • align:テキストフィールド内の埋め込みイメージの水平整列を指定します。有効な値は、left および right です。デフォルト値は left です。
  • hspace:イメージの周りの水平方向の空白の量 (テキストが表示されない領域) を指定します。デフォルト値は 8 です。
  • vspace:イメージの周りの垂直方向の空白の量 (テキストが表示されない領域) を指定します。デフォルト値は 8 です。
  • id:埋め込みイメージファイル、SWF ファイル、またはムービークリップを含むムービークリップインスタンスの名前(Flash Player が作成したもの)を指定します。この方法は、ActionScript を使用して埋め込みコンテンツを制御する場合に使用されます。
  • checkPolicyFile:イメージのドメインに関連付けられたサーバー上の URL ポリシーファイルを Flash Player が確認することを指定します。ポリシーファイルが存在する場合、ファイルに記載されているドメイン内の SWF ファイルは、読み込まれたイメージのデータにアクセスできます。例えば、BitmapData.draw() メソッドの呼び出しを、このイメージを source パラメータにして実行することよってアクセスできます。詳細については、『ActionScript 3.0 のプログラミング』の「Flash Player セキュリティ」の章を参照してください。

Flash はテキストフィールドに埋め込まれたメディアをフルサイズで表示します。埋め込むメディアのサイズを指定するには、<img> タグの height 属性と width 属性を使用します。

一般に、テキストフィールドに埋め込まれたイメージは、<img> タグの次の行に表示されます。ただし、<img> タグがテキストフィールドの最初の文字であった場合、イメージはテキストフィールドの最初の行に表示されます。

アプリケーションセキュリティサンドボックスの AIR コンテンツの場合、ActionScript TextField オブジェクトの HTML コンテンツにある img タグは無視されます。これはフィッシング攻撃を防ぐためです。

イタリックタグ <i> タグは、指定されたテキストをイタリックで表示します。イタリック体を利用できるフォントで使用する必要があります。
リスト項目タグ <li> タグは、タグが囲んでいるテキストの最初に箇条書き記号を配置します。メモ:Flash Player および AIR では、番号付きリストタグや番号なしリストタグ(<ol><ul>)は認識されないため、これらのタグが使われていてもリストの表示形態に変化はありません。どのリストにも番号は付かず、すべてのリストアイテムに箇条書き記号が使用されます。
段落タグ <p> タグは新しい段落を作成します。このタグを使用するには、テキストフィールドを複数行テキストフィールドに設定する必要があります。<p> タグは、次の属性をサポートします。
  • align—段落内のテキストの整列を指定します。有効な値は、leftrightjustify、および center です。
  • clas: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 および AIR では、次の HTML エンティティがサポートされています。

エンティティ 説明
&amp;lt; < (より小さい)
&amp;gt; > (より大きい)
&amp;amp; &(アンパサンド)
&amp;quot; " (二重引用符)
&amp;apos; ' (アポストロフィ、一重引用符)

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



実装
    public function get htmlText():String
    public function set htmlText(value:String):void
ignorePaddingプロパティ 
ignorePadding:Boolean

true の場合、paddingLeft および paddingRight スタイルはコンポーネントのテキストの周囲にスペースを追加しません。



実装
    public function get ignorePadding():Boolean
    public function set ignorePadding(value:Boolean):void
inheritingStylesプロパティ 
inheritingStyles:Object

この UITextField の継承スタイルのチェーンの先頭です。getStyle() メソッドは単純に inheritingStyles[styleName] にアクセスして、プロトタイプリンクのチェーン全体を検索します。このオブジェクトは initProtoChain() メソッドによって設定されます。通常はこのプロパティに直接アクセスする必要はありません。



実装
    public function get inheritingStyles():Object
    public function set inheritingStyles(value:Object):void
lengthプロパティ 
length:int  [読み取り専用]

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



実装
    public function get length():int
maxCharsプロパティ 
maxChars:int

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



実装
    public function get maxChars():int
    public function set maxChars(value:int):void
maxScrollHプロパティ 
maxScrollH:int  [読み取り専用]

scrollH の最大値です。



実装
    public function get maxScrollH():int
maxScrollVプロパティ 
maxScrollV:int  [読み取り専用]

scrollV の最大値です。



実装
    public function get maxScrollV():int
mouseEnabledプロパティ 
mouseEnabled:Boolean

このオブジェクトがマウスメッセージを受け取るかどうかを指定します。デフォルト値は true であり、これは表示リスト上の InteractiveObject がデフォルトでマウスイベントを受け取ることを意味します。mouseEnabledfalse に設定される場合、インスタンスはマウスイベントを受け取らなくなります。表示リスト上のこのインスタンスの子は影響を受けません。表示リスト上のオブジェクトのすべての子に関する mouseEnabled 動作を変更するには、flash.display.DisplayObjectContainer.mouseChildren を使用します。

このプロパティを設定すると、イベントは送出されなくなります。インタラクティブな機能を作成するには、addEventListener() メソッドを使用する必要があります。



実装
    public function get mouseEnabled():Boolean
    public function set mouseEnabled(value:Boolean):void
mouseWheelEnabledプロパティ 
mouseWheelEnabled:Boolean

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



実装
    public function get mouseWheelEnabled():Boolean
    public function set mouseWheelEnabled(value:Boolean):void
multilineプロパティ 
multiline:Boolean

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



実装
    public function get multiline():Boolean
    public function set multiline(value:Boolean):void
nestLevelプロパティ 
nestLevel:int

オブジェクト階層におけるこのオブジェクトの深度を表します。この数値は、測定およびレイアウトコードによって使用されます。このコンポーネントが DisplayList でない場合、この値は 0 になります。



実装
    public function get nestLevel():int
    public function set nestLevel(value:int):void
nonInheritingStylesプロパティ 
nonInheritingStyles:Object

この UITextField の非継承スタイルのチェーンの先頭です。getStyle() メソッドは単純に nonInheritingStyles[styleName] にアクセスして、プロトタイプリンクのチェーン全体を検索します。このオブジェクトは initProtoChain() メソッドによって設定されます。通常はこのプロパティに直接アクセスする必要はありません。



実装
    public function get nonInheritingStyles():Object
    public function set nonInheritingStyles(value:Object):void
nonZeroTextHeightプロパティ 
nonZeroTextHeight:Number  [読み取り専用]

textHeight と異なり、これはテキストが空の場合でもゼロ以外の値を返します。この場合、テキストが空でなかったときの textHeight の値を返します。



実装
    public function get nonZeroTextHeight():Number
numLinesプロパティ 
numLines:int  [読み取り専用]

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



実装
    public function get numLines():int
restrictプロパティ 
restrict:String

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



実装
    public function get restrict():String
    public function set restrict(value:String):void
scrollHプロパティ 
scrollH:int

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

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

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



実装
    public function get scrollH():int
    public function set scrollH(value:int):void
scrollVプロパティ 
scrollV:int

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

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



実装
    public function get scrollV():int
    public function set scrollV(value:int):void
selectableプロパティ 
selectable:Boolean

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

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



実装
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void
selectionBeginIndexプロパティ 
selectionBeginIndex:int  [読み取り専用]

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



実装
    public function get selectionBeginIndex():int
selectionEndIndexプロパティ 
selectionEndIndex:int  [読み取り専用]

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



実装
    public function get selectionEndIndex():int
sharpnessプロパティ 
sharpness:Number

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



実装
    public function get sharpness():Number
    public function set sharpness(value:Number):void
styleSheetプロパティ 
styleSheet:StyleSheet

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

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

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



実装
    public function get styleSheet():StyleSheet
    public function set styleSheet(value:StyleSheet):void
tabEnabledプロパティ 
tabEnabled:Boolean

通常、これらのメソッドは IInteractiveObject にのみ配置されていますが、下位互換性を保つために、その祖先メソッドを IFlexDisplayObject に直接含める必要があります。そのため、ITextField で使用できるように、この別個のインクルードファイルにこれらのメソッドも保持する必要があります。



実装
    public function get tabEnabled():Boolean
    public function set tabEnabled(value:Boolean):void
tabIndexプロパティ 
tabIndex:int

SWF ファイル内のオブジェクトのタブ順序を指定します。デフォルトでは tabIndex プロパティは -1 であり、これはそのオブジェクトにタブインデックスが設定されないことを意味します。

SWF ファイルに現在表示されているオブジェクトに tabIndex プロパティがある場合は、自動タブ順序が無効になり、SWF ファイルのオブジェクトの tabIndex プロパティからタブ順序が計算されます。カスタムタブ順序には、tabIndex プロパティを持つオブジェクトのみが含まれます。

tabIndex プロパティは、通常、負以外の整数です。オブジェクトのタブ順序は、その tabIndex プロパティに従って昇順に決定されます。tabIndex の値が 1 であるオブジェクトは、tabIndex の値が 2 であるオブジェクトの前になります。複数のオブジェクトの tabIndex に同じ値を使用しないでください。

tabIndexプロパティで定義されるカスタムタブ順序は flat です。つまり、SWF ファイル内のオブジェクトの階層関係は無視されます。SWF ファイルで tabIndex プロパティを持つすべてのオブジェクトは、タブ順序に従って配置されます。タブ順序は tabIndex の値の順番に従います。



実装
    public function get tabIndex():int
    public function set tabIndex(value:int):void
textプロパティ 
text:String

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

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



実装
    public function get text():String
    public function set text(value:String):void
textColorプロパティ 
textColor:uint

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



実装
    public function get textColor():uint
    public function set textColor(value:uint):void
textHeightプロパティ 
textHeight:Number  [読み取り専用]

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



実装
    public function get textHeight():Number
textWidthプロパティ 
textWidth:Number  [読み取り専用]

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



実装
    public function get textWidth():Number
thicknessプロパティ 
thickness:Number

このテキストフィールド内の文字エッジの太さです。このプロパティは、flash.text.AntiAliasTypeflash.text.AntiAliasType.ADVANCED に設定されている場合にのみ適用されます。

thickness の範囲は、-200 ~ 200 の数値です。thickness をこの範囲外の値に設定すると、このプロパティは範囲内の最も近い値 (-200 または 200) に設定されます。



実装
    public function get thickness():Number
    public function set thickness(value:Number):void
typeプロパティ 
type:String

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



実装
    public function get type():String
    public function set type(value:String):void
useRichTextClipboardプロパティ 
useRichTextClipboard:Boolean

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



実装
    public function get useRichTextClipboard():Boolean
    public function set useRichTextClipboard(value:Boolean):void
wordWrapプロパティ 
wordWrap:Boolean

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



実装
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void
メソッドの詳細
appendText()メソッド
public function appendText(newText:String):void

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

パラメータ

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

getCharBoundaries()メソッド 
public function getCharBoundaries(charIndex:int):Rectangle

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

パラメータ

charIndex:int — 文字の 0 から始まるインデックス値です。つまり、最初の位置は 0、2 番目の位置は 1 で、以下同様に続きます。

戻り値
Rectangle — 文字の境界ボックスを定義する x および y の最小値と最大値が指定された矩形です。
getCharIndexAtPoint()メソッド 
public function getCharIndexAtPoint(x:Number, y:Number):int

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

パラメータ

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

戻り値
int — 0 から始まる文字のインデックス値です。例えば、最初の位置は 0、次の位置は 1 と続きます(以下同様)。指定されたポイントがどの文字の上にもない場合は -1 を返します。
getFirstCharInParagraph()メソッド 
public function getFirstCharInParagraph(charIndex:int):int

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

パラメータ

charIndex:int — 文字の 0 から始まるインデックス値です。つまり、最初の文字は 0、2 番目の文字は 1 で、以下同様に続きます。

戻り値
int — 同じ段落内の最初の文字を示す、0 から始まるインデックス値です。
getImageReference()メソッド 
public function getImageReference(id:String):DisplayObject

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

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

パラメータ

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

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

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

パラメータ

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

戻り値
int — 0 から始まる行のインデックス値です。例えば、最初の行は 0、次の行は 1 と続きます(以下同様)。指定されたポイントがどの行の上にもない場合は -1 を返します。
getLineIndexOfChar()メソッド 
public function getLineIndexOfChar(charIndex:int):int

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

パラメータ

charIndex:int — 文字の 0 から始まるインデックス値です。つまり、最初の文字は 0、2 番目の文字は 1 で、以下同様に続きます。

戻り値
int — 行の 0 から始まるインデックス値です。
getLineLength()メソッド 
public function getLineLength(lineIndex:int):int

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

パラメータ

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

戻り値
int — 行内の文字数です。
getLineMetrics()メソッド 
public function getLineMetrics(lineIndex:int):TextLineMetrics

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

パラメータ

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

戻り値
TextLineMetrics — TextLineMetrics オブジェクトです。
getLineOffset()メソッド 
public function getLineOffset(lineIndex:int):int

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

パラメータ

lineIndex:int — 行の 0 から始まるインデックス値です。つまり、最初の行は 0、2 番目の行は 1 で、以下同様に続きます。

戻り値
int — 行の最初の文字を示す、0 から始まるインデックス値です。
getLineText()メソッド 
public function getLineText(lineIndex:int):String

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

パラメータ

lineIndex:int — 行の 0 から始まるインデックス値です。つまり、最初の行は 0、2 番目の行は 1 で、以下同様に続きます。

戻り値
String — 指定された行に含まれるテキストストリングです。
getParagraphLength()メソッド 
public function getParagraphLength(charIndex:int):int

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

パラメータ

charIndex:int — 文字の 0 から始まるインデックス値です。つまり、最初の文字は 0、2 番目の文字は 1 で、以下同様に続きます。

戻り値
int — 段落内の文字数を返します。
getStyle()メソッド 
public function getStyle(styleProp:String):*

このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。

このメソッドは、あらゆる種類のスタイルプロパティの取得に使用されるため、戻り値は Boolean、String、Number、int、uint(RGB カラーの場合)、Class(スキンの場合)、または何らかのオブジェクトになります。したがって、戻り値の型は単に * として指定されます。

特定のスタイルプロパティを取得する場合は、その型がわかっていて、その型の変数に結果を格納することがよくあります。* からその型へのキャストは必要ありません。

var backgroundColor:uint = getStyle("backgroundColor");

スタイルプロパティがスタイル参照チェーンのどこにも設定されていない場合は、getStyle() によって返される値は undefined になります。undefined は、false""NaN0、または null とは異なる特殊な値である点に注意してください。有効なスタイル値が undefined になることはありません。値が設定されたかどうかをテストするには、静的メソッド StyleManager.isValidStyleValue() を使用します。

パラメータ

styleProp:String — スタイルプロパティの名前です。

戻り値
* — スタイル値です。
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-1 までの範囲のテキストに関するフォーマット情報を含む TextFormat オブジェクトを返します。指定された範囲内のすべてのテキストに共通するプロパティのみが結果の TextFormat オブジェクトに設定されます。混在型のプロパティ(範囲内の位置によって異なる値が指定されている場合)は、その値が null に設定されます。

パラメータ

beginIndex:int (default = -1) — オプション。テキストフィールド内のテキスト範囲の開始位置を指定する整数です。
 
endIndex:int (default = -1) — オプション:該当するテキスト範囲の直後の文字の位置を指定する整数。意図したとおり、beginIndexendIndex の値を指定すると、beginIndex から endIndex-1 までのテキストが読み込まれます。

戻り値
TextFormat — 指定されたテキストのフォーマットプロパティを表す TextFormat オブジェクトです。
getUITextFormat()メソッド 
public function getUITextFormat():UITextFormat

このコンポーネントのフォーマット情報を含む UITextFormat オブジェクトを返します。このメソッドは、flash.text.TextField クラスの getTextFormat() メソッドに似ていますが、TextFormat オブジェクトではなく UITextFormat オブジェクトを返します。

UITextFormat クラスは TextFormat クラスを拡張し、テキスト測定メソッドの measureText() および measureHTMLText() を追加します。

戻り値
UITextFormat — このコンポーネントのフォーマット情報を持つオブジェクトです。
replaceSelectedText()メソッド 
public function replaceSelectedText(value:String):void

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

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

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

パラメータ

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

replaceText()メソッド 
public function replaceText(beginIndex:int, endIndex:int, newText:String):void

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

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

パラメータ

beginIndex:int — 置換範囲の開始位置の 0 から始まるインデックス値です。
 
endIndex:int — 該当するテキスト範囲の直後の文字の 0 から始まるインデックス位置です。
 
newText:String — 指定された文字範囲の置き換えに使用されるテキストです。

setColor()メソッド 
public function setColor(color:uint):void

テキストのフォントの色を設定します。

パラメータ

color:uint — 新しいフォントカラーです。

setFocus()メソッド 
public function setFocus():void

現在扱っているコンポーネントにフォーカスを設定します。このとき、コンポーネントのサブコンポーネントにフォーカスが渡されることがあります。

メモ:このメソッドでフォーカスを設定したときは、TextInput および TextArea コントロールだけがハイライトを表示します。すべてのコントロールは、ユーザーが Tab キーでコントロールを選択したときにハイライトを表示します。

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 以外のプロパティのみが、テキストフィールドに適用されます。formatnull に設定されているプロパティは適用されません。デフォルトで、新しく作成された TextFormat オブジェクトのプロパティはすべて null に設定されます。

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

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

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

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

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

パラメータ

format:TextFormat — 文字と段落のフォーマット情報を含む TextFormat オブジェクトです。
 
beginIndex:int (default = -1) — オプション:該当するテキスト範囲の直後の文字を指定して、ゼロから始まるインデックス位置を指定する整数。
 
endIndex:int (default = -1) — オプション:該当するテキスト範囲の直後の文字を指定する整数。意図したとおり、beginIndexendIndex の値を指定すると、beginIndex から endIndex-1 までのテキストが更新されます。

使用方法説明
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-1 位置までのテキスト範囲に適用します。

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

truncateToFit()メソッド 
public function truncateToFit(truncationIndicator:String = null):Boolean

コントロールに定義された領域に水平方向に収まるようテキストを切り詰めて、省略記号つまり 3 つのピリオド(...)をテキストに付加します。

パラメータ

truncationIndicator:String (default = null) — 切り詰めの後に追加されるテキストです。 null を渡すと、"..." のようなローカライズ可能なストリングが使用されます。

戻り値
Boolean — テキストの切り詰めが必要になった場合は true になります。




 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/core/IUITextField.html