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()。然后，可以使用新的优先级再次注册该侦听器。

注册该侦听器后，如果继续调用具有不同 type 或 useCapture 值的 addEventListener()，则会创建单独的侦听器注册。例如，如果首先注册 useCapture 设置为 true 的侦听器，则该侦听器只在捕获阶段进行侦听。如果您使用同一个侦听器对象再次调用 addEventListener()，但 useCapture 设置为 false，则您将有两个单独的侦听器：一个在捕获阶段侦听，另一个在目标阶段和冒泡阶段侦听。

不能只为目标阶段或冒泡阶段注册事件侦听器。这些阶段在注册期间是成对出现的，因为冒泡阶段只适用于目标节点的祖代。

如果不再需要某个事件侦听器，可调用 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 对象调度。