TextInput  - AS3 Flex

パッケージ	spark.components
クラス	public class TextInput
継承	TextInput SkinnableTextBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
サブクラス	DefaultStringTextInput, LabelEditor, MXFTETextInput

Spark テーマの TextInput スキンは RichEditableText クラスを使用します。つまり、Spark の TextInput コントロールは、Flash Text Engine（FTE）上に構築される Text Layout Framework（TLF）ライブラリをサポートしています。これらのレイヤーを組み合わせることにより、国際化対応の高品質な文字体裁とレイアウト機能を備えたテキスト編集が可能になります。

モバイルテーマの TextInput スキンは、RichEditableText ではなく StyleableStageText クラスを使用します。 StyleableStageText はネイティブテキストフィールドを使用するので、モバイルデバイス上のテキストの入力および操作がしやすくなりますが、考慮すべき制限および相違があります。 StageText が使用するネイティブテキストコントロールは、テキストの周りに様々なパディングを適用します。 垂直スクロールを回避するために、StageText ベースの TextInput スキンは、このパディングを予測して補正しようとします。 ネイティブテキストコントロールがテキストを処理する方法が、この点および他の点で異なるために、StageText ベースのスキンを使用した TextInput コントロールのデフォルトの高さは、TextField ベースの TextInput スキンを使用した場合のデフォルトの高さとは異なります。

text プロパティを使用すると、表示するテキストを設定したり、ユーザーが入力したテキストを取得したりできます。このプロパティは String なので、ユーザーが 123.45 のような数値を入力した場合は "123.45" として扱われます。

テキストのフォーマットは、fontFamily や fontSize などの CSS スタイルを使用して設定されます。

Spark テーマでは、widthInChars プロパティを使用してコントロールの幅を指定できます。この方法は、フォントサイズに応じて拡大 / 縮小する幅を指定するのに便利です。また、typicalText プロパティを使用することもできます。 typicalText を使用すると、widthInChars プロパティは無視されることに注意してください。 すべてのテーマで、幅をピクセル単位で明示的に指定したり、パーセントで指定したり、left や right などの制約を使用したりすることもできます。通常は高さを明示的に指定する必要はありません。コントロールのデフォルトの高さは、1 行のテキストを十分に表示できるように設定されています。

maxChars プロパティを使用して、ユーザーが入力できる文字数を制限したり、restrict を使用して、ユーザーが入力できる文字を制限したりすることもできます。パスワード入力用にこのコントロールを使用するには、displayAsPassword プロパティを true に設定します。

モバイルテーマの場合、ソフトキーボード固有のプロパティである、autoCapitalize、autoCorrect、returnKeyLabel および softKeyboardType プロパティでキーボードヒントを指定します。 ソフトキーボードは存在するが、ヒントで表される機能をサポートしない場合は、ヒントが無視されます。ハードウェアキーボードのみのモバイル環境では、これらのヒントが無視されます。

このコントロールは複数行のテキスト入力をサポートしないので、ユーザーが Enter キーを押すと、改行が挿入される代わりに、FlexEvent.ENTER イベントが送出されます。デフォルトでは、このコントロールには明示的な改行があります。

このコントロールはスキナブルコントロールで、デフォルトスキンには、Spark テーマの場合は RichEditableText インスタンスが含まれ、Mobile テーマの場合は StyleableStageText インスタンスが含まれます。 それがテキストの表示および編集を処理します。また、このスキンは境界線と背景の描画も処理します。この RichEditableText または StyleableStageText インスタンスには textDisplay オブジェクトとしてアクセスできます。モバイルテーマで StageText ベースのスキンではなく TextField ベースのスキンを使用する場合は、skinClass プロパティを「spark.skins.mobile.TextInputSkin」に設定します。

Spark テーマの場合、RichEditableText では TLF が使用されるので、Spark 版の TextInput コントロールではフランス語のように左から右（LTR）に読まれるテキスト、アラビア語のように右から左（RTL）に読まれるテキスト、またはフランス語のフレーズを含むアラビア語のように双方向から読まれるテキストを表示できます。 主に右から左へのテキストを使用する場合は、direction スタイルを rtl に設定します。textAlign スタイルのデフォルト設定は start です。この設定では、direction が ltr の場合にテキストが左揃えになり、direction が rtl の場合に右揃えになります。反対に整列するには、textAlign を end に設定します。

また、Spark の TextInput では TLF が使用されるので、1 回の編集セッション内で取り消し / やり直し操作を何度でも実行できます。編集セッションは、コントロールがキーボードフォーカスを取得したときに開始され、コントロールがフォーカスを失ったときに終了します。

List や DataGrid などのリストベースのコンポーネントでこのコンポーネントを使用するには、アイテムレンダラーを作成します。アイテムレンダラーの作成について詳しくは、「Custom Spark item renderers」を参照してください。

Spark テーマの場合、TextInput コントロールには、次のデフォルトの特性があります。

Mobile テーマの場合、TextInput コントロールには、次のデフォルトの特性があります。

MXML シンタックスを表示

MXML シンタックスを隠す

  <s:TextInput
    Properties
    widthInChars="Calculated default"  [applies to Spark theme]
  
    Events
    enter="No default"
  />
  

デフォルトの MXML プロパティtext

例を表示

さらに例を参照

関連する API エレメント