TextInput  - AS3 Flex

HTML テキストの TextInput コントロールから余分な空白文字（スペースや改行など）を削除するかどうかを指定します。

condenseWhite プロパティは、htmlText プロパティで設定されたテキストにのみ影響し、text プロパティで設定されたテキストには影響しません。 text プロパティでテキストを設定した場合、condenseWhite は無視されます。

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

デフォルト値： false;。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 condenseWhiteChanged イベントが送出されます。

アイテムレンダラーまたはアイテムエディターでコンポーネントを使用するときに、そのコンポーネントに値を渡すことができます。 通常、データバインディングを使用して、data プロパティのフィールドをこのコンポーネントのプロパティにバインドします。

ドロップインアイテムレンダラーまたはドロップインアイテムエディターとしてコントロールを使用すると、アイテムの現在の値が、このコントロールの text プロパティに自動的に書き込まれます。

MXML でこのプロパティを設定することはありません。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 dataChange イベントが送出されます。

関連する API エレメント

このコントロールがパスワードの入力で使用されるかどうかを示します。 true の場合、入力されたテキストはフィールドには表示されません。代わりに、コントロールに入力された各テキストの文字は、文字「*」として表示されます。

デフォルト値： false。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 displayAsPasswordChanged イベントが送出されます。

このコントロール内のテキストをユーザーが編集できるかどうかを示します。 true の場合、ユーザーがテキストを編集できます。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 editableChanged イベントが送出されます。

コンポーネントがフォーカスを得たときに、IME を有効にするかどうかを指定するフラグです。

このコンポーネントのフォントコンテキストを提供するモジュールファクトリです。

現在表示されているコンテンツ領域の一番左にあるピクセルのピクセル位置です （コンテンツ領域には、現在表示されている部分だけではなく、コントロールのすべての内容が含まれます）。 このプロパティは常に 0 に設定されており、wordWrap が true に設定されている場合は変更も無視されます。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 horizontalScrollPositionChanged イベントが送出されます。

TextInput コントロールによって表示されるテキストを指定します。テキストのスタイルを表す HTML マークアップを含めて指定します。 このプロパティで HTML テキストを指定する場合は、Flash TextField コントロールでサポートされている HTML タグのサブセットを使用できます。

このプロパティを設定すると、TextInput インスタンスの CSS スタイルが適用された後で HTML マークアップが適用されます。このプロパティを取得すると、HTML マークアップに CSS スタイルが適用されます。

たとえば、このプロパティに「This is an example of <b>bold</b> markup」というストリングを設定すると、TextInput には、通常どおりに CSS スタイルが適用された 「This is an example of bold markup」というテキストが表示されます。 また、<b> のマークアップによって、「bold」という単語がボールド体のフォントで表示されます。

HTML マークアップでは、< や > などの文字を使用します。これらの文字は、XML では特別な意味を持っています（MXML でも同じです）。 したがって、次のようなコードはコンパイルされません。

      <mx:TextInput htmlText="This is an example of <b>bold</b> markup"/>
      

この問題を回避するには、3 つの方法があります。

• ActionScript メソッドの htmlText プロパティを設定します（ActionScript は、initialize ハンドラーとして呼び出されます）。

        <mx:TextInput id="myTextInput" initialize="myTextInput_initialize()"/>
        

  myTextInput_initialize メソッドは、次のようにスクリプトの CDATA セクションに記述します。

        <fx:Script>
        <![CDATA[
        private function myTextInput_initialize():void {
            myTextInput.htmlText = "This is an example of <b>bold</b> markup";
        }
        ]]>
        </fx:Script>
        
        

  マークアップの読みやすさが保たれるので、これが最も単純な方法です。 TextInput に id を割り当てて、initialize ハンドラーでそのラベルを参照できるようにする必要があります。

• CDATA セクションで子タグを使用して、htmlText プロパティを指定します。 XML の CDATA セクションには、< や > などの文字が特別な意味を持たない文字データが含まれます。

        <mx:TextInput>
            <mx:htmlText><![CDATA[This is an example of <b>bold</b> markup]]></mx:htmlText>
        <mx:TextInput/>
        

  htmlText プロパティは、<mx:TextInput> タグでは属性ではなく子タグとして記述する必要があります。これは、XML では属性の値に CDATA を使用できないためです。 マークアップは読み取れますが、CDATA セクションではこの方法は複雑になります。

