The Configuration object for this TextFlow object. The Configuration object specifies the initial character and paragraph formats, the initial container format, and attributes for selection highlighting, links, focus, and scrolling.

If you do not specify a Configuration object, Text Layout Framework uses a default Configuration object, which is referenced by the defaultConfiguration property.

See also

Default configuration to be used for all new TextFlow objects if the configuration is not specified.

Manages the containers for this element.

The TextLines that are created from the element appear as children of the container. The flowComposer manages the containers, and as the text is edited it adds lines to and removes lines from the containers. The flowComposer also keeps track of some critical attributes, such as the width and height to compose to, whether scrolling is on, and so on.

The container and flowComposer are closely related. If you reset flowComposer , the container is reset to the new flowComposer's container. Likewise if the container is reset, flowComposer is reset to the container's new flowComposer.

See also

The generation number for this TextFlow object. The undo and redo operations use the generation number to validate that it's legal to undo or redo an operation. The generation numbers must match.

Each model change increments generation so if the generation number changes, you know the TextFlow model has changed.

The host character format for this TextFlow object.

See also

The host container format for this TextFlow object.

See also

The host paragraph format for this TextFlow object.

See also

The InteractionManager associated with this TextFlow object.

Controls all selection and editing on the text. If the TextFlow is not selectable, the interactionManager is null. To make the TextFlow editable, assign a interactionManager that is both an ISelectionManager and an IEditManager. To make a TextFlow that is read-only and allows selection, assign a interactionManager that is an ISelectionManager only.

See also

Constructor - creates a new TextFlow instance.

If you provide a config parameter, the contents of the Configuration object are copied and you cannot make changes. You can access configuration settings, however, through the configuration property. If the config parameter is null, you can access the default configuration settings through the defaultConfiguration property.

The Configuration object provides a mechanism for setting configurable default attributes on a TextFlow. While you can't make changes to the Configuration object, you can override default attributes, if necessary, by setting the attributes of TextFlow and its children.

See also

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener() . To change a listener's priority, you must first call removeEventListener() . Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true , it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false , you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener() ; otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger() .

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

Dispatched when any link is clicked.

Dispatched after every recompose.

Changing an operation at this time (after it has been executed) may fail.

Dispatched when a InlineGraphicElement is resized due to having width or height as auto or percent and the graphic has finished loading.

Dispatched when the mouse is pressed down over any link.

Dispatched when the mouse passes over any link.

Dispatched when the mouse is released over any link.

Dispatched when the mouse goes out of any link.

Dispatched when the mouse first enters any link.

Dispatched by a TextFlow object after text is scrolled within a controller container.

Dispatched whenever the selection is changed. Primarily used to update selection dependent UI.

Dispatched whenever the UndoManager has been called to change its stack of operations.

1. Add TextLayout to the library.
2. Save this code as TextFlowExample.as in the same directory as your FLA.
3. Set the Class in the Properties window of the FLA to TextFlowExample.

package {
    import flash.display.Sprite;
    
    import flashx.textLayout.container.DisplayObjectContainerController;
    import flashx.textLayout.container.IContainerController;
    import flashx.textLayout.elements.Configuration;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.CharacterFormat;
    import flashx.textLayout.formats.ParagraphFormat;
    import flashx.textLayout.formats.JustificationRule;
    import flashx.textLayout.formats.TextAlign;
    import flash.text.engine.FontPosture;
    import flash.text.engine.Kerning;


    public class TextFlowExample extends Sprite
    {
        public function TextFlowExample()
        {
            var config:Configuration = new Configuration();
            var charFormat:CharacterFormat = new CharacterFormat();
            var paraFormat:ParagraphFormat = new ParagraphFormat();
            charFormat.color = 0xFF0000;
            charFormat.fontFamily = "Arial, Helvetica, _sans";
            charFormat.fontSize = 48;
            charFormat.kerning = Kerning.ON;
            charFormat.fontStyle = FontPosture.ITALIC;
            paraFormat.textAlign = TextAlign.CENTER;
            config.textFlowInitialCharacterFormat = charFormat;
            config.textFlowInitialParagraphFormat = paraFormat;
            var textFlow:TextFlow = new TextFlow(config);

            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            span.text = "Hello, World!";
            p.addChild(span);
            textFlow.addChild(p);

            textFlow.flowComposer.addController(new DisplayObjectContainerController(this,500,200));
            textFlow.flowComposer.updateAllContainers(); 
        }
    }
}