StandardFlowComposer  - AS3

True, if the flow composer is currently performing a composition operation.

The number of containers assigned to this IFlowComposer instance.

The root element associated with this IFlowComposer instance.

Only a TextFlow object can be a root element.

Creates a StandardFlowComposer object.

To use an StandardFlowComposer object, assign it to the flowComposer property of a TextFlow object. Call the updateAllControllers() method to lay out and display the text in the containers attached to the flow composer.

package flashx.textLayout.compose.examples
{
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.compose.StandardFlowComposer;

    public class StandardFlowComposer_constructor
    {
        public function createComposer(textFlow:TextFlow):void
        {
             textFlow.flowComposer = new StandardFlowComposer();
        }
    }
}

Adds a controller to this IFlowComposer instance.

The container is added to the end of the container list.

Parameters

package flashx.textLayout.compose.examples
{
    public class StandardFlowComposer_addController
    {
        import flash.display.Sprite;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.container.ContainerController;
        
        public function setupController(textFlow:TextFlow):void
        {
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            textFlow.flowComposer.addController( controller );
        }
    }
}

Adds a controller to this IFlowComposer instance at the specified index.

The list of controllers is 0-based (the first controller has an index of 0).

Parameters

package flashx.textLayout.compose.examples
{
    public class StandardFlowComposer_addControllerAt
    {
        import flash.display.Sprite;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.container.ContainerController;
        
        public function setupController(textFlow:TextFlow):void
        {
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            textFlow.flowComposer.addControllerAt( controller, 0 );
        }
    }
}

Calculates how many lines are necessary to display the content in the root element of the flow and the positions of these lines in the flow's display containers.

The compose() method only composes content if it has changed since the last composition operation. Results are saved so that subsequent calls to compose() or updateAllControllers() do not perform an additional recomposition if the flow content has not changed.

If the contents of any container have changed, the method returns true.

Related API Elements

package flashx.textLayout.compose.examples
{
    public class StandardFlowComposer_compose
    {
        import flashx.textLayout.elements.TextFlow;
        
        public function compose(textFlow:TextFlow):void
        {
            textFlow.flowComposer.compose();
        }
    }
}

Composes the content of the root element up to and including the container at the specified index.

If the contents of any container up to and including the container at the specified index has changed, the method returns true. If index is greater than the number of controllers (or not specified), then all containers are composed.

Parameters

package flashx.textLayout.compose.examples
{
    public class StandardFlowComposer_composeToController
    {
        import flashx.textLayout.elements.TextFlow;
        
        public function compose(textFlow:TextFlow):void
        {
            textFlow.flowComposer.composeToController( 3 );
        }
    }
}

Composes the content of the root element up to the specified position.

If the contents of any container up to and including the container holding the content at the specified position has changed, the method returns true. If absolutePosition is greater than the length of the TextFlow (or not specified), then the entire flow is composed.

Parameters

package flashx.textLayout.compose.examples
{
    public class StandardFlowComposer_composeToPosition
    {
        import flashx.textLayout.elements.TextFlow;
        
        public function compose(textFlow:TextFlow):void
        {
            textFlow.flowComposer.composeToPosition( 344 );
        }
    }
}

Returns the index of the controller containing the content at the specified position.

A position can be considered to be the division between two characters or other elements of a text flow. If the value in absolutePosition is a position between the last character of one container and the first character of the next, then the preceding container is returned if the preferPrevious parameter is set to true and the later container is returned if the preferPrevious parameter is set to false.

The method returns -1 if the content at the specified position is not in any container or is outside the range of positions in the text flow.

Parameters

package flashx.textLayout.compose.examples
{
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.compose.StandardFlowComposer;
    
    public class StandardFlowComposer_findControllerIndexAtPosition
    {
        public function findControllerIndexAtPosition(textFlow:TextFlow):void
        {
            var index:int = textFlow.flowComposer.findControllerIndexAtPosition( 344 );
        }
    }
}

Returns the absolute position of the first content element in the specified ContainerController object.

A position is calculated by counting the division between two characters or other elements of a text flow. The position preceding the first element of a flow is zero. An absolute position is the position counting from the beginning of the flow.

Parameters

Returns the ContainerController object at the specified index.

Parameters

package flashx.textLayout.compose.examples
{
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.container.ContainerController;
    
    public class StandardFlowComposer_getControllerAt
    {
        public function findControllerIndexAtPosition(textFlow:TextFlow):void
        {
            var controller:ContainerController =  textFlow.flowComposer.getControllerAt( 0 );
        }
    }
}

Returns the index of the specified ContainerController object.

Parameters

package flashx.textLayout.compose.examples
{
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.container.ContainerController;
    
    public class StandardFlowComposer_getControllerIndex
    {
        public function getControllerIndex(textFlow:TextFlow, controller:ContainerController):void
        {
            var index:int =  textFlow.flowComposer.getControllerIndex( controller );
        }
    }
}

Called by the TextFlow when the interaction manager changes.

This function is called automatically. Your code does not typically need to call this method. Classes that extend StandardFlowComposer can override this method to update event listeners and other properties that depend on the interaction manager.

Parameters

Returns true if composition is necessary, false otherwise

Removes all controllers from this IFlowComposer instance.

Removes a controller from this IFlowComposer instance.

Parameters

Removes the controller at the specified index from this IFlowComposer instance.

Parameters

Sets the focus to the container that contains the location specified by the absolutePosition parameter.

The StandardFlowComposer calls the setFocus() method of the ContainerController object containing the specified text flow position.

Parameters

Related API Elements

Parameters

Composes the content of the root element and updates the display.

Text layout is conducted in two phases: composition and display. In the composition phase, the flow composer calculates how many lines are necessary to display the content as well as the position of these lines in the flow's display containers. In the display phase, the flow composer updates the display object children of its containers. The updateAllControllers() method initiates both phases in sequence. The StandardFlowComposer keeps track of changes to content so that a full cycle of composition and display is only performed when necessary.

This method updates all the text lines and the display list immediately and synchronously.

If the contents of any container is changed, the method returns true.

Composes and updates the display up to and including the container at the specified index.

The updateToController() method composes the content and updates the display of all containers up to and including the container at the specified index. For example, if you have a chain of 20 containers and specify an index of 10, updateToController() ensures that the first through the tenth (indexes 0-9) containers are composed and displayed. Composition stops at that point. If controllerIndex is -1 (or not specified), then all containers are updated.

This method updates all the text lines and the display list immediately and synchronously.

If the contents of any container is changed, the method returns true.

Parameters