• 属性値内の HTML マークアップ文字 < と > が書き込まれるところでは、hmtlText 属性を使用します。XML エンティティの < と > は使用しません。

        <mx:TextInput htmlText="This is an example of <b>bold</b> markup"/>
        

  HTML マークアップの読み取りがほとんど不可能になるので、この方法はお勧めしません。

condenseWhite プロパティが true の場合、htmlText プロパティが設定されていると、複数の空白文字は、HTML 対応ブラウザーと同じように圧縮されます。例えば、3 つの連続するスペースは、1 つのスペースとして表示されます。 condenseWhite の既定値は false なので、空白文字を圧縮するには condenseWhite を true に設定する必要があります。

htmlText プロパティの設定直後にそれを読み込んだ場合は、設定したものと同じストリングが取得されます。 ただし、LayoutManager の実行後には、値は変更され、CSS スタイルを含むマークアップが追加されます。

htmlText プロパティの設定は、様々な方法で text プロパティに影響を与えます。 text プロパティの読み込みをhtmlText プロパティの設定直後に行うと、null が取得されます。これは、text（新しい htmlText に対応）がまだ決定されていないことを示します。 ただし、LayoutManager を実行すると、text プロパティの値は、htmlText ストリングからすべての HTML マークアップが削除されたストリングに変更されます。つまり、TextInput に実際に表示される文字になります。

逆に、text プロパティを設定しても、すでに設定されている htmlText はどれも無関係です。 htmlText プロパティの読み込みを text プロパティの設定直後に行うと、null が取得されます。これは、htmlText（新しい text に対応）がまだ決定されていないことを示します。 ただし、LayoutManager を実行すると、htmlText プロパティの値は、新しいテキストに CSS スタイルの HTML マークアップが追加された値に変更されます。

LayoutManager を直ちに実行するには、TextInput に対して validateNow() メソッドを呼び出します。 例えば、何らかの htmlText を設定し、validateNow() メソッドを呼び出し、HTML マークアップを含まない、対応する text を直ちに取得できます。

ActionScript の中に text プロパティと htmlText プロパティの両方を設定した場合は、最後に設定されたプロパティが有効になります。 MXML では両方設定しないでください。これは、MXML ではインスタンスのプロパティの取得を特定の順序で設定することが保証されていないためです。

text プロパティまたは htmlText プロパティをループの中に設定すると処理が速くなります。これは、テキストを実際に表示する TextField が、LayoutManager が実行されるまでは更新されないためです。

このプロパティを null に設定しようとした場合は、代わりに空のストリングに設定されます。 このプロパティの値が一時的に null になった場合、text が設定されたばかりで、対応する htmlText がまだ認識されていないことを意味します。

デフォルト値： ""。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 htmlTextChanged イベントが送出されます。

関連する API エレメント

IME（入力メソッドエディター）のモードを指定します。IME を使用することによって、ユーザーは中国語、日本語、および韓国語のテキストを入力できます。Flex では、コントロールにフォーカスが置かれたときに、IME を指定されたモードに設定し、コントロールからフォーカスが離れたときに、元のモードに戻します。

このプロパティで有効な値の定数は、flash.system.IMEConversionMode クラスで定義されています。IME を指定しない場合は、null を指定します。

デフォルト値： null。

関連する API エレメント

TextArea に表示されるテキストの文字数です。

デフォルト値： 0。

ドロップインアイテムレンダラーまたはドロップインアイテムエディターとして使用すると、このコンポーネントの listData プロパティが、リストコントロールからの該当するデータで初期化されます。 その後、コンポーネントでこの listData プロパティを使用して、ドロップインアイテムレンダラーまたはドロップインアイテムエディターの data プロパティを初期化できます。

MXML および ActionScript でこのプロパティを設定することはありません。このコンポーネントがドロップインアイテムレンダラーまたはドロップインアイテムエディターとして使用されるときに、Flex でプロパティが設定されます。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 dataChange イベントが送出されます。

関連する API エレメント

テキストフィールドにユーザーが入力できる最大文字数です。 コントロールの text プロパティまたは htmlText プロパティの設定で指定するテキストの長さが、このプロパティによって制限されることはありません。

デフォルト値は 0 で、これは制限がないことを意味する特殊なケースです。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 maxCharsChanged イベントが送出されます。

true の場合、このコントロールの drawFocus() メソッドの呼び出しが親の drawFocus() メソッドに転送されます。TextInput が NumericStepper や ComboBox などの複合コントロールの一部である場合に使用されます。

