| <!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="TextContainerManager,flashx.textLayout.container.TextContainerManager,AUTO,OFF,ON,_mouseWheelListenerAttached,absoluteStart,alignmentBaseline,backgroundAlpha,backgroundColor,baselineShift,blockProgression,borderBottomColor,borderBottomPriority,borderBottomWidth,borderLeftColor,borderLeftPriority,borderLeftWidth,borderRightColor,borderRightPriority,borderRightWidth,borderTopColor,borderTopPriority,borderTopWidth,breakOpportunity,cellCount,cellPadding,cellSpacing,cffHinting,clearFloats,color,columnBreakAfter,columnBreakBefore,columnCount,columnCount,columnGap,columnGap,columnState,columnWidth,columnWidth,compositionHeight,compositionHeight,compositionWidth,compositionWidth,computedFormat,configuration,container,container,containerBreakAfter,containerBreakBefore,containerControllerInitialFormat,coreStyles,defaultConfiguration,digitCase,digitWidth,direction,dominantBaseline,editingMode,firstBaselineOffset,flowComposer,fontFamily,fontLookup,fontSize,fontStyle,fontWeight,format,frame,horizontalScrollPolicy,horizontalScrollPolicy,horizontalScrollPosition,horizontalScrollPosition,hostFormat,interactionManager,interactiveObjects,justificationRule,justificationStyle,kerning,leadingModel,ligatureLevel,lineBreak,lineHeight,lineThrough,linkActiveFormat,linkHoverFormat,linkNormalFormat,listAutoPadding,listMarkerFormat,listStylePosition,listStyleType,locale,marginBottom,marginLeft,marginRight,marginTop,maxCellHeight,minCellHeight,numLines,oldInteractiveObjects,paddingBottom,paddingLeft,paddingRight,paddingTop,paragraphEndIndent,paragraphSpaceAfter,paragraphSpaceBefore,paragraphStartIndent,preserveSelectionOnSetText,renderingMode,rootElement,rules,styleName,styles,swfContext,tabStops,tableColumnWidth,tableWidth,textAlign,textAlignLast,textAlpha,textDecoration,textFlow,textIndent,textJustify,textLength,textRotation,trackingLeft,trackingRight,typographicCase,userStyles,usesDiscretionaryHyphens,verticalAlign,verticalScrollPolicy,verticalScrollPolicy,verticalScrollPosition,verticalScrollPosition,whiteSpaceCollapse,wordSpacing,activateHandler,activateHandler,addBackgroundShape,addCellSelections,addInlineGraphicElement,addSelectionContainer,addTableBlock,addTextLine,autoScrollIfNecessary,beginInteraction,beginMouseCapture,beginMouseCapture,beginMouseCapture,clearCellList,clearStyle,compose,createContextMenu,createContextMenu,createEditManager,createSelectionManager,deactivateHandler,deactivateHandler,dispose,drawBackgroundAndSetScrollRect,editHandler,editHandler,endInteraction,endMouseCapture,endMouseCapture,endMouseCapture,focusChangeHandler,focusChangeHandler,focusInHandler,focusInHandler,focusOutHandler,focusOutHandler,getCellAt,getColumnAt,getContentBounds,getContentBounds,getFirstTextLineChildIndex,getFocusedSelectionFormat,getInactiveSelectionFormat,getLineAt,getScrollDelta,getScrollDelta,getStyle,getText,getTextFlow,getUndoManager,getUnfocusedSelectionFormat,imeStartCompositionHandler,imeStartCompositionHandler,invalidateContents,invalidateSelectionFormats,invalidateUndoManager,isDamaged,isDamaged,keyDownHandler,keyDownHandler,keyFocusChangeHandler,keyFocusChangeHandler,keyUpHandler,keyUpHandler,menuSelectHandler,menuSelectHandler,mouseDoubleClickHandler,mouseDoubleClickHandler,mouseDownHandler,mouseDownHandler,mouseMoveHandler,mouseMoveHandler,mouseMoveSomewhere,mouseMoveSomewhere,mouseMoveSomewhere,mouseOutHandler,mouseOutHandler,mouseOverHandler,mouseOverHandler,mouseUpHandler,mouseUpHandler,mouseUpSomewhere,mouseUpSomewhere,mouseUpSomewhere,mouseWheelHandler,mouseWheelHandler,pushTableCell,removeBackgroundShape,removeInlineGraphicElement,removeSelectionContainer,removeTableBlock,removeTextLine,resetLine,scrollToRange,scrollToRange,selectRange,setCompositionSize,setStyle,setText,setTextFlow,softKeyboardActivatingHandler,softKeyboardActivatingHandler,textInputHandler,textInputHandler,updateContainer,updateGraphics,updateVisibleRectangle"><title>flashx.textLayout.container.TextContainerManager</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 = 'TextContainerManager - 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/container/TextContainerManager.html&flashx/textLayout/container/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">TextContainerManager</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</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("TextContainerManager"); titleBar_setSubNav(false,true,false,false,false,false,true,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.container</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TextContainerManager</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">TextContainerManager <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../flashx/textLayout/compose/ISWFContext.html">ISWFContext</a>, <a href="../../../flashx/textLayout/edit/IInteractionEventHandler.html">IInteractionEventHandler</a>, <a href="../../../flashx/textLayout/container/ISandboxSupport.html">ISandboxSupport</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> Manages text in a container. Assumes that it manages all children of the container. |
| Consider using TextContainerManager for better performance in cases where there is a |
| one container per TextFlow, and the TextFlow is not the main focus, is static text, or |
| is infrequently selected. Good for text in form fields, for example. |
| |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="ContainerController.html" target="">ContainerController</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</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="#compositionHeight" class="signatureLink">compositionHeight</a> : Number<div class="summaryTableDescription"> Returns the vertical extent allowed for text inside the container.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#compositionWidth" class="signatureLink">compositionWidth</a> : Number<div class="summaryTableDescription"> Returns the horizontal extent allowed for text inside the container.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#configuration" class="signatureLink">configuration</a> : <a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</a><div class="summaryTableDescription">[read-only] The Configuration object for this TextContainerManager.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#container" class="signatureLink">container</a> : Sprite<div class="summaryTableDescription">[read-only] Returns the container (DisplayObjectContainer) that holds the text that this TextContainerManager manages.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#defaultConfiguration" class="signatureLink">defaultConfiguration</a> : <a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</a><div class="summaryTableDescription">[static] [read-only] The default configuration for this TextContainerManager.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#editingMode" class="signatureLink">editingMode</a> : String<div class="summaryTableDescription"> Editing mode of this TextContainerManager.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#horizontalScrollPolicy" class="signatureLink">horizontalScrollPolicy</a> : String<div class="summaryTableDescription"> |
| Controls whether the factory generates all text lines or stops when the container bounds are filled. |
| Specifies the horizontal scrolling policy, which you can set by assigning one of the constants of |
| the ScrollPolicy class: ON, OFF, or AUTO.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#horizontalScrollPosition" class="signatureLink">horizontalScrollPosition</a> : Number<div class="summaryTableDescription"> Specifies the current horizontal scroll location on the stage.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#hostFormat" class="signatureLink">hostFormat</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription"> Sets the format when display just a string.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#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">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#preserveSelectionOnSetText" class="signatureLink">preserveSelectionOnSetText</a> : Boolean<div class="summaryTableDescription"> </div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#swfContext" class="signatureLink">swfContext</a> : <a href="../../../flashx/textLayout/compose/ISWFContext.html">ISWFContext</a><div class="summaryTableDescription"> |
| Optional ISWFContext instance used to make FTE calls as needed in the proper swf context.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#verticalScrollPolicy" class="signatureLink">verticalScrollPolicy</a> : String<div class="summaryTableDescription"> |
| Controls whether the factory generates all text lines or stops when the container bounds are filled. Specifies the vertical scrolling policy, which you can set by assigning one of the constants of the ScrollPolicy |
| class: ON, OFF, or, AUTO.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#verticalScrollPosition" class="signatureLink">verticalScrollPosition</a> : Number<div class="summaryTableDescription"> Specifies the current vertical scroll location on the stage.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </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="#TextContainerManager()" class="signatureLink">TextContainerManager</a>(container:Sprite, configuration:<a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</a> = null)</div><div class="summaryTableDescription"> Constructor function - creates a TextContainerManager instance.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#activateHandler()" class="signatureLink">activateHandler</a>(event:Event):void</div><div class="summaryTableDescription"> Processes the Event.ACTIVATE event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#beginInteraction()" class="signatureLink">beginInteraction</a>():<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</a></div><div class="summaryTableDescription"> Returns the current ISelectionManager instance.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#beginMouseCapture()" class="signatureLink">beginMouseCapture</a>():void</div><div class="summaryTableDescription"> |
| Called to request clients to begin the forwarding of mouseup and mousemove events from outside a security sandbox.</div></td><td class="summaryTableOwnerCol">TextContainerManager</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>():void</div><div class="summaryTableDescription"> Composes the container text; calls either the factory or updateAllControllers().</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#deactivateHandler()" class="signatureLink">deactivateHandler</a>(event:Event):void</div><div class="summaryTableDescription"> Processes the Event.DEACTIVATE event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#drawBackgroundAndSetScrollRect()" class="signatureLink">drawBackgroundAndSetScrollRect</a>(scrollX:Number, scrollY:Number):Boolean</div><div class="summaryTableDescription"> |
| Returns true if it has filled in the container's scrollRect property.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#editHandler()" class="signatureLink">editHandler</a>(event:Event):void</div><div class="summaryTableDescription"> |
| Processes an edit event (CUT, COPY, PASTE, SELECT_ALL) when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#endInteraction()" class="signatureLink">endInteraction</a>():void</div><div class="summaryTableDescription"> Terminates interaction.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#endMouseCapture()" class="signatureLink">endMouseCapture</a>():void</div><div class="summaryTableDescription"> |
| Called to inform clients that the the forwarding of mouseup and mousemove events from outside a security sandbox is no longer needed.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#focusChangeHandler()" class="signatureLink">focusChangeHandler</a>(event:FocusEvent):void</div><div class="summaryTableDescription"> |
| Processes the FocusEvent.KEY_FOCUS_CHANGE and FocusEvent.MOUSE_FOCUS_CHANGE events |
| when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#focusInHandler()" class="signatureLink">focusInHandler</a>(event:FocusEvent):void</div><div class="summaryTableDescription"> Process a focusIn event.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#focusOutHandler()" class="signatureLink">focusOutHandler</a>(event:FocusEvent):void</div><div class="summaryTableDescription"> Processes the FocusEvent.FOCUS_OUT event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getContentBounds()" class="signatureLink">getContentBounds</a>():Rectangle</div><div class="summaryTableDescription"> Creates a rectangle that shows where the last call to either the compose() |
| method or the updateContainer() method placed the text.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLineAt()" class="signatureLink">getLineAt</a>(index:int):TextLine</div><div class="summaryTableDescription"> Return the TextLine at the index from array of composed lines.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getScrollDelta()" class="signatureLink">getScrollDelta</a>(numLines:int):Number</div><div class="summaryTableDescription"> |
| Figure out the scroll distance required to scroll up or down by the specified number of lines.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getText()" class="signatureLink">getText</a>(separator:String = 
):String</div><div class="summaryTableDescription"> |
| Returns the current text using a separator between paragraphs.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getTextFlow()" class="signatureLink">getTextFlow</a>():<a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></div><div class="summaryTableDescription"> The current TextFlow.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#imeStartCompositionHandler()" class="signatureLink">imeStartCompositionHandler</a>(event:IMEEvent):void</div><div class="summaryTableDescription"> Processes the IME_START_COMPOSITION event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateSelectionFormats()" class="signatureLink">invalidateSelectionFormats</a>():void</div><div class="summaryTableDescription"> Call this if you change the selection formats (SelectionFormat) and want the interactionManager |
| to update.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateUndoManager()" class="signatureLink">invalidateUndoManager</a>():void</div><div class="summaryTableDescription"> Call this if you are editing, and want to reset the undo manager used for editing.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#isDamaged()" class="signatureLink">isDamaged</a>():Boolean</div><div class="summaryTableDescription"> Returns true if the content needs composing.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#keyDownHandler()" class="signatureLink">keyDownHandler</a>(event:KeyboardEvent):void</div><div class="summaryTableDescription"> Processes the KeyboardEvent.KEY_DOWN event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#keyFocusChangeHandler()" class="signatureLink">keyFocusChangeHandler</a>(event:FocusEvent):void</div><div class="summaryTableDescription"> Processes the FocusEvent.KEY_FOCUS_CHANGE event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#keyUpHandler()" class="signatureLink">keyUpHandler</a>(event:KeyboardEvent):void</div><div class="summaryTableDescription"> Processes the Keyboard.KEY_UP event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#menuSelectHandler()" class="signatureLink">menuSelectHandler</a>(event:ContextMenuEvent):void</div><div class="summaryTableDescription"> |
| Processes the ContextMenuEvent.MENU_SELECT event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseDoubleClickHandler()" class="signatureLink">mouseDoubleClickHandler</a>(event:MouseEvent):void</div><div class="summaryTableDescription"> Processes the MouseEvent.DOUBLE_CLICK event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseDownHandler()" class="signatureLink">mouseDownHandler</a>(event:MouseEvent):void</div><div class="summaryTableDescription"> Processes the MouseEvent.MOUSE_DOWN event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseMoveHandler()" class="signatureLink">mouseMoveHandler</a>(event:MouseEvent):void</div><div class="summaryTableDescription"> |
| Processes the MouseEvent.MOUSE_MOVE event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseMoveSomewhere()" class="signatureLink">mouseMoveSomewhere</a>(e:Event):void</div><div class="summaryTableDescription"> Client call to forward a mouseMove event from outside a security sandbox.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseOutHandler()" class="signatureLink">mouseOutHandler</a>(event:MouseEvent):void</div><div class="summaryTableDescription"> Processes the MouseEvent.MOUSE_OUT event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseOverHandler()" class="signatureLink">mouseOverHandler</a>(event:MouseEvent):void</div><div class="summaryTableDescription"> Process a mouseOver event.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseUpHandler()" class="signatureLink">mouseUpHandler</a>(event:MouseEvent):void</div><div class="summaryTableDescription"> |
| Processes the MouseEvent.MOUSE_UP event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseUpSomewhere()" class="signatureLink">mouseUpSomewhere</a>(e:Event):void</div><div class="summaryTableDescription"> Client call to forward a mouseUp event from outside a security sandbox.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#mouseWheelHandler()" class="signatureLink">mouseWheelHandler</a>(event:MouseEvent):void</div><div class="summaryTableDescription"> Processes the MouseEvent.MOUSE_WHEEL event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#resetLine()" class="signatureLink">resetLine</a>(textLine:TextLine):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#scrollToRange()" class="signatureLink">scrollToRange</a>(activePosition:int, anchorPosition:int):void</div><div class="summaryTableDescription"> |
| Scrolls so that the text range is visible in the container.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setText()" class="signatureLink">setText</a>(text:String):void</div><div class="summaryTableDescription"> |
| Sets the text property to the specified String.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setTextFlow()" class="signatureLink">setTextFlow</a>(textFlow:<a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</a>):void</div><div class="summaryTableDescription"> Sets a TextFlow into this TextContainerManager replacing any existing TextFlow and discarding the |
| current text.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#softKeyboardActivatingHandler()" class="signatureLink">softKeyboardActivatingHandler</a>(event:Event):void</div><div class="summaryTableDescription"> Processes the SOFT_KEYBOARD_ACTIVATING event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#textInputHandler()" class="signatureLink">textInputHandler</a>(event:TextEvent):void</div><div class="summaryTableDescription"> Processes the TextEvent.TEXT_INPUT event when the client manages events.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#updateContainer()" class="signatureLink">updateContainer</a>():Boolean</div><div class="summaryTableDescription"> Updates the display; calls either the factory or updateAllControllers().</div></td><td class="summaryTableOwnerCol">TextContainerManager</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="#createContextMenu()" class="signatureLink">createContextMenu</a>():ContextMenu</div><div class="summaryTableDescription"> Creates a ContextMenu for the TextContainerManager.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createEditManager()" class="signatureLink">createEditManager</a>(undoManager:<a href="../../../flashx/undo/IUndoManager.html">IUndoManager</a>):<a href="../../../flashx/textLayout/edit/IEditManager.html">IEditManager</a></div><div class="summaryTableDescription">Create an edit manager to use for editing.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createSelectionManager()" class="signatureLink">createSelectionManager</a>():<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</a></div><div class="summaryTableDescription">Create a selection manager to use for selection.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getFocusedSelectionFormat()" class="signatureLink">getFocusedSelectionFormat</a>():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></div><div class="summaryTableDescription"> Returns the focusedSelectionFormat - by default get it from the configuration.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getInactiveSelectionFormat()" class="signatureLink">getInactiveSelectionFormat</a>():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></div><div class="summaryTableDescription"> Returns the inactiveSelectionFormat - by default get it from the configuration |
| This can be overridden in the subclass to supply a different SelectionFormat |
| </div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getUndoManager()" class="signatureLink">getUndoManager</a>():<a href="../../../flashx/undo/IUndoManager.html">IUndoManager</a></div><div class="summaryTableDescription"> |
| Returns the undo manager to use.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getUnfocusedSelectionFormat()" class="signatureLink">getUnfocusedSelectionFormat</a>():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></div><div class="summaryTableDescription"> Returns the unfocusedSelectionFormat - by default get it from the configuration |
| You can override this method in the subclass to supply a different SelectionFormat.</div></td><td class="summaryTableOwnerCol">TextContainerManager</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </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="#event:click" class="signatureLink">click</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when any link is clicked.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:compositionComplete" class="signatureLink">compositionComplete</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after every recompose.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:damage" class="signatureLink">damage</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by a TextFlow object each time it is damaged</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:flowOperationBegin" class="signatureLink">flowOperationBegin</a></div></td><td class="summaryTableDescription summaryTableCol"> |
| Defines the value of the type property of a flowOperationBegin event object.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:flowOperationComplete" class="signatureLink">flowOperationComplete</a></div></td><td class="summaryTableDescription summaryTableCol"> |
| Defines the value of the type property of a flowOperationComplete event object.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:flowOperationEnd" class="signatureLink">flowOperationEnd</a></div></td><td class="summaryTableDescription summaryTableCol"> |
| Defines the value of the type property of a flowOperationEnd event object.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:inlineGraphicStatusChanged" class="signatureLink">inlineGraphicStatusChanged</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a InlineGraphicElement is resized due to having width or height as auto or percent and the graphic has finished loading.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:mouseDown" class="signatureLink">mouseDown</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the mouse is pressed down over any link.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:mouseMove" class="signatureLink">mouseMove</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the mouse passes over any link.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:mouseUp" class="signatureLink">mouseUp</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the mouse is released over any link.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:rollOut" class="signatureLink">rollOut</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the mouse goes out of any link.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:rollOver" class="signatureLink">rollOver</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the mouse first enters any link.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:scroll" class="signatureLink">scroll</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by a TextFlow object after text is scrolled within a controller container.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:selectionChange" class="signatureLink">selectionChange</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched whenever the selection is changed.</td><td class="summaryTableOwnerCol">TextContainerManager</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:updateComplete" class="signatureLink">updateComplete</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by a TextFlow object each time a container has had new DisplayObjects added or updated as a result of composition.</td><td class="summaryTableOwnerCol">TextContainerManager</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="compositionHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">compositionHeight</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>compositionHeight:Number</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 vertical extent allowed for text inside the container. The value is specified in pixels. |
| <p>After setting this property, the text in the container is damaged and requires composing.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get compositionHeight():Number</code><br/><code> public function set compositionHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="compositionWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">compositionWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>compositionWidth:Number</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 horizontal extent allowed for text inside the container. The value is specified in pixels. |
| |
| <p>After setting this property, the text in the container is damaged and requires composing.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get compositionWidth():Number</code><br/><code> public function set compositionWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="configuration"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">configuration</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>configuration:<a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</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 Configuration object for this TextContainerManager. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get configuration():<a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso">IConfiguration</div></div><a name="propertyDetail"></a><a name="container"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">container</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>container:Sprite</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> Returns the container (DisplayObjectContainer) that holds the text that this TextContainerManager manages. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get container():Sprite</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ContainerController.html#container" target="">ContainerController.container</a></div></div><a name="propertyDetail"></a><a name="defaultConfiguration"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">defaultConfiguration</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>defaultConfiguration:<a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</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 default configuration for this TextContainerManager. Column and padding attributes |
| are set to <code>FormatValue.INHERIT</code>. |
| </p><br/><span class="label"> Implementation </span><br/><code> public static function get defaultConfiguration():<a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/IConfiguration.html" target="">IConfiguration</a><br/><a href="../../../flashx/textLayout/formats/FormatValue.html#INHERIT" target="">FormatValue.INHERIT</a></div></div><a name="propertyDetail"></a><a name="editingMode"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">editingMode</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>editingMode:String</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> Editing mode of this TextContainerManager. Modes are reading only, reading and selection permitted, |
| and editing (reading, selection, and writing) permitted. Use the constant values of the EditingMode |
| class to set this property. |
| <p>Default value is READ_WRITE.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get editingMode():String</code><br/><code> public function set editingMode(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/EditingMode.html" target="">EditingMode</a></div></div><a name="propertyDetail"></a><a name="horizontalScrollPolicy"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">horizontalScrollPolicy</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>horizontalScrollPolicy:String</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> |
| Controls whether the factory generates all text lines or stops when the container bounds are filled. |
| |
| </p> |
| Specifies the horizontal scrolling policy, which you can set by assigning one of the constants of |
| the ScrollPolicy class: ON, OFF, or AUTO. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get horizontalScrollPolicy():String</code><br/><code> public function set horizontalScrollPolicy(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="horizontalScrollPosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">horizontalScrollPosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>horizontalScrollPosition:Number</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> Specifies the current horizontal scroll location on the stage. The value specifies the number of |
| pixels from the left. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get horizontalScrollPosition():Number</code><br/><code> public function set horizontalScrollPosition(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="hostFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hostFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>hostFormat:<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><p></p><p></p><p> Sets the format when display just a string. If displaying a TextFlow this has no immediate effect. The supplied ITextLayoutFormat is not copied. Modifying it without calling this setter has indeterminate effects. </p><br/><span class="label"> Implementation </span><br/><code> public function get hostFormat():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><code> public function set hostFormat(value:<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a>):void</code><br/></div><a name="propertyDetail"></a><a name="numLines"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numLines</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>numLines: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 total number of lines composed in the flow. By default TLF does not compose the entire flow and this value may be innacruate. |
| Use composeToPosition to get all lines composed. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get numLines():int</code><br/></div><a name="propertyDetail"></a><a name="preserveSelectionOnSetText"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">preserveSelectionOnSetText</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>preserveSelectionOnSetText: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> </p><br/><span class="label"> Implementation </span><br/><code> public function get preserveSelectionOnSetText():Boolean</code><br/><code> public function set preserveSelectionOnSetText(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="swfContext"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">swfContext</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>swfContext:<a href="../../../flashx/textLayout/compose/ISWFContext.html">ISWFContext</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> |
| Optional ISWFContext instance used to make FTE calls as needed in the proper swf context. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get swfContext():<a href="../../../flashx/textLayout/compose/ISWFContext.html">ISWFContext</a></code><br/><code> public function set swfContext(value:<a href="../../../flashx/textLayout/compose/ISWFContext.html">ISWFContext</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/compose/ISWFContext.html" target="">flashx.textLayout.compose.ISWFContext</a></div></div><a name="propertyDetail"></a><a name="verticalScrollPolicy"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalScrollPolicy</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalScrollPolicy:String</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> |
| Controls whether the factory generates all text lines or stops when the container bounds are filled. |
| |
| </p> Specifies the vertical scrolling policy, which you can set by assigning one of the constants of the ScrollPolicy |
| class: ON, OFF, or, AUTO. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get verticalScrollPolicy():String</code><br/><code> public function set verticalScrollPolicy(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="verticalScrollPosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalScrollPosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalScrollPosition:Number</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> Specifies the current vertical scroll location on the stage. The value specifies the number of |
| pixels from the top. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get verticalScrollPosition():Number</code><br/><code> public function set verticalScrollPosition(value:Number):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="TextContainerManager()"></a><a name="TextContainerManager(flash.display.Sprite,flashx.textLayout.elements.IConfiguration)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">TextContainerManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function TextContainerManager(container:Sprite, configuration:<a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</a> = null)</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> Constructor function - creates a TextContainerManager instance. |
| For best results: |
| <ol> |
| <li>Start with TextContainerManager.defaultConfiguration and modify it</li> |
| <li>Share the same Configuration among many InputManagers</li> |
| </ol> |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">container</span>:Sprite</code> — The DisplayObjectContainer in which to manage the text lines. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">configuration</span>:<a href="../../../flashx/textLayout/elements/IConfiguration.html">IConfiguration</a></code> (default = <code>null</code>)<code></code> — - The IConfiguration instance to use with this TextContainerManager instance. |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="activateHandler()"></a><a name="activateHandler(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">activateHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function activateHandler(event:Event):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> Processes the <code>Event.ACTIVATE</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code> — The Event object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">Event.ACTIVATE</div></div><a name="beginInteraction()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">beginInteraction</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function beginInteraction():<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</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 current ISelectionManager instance. Converts to TextFlow instance and creates one if necessary. |
| </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/edit/ISelectionManager.html">ISelectionManager</a></code> — the interaction manager for this TextContainerManager instance. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/ISelectionManager.html" target="">ISelectionManager</a></div></div><a name="beginMouseCapture()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">beginMouseCapture</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function beginMouseCapture():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 to request clients to begin the forwarding of mouseup and mousemove events from outside a security sandbox. |
| </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():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> Composes the container text; calls either the factory or <code>updateAllControllers()</code>. |
| </p></div><a name="createContextMenu()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createContextMenu</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function createContextMenu():ContextMenu</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> Creates a ContextMenu for the TextContainerManager. Use the methods of the ContextMenu |
| class to add items to the menu. |
| <p>You can override this method to define a custom context menu.</p> |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>ContextMenu</code> — the created context menu. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">ContextMenu</div></div><a name="createEditManager()"></a><a name="createEditManager(flashx.undo.IUndoManager)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createEditManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function createEditManager(undoManager:<a href="../../../flashx/undo/IUndoManager.html">IUndoManager</a>):<a href="../../../flashx/textLayout/edit/IEditManager.html">IEditManager</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>Create an edit manager to use for editing. Override this method if you have a custom EditManager that you |
| want to use in place of the default. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">undoManager</span>:<a href="../../../flashx/undo/IUndoManager.html">IUndoManager</a></code> — IUndoManager instance for the EditManager being created. |
| </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/edit/IEditManager.html">IEditManager</a></code> — the editing manager for this TextContainerManager instance. |
| </td></tr></table></div><a name="createSelectionManager()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createSelectionManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function createSelectionManager():<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</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>Create a selection manager to use for selection. Override this method if you have a custom SelectionManager that you |
| want to use in place of the default. |
| </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/edit/ISelectionManager.html">ISelectionManager</a></code> — a new SelectionManager instance. |
| </td></tr></table></div><a name="deactivateHandler()"></a><a name="deactivateHandler(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">deactivateHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function deactivateHandler(event:Event):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> Processes the <code>Event.DEACTIVATE</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code> — The Event object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">Event.DEACTIVATE</div></div><a name="drawBackgroundAndSetScrollRect()"></a><a name="drawBackgroundAndSetScrollRect(Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">drawBackgroundAndSetScrollRect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function drawBackgroundAndSetScrollRect(scrollX:Number, scrollY:Number):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> |
| Returns <code>true</code> if it has filled in the container's scrollRect property. |
| This method enables you to test whether <code>scrollRect</code> is set without actually accessing the <code>scrollRect</code> property |
| which can possibly create a performance issue. |
| <p>Override this method to draw a background or a border. Overriding this method can be tricky as the scrollRect <b>must</b> |
| be set as specified.</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">scrollX</span>:Number</code> — The starting horizontal position of the scroll rectangle. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">scrollY</span>:Number</code> — The starting vertical position of the scroll rectangle. |
| |
| </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 it has created the <code>scrollRect</code> object. |
| </td></tr></table></div><a name="editHandler()"></a><a name="editHandler(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">editHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function editHandler(event:Event):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> |
| Processes an edit event (CUT, COPY, PASTE, SELECT_ALL) when the client manages events. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code> — Event object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">Event</div></div><a name="endInteraction()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">endInteraction</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function endInteraction():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> Terminates interaction. |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/ISelectionManager.html" target="">ISelectionManager</a></div></div><a name="endMouseCapture()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">endMouseCapture</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function endMouseCapture():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 to inform clients that the the forwarding of mouseup and mousemove events from outside a security sandbox is no longer needed. |
| </p></div><a name="focusChangeHandler()"></a><a name="focusChangeHandler(flash.events.FocusEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusChangeHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function focusChangeHandler(event:FocusEvent):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> |
| Processes the <code>FocusEvent.KEY_FOCUS_CHANGE</code> and <code>FocusEvent.MOUSE_FOCUS_CHANGE</code> events |
| when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:FocusEvent</code> — The FocusEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">FocusEvent.KEY_FOCUS_CHANGE<br/>FocusEvent.MOUSE_FOCUS_CHANGE</div></div><a name="focusInHandler()"></a><a name="focusInHandler(flash.events.FocusEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusInHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function focusInHandler(event:FocusEvent):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> Process a focusIn event. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:FocusEvent</code></td></tr></table></p></div><a name="focusOutHandler()"></a><a name="focusOutHandler(flash.events.FocusEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusOutHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function focusOutHandler(event:FocusEvent):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> Processes the <code>FocusEvent.FOCUS_OUT</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:FocusEvent</code> — The FocusEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">FocusEvent.FOCUS_OUT</div></div><a name="getContentBounds()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getContentBounds</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getContentBounds():Rectangle</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> Creates a rectangle that shows where the last call to either the <code>compose()</code> |
| method or the <code>updateContainer()</code> method placed the text. |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Rectangle</code> — the bounds of the content |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="TextContainerManager.html#compose()" target="">compose()</a><br/><a href="TextContainerManager.html#updateContainer()" target="">updateContainer()</a></div></div><a name="getFocusedSelectionFormat()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getFocusedSelectionFormat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function getFocusedSelectionFormat():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><p></p><p></p><p> Returns the focusedSelectionFormat - by default get it from the configuration. |
| This can be overridden in the subclass to supply a different SelectionFormat |
| </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/edit/SelectionFormat.html">SelectionFormat</a></code></td></tr></table></div><a name="getInactiveSelectionFormat()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getInactiveSelectionFormat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function getInactiveSelectionFormat():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><p></p><p></p><p> Returns the inactiveSelectionFormat - by default get it from the configuration |
| This can be overridden in the subclass to supply a different SelectionFormat |
| </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/edit/SelectionFormat.html">SelectionFormat</a></code></td></tr></table></div><a name="getLineAt()"></a><a name="getLineAt(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLineAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLineAt(index:int):TextLine</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> Return the TextLine at the index from array of composed lines. |
| </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> — Finds the line at this index position in the text. |
| </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>TextLine</code> — the TextLine that occurs at the specified index. |
| </td></tr></table></div><a name="getScrollDelta()"></a><a name="getScrollDelta(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getScrollDelta</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getScrollDelta(numLines:int):Number</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> |
| Figure out the scroll distance required to scroll up or down by the specified number of lines. |
| Negative numbers scroll upward, bringing more of the top of the TextFlow into view. Positive numbers |
| scroll downward, bringing the next line from the bottom into full view. |
| |
| <p>When scrolling up, for example, the method makes the next line fully visible. If the next line is partially |
| obscured and the number of lines specified is 1, the partially obscured line becomes fully visible.</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">numLines</span>:int</code> — The number of lines to scroll. |
| </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>Number</code> — the delta amount of space to scroll |
| </td></tr></table></div><a name="getText()"></a><a name="getText(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getText</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getText(separator:String = 
):String</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 current text using a separator between paragraphs. |
| The separator can be specified with the <code>separator</code> |
| argument. The default value of the <code>separator</code> argument |
| is the Unicode character <code>'PARAGRAPH SEPARATOR' (U+2029)</code>. |
| <p>Calling the setter discards any attached TextFlow. Any selection is lost.</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">separator</span>:String</code> (default = <code>
</code>)<code></code> — String to set between paragraphs. |
| </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>String</code></td></tr></table></div><a name="getTextFlow()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getTextFlow</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getTextFlow():<a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</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> The current TextFlow. Converts this to a full TextFlow representation if it |
| isn't already one. |
| </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/elements/TextFlow.html">TextFlow</a></code> — the current TextFlow object |
| </td></tr></table></div><a name="getUndoManager()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getUndoManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function getUndoManager():<a href="../../../flashx/undo/IUndoManager.html">IUndoManager</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 undo manager to use. By default, creates a unique undo manager. |
| You can override this method in the subclass if you want to customize the undo manager |
| (for example, to use a shared undo manager for multiple TextContainerManager instances). |
| </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/undo/IUndoManager.html">IUndoManager</a></code> — new IUndoManager instance. |
| </td></tr></table></div><a name="getUnfocusedSelectionFormat()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getUnfocusedSelectionFormat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function getUnfocusedSelectionFormat():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</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 unfocusedSelectionFormat - by default get it from the configuration |
| You can override this method in the subclass to supply a different SelectionFormat. |
| </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/edit/SelectionFormat.html">SelectionFormat</a></code></td></tr></table></div><a name="imeStartCompositionHandler()"></a><a name="imeStartCompositionHandler(flash.events.IMEEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">imeStartCompositionHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function imeStartCompositionHandler(event:IMEEvent):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.1, AIR 1.5</td></tr></table><p></p><p></p><p> Processes the <code>IME_START_COMPOSITION</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:IMEEvent</code> — The IMEEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">IMEEvent.IME_START_COMPOSITION</div></div><a name="invalidateSelectionFormats()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateSelectionFormats</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function invalidateSelectionFormats():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> Call this if you change the selection formats (SelectionFormat) and want the interactionManager |
| to update. |
| |
| </p></div><a name="invalidateUndoManager()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateUndoManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function invalidateUndoManager():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> Call this if you are editing, and want to reset the undo manager used for editing. |
| </p></div><a name="isDamaged()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isDamaged</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function isDamaged():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> Returns <code>true</code> if the content needs composing. |
| |
| </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 the content needs composing; <code>false</code> otherwise. |
| </td></tr></table></div><a name="keyDownHandler()"></a><a name="keyDownHandler(flash.events.KeyboardEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">keyDownHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function keyDownHandler(event:KeyboardEvent):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> Processes the <code>KeyboardEvent.KEY_DOWN</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:KeyboardEvent</code> — KeyboardEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">KeyboardEvent.KEY_DOWN</div></div><a name="keyFocusChangeHandler()"></a><a name="keyFocusChangeHandler(flash.events.FocusEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">keyFocusChangeHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function keyFocusChangeHandler(event:FocusEvent):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> Processes the <code>FocusEvent.KEY_FOCUS_CHANGE</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:FocusEvent</code> — The FocusEvent object. |
| </td></tr></table></p></div><a name="keyUpHandler()"></a><a name="keyUpHandler(flash.events.KeyboardEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">keyUpHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function keyUpHandler(event:KeyboardEvent):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> Processes the <code>Keyboard.KEY_UP</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:KeyboardEvent</code> — The KeyboardEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">KeyboardEvent.KEY_UP</div></div><a name="menuSelectHandler()"></a><a name="menuSelectHandler(flash.events.ContextMenuEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">menuSelectHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function menuSelectHandler(event:ContextMenuEvent):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> |
| Processes the <code>ContextMenuEvent.MENU_SELECT</code> event when the client manages events. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:ContextMenuEvent</code> — ContextMenuEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">ContextMenuEvent.MENU_SELECT</div></div><a name="mouseDoubleClickHandler()"></a><a name="mouseDoubleClickHandler(flash.events.MouseEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseDoubleClickHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseDoubleClickHandler(event:MouseEvent):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> Processes the <code>MouseEvent.DOUBLE_CLICK</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:MouseEvent</code> — The MouseEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">MouseEvent.DOUBLE_CLICK</div></div><a name="mouseDownHandler()"></a><a name="mouseDownHandler(flash.events.MouseEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseDownHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseDownHandler(event:MouseEvent):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> Processes the <code>MouseEvent.MOUSE_DOWN</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:MouseEvent</code> — The MouseEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">MouseEvent.MOUSE_DOWN</div></div><a name="mouseMoveHandler()"></a><a name="mouseMoveHandler(flash.events.MouseEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseMoveHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseMoveHandler(event:MouseEvent):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> |
| Processes the <code>MouseEvent.MOUSE_MOVE</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:MouseEvent</code> — The MouseEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">MouseEvent.MOUSE_MOVE</div></div><a name="mouseMoveSomewhere()"></a><a name="mouseMoveSomewhere(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseMoveSomewhere</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseMoveSomewhere(e:Event):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> Client call to forward a mouseMove event from outside a security sandbox. Coordinates of the mouse move are not needed. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">e</span>:Event</code></td></tr></table></p></div><a name="mouseOutHandler()"></a><a name="mouseOutHandler(flash.events.MouseEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseOutHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseOutHandler(event:MouseEvent):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> Processes the <code>MouseEvent.MOUSE_OUT</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:MouseEvent</code> — The MouseEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">MouseEvent.MOUSE_OUT</div></div><a name="mouseOverHandler()"></a><a name="mouseOverHandler(flash.events.MouseEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseOverHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseOverHandler(event:MouseEvent):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> Process a mouseOver event. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:MouseEvent</code></td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">MouseEvent.MOUSE_OVER</div></div><a name="mouseUpHandler()"></a><a name="mouseUpHandler(flash.events.MouseEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseUpHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseUpHandler(event:MouseEvent):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> |
| Processes the <code>MouseEvent.MOUSE_UP</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:MouseEvent</code> — The MouseEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">MouseEvent.MOUSE_UP</div></div><a name="mouseUpSomewhere()"></a><a name="mouseUpSomewhere(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseUpSomewhere</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseUpSomewhere(e:Event):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> Client call to forward a mouseUp event from outside a security sandbox. Coordinates of the mouse up are not needed. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">e</span>:Event</code></td></tr></table></p></div><a name="mouseWheelHandler()"></a><a name="mouseWheelHandler(flash.events.MouseEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseWheelHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function mouseWheelHandler(event:MouseEvent):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> Processes the <code>MouseEvent.MOUSE_WHEEL</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:MouseEvent</code> — The MouseEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">MouseEvent.MOUSE_WHEEL</div></div><a name="resetLine()"></a><a name="resetLine(flash.text.engine.TextLine)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">resetLine</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function resetLine(textLine:TextLine):void</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">textLine</span>:TextLine</code></td></tr></table></p></div><a name="scrollToRange()"></a><a name="scrollToRange(int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scrollToRange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function scrollToRange(activePosition:int, anchorPosition: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> |
| Scrolls so that the text range is visible in the container. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">activePosition</span>:int</code> — The end of the selection that is changed when you extend the selection. It can be |
| either the start or the end of the selection, expressed as an offset from the start of the text flow. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">anchorPosition</span>:int</code> — The stable end of the selection when you extend the selection. It can be either |
| the start or the end of the selection. |
| </td></tr></table></p></div><a name="setText()"></a><a name="setText(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setText</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setText(text:String):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 <code>text</code> property to the specified String. |
| Discards any attached TextFlow. Any selection is lost. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">text</span>:String</code> — the String to set |
| </td></tr></table></p></div><a name="setTextFlow()"></a><a name="setTextFlow(flashx.textLayout.elements.TextFlow)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setTextFlow</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setTextFlow(textFlow:<a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</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> Sets a TextFlow into this TextContainerManager replacing any existing TextFlow and discarding the |
| current text. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">textFlow</span>:<a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></code></td></tr></table></p></div><a name="softKeyboardActivatingHandler()"></a><a name="softKeyboardActivatingHandler(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">softKeyboardActivatingHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function softKeyboardActivatingHandler(event:Event):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.2, AIR 1.5</td></tr></table><p></p><p></p><p> Processes the <code>SOFT_KEYBOARD_ACTIVATING</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code> — The SoftKeyboardEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING</div></div><a name="textInputHandler()"></a><a name="textInputHandler(flash.events.TextEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textInputHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function textInputHandler(event:TextEvent):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> Processes the <code>TextEvent.TEXT_INPUT</code> event when the client manages events. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:TextEvent</code> — The TextEvent object. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">TextEvent.TEXT_INPUT</div></div><a name="updateContainer()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateContainer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function updateContainer():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> Updates the display; calls either the factory or updateAllControllers(). |
| |
| </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><div class="detailSectionHeader"> Event Detail </div><a name="event:click"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">click</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowElementMouseEvent.html"><code>flashx.textLayout.events.FlowElementMouseEvent</code></a><br/><p></p><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> Dispatched when any link is clicked. |
| </p></div><a name="event:compositionComplete"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">compositionComplete</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/CompositionCompleteEvent.html"><code>flashx.textLayout.events.CompositionCompleteEvent</code></a><br/><p></p><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> Dispatched after every recompose. |
| </p></div><a name="event:damage"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">damage</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/DamageEvent.html"><code>flashx.textLayout.events.DamageEvent</code></a><br/><p></p><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> Dispatched by a TextFlow object each time it is damaged |
| </p></div><a name="event:flowOperationBegin"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">flowOperationBegin</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowOperationEvent.html"><code>flashx.textLayout.events.FlowOperationEvent</code></a><br/><span class="label">FlowOperationEvent.type property = </span><a href="../../../flashx/textLayout/events/FlowOperationEvent.html#FLOW_OPERATION_BEGIN"><code>flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_BEGIN</code></a><br/><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> |
| Defines the value of the <code>type</code> property of a <code>flowOperationBegin</code> event object. |
| Dispatched before an operation is executed. Cancelling this event blocks the operation. |
| </div><a name="event:flowOperationComplete"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">flowOperationComplete</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowOperationEvent.html"><code>flashx.textLayout.events.FlowOperationEvent</code></a><br/><span class="label">FlowOperationEvent.type property = </span><a href="../../../flashx/textLayout/events/FlowOperationEvent.html#FLOW_OPERATION_COMPLETE"><code>flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_COMPLETE</code></a><br/><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> |
| Defines the value of the <code>type</code> property of a <code>flowOperationComplete</code> event object. |
| Dispatched after all operations including pending and composite operations are completed, composition is finished and the display is scrolled. |
| </div><a name="event:flowOperationEnd"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">flowOperationEnd</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowOperationEvent.html"><code>flashx.textLayout.events.FlowOperationEvent</code></a><br/><span class="label">FlowOperationEvent.type property = </span><a href="../../../flashx/textLayout/events/FlowOperationEvent.html#FLOW_OPERATION_END"><code>flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_END</code></a><br/><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> |
| Defines the value of the <code>type</code> property of a <code>flowOperationEnd</code> event object. |
| Dispatched after an operation completes. Any errors are stored in <code>OperationEvent.error</code>. |
| If there is an error, cancelling this event blocks the rethrow of the error. |
| Generally speaking all errors are likely to be fatal. |
| <p>Changing an operation at this time (after it has been executed) may fail.</p> |
| </div><a name="event:inlineGraphicStatusChanged"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">inlineGraphicStatusChanged</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/StatusChangeEvent.html"><code>flashx.textLayout.events.StatusChangeEvent</code></a><br/><p></p><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> Dispatched when a InlineGraphicElement is resized due to having width or height as auto or percent |
| and the graphic has finished loading. |
| </p></div><a name="event:mouseDown"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseDown</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowElementMouseEvent.html"><code>flashx.textLayout.events.FlowElementMouseEvent</code></a><br/><p></p><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> Dispatched when the mouse is pressed down over any link. |
| </p></div><a name="event:mouseMove"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseMove</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowElementMouseEvent.html"><code>flashx.textLayout.events.FlowElementMouseEvent</code></a><br/><p></p><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> Dispatched when the mouse passes over any link. |
| </p></div><a name="event:mouseUp"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseUp</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowElementMouseEvent.html"><code>flashx.textLayout.events.FlowElementMouseEvent</code></a><br/><p></p><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> Dispatched when the mouse is released over any link. |
| </p></div><a name="event:rollOut"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rollOut</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowElementMouseEvent.html"><code>flashx.textLayout.events.FlowElementMouseEvent</code></a><br/><p></p><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> Dispatched when the mouse goes out of any link. |
| </p></div><a name="event:rollOver"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rollOver</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/FlowElementMouseEvent.html"><code>flashx.textLayout.events.FlowElementMouseEvent</code></a><br/><p></p><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> Dispatched when the mouse first enters any link. |
| </p></div><a name="event:scroll"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scroll</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/TextLayoutEvent.html"><code>flashx.textLayout.events.TextLayoutEvent</code></a><br/><p></p><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> Dispatched by a TextFlow object after text is scrolled within a controller container. |
| </p></div><a name="event:selectionChange"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectionChange</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/SelectionEvent.html"><code>flashx.textLayout.events.SelectionEvent</code></a><br/><p></p><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> Dispatched whenever the selection is changed. Primarily used to update selection-dependent user interface. |
| </p></div><a name="event:updateComplete"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateComplete</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../../flashx/textLayout/events/UpdateCompleteEvent.html"><code>flashx.textLayout.events.UpdateCompleteEvent</code></a><br/><p></p><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> Dispatched by a TextFlow object each time a container has had new DisplayObjects added or updated as a result of composition. |
| </p></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 --> |
