| Package | org.unbland.ui |
| Class | public class UITextField |
| Inheritance | UITextField  UIBase flash.display.Sprite |
このクラスは抽象クラスのため直接インスタンス化できません.
あらかじめ配置しておくオブジェクトは以下の通りです.
| Property | Defined by | ||
|---|---|---|---|
| allSelected : Boolean
テキストフィールドをクリックしてフォーカスが移った際, テキストを全選択するか否かです.
| UITextField | ||
| alwaysShowSelection : Boolean
true に設定されフォーカスがない場合, テキスト内の選択内容は灰色でハイライト表示されます.
| UITextField | ||
| antiAliasType : String
テキストに使用されるアンチエイリアス処理のタイプです.
| UITextField | ||
| areaBounds : Rectangle [read-only]
各パラメータの計算結果が反映されたこの UI のエリア領域です.
| UITextField | ||
| areaHeight : Number
この UI のエリア領域の高さを示す数値です.
| UITextField | ||
| areaWidth : Number
この UI のエリア領域の幅を示す数値です.
| UITextField | ||
 | autoRendering : Boolean
この UI のレンダリングを自動的に行うか否かです.
| UIBase | |
| bottomScrollV : int [read-only]
現在表示されている一番下の行を示す, 1 から始まるインデックス値です.
| UITextField | ||
| caretIndex : int [read-only]
カーソル (キャレット) 位置のインデックスです.
| UITextField | ||
| condenseWhite : Boolean
HTML テキストが含まれるテキストフィールド内の余分な空白
(スペース, 改行など) を削除するか否かです.
| UITextField | ||
| defaultTextFormat : TextFormat
新しく挿入するテキスト
(ユーザーが入力したテキストや replaceSelectedText メソッドで挿入したテキストなど)
に適用するフォーマットを指定します.
| UITextField | ||
| displayAsPassword : Boolean
テキストをパスワードとして扱うか否かです.
| UITextField | ||
| editable : Boolean
テキストがユーザー入力により編集可能か否かです.
| UITextField | ||
| embedFonts : Boolean
埋め込みフォントのアウトラインを使用してレンダリングするか否かです.
| UITextField | ||
| enabled : Boolean
この UI がユーザーのマウスやキーボード操作を受け付けるか否かです.
| UIBase | |
| fieldBounds : Rectangle [read-only]
各パラメータの計算結果が反映されたテキストフィールドのエリア領域です.
| UITextField | ||
| gridFitType : String
このテキストに使用されるグリッドフィッティングのタイプです.
| UITextField | ||
| htmlText : String
テキストフィールドの内容を HTML で表します.
| UITextField | ||
| imeMode : String
IME (入力メソッドエディタ) のモードを指定します.
| UITextField | ||
| length : int [read-only]
テキストの文字数です.
| UITextField | ||
| margin : Margin
テキストフィールドのマージンを設定するためのオブジェクトです.
| UITextField | ||
| maxAreaHeight : Number
この UI のエリア領域の最大高を示す数値です.
| UITextField | ||
| maxAreaWidth : Number
この UI のエリア領域の最大幅を示す数値です.
| UITextField | ||
| maxChars : int
ユーザーが入力するときに, テキストに入る最大の文字数です.
| UITextField | ||
| maxScrollH : int [read-only]
scrollH の最大値です.
| UITextField | ||
| maxScrollV : int [read-only]
scrollV の最大値です.
| UITextField | ||
| minAreaHeight : Number
この UI のエリア領域の最小高を示す数値です.
| UITextField | ||
| minAreaWidth : Number
この UI のエリア領域の最小幅を示す数値です.
| UITextField | ||
| mouseWheelEnabled : Boolean
複数行にわたるテキストでユーザーがホイールを回転させると,
自動的にスクロールするか否かです.
| UITextField | ||
| multiline : Boolean
テキストが複数行であるか否かです.
| UITextField | ||
| numLines : int [read-only]
テキストの行数です.
| UITextField | ||
| pixelSnapped : Boolean
レンダリングの時に各パーツをピクセルに吸着して配置するか否かです.
| UIBase | |
| restrict : String
ユーザーがテキストに入力できる文字のセットを指定します.
| UITextField | ||
| scrollH : int
現在の水平スクロール位置です.
| UITextField | ||
| scrollV : int
現在の垂直スクロール位置です.
| UITextField | ||
| selectionBeginIndex : int [read-only]
現在の選択範囲の最初の文字を示す, 0 から始まるインデックス値です.
| UITextField | ||
| selectionEndIndex : int [read-only]
現在の選択範囲における最後の文字を示す, 0 から始まるインデックス値です.
| UITextField | ||
| sharpness : Number
このテキスト内の文字エッジのシャープネスです.
| UITextField | ||
| styleSheet : StyleSheet
テキストにスタイルシートを関連付けます.
| UITextField | ||
| textColor : uint
テキストの色です (16 進数形式).
| UITextField | ||
| textHeight : Number [read-only]
テキストの高さです (ピクセル単位).
| UITextField | ||
| textWidth : Number [read-only]
テキストの高さです (ピクセル単位).
| UITextField | ||
| thickness : Number
このテキスト内の文字エッジの太さです.
| UITextField | ||
| useRichTextClipboard : Boolean
テキストと共にテキストのフォーマットをコピー＆ペーストするか否かです.
| UITextField | ||
| value : String
この UI が示すテキスト文字列です.
| UITextField | ||
| wordWrap : Boolean
テキストを折り返すか否かです.
| UITextField | ||
| Method | Defined by | ||
|---|---|---|---|
|
UITextField(areaWidth:Number = 200, areaHeight:Number = 20, margin:Margin = null, pixelSnapped:Boolean = true, autoRendering:Boolean = true)
UITextField クラスは抽象クラスのため直接インスタンス化できません.
| UITextField | ||
|
appendText(newText:String):void
newText パラメータで指定された文字列を, テキストの最後に付加します.
| UITextField | ||
|
UI のプロパティ同士が同期するように設定します.
| UIBase | |
|
dispose():void
このオブジェクト内で使用されている全てのオブジェクトを開放します.
| UITextField | ||
|
getCharBoundaries(charIndex:int):Rectangle
charIndex パラメータで指定された文字の境界ボックスである矩形を返します.
| UITextField | ||
|
getCharIndexAtPoint(x:Number, y:Number):int
x および y パラメータで指定された点にある文字の, 0 から始まるインデックス値を返します.
| UITextField | ||
|
getFirstCharInParagraph(charIndex:int):int
指定したインデックスの文字と同じ段落内の最初の文字インデックス値を返します.
| UITextField | ||
|
getImageReference(id:String):DisplayObject
| UITextField | ||
|
getLineIndexAtPoint(x:Number, y:Number):int
x および y パラメータで指定された点にある行の 0 から始まるインデックス値を返します.
| UITextField | ||
|
getLineIndexOfChar(charIndex:int):int
charIndex パラメータで指定された文字を含む行の 0 から始まるインデックス値を返します.
| UITextField | ||
|
getLineLength(lineIndex:int):int
lineIndex パラメータで指定された行の文字数を返します.
| UITextField | ||
|
getLineMetrics(lineIndex:int):TextLineMetrics
lineIndex パラメータで指定された行に関するメトリック情報を返します.
| UITextField | ||
|
getLineOffset(lineIndex:int):int
lineIndex パラメータで指定された行の最初の 0 から始まる文字インデックス値を返します.
| UITextField | ||
|
getLineText(lineIndex:int):String
lineIndex パラメータで指定された行のテキストを返します.
| UITextField | ||
|
getParagraphLength(charIndex:int):int
charIndex パラメータで指定された文字を含む段落の長さを返します.
| UITextField | ||
|
getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
beginIndex パラメータと endIndex パラメータで指定された範囲のテキストのフォーマット情報を含む
TextFormat オブジェクトを返します.
| UITextField | ||
|
lock():void
update メソッドの呼び出しによる UI の更新処理をロックします.
| UIBase | |
|
render():void
レンダリング (パーツの再配置など) を行います.
| UITextField | ||
|
replaceSelectedText(value:String):void
現在の選択内容を value パラメータの内容に置き換えます.
| UITextField | ||
|
replaceText(beginIndex:int, endIndex:int, newText:String):void
beginIndex パラメータと endIndex パラメータで指定された範囲を,
newText パラメータの内容に置き換えます.
| UITextField | ||
|
setSelection(beginIndex:int, endIndex:int):void
最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します.
| UITextField | ||
|
setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
format パラメータで指定したテキストフォーマットを, 指定された範囲のテキストに適用します.
| UITextField | ||
|
UI のプロパティ同士の同期を解除します.
| UIBase | |
|
unlock():void
更新処理のロックを解除し, ロック中に更新されたプロパティがある場合は更新処理を行います.
| UIBase | |
|
update():void
各プロパティの情報を元に UI のエリア領域などを更新します.
| UIBase | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| 値が変更される前に送出される textInput イベントとは異なり, コントロールの値が変更された後に送出されます. | UITextField | |||
| HTML が有効になっているテキストフィールドのハイパーリンクをユーザーがクリックしたときに送出されます. | UITextField | |||
| ユーザーがスクロールした後に, TextField オブジェクトによって送出されます. | UITextField | |||
| ユーザーがテキストの文字を入力したときに送出されます. | UITextField | |||
| allSelected | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesallSelected:Boolean [read-write]テキストフィールドをクリックしてフォーカスが移った際, テキストを全選択するか否かです.
The default value is false.
public function get allSelected():Boolean
public function set allSelected(value:Boolean):void
| alwaysShowSelection | property |
alwaysShowSelection:Boolean [read-write]true に設定されフォーカスがない場合, テキスト内の選択内容は灰色でハイライト表示されます.
Implementation public function get alwaysShowSelection():Boolean
public function set alwaysShowSelection(value:Boolean):void
| antiAliasType | property |
antiAliasType:String [read-write]テキストに使用されるアンチエイリアス処理のタイプです.
Implementation public function get antiAliasType():String
public function set antiAliasType(value:String):void
| areaBounds | property |
areaBounds:Rectangle [read-only]各パラメータの計算結果が反映されたこの UI のエリア領域です.
Implementation public function get areaBounds():Rectangle
| areaHeight | property |
areaHeight:Number [read-write]この UI のエリア領域の高さを示す数値です. 範囲外の数値は丸め込まれます.
Implementation public function get areaHeight():Number
public function set areaHeight(value:Number):void
See also
| areaWidth | property |
areaWidth:Number [read-write]この UI のエリア領域の幅を示す数値です. 範囲外の数値は丸め込まれます.
Implementation public function get areaWidth():Number
public function set areaWidth(value:Number):void
See also
| bottomScrollV | property |
bottomScrollV:int [read-only]現在表示されている一番下の行を示す, 1 から始まるインデックス値です.
Implementation public function get bottomScrollV():int
| caretIndex | property |
caretIndex:int [read-only]カーソル (キャレット) 位置のインデックスです.
Implementation public function get caretIndex():int
| condenseWhite | property |
condenseWhite:Boolean [read-write]HTML テキストが含まれるテキストフィールド内の余分な空白 (スペース, 改行など) を削除するか否かです.
Implementation public function get condenseWhite():Boolean
public function set condenseWhite(value:Boolean):void
| defaultTextFormat | property |
defaultTextFormat:TextFormat [read-write]新しく挿入するテキスト (ユーザーが入力したテキストや replaceSelectedText メソッドで挿入したテキストなど) に適用するフォーマットを指定します.
Implementation public function get defaultTextFormat():TextFormat
public function set defaultTextFormat(value:TextFormat):void
| displayAsPassword | property |
displayAsPassword:Boolean [read-write]テキストをパスワードとして扱うか否かです.
Implementation public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
| editable | property |
editable:Boolean [read-write]テキストがユーザー入力により編集可能か否かです.
Implementation public function get editable():Boolean
public function set editable(value:Boolean):void
| embedFonts | property |
embedFonts:Boolean [read-write]埋め込みフォントのアウトラインを使用してレンダリングするか否かです.
Implementation public function get embedFonts():Boolean
public function set embedFonts(value:Boolean):void
| fieldBounds | property |
fieldBounds:Rectangle [read-only]各パラメータの計算結果が反映されたテキストフィールドのエリア領域です.
Implementation public function get fieldBounds():Rectangle
| gridFitType | property |
gridFitType:String [read-write]このテキストに使用されるグリッドフィッティングのタイプです.
Implementation public function get gridFitType():String
public function set gridFitType(value:String):void
| htmlText | property |
htmlText:String [read-write]テキストフィールドの内容を HTML で表します.
Implementation public function get htmlText():String
public function set htmlText(value:String):void
| imeMode | property |
imeMode:String [read-write]IME (入力メソッドエディタ) のモードを指定します.
IME を使用することによってユーザーは, 中国語・日本語・韓国語のテキストを入力できます. テキストにフォーカスが移った時に IME を指定されたモードに設定し, テキストにフォーカスが外れた時に IME を元のモードに設定します.
The default value is undefined.
public function get imeMode():String
public function set imeMode(value:String):void
|
See also
| length | property |
length:int [read-only]テキストの文字数です.
Implementation public function get length():int
| margin | property |
margin:Margin [read-write]テキストフィールドのマージンを設定するためのオブジェクトです.
Implementation public function get margin():Margin
public function set margin(value:Margin):void
| maxAreaHeight | property |
maxAreaHeight:Number [read-write]この UI のエリア領域の最大高を示す数値です. 最小値を下回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.
The default value is NaN.
public function get maxAreaHeight():Number
public function set maxAreaHeight(value:Number):void
See also
| maxAreaWidth | property |
maxAreaWidth:Number [read-write]この UI のエリア領域の最大幅を示す数値です. 最小値を下回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.
The default value is NaN.
public function get maxAreaWidth():Number
public function set maxAreaWidth(value:Number):void
See also
| maxChars | property |
maxChars:int [read-write]ユーザーが入力するときに, テキストに入る最大の文字数です.
Implementation public function get maxChars():int
public function set maxChars(value:int):void
| maxScrollH | property |
maxScrollH:int [read-only]scrollH の最大値です.
Implementation public function get maxScrollH():int
| maxScrollV | property |
maxScrollV:int [read-only]scrollV の最大値です.
Implementation public function get maxScrollV():int
| minAreaHeight | property |
minAreaHeight:Number [read-write]この UI のエリア領域の最小高を示す数値です. 最大値を上回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.
The default value is NaN.
public function get minAreaHeight():Number
public function set minAreaHeight(value:Number):void
See also
| minAreaWidth | property |
minAreaWidth:Number [read-write]この UI のエリア領域の最小幅を示す数値です. 最大値を上回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.
The default value is NaN.
public function get minAreaWidth():Number
public function set minAreaWidth(value:Number):void
See also
| mouseWheelEnabled | property |
mouseWheelEnabled:Boolean [read-write]複数行にわたるテキストでユーザーがホイールを回転させると, 自動的にスクロールするか否かです.
Implementation public function get mouseWheelEnabled():Boolean
public function set mouseWheelEnabled(value:Boolean):void
| multiline | property |
multiline:Boolean [read-write]テキストが複数行であるか否かです.
Implementation public function get multiline():Boolean
public function set multiline(value:Boolean):void
| numLines | property |
numLines:int [read-only]テキストの行数です.
Implementation public function get numLines():int
| restrict | property |
restrict:String [read-write]ユーザーがテキストに入力できる文字のセットを指定します.
Implementation public function get restrict():String
public function set restrict(value:String):void
| scrollH | property |
scrollH:int [read-write]現在の水平スクロール位置です.
Implementation public function get scrollH():int
public function set scrollH(value:int):void
| scrollV | property |
scrollV:int [read-write]現在の垂直スクロール位置です.
Implementation public function get scrollV():int
public function set scrollV(value:int):void
| selectionBeginIndex | property |
selectionBeginIndex:int [read-only]現在の選択範囲の最初の文字を示す, 0 から始まるインデックス値です.
Implementation public function get selectionBeginIndex():int
| selectionEndIndex | property |
selectionEndIndex:int [read-only]現在の選択範囲における最後の文字を示す, 0 から始まるインデックス値です.
Implementation public function get selectionEndIndex():int
| sharpness | property |
sharpness:Number [read-write]このテキスト内の文字エッジのシャープネスです.
Implementation public function get sharpness():Number
public function set sharpness(value:Number):void
| styleSheet | property |
styleSheet:StyleSheet [read-write]テキストにスタイルシートを関連付けます.
Implementation public function get styleSheet():StyleSheet
public function set styleSheet(value:StyleSheet):void
| textColor | property |
textColor:uint [read-write]テキストの色です (16 進数形式).
Implementation public function get textColor():uint
public function set textColor(value:uint):void
| textHeight | property |
textHeight:Number [read-only]テキストの高さです (ピクセル単位).
Implementation public function get textHeight():Number
| textWidth | property |
textWidth:Number [read-only]テキストの高さです (ピクセル単位).
Implementation public function get textWidth():Number
| thickness | property |
thickness:Number [read-write]このテキスト内の文字エッジの太さです.
Implementation public function get thickness():Number
public function set thickness(value:Number):void
| useRichTextClipboard | property |
useRichTextClipboard:Boolean [read-write]テキストと共にテキストのフォーマットをコピー＆ペーストするか否かです.
Implementation public function get useRichTextClipboard():Boolean
public function set useRichTextClipboard(value:Boolean):void
| value | property |
value:String [read-write]この UI が示すテキスト文字列です.
Implementation public function get value():String
public function set value(value:String):void
| wordWrap | property |
wordWrap:Boolean [read-write]テキストを折り返すか否かです.
Implementation public function get wordWrap():Boolean
public function set wordWrap(value:Boolean):void
| UITextField | () | constructor |
public function UITextField(areaWidth:Number = 200, areaHeight:Number = 20, margin:Margin = null, pixelSnapped:Boolean = true, autoRendering:Boolean = true)UITextField クラスは抽象クラスのため直接インスタンス化できません.
ParametersareaWidth:Number (default = 200) |
|
areaHeight:Number (default = 20) |
|
margin:Margin (default = null) |
|
pixelSnapped:Boolean (default = true) |
|
autoRendering:Boolean (default = true) |
| appendText | () | method |
public function appendText(newText:String):voidnewText パラメータで指定された文字列を, テキストの最後に付加します.
ParametersnewText:String — 付加する文字列です.
|
| dispose | () | method |
public override function dispose():voidこのオブジェクト内で使用されている全てのオブジェクトを開放します.
| getCharBoundaries | () | method |
public function getCharBoundaries(charIndex:int):RectanglecharIndex パラメータで指定された文字の境界ボックスである矩形を返します.
ParameterscharIndex:int — 文字の 0 から始まるインデックス値です.
|
Rectangle — charIndex パラメータで指定された文字の境界ボックスである矩形です.
|
| getCharIndexAtPoint | () | method |
public function getCharIndexAtPoint(x:Number, y:Number):intx および y パラメータで指定された点にある文字の, 0 から始まるインデックス値を返します.
Parametersx:Number — 文字の x 座標です.
|
|
y:Number — 文字の y 座標です.
|
int — 0 から始まる文字のインデックス値です.
|
| getFirstCharInParagraph | () | method |
public function getFirstCharInParagraph(charIndex:int):int指定したインデックスの文字と同じ段落内の最初の文字インデックス値を返します.
ParameterscharIndex:int — 文字の 0 から始まる文字のインデックス値です.
|
int — 0 から始まる文字のインデックス値です.
|
|
| getImageReference | () | method |
public function getImageReference(id:String):DisplayObject
タグを使用して HTML フォーマットのテキストフィールドに追加されたイメージ,
または SWF の中で, 指定された id 属性をもつ表示オブジェクトを返します.
id:String — <img> タグの id 属性値です.
|
DisplayObject — 一致する id 属性をもつ表示オブジェクトです.
|
| getLineIndexAtPoint | () | method |
public function getLineIndexAtPoint(x:Number, y:Number):intx および y パラメータで指定された点にある行の 0 から始まるインデックス値を返します.
Parametersx:Number — 行の x 座標です.
|
|
y:Number — 行の y 座標です.
|
int — 0 から始まる行のインデックス値です.
|
| getLineIndexOfChar | () | method |
public function getLineIndexOfChar(charIndex:int):intcharIndex パラメータで指定された文字を含む行の 0 から始まるインデックス値を返します.
ParameterscharIndex:int — 文字の 0 から始まる文字のインデックス値です.
|
int — 0 から始まる行のインデックス値です.
|
|
| getLineLength | () | method |
public function getLineLength(lineIndex:int):intlineIndex パラメータで指定された行の文字数を返します.
ParameterslineIndex:int — 0 から始まる行のインデックス値です.
|
int — lineIndex パラメータで指定された行の文字数です.
|
|
| getLineMetrics | () | method |
public function getLineMetrics(lineIndex:int):TextLineMetricslineIndex パラメータで指定された行に関するメトリック情報を返します.
ParameterslineIndex:int — 0 から始まる行のインデックス値です.
|
TextLineMetrics — lineIndex パラメータで指定された行に関するメトリック情報です.
|
|
See also
| getLineOffset | () | method |
public function getLineOffset(lineIndex:int):intlineIndex パラメータで指定された行の最初の 0 から始まる文字インデックス値を返します.
ParameterslineIndex:int — 0 から始まる行のインデックス値です.
|
int — lineIndex パラメータで指定された行の最初の 0 から始まる文字インデックス値です.
|
|
| getLineText | () | method |
public function getLineText(lineIndex:int):StringlineIndex パラメータで指定された行のテキストを返します.
ParameterslineIndex:int — 0 から始まる行のインデックス値です.
|
String — lineIndex パラメータで指定された行のテキストです.
|
|
| getParagraphLength | () | method |
public function getParagraphLength(charIndex:int):intcharIndex パラメータで指定された文字を含む段落の長さを返します.
ParameterscharIndex:int — 文字の 0 から始まる文字のインデックス値です.
|
int — charIndex パラメータで指定された文字を含む段落の長さです.
|
|
| getTextFormat | () | method |
public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormatbeginIndex パラメータと endIndex パラメータで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクトを返します.
ParametersbeginIndex:int (default = -1) |
|
endIndex:int (default = -1) |
TextFormat — 指定されたテキストのフォーマットプロパティを表す TextFormat オブジェクトです.
|
| render | () | method |
public override function render():voidレンダリング (パーツの再配置など) を行います.
本来はこのメソッドを明示的に呼び出す必要はありませんが, プロパティを操作しても表示がおかしい場合は明示的に呼び出します.
プロパティを操作しても表示がおかしいのは以下のような場合です.
| replaceSelectedText | () | method |
public function replaceSelectedText(value:String):void現在の選択内容を value パラメータの内容に置き換えます.
Parametersvalue:String — 現在選択されているテキストを置き換える文字列です.
|
| replaceText | () | method |
public function replaceText(beginIndex:int, endIndex:int, newText:String):voidbeginIndex パラメータと endIndex パラメータで指定された範囲を, newText パラメータの内容に置き換えます.
ParametersbeginIndex:int — テキスト範囲の開始位置を示すインデックス値です.
|
|
endIndex:int — テキスト範囲の終了位置を示すインデックス値です.
|
|
newText:String — 指定された範囲のテキストを置き換える文字列です.
|
| setSelection | () | method |
public function setSelection(beginIndex:int, endIndex:int):void最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します.
ParametersbeginIndex:int — テキスト範囲の開始位置を示すインデックス値です.
|
|
endIndex:int — テキスト範囲の終了位置を示すインデックス値です.
|
| setTextFormat | () | method |
public function setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):voidformat パラメータで指定したテキストフォーマットを, 指定された範囲のテキストに適用します.
Parametersformat:TextFormat — 文字と段落のフォーマット情報を含む TextFormat オブジェクトです.
|
|
beginIndex:int (default = -1) |
|
endIndex:int (default = -1) |
| change | event |
| link | event |
| scroll | event |
| textInput | event |