RichEditableText  - AS3 Flex

パッケージ	spark.components
クラス	public class RichEditableText
継承	RichEditableText UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
実装	IFocusManagerComponent, IIMESupport, ISystemCursorClient, IViewport, IEditableText

mobileDevice プロファイルを使用するアプリケーションでこのコンポーネントを使用することは推奨されません。

リッチテキストには、クリック可能なハイパーリンク、埋め込み式のインライングラフィック、他の URL からロードされるグラフィックなどが含まれている場合があります。

RichEditableText にはスクロールバーはありませんが、プログラムを通じてスクロールするための IViewport インターフェイスが実装されているので、スクロールバーを表示できる Scroller で制御できます。また、マウスホイールを使用した垂直スクロールもサポートされています。

テキストのフォーマットを変更するためのユーザーインターフェイスはありません。ただし、プログラムを通じて変更を行うための API が用意されています。これらの API を使用すると、選択範囲を太字に変更する太字ボタンなどを作成することができます。

このクラスは、Spark 版の TextInput と TextArea のスキンで使用されます。TextInput ではリッチテキストを処理する機能は公開されていませんが、TextArea では公開されています。デフォルトでは、RichEditableText の背景は透明で、境界線の描画はサポートされていません。

RichEditableText では、Text Layout Framework（TLF）ライブラリが使用されます。このライブラリは、Flash Player 10 の新しい Flash Text Engine（FTE）をベースとして作成されています。これらのレイヤーを組み合わせることにより、国際化対応の高品質な文字体裁とレイアウト機能を備えたテキスト編集が可能になります。

Spark アーキテクチャには 3 つのテキストプリミティブ（Label、RichText および RichEditableText）が用意されています。Label は TLF を使用せず FTE のみを使用するので、最も高速で軽いですが、機能は限られており、リッチテキスト、スクロール、選択、編集はサポートされません。RichText には、複雑なレイアウト設定を含むリッチテキストを表示する機能が追加されていますが、インタラクティブ機能はサポートされません。RichEditableText は最も重いですが、TLF で実行できるほとんどの機能がサポートされます。通常は、ニーズに合わせて最も高速なテキストプリミティブを使用します。

RichEditableText は、MX コンポーネントで使用される UITextField クラスに似ています。このクラスでは FTE および TLF は使用されず、古い TextField クラスが拡張されています。

UITextField と RichEditableText の最も重要な違いは、次のとおりです。

• RichEditableText では、文字体裁、国際言語のサポート、およびテキストレイアウトの機能が向上しています。
• RichEditableText には、リッチテキストのオブジェクト指向モデルがありますが、UITextField にはありません。
• RichEditableText では、大量のテキストを表示する機能を強化されています。
• RichEditableText では、UITextField とは異なる方法でフォントを埋め込む必要があります。フォントを埋め込む際に embedAsCFF 属性の使用する方法について詳しくは、マニュアルを参照してください。

RichEditableText では、リッチテキストの TLF オブジェクト指向モデルが使用されます。このモデルでは、区分、段落、スパン、ハイパーリンク、画像などのテキストレイアウト要素が ActionScript オブジェクトによって実行時に表現されます。これらのオブジェクトは、プログラムを通じてアクセスして操作できます。リッチテキストを表す TLF の中心的なオブジェクトは TextFlow です。そのため、RichEditableText コントロールに対してリッチテキストを指定するには、RichEditableText の textFlow プロパティを TextFlow インスタンスに設定します。TLF マークアップをインポートするなどの方法で TextFlow を作成する方法については、textFlow プロパティの説明を参照してください。複数のフォーマットが混在するテキストを表示する必要がない場合は、text プロパティを使用して「plain text」という String を設定します。text プロパティと textFlow プロパティの相互作用（例えば、一方を設定して他方を取得する方法など）について詳しくは、各プロパティの説明を参照してください。

次の例に示すように、コンパイル時に、TLF マークアップタグを RichEditableText タグ内に配置できます。

      <s:RichEditableText>Hello <s:span fontWeight="bold">World!</s:span></s:RichEditableText>
      

デフォルトのテキストフォーマットは、fontFamily や fontSize などの CSS スタイルによって決定されます。TextFlow でフォーマット情報が指定されている場合は、CSS スタイルで指定されているデフォルトのフォーマットがオーバーライドされます。

行の間隔は lineHeight スタイルで制御でき、段落の間隔は paragraphSpaceBefore スタイルと paragraphSpaceAfter スタイルで制御できます。テキストの整列や均等割り付けには、textAlign スタイルと textAlignLast スタイルを使用できます。コンポーネントの端からテキストまでのインセットを指定するには、paddingLeft、paddingTop、paddingRight および paddingBottom スタイルを使用します。

デフォルトでは、RichEditableText のサイズは自動的に設定されます。テキストがない場合は非常に小さなサイズから始まり、テキストが入力されるにつれて maxWidth の値まで幅が広がります。Enter キーを押して改行が挿入されると高さが増大します。

widthInChars プロパティおよび heightInLines プロパティを使用すると、フォントサイズに応じて伸縮する方式で幅と高さを指定できるので便利です。 typicalText プロパティも使用できます。 typicalText を使用する場合、widthInChars および heightInLines は無視されることに注意してください。 また、幅や高さを明示的にピクセル単位で指定したり、パーセントで指定したり、left と right や top と bottom などの制約を使用することもできます。

明示的な値、パーセント、maxWidth、または left および right 制約を使用して幅を指定すると、コンポーネントの右端でテキストが折り返され、表示領域にテキストが収まりきらない場合は、テキストの垂直スクロールが可能になります。lineBreak スタイルを explicit に設定した場合は、CR（¥r）、LF（¥n）または CR+LF（¥r¥n）を text で使用する場合や、<p> と <br/> を TLF マークアップで使用する場合と同様に、明示的に改行が指定されている位置でのみ行が折り返されます。この場合、コントロールの幅を超える行があるときは、テキストの水平スクロールが可能になります。

maxChars プロパティを使用して、ユーザーが入力できる文字数を制限したり、restrict を使用して、ユーザーが入力できる文字を制限したりすることもできます。

multiline プロパティは、Enter キーを押したときの動作を決定します。true の場合、Enter キーを押すと新しい段落が始まります。false の場合、FlexEvent.ENTER イベントが送出されます。

テキストの編集を許可しない場合は、editable プロパティを false に設定します。テキストの選択も許可しない場合は、selectable プロパティを false に設定します。

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

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

RichEditableText は TLF の TextContainerManager クラスを使用して、テキストの表示、スクロール、選択、編集およびコンテキストメニューを処理します。

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

MXML シンタックスを表示

MXML シンタックスを隠す

      <s:RichEditableText
        Properties
        clipAndEnableScrolling="false|true"
        contentHeight="Calculated default"
        contentWidth="Calculated default"
        displayAsPassword="false"
        editable="true"
        heightInLines="NaN"
        horizontalScrollPosition="0"
        imeMode="null"
        maxChars="0"
        multiline="true"
        restrict="null"
        selectable="true"
        selectionActivePosition="-1"
        selectionAnchorPosition="-1"
        selectionHighlighting="TextSelectionHighlighting.WHEN_FOCUSED"
        text=""
        textFlow="TextFlow"
        typicalText=null
        verticalScrollPosition="0"
        widthInChars="NaN"
      
        Events
        change="No default"
        changing="No default"
        enter="No default"
        selectionChange="No default"
      />
      

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

例を表示

さらに例を参照

関連する API エレメント