ユーザーがコントロールに入力できる文字のセットを示します。 restrict プロパティの値が null である場合は、任意の文字を入力できます。restrict プロパティの値が空のストリングである場合は、いずれの文字も入力できません。このプロパティはユーザーの操作のみを制限します。スクリプトでテキストフィールドに入力するテキストは制限しません。 restrict プロパティの値が文字のストリングである場合は、そのストリング内の文字のみをテキストフィールドに入力できます。

ストリングは左から右へスキャンされます。 ハイフン（-）文字を使用して、範囲を指定できます。ストリングがキャレット（^）文字で始まる場合、そのストリングに含まれる文字を除いて、すべての文字を入力できます。ストリングがキャレット（^）文字以外で始まる場合は、そのストリングに含まれる文字のみを入力できます。

一部の文字は restrict プロパティで使用すると特殊な意味を持つため、リテラル文字の -、^ および ¥ を指定するには、円記号を使用する必要があります。 restrict プロパティを MXML タグで属性として使用する場合は、¥^¥-¥¥ のように、単一の円記号を使います。 restrict を ActionScript 式に設定する場合、¥¥^¥¥-¥¥¥ のように、円記号を 2 つ続けて指定します。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 restrictChanged イベントが送出されます。

TextInput 内のテキストが選択可能かどうかを示すフラグです。

現在の選択範囲の最後の文字の直後の位置を示す 0 ベースのインデックスです。つまり、最後の文字の位置を示す 1 ベースインデックスと同じです。 選択範囲の最後の文字が、例えば 5 番目の文字の場合、このプロパティの値は 5 になります。コントロールがフォーカスを取得したとき、selectionAnchorIndex プロパティと selectionActiveIndex プロパティが両方とも設定されていれば選択範囲が表示されます。

現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。例えば、最初の文字が 0、次の文字が 1 と続きます（以下同様）。コントロールがフォーカスを取得したとき、selectionAnchorIndex プロパティと selectionActiveIndex プロパティが両方とも設定されていれば選択範囲が表示されます。

現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。例えば、最初の文字が 0、次の文字が 1 と続きます（以下同様）。コントロールがフォーカスを取得したとき、selectionBeginIndex プロパティと selectionEndIndex プロパティが両方とも設定されている場合は選択範囲が表示されます。

デフォルト値： 0。

現在の選択範囲の最後の文字の直後の位置を示す 0 ベースのインデックスです。つまり、最後の文字の位置を示す 1 ベースインデックスと同じです。 選択範囲の最後の文字が、例えば 5 番目の文字の場合、このプロパティの値は 5 になります。コントロールがフォーカスを取得したとき、selectionBeginIndex プロパティと selectionEndIndex プロパティが両方とも設定されている場合は選択範囲が表示されます。

デフォルト値： 0。

コントロールに表示されるプレーンテキストです。その外観は、この Label コントロールの CSS スタイルによって決定されます。

テキストストリング内の HTML タグはすべて無視され、ストリングに入力したとおりに表示されます。 HTML タグを使用してフォーマットされたテキストを表示するには、htmlText プロパティを使用します。 htmlText プロパティを設定している場合は、その HTML で、設定されたテキストが置き換えられ、text プロパティは、HTML テキストから HTML タグを除いたプレーンテキストを返します。 詳細については、「htmlText プロパティ」を参照してください。

特殊文字である左山括弧（<）、右山括弧（>）、アンパサンド（&）をテキストに含める場合は、CDATA タグでテキストストリングを囲む必要があります。 特殊文字の代わりに、< などの HTML 文字エンティティを使用できます。

このプロパティを null に設定しようとした場合は、代わりに空のストリングに設定されます。 text プロパティには、値 null を一時的に設定できます。これは、htmlText が最近設定され、対応する text 値がまだ決定されていないことを示します。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 textChanged イベントが送出されます。

この TextInput のテキストを表示するための内部 UITextField です。

テキストの高さです。

textHeight プロパティの値は、コンポーネントが検証された後でのみ正しい値になります。 text を設定し、その直後に textHeight を取得した場合は、間違った値を受け取る可能性があります。 コンポーネントが検証されるまで待つか、値を取得する前に validateNow() メソッドを呼び出します。 この動作は、値を直ちに更新する flash.text.TextField コントロールの動作とは異なります。

関連する API エレメント