TextFlow  - AS3

この TextFlow オブジェクトの Configuration オブジェクトです。Configuration オブジェクトは、文字と段落の初期フォーマット、コンテナの初期フォーマット、および選択範囲のハイライト、リンク、フォーカスおよびスクロールの属性を指定します。

Configuration オブジェクトを指定しない場合、Text Layout Framework はデフォルトの Configuration オブジェクトを使用します。これは defaultConfiguration プロパティにより参照されます。

関連する API エレメント

構成が指定されていない場合にすべての新規 TextFlow オブジェクトに対して使用されるデフォルトの構成です。

関連する API エレメント

このエレメントのコンテナを管理します。

エレメントから作成された TextLine は、コンテナの子として表示されます。flowComposer はコンテナを管理し、テキストが編集されると、コンテナに行を追加したりコンテナから行を削除したりします。また、flowComposer は、構成したい幅と高さ、スクロールを有効にするかどうかなどのクリティカルな属性を追跡します。

コンテナと flowComposer は密接に関係します。flowComposer をリセットすると、コンテナはリセットされて、新しい flowComposer のコンテナになります。同様に、コンテナがリセットされると、flowComposer はリセットされてそのコンテナの新しい flowComposer になります。

関連する API エレメント

エレメントのスタイルを解決するためのコールバック関数です。これを使用して、例えば CSS や名前付きスタイルを使用したスタイルを指定できます。

関連する API エレメント

この TextFlow オブジェクトの世代番号です。取り消し操作およびやり直し操作では、世代番号を使用して、操作の取り消しまたはやり直しが適切かどうかが検証されます。世代番号が一致している必要があります。

モデルが変更されるたびに generation は増分されるため、世代番号の変更によってモデルが変更されたことを判別できます。

この TextFlow オブジェクトの TextLayoutFormat オブジェクトです。これにより、ホストフォーマットを再使用するためのいくつかの最適化が有効になります。次に例を示します。

        textFlowA.hostFormat = textFlowB.hostFormat
        

        format = new TextLayoutFormat()
        textFlow.hostFormat = format
        format.fontSize = 24;
        

関連する API エレメント

この TextFlow オブジェクトに関連付けられた InteractionManager です。

テキストに対するすべての選択と編集を制御します。TextFlow が選択可能でない場合、interactionManager は null になります。TextFlow を編集可能にするには、ISelectionManager と IEditManager の両方を意味する interactionManager を割り当てる必要があります。TextFlow を読み取り専用および選択可能にするには、ISelectionManager のみを意味する interactionManager を割り当てる必要があります。

関連する API エレメント

コンストラクター - 新しい TextFlow インスタンスを作成します。

config パラメーターを指定すると、Configuration オブジェクトのコンテンツがコピーされ、変更できなくなります。ただし、configuration プロパティを介して構成設定にアクセスすることはできます。config パラメーターが null の場合、defaultConfiguration プロパティを介してデフォルトの構成設定にアクセスできます。

Configuration オブジェクトは、TextFlow に関する構成可能なデフォルト属性の設定のメカニズムを提供します。Configuration オブジェクトを変更できない場合でも、必要に応じて TextFlow とその子の属性を設定することで、デフォルト属性をオーバーライドできます。

関連する API エレメント

イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。イベントリスナーは、特定のタイプのイベント、段階、および優先度に関する表示リスト内のすべてのノードに登録できます。

イベントリスナーが正常に登録された後に、addEventListener() をさらに呼び出して優先度を変更することはできません。リスナーの優先度を変更するには、最初に removeEventListener() を呼び出す必要があります。その後、同じリスナーを新しい優先度レベルで再度登録できます。

リスナーが登録された後に、addEventListener()（type または useCapture に別の値を設定）を再度呼び出すと、別のリスナー登録が作成されることに注意してください。例えば、最初にリスナーを登録するときに useCapture を true に設定すると、そのリスナーはキャプチャ段階のみでリスニングします。同じリスナーオブジェクトを使用して再度 addEventListener() を呼び出すと（このとき、useCapture に false を設定）、異なる 2 つのリスナーが登録されます。1 つはキャプチャ段階でリスニングするリスナーで、もう 1 つはターゲット段階とバブリング段階でリスニングするリスナーです。

ターゲット段階またはバブリング段階のみを対象とするイベントリスナーを登録することはできません。登録時にこれらの段階が組み合わされるのは、バブリングはターゲットノードの祖先にしか適用されないためです。

イベントリスナーが不要になった場合は、EventDispatcher.removeEventListener() を呼び出して、イベントリスナーを削除します。削除しない場合、メモリの問題が発生する可能性があります。ガベージコレクターは参照を有するオブジェクトを削除しないため、登録されているイベントリスナーに関係したオブジェクトはメモリから自動的に除去されません。

EventDispatcher インスタンスをコピーしても、それに関連付けられているイベントリスナーはコピーされません。新しく作成したノードにイベントリスナーが必要な場合は、ノードを作成した後に、リスナーを関連付ける必要があります。ただし、EventDispatcher インスタンスを移動した場合は、関連付けられているイベントリスナーも一緒に移動されます。

イベントがノードで処理されるときに、イベントリスナーがそのノードに登録中であれば、イベントリスナーは現在の段階ではトリガーされません。ただし、バブリング段階など、イベントフローの後の段階でトリガーすることができます。

