| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="StandardFlowComposer,flashx.textLayout.compose.StandardFlowComposer,FIRST,GEOMETRY,INVALID,LAST,MIDDLE,ONLY,_accumulatedMinimumStart,_ascent,_atColumnStart,_blockProgression,_contentCommittedExtent,_contentCommittedHeight,_contentLogicalExtent,_controllerVisibleBoundsHeightTW,_controllerVisibleBoundsWidthTW,_controllerVisibleBoundsXTW,_controllerVisibleBoundsYTW,_curElement,_curElementOffset,_curElementStart,_curInteractiveObjects,_curLineStart,_curLine,_curParaElement,_curParaFormat,_curParaStart,_curParcel,_curParcelStart,_descent,_floatSlug,_flowComposer,_forceILGs,_lastGoodStart,_lastLineDescent,_lastLineLeading,_lastLineLeadingModel,_lineOffset,_linePass,_lineSlug,_listItemElement,_measuring,_paragraphContainsVisibleLines,_paragraphSpaceCarried,_parcelBottom,_parcelLeft,_parcelList,_parcelLogicalTop,_parcelRight,_parcelTop,_previousLine,_pushInFloats,_rootElement,_savedLineSlug,_startComposePosition,_startController,_stopComposePos,_textFlow,_textIndent,_verticalSpaceCarried,_workingContentExtent,_workingContentHeight,_workingContentLogicalExtent,_workingParcelIndex,_workingParcelLogicalTop,_workingTotalDepth,absoluteStart,ascent,ascent,blockIndex,columnIndex,composing,composing,container,controller,damageAbsoluteStart,damageAbsoluteStart,descent,descent,globalSWFContext,height,height,height,lineOffset,location,numControllers,numControllers,numLines,numLines,paragraph,parcelList,parentTable,releaseLineCreationData,rootElement,rootElement,spaceAfter,spaceBefore,startController,swfContext,swfContext,swfContext,textFlow,textHeight,textHeight,textLength,textLineExists,textLineRecyclerEnabled,unjustifiedTextWidth,validity,width,x,x,x,y,y,y,addCell,addController,addController,addControllerAt,addControllerAt,addLineForReuse,advanceToNextContainer,advanceToNextParcel,applyVerticalAlignmentToColumn,calculateLeadingParameters,callInContext,clear,clearCells,commitLastLineState,compose,compose,composeFloat,composeInlineGraphicElement,composeInternal,composeNextLine,composeParagraphElementIntoLines,composeTextFlow,composeToController,composeToController,composeToPosition,composeToPosition,createParcelList,damage,damage,doVerticalAlignment,drawBackground,endLine,endTableBlock,finalParcelAdjustment,findControllerIndexAtPosition,findControllerIndexAtPosition,findLineAtPosition,findLineAtPosition,findLineIndexAtPosition,findLineIndexAtPosition,finishComposeLine,finishController,finishParcel,fitLineToParcel,getAbsoluteStart,getBounds,getCellsInRange,getControllerAt,getControllerAt,getControllerIndex,getControllerIndex,getFirstIndentCharPos,getLineAt,getLineAt,getLineForReuse,getTableCells,getTextLine,hiliteBlockSelection,initialize,initializeForComposer,interactionManagerChanged,interactionManagerChanged,isDamaged,isDamaged,isLineVisible,oldTestLineVisible,parcelHasChanged,popInsideListItemMargins,preCompose,preProcessILGs,processFloatsAtLineEnd,processFloatsAtLineStart,processInlinesAtLineEnd,pushInsideListItemMargins,releaseParcelList,removeAllControllers,removeAllControllers,removeController,removeController,removeControllerAt,removeControllerAt,resetLine,setController,setFocus,setFocus,setRootElement,setRootElement,startLine,updateAllControllers,updateAllControllers,updateCompositionShapes,updateLengths,updateLengths,updateToController,updateToController"><title>flashx.textLayout.compose.StandardFlowComposer</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'StandardFlowComposer - ApacheFlex API Reference'; |
| var baseRef = '../../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.14.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a> | <a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a> | <a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a> | <a id="framesLink1" href="../../../index.html?flashx/textLayout/compose/StandardFlowComposer.html&flashx/textLayout/compose/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">StandardFlowComposer</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("StandardFlowComposer"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">flashx.textLayout.compose</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class StandardFlowComposer</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">StandardFlowComposer <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a> <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../flashx/textLayout/compose/IFlowComposer.html">IFlowComposer</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p></p><p></p> |
| The StandardFlowComposer class provides a standard composer and container manager. |
| <p>Each call to <code>compose()</code> or <code>updateAllControllers()</code> normalizes the text flow as a first step. |
| The normalizing process checks the parts of the TextFlow object that were modified and takes the following steps: |
| <ol> |
| <li> Deletes empty FlowLeafElement and SubParagraphGroupElement objects.</li> |
| <li> Merges sibling spans that have identical attributes.</li> |
| <li> Adds an empty paragraph if a flow is empty.</li> |
| </ol> |
| </p> |
| <p>To use a StandardFlowComposer, assign it to the |
| <code>flowComposer</code> property of a TextFlow object. Call the <code>updateAllControllers()</code> |
| method to lay out and display the text in the containers attached to the flow composer.</p> |
| |
| <p> |
| <b>Note:</b> For simple, static text flows, you can also use the one of the text line factory classes. |
| These factory classes will typically create lines with less overhead than a flow composer, but do not |
| support editing, dynamic changes, or user interaction.</p> |
| |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/TextFlow.html#flowComposer" target="">flashx.textLayout.elements.TextFlow.flowComposer</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#composing" class="signatureLink">composing</a> : Boolean<div class="summaryTableDescription">[read-only] |
| True, if the flow composer is currently performing a composition operation.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#damageAbsoluteStart" class="signatureLink">damageAbsoluteStart</a> : int<div class="summaryTableDescription">[read-only] |
| The absolute position immediately preceding the first element in the text |
| flow that requires composition and updating.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#numControllers" class="signatureLink">numControllers</a> : int<div class="summaryTableDescription">[read-only] |
| The number of containers assigned to this IFlowComposer instance.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#numLines" class="signatureLink">numLines</a> : int<div class="summaryTableDescription">[read-only] |
| The total number of lines composed in the flow.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rootElement" class="signatureLink">rootElement</a> : <a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a><div class="summaryTableDescription">[read-only] |
| The root element associated with this IFlowComposer instance.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#swfContext" class="signatureLink">swfContext</a> : <a href="../../../flashx/textLayout/compose/ISWFContext.html">ISWFContext</a><div class="summaryTableDescription"> |
| The ISWFContext instance used to make FTE calls as needed.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#textFlow" class="signatureLink">textFlow</a> : <a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</a><div class="summaryTableDescription">[read-only] |
| The TextFlow object to which this flow composer is attached.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#StandardFlowComposer()" class="signatureLink">StandardFlowComposer</a>()</div><div class="summaryTableDescription"> |
| Creates a StandardFlowComposer object.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addController()" class="signatureLink">addController</a>(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):void</div><div class="summaryTableDescription"> |
| Adds a controller to this IFlowComposer instance.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addControllerAt()" class="signatureLink">addControllerAt</a>(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>, index:int):void</div><div class="summaryTableDescription"> |
| Adds a controller to this IFlowComposer instance at the specified index.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#compose()" class="signatureLink">compose</a>():Boolean</div><div class="summaryTableDescription"> |
| 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.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#composeToController()" class="signatureLink">composeToController</a>(index:int):Boolean</div><div class="summaryTableDescription"> |
| Composes the content of the root element up to and including the container at the specified index.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#composeToPosition()" class="signatureLink">composeToPosition</a>(absolutePosition:int):Boolean</div><div class="summaryTableDescription"> |
| Composes the content of the root element up to the specified position.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#damage()" class="signatureLink">damage</a>(startPosition:int, damageLength:int, damageType:String):void</div><div class="summaryTableDescription"> Mark lines as damaged and needing a recompose.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#findControllerIndexAtPosition()" class="signatureLink">findControllerIndexAtPosition</a>(absolutePosition:int, preferPrevious:Boolean = false):int</div><div class="summaryTableDescription"> |
| Returns the index of the controller containing the content at the specified position.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#findLineAtPosition()" class="signatureLink">findLineAtPosition</a>(absolutePosition:int, preferPrevious:Boolean = false):<a href="../../../flashx/textLayout/compose/TextFlowLine.html">TextFlowLine</a></div><div class="summaryTableDescription"> |
| Returns the TextFlowLine object containing the content at the specified position.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#findLineIndexAtPosition()" class="signatureLink">findLineIndexAtPosition</a>(absolutePosition:int, preferPrevious:Boolean = false):int</div><div class="summaryTableDescription"> |
| Returns the sequential line number of the TextFlowLine object that contains the content at the specified position.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getAbsoluteStart()" class="signatureLink">getAbsoluteStart</a>(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):int</div><div class="summaryTableDescription"> |
| Returns the absolute position of the first content element in the specified ContainerController object.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getControllerAt()" class="signatureLink">getControllerAt</a>(index:int):<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></div><div class="summaryTableDescription"> |
| Returns the ContainerController object at the specified index.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getControllerIndex()" class="signatureLink">getControllerIndex</a>(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):int</div><div class="summaryTableDescription"> |
| Returns the index of the specified ContainerController object.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#getLineAt()" class="signatureLink">getLineAt</a>(index:int):<a href="../../../flashx/textLayout/compose/TextFlowLine.html">TextFlowLine</a></div><div class="summaryTableDescription"> |
| Returns the line with the specified line number.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#interactionManagerChanged()" class="signatureLink">interactionManagerChanged</a>(newInteractionManager:<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</a>):void</div><div class="summaryTableDescription"> |
| Called by the TextFlow when the interaction manager changes.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#isDamaged()" class="signatureLink">isDamaged</a>(absolutePosition:int):Boolean</div><div class="summaryTableDescription"> |
| Indicates whether any TextFlowLine objects between the beginning of the flow and the line containing the content at |
| the specified position are marked as damaged.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeAllControllers()" class="signatureLink">removeAllControllers</a>():void</div><div class="summaryTableDescription"> |
| Removes all controllers from this IFlowComposer instance.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeController()" class="signatureLink">removeController</a>(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):void</div><div class="summaryTableDescription"> |
| Removes a controller from this IFlowComposer instance.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeControllerAt()" class="signatureLink">removeControllerAt</a>(index:int):void</div><div class="summaryTableDescription"> |
| Removes the controller at the specified index from this IFlowComposer instance.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setFocus()" class="signatureLink">setFocus</a>(absolutePosition:int, leanLeft:Boolean = false):void</div><div class="summaryTableDescription"> |
| Sets the focus to the container that contains the location specified by the absolutePosition |
| parameter.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setRootElement()" class="signatureLink">setRootElement</a>(newRootElement:<a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a>):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#updateAllControllers()" class="signatureLink">updateAllControllers</a>():Boolean</div><div class="summaryTableDescription"> |
| Composes the content of the root element and updates the display.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html#updateLengths()" class="signatureLink">updateLengths</a>(startPosition:int, deltaLength:int):void</div><div class="summaryTableDescription"> Update the lengths in the lines to maintain mapping to the TextFlow.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/compose/FlowComposerBase.html">FlowComposerBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#updateToController()" class="signatureLink">updateToController</a>(index:int):Boolean</div><div class="summaryTableDescription"> |
| Composes and updates the display up to and including the container at the specified index.</div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#preCompose()" class="signatureLink">preCompose</a>():Boolean</div><div class="summaryTableDescription"> Returns true if composition is necessary, false otherwise </div></td><td class="summaryTableOwnerCol">StandardFlowComposer</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="composing"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">composing</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>composing:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| True, if the flow composer is currently performing a composition operation. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get composing():Boolean</code><br/></div><a name="propertyDetail"></a><a name="numControllers"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numControllers</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>numControllers:int</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| The number of containers assigned to this IFlowComposer instance. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get numControllers():int</code><br/></div><a name="propertyDetail"></a><a name="rootElement"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rootElement</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rootElement:<a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a></code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| The root element associated with this IFlowComposer instance. |
| |
| <p>Only a TextFlow object can be a root element.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rootElement():<a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a></code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="StandardFlowComposer()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">StandardFlowComposer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function StandardFlowComposer()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p> |
| Creates a StandardFlowComposer object. |
| <p>To use an StandardFlowComposer object, assign it to the |
| <code>flowComposer</code> property of a TextFlow object. Call the <code>updateAllControllers()</code> |
| method to lay out and display the text in the containers attached to the flow composer.</p> |
| |
| </p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addController()"></a><a name="addController(flashx.textLayout.container.ContainerController)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addController</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addController(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Adds a controller to this IFlowComposer instance. |
| <p>The container is added to the end of the container list.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">controller</span>:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></code> — The ContainerController object to add. |
| </td></tr></table></p></div><a name="addControllerAt()"></a><a name="addControllerAt(flashx.textLayout.container.ContainerController,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addControllerAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addControllerAt(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>, index:int):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Adds a controller to this IFlowComposer instance at the specified index. |
| <p>The list of controllers is 0-based (the first controller has an index of 0).</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">controller</span>:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></code> — The ContainerController object to add. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> — A numeric index that specifies the position in the controller list at which to insert the ContainerController object. |
| </td></tr></table></p></div><a name="compose()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">compose</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function compose():Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| 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. |
| |
| <p>The <code>compose()</code> method only composes content if it has changed since the last composition operation. |
| Results are saved so that subsequent |
| calls to <code>compose()</code> or <code>updateAllControllers()</code> do not perform an additional recomposition |
| if the flow content has not changed.</p> |
| |
| <p>If the contents of any container have changed, the method returns <code>true</code>.</p> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — true if anything changed. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="StandardFlowComposer.html#updateAllControllers()" target="">updateAllControllers()</a><br/><a href="StandardFlowComposer.html#updateToController()" target="">updateToController()</a></div></div><a name="composeToController()"></a><a name="composeToController(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">composeToController</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function composeToController(index:int):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Composes the content of the root element up to and including the container at the specified index. |
| |
| <p>If the contents of any container up to and including the container at the specified |
| index has changed, the method returns <code>true</code>. If <code>index</code> is greater than the number of controllers |
| (or not specified), then all containers are composed.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> (default = <code>NaN</code>)<code></code> — compose at least up to this container in the TextFlow. If controllerIndex is greater than the number of controllers, compose to the end of the last container. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — true if anything changed. |
| </td></tr></table></div><a name="composeToPosition()"></a><a name="composeToPosition(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">composeToPosition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function composeToPosition(absolutePosition:int):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Composes the content of the root element up to the specified position. |
| |
| <p>If the contents of any container up to and including the container holding the content at the specified |
| position has changed, the method returns <code>true</code>. If <code>absolutePosition</code> is greater than the length of the TextFlow |
| (or not specified), then the entire flow is composed.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">absolutePosition</span>:int</code> (default = <code>NaN</code>)<code></code> — compose at least up to this position in the TextFlow. By default or if absolutePosition is past the end of the flow compose to the end of the flow. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — true if anything changed. |
| </td></tr></table></div><a name="findControllerIndexAtPosition()"></a><a name="findControllerIndexAtPosition(int,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">findControllerIndexAtPosition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function findControllerIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns the index of the controller containing the content at the specified position. |
| |
| <p>A position can be considered to be the division between two characters or other elements of a text flow. If |
| the value in <code>absolutePosition</code> 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 <code>preferPrevious</code> parameter is set to <code>true</code> and the later container is returned if |
| the <code>preferPrevious</code> parameter is set to <code>false</code>.</p> |
| <p>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.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">absolutePosition</span>:int</code> — The position of the content for which the container index is sought. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">preferPrevious</span>:Boolean</code> (default = <code>false</code>)<code></code> — Specifies which container index to return when the position is between the last element in |
| one container and the first element in the next. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>int</code> — the index of the container controller or -1 if not found. |
| </td></tr></table></div><a name="getAbsoluteStart()"></a><a name="getAbsoluteStart(flashx.textLayout.container.ContainerController)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getAbsoluteStart</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getAbsoluteStart(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns the absolute position of the first content element in the specified ContainerController object. |
| <p>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.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">controller</span>:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></code> — A ContainerController object associated with this flow composer. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>int</code> — the position before the first character or graphic in the ContainerController. |
| </td></tr></table></div><a name="getControllerAt()"></a><a name="getControllerAt(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getControllerAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getControllerAt(index:int):<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns the ContainerController object at the specified index. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> — The index of the ContainerController object to return. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></code> — the ContainerController object at the specified position. |
| </td></tr></table></div><a name="getControllerIndex()"></a><a name="getControllerIndex(flashx.textLayout.container.ContainerController)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getControllerIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getControllerIndex(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns the index of the specified ContainerController object. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">controller</span>:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></code> — A reference to the ContainerController object to find. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>int</code> — the index of the specified ContainerController object or -1 if the controller is not attached to this flow composer. |
| </td></tr></table></div><a name="interactionManagerChanged()"></a><a name="interactionManagerChanged(flashx.textLayout.edit.ISelectionManager)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">interactionManagerChanged</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function interactionManagerChanged(newInteractionManager:<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Called by the TextFlow when the interaction manager changes. |
| |
| <p>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.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">newInteractionManager</span>:<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</a></code> — The new ISelectionManager instance. |
| |
| </td></tr></table></p></div><a name="preCompose()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">preCompose</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function preCompose():Boolean</code><p></p><p></p><p> Returns true if composition is necessary, false otherwise </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code></td></tr></table></div><a name="removeAllControllers()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeAllControllers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeAllControllers():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Removes all controllers from this IFlowComposer instance. |
| |
| </p></div><a name="removeController()"></a><a name="removeController(flashx.textLayout.container.ContainerController)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeController</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeController(controller:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Removes a controller from this IFlowComposer instance. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">controller</span>:<a href="../../../flashx/textLayout/container/ContainerController.html">ContainerController</a></code> — The ContainerController instance to remove. |
| </td></tr></table></p></div><a name="removeControllerAt()"></a><a name="removeControllerAt(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeControllerAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeControllerAt(index:int):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Removes the controller at the specified index from this IFlowComposer instance. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> — The index of the ContainerController object to remove. |
| </td></tr></table></p></div><a name="setFocus()"></a><a name="setFocus(int,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setFocus(absolutePosition:int, leanLeft:Boolean = false):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Sets the focus to the container that contains the location specified by the <code>absolutePosition</code> |
| parameter. |
| <p>The StandardFlowComposer calls the <code>setFocus()</code> method of the ContainerController object |
| containing the specified text flow position.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">absolutePosition</span>:int</code> — Specifies the position in the text flow of the container to receive focus. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">leanLeft</span>:Boolean</code> (default = <code>false</code>)<code></code> — If true and the position is before the first character in a container, sets focus to the end of |
| the previous container. |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.Stage.focus</div></div><a name="setRootElement()"></a><a name="setRootElement(flashx.textLayout.elements.ContainerFormattedElement)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setRootElement</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setRootElement(newRootElement:<a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">newRootElement</span>:<a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a></code></td></tr></table></p></div><a name="updateAllControllers()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateAllControllers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function updateAllControllers():Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Composes the content of the root element and updates the display. |
| <p>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 <code>updateAllControllers()</code> |
| 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.</p> |
| |
| <p>This method updates all the text lines and the display list immediately and synchronously.</p> |
| <p>If the contents of any container is changed, the method returns <code>true</code>.</p> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — true if anything changed. |
| </td></tr></table></div><a name="updateToController()"></a><a name="updateToController(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateToController</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function updateToController(index:int):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Composes and updates the display up to and including the container at the specified index. |
| |
| <p>The <code>updateToController()</code> 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, |
| <code>updateToController()</code> ensures that the first through the tenth (indexes 0-9) |
| containers are composed and displayed. Composition stops at that point. If <code>controllerIndex</code> |
| is -1 (or not specified), then all containers are updated.</p> |
| <p>This method updates all the text lines and the display list immediately and synchronously.</p> |
| |
| <p>If the contents of any container is changed, the method returns <code>true</code>.</p> |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> (default = <code>NaN</code>)<code></code> — index of the last container to update (by default updates all containers) |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — <code>true</code>, if anything changed. |
| </td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Mar 25 2015, 07:57 PM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Mar 25 2015, 07:57 PM +01:00 --> |
