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 模型已變更。

此 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 來註冊偵聽程式，則只會在捕捉階段進行偵聽。 如果您使用相同的偵聽程式物件 (但將 useCapture 設為 false) 再次呼叫 addEventListener()，會得到兩個不同的偵聽程式： 一個會在捕捉階段進行偵聽，另一個則會在目標與反昇階段進行偵聽。

您無法單獨針對目標階段或反昇階段註冊事件偵聽程式。 由於反昇階段只適用於目標節點的祖系，因此這兩種階段必須一起進行註冊。

當您不再需要事件偵聽程式，可以呼叫 EventDispatcher.removeEventListener() 來移除它，否則可能產生記憶體問題。 含有已註冊之事件偵聽程式的物件不會自動從記憶體中移除，因為垃圾回收器不會將仍保有參照的物件移除。

複製 EventDispatcher 實體並不會將附加在該實體上的事件偵聽程式一併複製 (如果新建立的節點需要事件偵聽程式，則您必須在建立節點後再附加偵聽程式)。 然而，如果您移動了 EventDispatcher 實體，則附加的事件偵聽程式也會跟著移動。

若於此節點正在處理事件的同時將事件偵聽程式註冊到某個節點上，則事件偵聽程式不會在目前階段觸發，但會在事件流程的後續階段 (例如反昇階段) 中觸發。

如果您在節點正在處理事件的同時將事件偵聽程式從節點中移除，則事件偵聽程式還是會被目前的動作觸發。 一旦移除了事件偵聽程式，就無法再叫用它 (除非您為了日後的處理而再次註冊它)。

參數

會將事件傳送到事件流程。事件目標就是呼叫 dispatchEvent() 時所需的 EventDispatcher 物件。

參數

傳回 id 屬性符合 idName 參數的元素。可根據 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();
        }
    }
}

            
            

傳回 styleName 設為 styleNameValue 的所有元素。

參數

相關 API 元素

傳回 typeName 設為 typeNameValue 的所有元素。

參數

相關 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 變更局部完成時，即會送出此事件，因此事件可能會處於不一致的狀態：部分變更已完成，而其他變更仍處於擱置狀態。從事件中取得需要的資訊，並在控制權傳回您的應用程式之後進行必要變更。

在此時 (執行作業之後) 變更作業可能失敗。

因寬度或高度的 auto 或百分比設定而調整 InlineGraphicElement 的大小時，在圖形完成載入後發送。

在任何連結按下滑鼠時發送。

在滑鼠滑過任何連結時發送。

在任何連結上放開滑鼠時發送。

當滑鼠移出任何連結時發出。

當滑鼠第一次進入任何連結時發送。

在控制器容器內捲動文字之後，由 TextFlow 物件發送。

只要選取範圍變更就發送。主要用於更新與選取範圍有關的使用者介面。它也可用來變更選取範圍，但不能用來變更 TextFlow 本身。

每次容器因撰寫而新增或更新 DisplayObject 時，由 TextFlow 物件發送。