イベントがノードで処理されているときにイベントリスナーがノードから削除された場合でも、イベントは現在のアクションによってトリガーされます。削除された後は、その後の処理で再び登録されない限り、イベントリスナーは二度と呼び出されません。

パラメーター

イベントをイベントフローに送出します。イベントターゲットは EventDispatcher オブジェクトです。これに対して dispatchEvent() が呼び出されます。

パラメーター

idName パラメーターに一致する id プロパティを持つエレメントを返します。id に基づくスタイルを適用する機能を提供します。

例えば、次の行は、id が span1 のエレメントのスタイル "color" を 0xFF0000（赤）に設定します。

         textFlow.getElementByID("span1").setStyle("color", 0xFF0000);
         

注意：次のコードでは、p.addChild(s) が元の親から s を削除し、それを p（新しい親）に追加しています。

         var s:SpanElement = new SpanElement();
         var p:ParagraphElement = new ParagraphElement();
         ...
         s = textFlow.getElementByID("span3") as SpanElement;
         p.addChild(s);
         textFlow.addChild(p);
         

パラメーター

関連する API エレメント

package flashx.textLayout.elements.examples {
    import flash.display.Sprite;
    
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class TextFlow_getElementByIDExample extends Sprite
    {
        public function TextFlow_getElementByIDExample()
        {    
            // create the TextFlow object
            var textFlow:TextFlow = new TextFlow();
            
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
            "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                "<flow:p>"+
                    "<flow:span id='span1'>In the first paragraph of the </flow:span>"+
                    "<flow:span id='span2' fontStyle=\"italic\">cheap </flow:span>"+
                    "<flow:span id='span3'>Western novel, a cowboy meets a saloon girl.</flow:span>"+
                "</flow:p>"+
            "</flow:TextFlow>";
            var s:SpanElement = new SpanElement();
            var s2:SpanElement = new SpanElement();
            var p:ParagraphElement = new ParagraphElement();
            // import the xml markup into a TextFlow object and display it on the stage
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // get element with ID of span3, make a copy of it
            textFlow.getElementByID("span3").setStyle("color", 0xFF0000); 
            textFlow.flowComposer.addController(new ContainerController(this, 200, 800));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

            
            

styleNameValue に設定されている styleName を持つすべてのエレメントを返します。

パラメーター

関連する API エレメント

typeNameValue に設定されている typeName を持つすべてのエレメントを返します。

パラメーター

関連する API エレメント

EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。これにより、EventDispatcher オブジェクトがイベントタイプの処理をイベントフロー階層のどこで変更したかを判断できます。特定のイベントタイプが実際にイベントリスナーをトリガーするかどうかを判別するには、IEventDispatcher.willTrigger() を使用します。

hasEventListener() と willTrigger() の違いは、hasEventListener() では自身が属するオブジェクトのみ検証され、willTrigger() では type パラメーターで指定されたイベントのイベントフロー全体が検証されることです。

パラメーター

TextFlow のすべてのフォーマット情報を無効化し、フォーマットの再計算を強制します。スタイルが変更された場合は、このメソッドを呼び出します。

関連する API エレメント

EventDispatcher オブジェクトからリスナーを削除します。対応するリスナーが EventDispatcher オブジェクトに登録されていない場合は、このメソッドを呼び出しても効果はありません。

パラメーター

指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。指定されたタイプのイベントがこの EventDispatcher オブジェクトまたはその子孫に送出されたときに、イベントリスナーがイベントフローの任意の段階でトリガーされる場合、このメソッドは true を返します。

hasEventListener() と willTrigger() の違いは、hasEventListener() では自身が属するオブジェクトのみ検証され、willTrigger() では type パラメーターで指定されたイベントのイベントフロー全体が検証されることです。

パラメーター

リンクがクリックされると送出されます。

再構成されるたびに送出されます。

TextFlow オブジェクトが損傷されるたびに、TextFlow オブジェクトにより送出されます。このイベントを使用すると、TextFlow が変更されたことが確認できます。ただし、このイベントを送信するときは、TextFlow 自体にはアクセスしないでください。このイベントは、TextFlow の変更が部分的に完了したときに送信されます。そのため、既に完了した変更もあれば、まだ保留中の変更もあるという一貫性のない状態が生じる場合があります。必要な情報をイベントから取得し、アプリケーションに制御が戻されたら、必要に応じて変更を行います。

この時点で（実行後に）操作を変更すると、失敗することがあります。

幅または高さが auto またはパーセントに指定されてグラフィックのロードが完了したために InlineGraphicElement のサイズが変更された場合に送出されます。

マウスボタンがリンク上で押されると送出されます。

マウスがリンクの上を通過すると送出されます。

マウスボタンがリンク上で離されると送出されます。

マウスがリンクの領域から離れると送出されます。

マウスがリンクの領域に入ると送出されます。

テキストがコントローラーコンテナ内でスクロールされると、TextFlow オブジェクトにより送出されます。

選択が変更されるたびに送出されます。主に選択依存ユーザーインターフェイスを更新するために使用されます。選択範囲の変更にも使用できますが、TextFlow 自体を変更する場合には使用できません。

コンテナに新規の DisplayObjects が追加されたり、構成の結果としてコンテナが更新されるたびに、TextFlow オブジェクトにより送出されます。