| <!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="ContainerController,flashx.textLayout.container.ContainerController,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.ContainerController</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 = 'ContainerController - 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.16.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/ContainerController.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">ContainerController</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("ContainerController"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">flashx.textLayout.container</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ContainerController</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ContainerController <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../flashx/textLayout/edit/IInteractionEventHandler.html">IInteractionEventHandler</a>, <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</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> |
| The ContainerController class defines the relationship between a TextFlow object and a container. |
| A TextFlow may have one or more rectangular areas that can hold text; the text is said to be flowing |
| through the containers. Each container is a Sprite that is the parent DisplayObject for the TextLines. |
| Each container has a ContainerController that manages the container; the controller holds the target |
| width and height for the text area, populates the container with TextLines, and handles scrolling. A |
| controller also has a format associated with it that allows some formatting attributes to be applied |
| to the text in the container. This allows, for instance, a TextFlow to have one container where the |
| text appears in a single column, and a second container in the same TextFlow with two column text. Not |
| all formatting attributes that can be applied to the container will affect the text; only the ones that |
| affect container-level layout. The diagram below illustrates the relationship between the TextFlow, |
| its flowComposer, and the display list. |
| |
| <p> |
| <img src="../../../images/textLayout_multiController.gif" alt="IContainerController"></img> |
| </p> |
| |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/compose/IFlowComposer.html" target="">flashx.textLayout.compose.IFlowComposer</a><br/><a href="../../../flashx/textLayout/elements/TextFlow.html" target="">flashx.textLayout.elements.TextFlow</a><br/>flash.text.engine.TextLine</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="#absoluteStart" class="signatureLink">absoluteStart</a> : int<div class="summaryTableDescription">[read-only] |
| Returns the first character in the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#alignmentBaseline" class="signatureLink">alignmentBaseline</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the baseline to which the dominant baseline aligns.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#backgroundAlpha" class="signatureLink">backgroundAlpha</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Alpha (transparency) value for the background (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#backgroundColor" class="signatureLink">backgroundColor</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Background color of the text (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#baselineShift" class="signatureLink">baselineShift</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Amount to shift the baseline from the dominantBaseline value.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#blockProgression" class="signatureLink">blockProgression</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies a vertical or horizontal progression of line placement.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderBottomColor" class="signatureLink">borderBottomColor</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Color of the bottom border (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderBottomPriority" class="signatureLink">borderBottomPriority</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderBottomWidth" class="signatureLink">borderBottomWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Bottom border width in pixels (adopts default value if undefined during cascade) |
| Legal values are numbers from 0 to 128 and FormatValue.INHERIT. |
| Default value is undefined indicating not set. |
| If undefined during the cascade this property will have a value of 0. |
| |
| </div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderLeftColor" class="signatureLink">borderLeftColor</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Color of the left border (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderLeftPriority" class="signatureLink">borderLeftPriority</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderLeftWidth" class="signatureLink">borderLeftWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Left border width in pixels (adopts default value if undefined during cascade) |
| Legal values are numbers from 0 to 128 and FormatValue.INHERIT. |
| Default value is undefined indicating not set. |
| If undefined during the cascade this property will have a value of 0. |
| |
| </div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderRightColor" class="signatureLink">borderRightColor</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Color of the right border (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderRightPriority" class="signatureLink">borderRightPriority</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderRightWidth" class="signatureLink">borderRightWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Right border width in pixels (adopts default value if undefined during cascade) |
| Legal values are numbers from 0 to 128 and FormatValue.INHERIT. |
| Default value is undefined indicating not set. |
| If undefined during the cascade this property will have a value of 0. |
| |
| </div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderTopColor" class="signatureLink">borderTopColor</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Color of the top border (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderTopPriority" class="signatureLink">borderTopPriority</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#borderTopWidth" class="signatureLink">borderTopWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Top border width in pixels (adopts default value if undefined during cascade) |
| Legal values are numbers from 0 to 128 and FormatValue.INHERIT. |
| Default value is undefined indicating not set. |
| If undefined during the cascade this property will have a value of 0. |
| |
| </div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#breakOpportunity" class="signatureLink">breakOpportunity</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls where lines are allowed to break when breaking wrapping text into multiple lines.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#cellPadding" class="signatureLink">cellPadding</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| cellPadding specifies the amount of space between the border of the cell and its contents.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#cellSpacing" class="signatureLink">cellSpacing</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| cellSpacing specifies how much space the user agent should leave between the left side of the table and the left-hand side of the leftmost column, the top of the table and the top side of the topmost row, and so on for the right and bottom of the table.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#cffHinting" class="signatureLink">cffHinting</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The type of CFF hinting used for this text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#clearFloats" class="signatureLink">clearFloats</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls how text wraps around a float.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#color" class="signatureLink">color</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Color of the text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#columnBreakAfter" class="signatureLink">columnBreakAfter</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls column after before the element.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#columnBreakBefore" class="signatureLink">columnBreakBefore</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls column break before the element.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#columnCount" class="signatureLink">columnCount</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Number of text columns (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#columnGap" class="signatureLink">columnGap</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#columnState" class="signatureLink">columnState</a> : <a href="../../../flashx/textLayout/container/ColumnState.html">ColumnState</a><div class="summaryTableDescription">[read-only] |
| Returns a ColumnState object, which describes the number and characteristics of columns in |
| the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#columnWidth" class="signatureLink">columnWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Column width in pixels (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></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">[read-only] |
| Returns the vertical extent allowed for text inside the container.</div></td><td class="summaryTableOwnerCol">ContainerController</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">[read-only] |
| Returns the horizontal extent allowed for text inside the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#computedFormat" class="signatureLink">computedFormat</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription">[read-only] |
| Returns an ITextLayoutFormat instance with the attributes applied to this container, including the attributes inherited from its |
| root element.</div></td><td class="summaryTableOwnerCol">ContainerController</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 display object that holds the text lines for this ContainerController instance.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#containerBreakAfter" class="signatureLink">containerBreakAfter</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls container after before the element.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#containerBreakBefore" class="signatureLink">containerBreakBefore</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls container break before the element.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#containerControllerInitialFormat" class="signatureLink">containerControllerInitialFormat</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#coreStyles" class="signatureLink">coreStyles</a> : Object<div class="summaryTableDescription">[read-only] Returns the coreStyles on this ContainerController.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#digitCase" class="signatureLink">digitCase</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The type of digit case used for this text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#digitWidth" class="signatureLink">digitWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Type of digit width used for this text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#direction" class="signatureLink">direction</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the default bidirectional embedding level of the text in the text block.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#dominantBaseline" class="signatureLink">dominantBaseline</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#firstBaselineOffset" class="signatureLink">firstBaselineOffset</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the baseline position of the first line in the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#flowComposer" class="signatureLink">flowComposer</a> : <a href="../../../flashx/textLayout/compose/IFlowComposer.html">IFlowComposer</a><div class="summaryTableDescription">[read-only] |
| Returns the flow composer object that composes and highlights text into the container that this |
| controller manages.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#fontFamily" class="signatureLink">fontFamily</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The name of the font to use, or a comma-separated list of font names.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#fontLookup" class="signatureLink">fontLookup</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Font lookup to use.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#fontSize" class="signatureLink">fontSize</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The size of the text in pixels.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#fontStyle" class="signatureLink">fontStyle</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Style of text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#fontWeight" class="signatureLink">fontWeight</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Weight of text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#format" class="signatureLink">format</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription"> |
| Stores the ITextLayoutFormat object that contains the attributes for this container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#frame" class="signatureLink">frame</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| frame specifies which sides of the frame surrounding a table will be visible.</div></td><td class="summaryTableOwnerCol">ContainerController</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"> |
| 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">ContainerController</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">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#interactionManager" class="signatureLink">interactionManager</a> : <a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</a><div class="summaryTableDescription">[read-only] |
| The InteractionManager associated with this TextFlow object.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#justificationRule" class="signatureLink">justificationRule</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Rule used to justify text in a paragraph.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#justificationStyle" class="signatureLink">justificationStyle</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The style used for justification of the paragraph.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#kerning" class="signatureLink">kerning</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Kerning adjusts the pixels between certain character pairs to improve readability.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#leadingModel" class="signatureLink">leadingModel</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the leading model, which is a combination of leading basis and leading direction.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#ligatureLevel" class="signatureLink">ligatureLevel</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls which of the ligatures that are defined in the font may be used in the text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#lineBreak" class="signatureLink">lineBreak</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Controls word wrapping within the container (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#lineHeight" class="signatureLink">lineHeight</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Leading controls for the text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#lineThrough" class="signatureLink">lineThrough</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| If true, applies strikethrough, a line drawn through the middle of the text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#linkActiveFormat" class="signatureLink">linkActiveFormat</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Defines the formatting attributes used for links in normal state.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#linkHoverFormat" class="signatureLink">linkHoverFormat</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#linkNormalFormat" class="signatureLink">linkNormalFormat</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Defines the formatting attributes used for links in normal state.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#listAutoPadding" class="signatureLink">listAutoPadding</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#listMarkerFormat" class="signatureLink">listMarkerFormat</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Defines the formatting attributes list markers.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#listStylePosition" class="signatureLink">listStylePosition</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. |
| Default value is undefined indicating not set. |
| If undefined during the cascade this property will inherit its value from an ancestor.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#listStyleType" class="signatureLink">listStyleType</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT. |
| Default value is undefined indicating not set. |
| If undefined during the cascade this property will inherit its value from an ancestor.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#locale" class="signatureLink">locale</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The locale of the text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#marginBottom" class="signatureLink">marginBottom</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| bottom margin in pixels (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#marginLeft" class="signatureLink">marginLeft</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| left margin in pixels(adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#marginRight" class="signatureLink">marginRight</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| right margin in pixels (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#marginTop" class="signatureLink">marginTop</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| top margin in pixels (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#maxCellHeight" class="signatureLink">maxCellHeight</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Maximum height of a table cell.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#minCellHeight" class="signatureLink">minCellHeight</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Minimum height of a table cell.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paddingBottom" class="signatureLink">paddingBottom</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Bottom inset in pixels.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paddingLeft" class="signatureLink">paddingLeft</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Left inset in pixels.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paddingRight" class="signatureLink">paddingRight</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Right inset in pixels.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paddingTop" class="signatureLink">paddingTop</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Top inset in pixels.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paragraphEndIndent" class="signatureLink">paragraphEndIndent</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| A Number that specifies, in pixels, the amount to indent the paragraph's end edge.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paragraphSpaceAfter" class="signatureLink">paragraphSpaceAfter</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| A Number that specifies the amount of space, in pixels, to leave after the paragraph.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paragraphSpaceBefore" class="signatureLink">paragraphSpaceBefore</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| A Number that specifies the amount of space, in pixels, to leave before the paragraph.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#paragraphStartIndent" class="signatureLink">paragraphStartIndent</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| A Number that specifies, in pixels, the amount to indent the paragraph's start edge.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#renderingMode" class="signatureLink">renderingMode</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The rendering mode used for this text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rootElement" class="signatureLink">rootElement</a> : <a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a><div class="summaryTableDescription">[read-only] |
| Returns the root element that appears in the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rules" class="signatureLink">rules</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| rules specifies which rules will appear between cells within a table.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#styleName" class="signatureLink">styleName</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#styles" class="signatureLink">styles</a> : Object<div class="summaryTableDescription">[read-only] Returns the styles on this ContainerController.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#tableColumnWidth" class="signatureLink">tableColumnWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Width of table column specifies a default width for each column spanned by the current COL element.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#tableWidth" class="signatureLink">tableWidth</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Width of table element specifies the desired width of the entire table and is intended for visual user agents.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#tabStops" class="signatureLink">tabStops</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the tab stops associated with the paragraph.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textAlign" class="signatureLink">textAlign</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Alignment of lines in the paragraph relative to the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textAlignLast" class="signatureLink">textAlignLast</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Alignment of the last (or only) line in the paragraph relative to the container in justified text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textAlpha" class="signatureLink">textAlpha</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Alpha (transparency) value for the text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textDecoration" class="signatureLink">textDecoration</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Decoration on text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textFlow" class="signatureLink">textFlow</a> : <a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</a><div class="summaryTableDescription">[read-only] |
| Returns the TextFlow object whose content appears in the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textIndent" class="signatureLink">textIndent</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| A Number that specifies, in pixels, the amount to indent the first line of the paragraph.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textJustify" class="signatureLink">textJustify</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies options for justifying text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textLength" class="signatureLink">textLength</a> : int<div class="summaryTableDescription">[read-only] Returns the total number of characters in the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textRotation" class="signatureLink">textRotation</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Determines the number of degrees to rotate this text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#trackingLeft" class="signatureLink">trackingLeft</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#trackingRight" class="signatureLink">trackingRight</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#typographicCase" class="signatureLink">typographicCase</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| The type of typographic case used for this text.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#userStyles" class="signatureLink">userStyles</a> : Object<div class="summaryTableDescription"> Allows you to read and write user styles on a ContainerController object.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#verticalAlign" class="signatureLink">verticalAlign</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Vertical alignment or justification (adopts default value if undefined during cascade).</div></td><td class="summaryTableOwnerCol">ContainerController</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"> 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">ContainerController</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">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#whiteSpaceCollapse" class="signatureLink">whiteSpaceCollapse</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Collapses or preserves whitespace when importing text into a TextFlow.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#wordSpacing" class="signatureLink">wordSpacing</a> : *<div class="summaryTableDescription"> |
| TextLayoutFormat: |
| Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification.</div></td><td class="summaryTableOwnerCol">ContainerController</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="#ContainerController()" class="signatureLink">ContainerController</a>(container:Sprite, compositionWidth:Number = 100, compositionHeight:Number = 100)</div><div class="summaryTableDescription"> |
| Constructor - creates a ContainerController instance.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#autoScrollIfNecessary()" class="signatureLink">autoScrollIfNecessary</a>(mouseX:int, mouseY:int):void</div><div class="summaryTableDescription"> |
| Handle a scroll event during a "drag" selection.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#clearStyle()" class="signatureLink">clearStyle</a>(styleProp:String):void</div><div class="summaryTableDescription"> Clears the style specified by styleProp from this FlowElement.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dispose()" class="signatureLink">dispose</a>():void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</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">ContainerController</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">ContainerController</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"> Processes the FocusEvent.FOCUS_IN event when the client manages events.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</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"> |
| Returns the area that the text occupies, as reflected by the last compose or update operation.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getStyle()" class="signatureLink">getStyle</a>(styleProp:String):*</div><div class="summaryTableDescription"> Returns the value of the style specified by the styleProp parameter.</div></td><td class="summaryTableOwnerCol">ContainerController</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 IMEEvent.IME_START_COMPOSITION event when the client manages events.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateContents()" class="signatureLink">invalidateContents</a>():void</div><div class="summaryTableDescription"> |
| Marks all the text in this container as needing composing.</div></td><td class="summaryTableOwnerCol">ContainerController</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"> |
| Determines whether the container has text that requires composing.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</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">ContainerController</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">ContainerController</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">ContainerController</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">ContainerController</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">ContainerController</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">ContainerController</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>(event:Event):void</div><div class="summaryTableDescription"> Client call to forward a mouseMove event from outside a security sandbox.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</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"> |
| Processes the MouseEvent.MOUSE_OVER event when the client manages events.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</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>(event:Event):void</div><div class="summaryTableDescription"> Client call to forward a mouseUp event from outside a security sandbox.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</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">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#selectRange()" class="signatureLink">selectRange</a>(anchorIndex:int, activeIndex:int):void</div><div class="summaryTableDescription"> |
| Sets the range of selected text in a component implementing ITextSupport.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setCompositionSize()" class="signatureLink">setCompositionSize</a>(w:Number, h:Number):void</div><div class="summaryTableDescription"> |
| Sets the width and height allowed for text in the container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setStyle()" class="signatureLink">setStyle</a>(styleProp:String, newValue:*):void</div><div class="summaryTableDescription"> |
| Sets the value of the style specified by the styleProp parameter to the value |
| specified by the newValue parameter.</div></td><td class="summaryTableOwnerCol">ContainerController</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 SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING event when the client manages events.</div></td><td class="summaryTableOwnerCol">ContainerController</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">ContainerController</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="#addBackgroundShape()" class="signatureLink">addBackgroundShape</a>(shape:Shape):void</div><div class="summaryTableDescription"> |
| Adds a flash.display.Shape object on which background shapes (such as background color) are drawn.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addInlineGraphicElement()" class="signatureLink">addInlineGraphicElement</a>(parent:DisplayObjectContainer, inlineGraphicElement:DisplayObject, index:int):void</div><div class="summaryTableDescription"> |
| Adds a flash.display.DisplayObject object as a descendant of parent.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addSelectionContainer()" class="signatureLink">addSelectionContainer</a>(selectionContainer:DisplayObjectContainer):void</div><div class="summaryTableDescription"> |
| Adds a flash.display.DisplayObjectContainer object to which selection shapes (such as block selection highlight, cursor etc.) are added.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addTableBlock()" class="signatureLink">addTableBlock</a>(block:<a href="../../../flashx/textLayout/elements/TableBlockContainer.html">TableBlockContainer</a>, index:int):void</div><div class="summaryTableDescription"> |
| Adds a TableBlockContainer object as a descendant of container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addTextLine()" class="signatureLink">addTextLine</a>(textLine:TextLine, index:int):void</div><div class="summaryTableDescription"> |
| Adds a flash.text.engine.TextLine object as a descendant of container.</div></td><td class="summaryTableOwnerCol">ContainerController</td></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 context menu for the ContainerController.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getFirstTextLineChildIndex()" class="signatureLink">getFirstTextLineChildIndex</a>():int</div><div class="summaryTableDescription"> |
| Gets the index at which the first text line must appear in its parent.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeBackgroundShape()" class="signatureLink">removeBackgroundShape</a>(shape:Shape):void</div><div class="summaryTableDescription"> |
| Removes a flash.display.Shape object on which background shapes (such as background color) are drawn.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeInlineGraphicElement()" class="signatureLink">removeInlineGraphicElement</a>(parent:DisplayObjectContainer, inlineGraphicElement:DisplayObject):void</div><div class="summaryTableDescription"> |
| Removes a flash.display.DisplayObject object from its parent.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeSelectionContainer()" class="signatureLink">removeSelectionContainer</a>(selectionContainer:DisplayObjectContainer):void</div><div class="summaryTableDescription"> |
| Removes the flash.display.DisplayObjectContainer object which contains selection shapes (such as block selection highlight, cursor etc.).</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeTableBlock()" class="signatureLink">removeTableBlock</a>(block:<a href="../../../flashx/textLayout/elements/TableBlockContainer.html">TableBlockContainer</a>):void</div><div class="summaryTableDescription"> |
| Removes a TableBlockContainer object from its parent.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeTextLine()" class="signatureLink">removeTextLine</a>(textLine:TextLine):void</div><div class="summaryTableDescription"> |
| Removes a flash.text.engine.TextLine object from its parent.</div></td><td class="summaryTableOwnerCol">ContainerController</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#updateVisibleRectangle()" class="signatureLink">updateVisibleRectangle</a>():void</div><div class="summaryTableDescription"> |
| If scrolling, sets the scroll rectangle to the container rectangle so that any lines that are |
| halfway in view are clipped to the scrollable region.</div></td><td class="summaryTableOwnerCol">ContainerController</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="_mouseWheelListenerAttached"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_mouseWheelListenerAttached</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>tlf_internal var _mouseWheelListenerAttached:Boolean = false</code><p></p></div><a name="propertyDetail"></a><a name="absoluteStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">absoluteStart</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>absoluteStart: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> |
| Returns the first character in the container. If this is not the first container in the flow, |
| this value is updated when the text is composed, that is when the IFlowComposer's <code>compose()</code> or |
| <code>updateAllControllers()</code> methods are called. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get absoluteStart():int</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/compose/IFlowComposer.html" target="">flashx.textLayout.compose.IFlowComposer</a></div></div><a name="propertyDetail"></a><a name="alignmentBaseline"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">alignmentBaseline</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>alignmentBaseline:*</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> |
| TextLayoutFormat: |
| Specifies the baseline to which the dominant baseline aligns. For example, if you set <code>dominantBaseline</code> to ASCENT, setting <code>alignmentBaseline</code> to DESCENT aligns the top of the text with the DESCENT baseline, or below the line. The largest element in the line generally determines the baselines.<p><img src="../../../images/textLayout_baselines.jpg" alt="baselines"></img></p> |
| <p>Legal values are TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, TextBaseline.USE_DOMINANT_BASELINE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextBaseline.USE_DOMINANT_BASELINE.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get alignmentBaseline():*</code><br/><code> public function set alignmentBaseline(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.TextBaseline</div></div><a name="propertyDetail"></a><a name="backgroundAlpha"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">backgroundAlpha</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>backgroundAlpha:*</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> |
| TextLayoutFormat: |
| Alpha (transparency) value for the background (adopts default value if undefined during cascade). A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with alpha set to 0 are active, even though they are invisible. |
| <p>Legal values are numbers from 0 to 1 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 1.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get backgroundAlpha():*</code><br/><code> public function set backgroundAlpha(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="backgroundColor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">backgroundColor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>backgroundColor:*</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> |
| TextLayoutFormat: |
| Background color of the text (adopts default value if undefined during cascade). Can be either the constant value <code>BackgroundColor.TRANSPARENT</code>, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. |
| <p>Legal values as a string are BackgroundColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BackgroundColor.TRANSPARENT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get backgroundColor():*</code><br/><code> public function set backgroundColor(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BackgroundColor.html" target="">flashx.textLayout.formats.BackgroundColor</a></div></div><a name="propertyDetail"></a><a name="baselineShift"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">baselineShift</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>baselineShift:*</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> |
| TextLayoutFormat: |
| Amount to shift the baseline from the <code>dominantBaseline</code> value. Units are in pixels, or a percentage of <code>fontSize</code> (in which case, enter a string value, like 140%). Positive values shift the line up for horizontal text (right for vertical) and negative values shift it down for horizontal (left for vertical). |
| <p>Legal values are BaselineShift.SUPERSCRIPT, BaselineShift.SUBSCRIPT, FormatValue.INHERIT.</p> |
| <p>Legal values as a number are from -1000 to 1000.</p> |
| <p>Legal values as a percent are numbers from -1000 to 1000.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get baselineShift():*</code><br/><code> public function set baselineShift(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BaselineShift.html" target="">flashx.textLayout.formats.BaselineShift</a></div></div><a name="propertyDetail"></a><a name="blockProgression"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">blockProgression</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>blockProgression:*</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> |
| TextLayoutFormat: |
| Specifies a vertical or horizontal progression of line placement. |
| Lines are either placed top-to-bottom (<code>BlockProgression.TB</code>, used for horizontal text) or right-to-left (<code>BlockProgression.RL</code>, used for vertical text). |
| <p>Legal values are BlockProgression.RL, BlockProgression.TB, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of BlockProgression.TB.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get blockProgression():*</code><br/><code> public function set blockProgression(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BlockProgression.html" target="">flashx.textLayout.formats.BlockProgression</a></div></div><a name="propertyDetail"></a><a name="borderBottomColor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderBottomColor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderBottomColor:*</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> |
| TextLayoutFormat: |
| Color of the bottom border (adopts default value if undefined during cascade). Can be either the constant value <code>BorderColor.TRANSPARENT</code>, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. |
| <p>Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderBottomColor():*</code><br/><code> public function set borderBottomColor(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BorderColor.html" target="">flashx.textLayout.formats.BorderColor</a></div></div><a name="propertyDetail"></a><a name="borderBottomPriority"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderBottomPriority</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderBottomPriority:*</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> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority. |
| <p>Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit, and default to 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderBottomPriority():*</code><br/><code> public function set borderBottomPriority(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="borderBottomWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderBottomWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderBottomWidth:*</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> |
| TextLayoutFormat: |
| Bottom border width in pixels (adopts default value if undefined during cascade) |
| <p>Legal values are numbers from 0 to 128 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderBottomWidth():*</code><br/><code> public function set borderBottomWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="borderLeftColor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderLeftColor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderLeftColor:*</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> |
| TextLayoutFormat: |
| Color of the left border (adopts default value if undefined during cascade). Can be either the constant value <code>BorderColor.TRANSPARENT</code>, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. |
| <p>Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderLeftColor():*</code><br/><code> public function set borderLeftColor(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BorderColor.html" target="">flashx.textLayout.formats.BorderColor</a></div></div><a name="propertyDetail"></a><a name="borderLeftPriority"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderLeftPriority</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderLeftPriority:*</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> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority. |
| <p>Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit, and default to 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderLeftPriority():*</code><br/><code> public function set borderLeftPriority(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="borderLeftWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderLeftWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderLeftWidth:*</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> |
| TextLayoutFormat: |
| Left border width in pixels (adopts default value if undefined during cascade) |
| <p>Legal values are numbers from 0 to 128 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderLeftWidth():*</code><br/><code> public function set borderLeftWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="borderRightColor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderRightColor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderRightColor:*</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> |
| TextLayoutFormat: |
| Color of the right border (adopts default value if undefined during cascade). Can be either the constant value <code>BorderColor.TRANSPARENT</code>, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. |
| <p>Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderRightColor():*</code><br/><code> public function set borderRightColor(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BorderColor.html" target="">flashx.textLayout.formats.BorderColor</a></div></div><a name="propertyDetail"></a><a name="borderRightPriority"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderRightPriority</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderRightPriority:*</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> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority. |
| <p>Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit, and default to 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderRightPriority():*</code><br/><code> public function set borderRightPriority(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="borderRightWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderRightWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderRightWidth:*</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> |
| TextLayoutFormat: |
| Right border width in pixels (adopts default value if undefined during cascade) |
| <p>Legal values are numbers from 0 to 128 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderRightWidth():*</code><br/><code> public function set borderRightWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="borderTopColor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderTopColor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderTopColor:*</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> |
| TextLayoutFormat: |
| Color of the top border (adopts default value if undefined during cascade). Can be either the constant value <code>BorderColor.TRANSPARENT</code>, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. |
| <p>Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderTopColor():*</code><br/><code> public function set borderTopColor(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BorderColor.html" target="">flashx.textLayout.formats.BorderColor</a></div></div><a name="propertyDetail"></a><a name="borderTopPriority"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderTopPriority</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderTopPriority:*</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> |
| TextLayoutFormat: |
| Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority. |
| <p>Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit, and default to 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderTopPriority():*</code><br/><code> public function set borderTopPriority(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="borderTopWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">borderTopWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>borderTopWidth:*</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> |
| TextLayoutFormat: |
| Top border width in pixels (adopts default value if undefined during cascade) |
| <p>Legal values are numbers from 0 to 128 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get borderTopWidth():*</code><br/><code> public function set borderTopWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="breakOpportunity"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">breakOpportunity</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>breakOpportunity:*</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> |
| TextLayoutFormat: |
| Controls where lines are allowed to break when breaking wrapping text into multiple lines. Set to <code>BreakOpportunity.AUTO</code> to break text normally. Set to <code>BreakOpportunity.NONE</code> to <i>not</i> break the text unless the text would overrun the measure and there are no other places to break the line. Set to <code>BreakOpportunity.ANY</code> to allow the line to break anywhere, rather than just between words. Set to <code>BreakOpportunity.ALL</code> to have each typographic cluster put on a separate line (useful for text on a path). |
| <p>Legal values are BreakOpportunity.ALL, BreakOpportunity.ANY, BreakOpportunity.AUTO, BreakOpportunity.NONE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of BreakOpportunity.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get breakOpportunity():*</code><br/><code> public function set breakOpportunity(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.BreakOpportunity</div></div><a name="propertyDetail"></a><a name="cellPadding"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cellPadding</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>cellPadding:*</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> |
| TextLayoutFormat: |
| cellPadding specifies the amount of space between the border of the cell and its contents. If the value of this attribute is a pixel length, all four margins should be this distance from the contents. If the value of the attribute is a percentage length, the top and bottom margins should be equally separated from the content based on a percentage of the available vertical space, and the left and right margins should be equally separated from the content based on a percentage of the available horizontal space. |
| <p>Legal values as a number are from 0 to 1000.</p> |
| <p>Legal values as a percent are numbers from 0% to 100%.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get cellPadding():*</code><br/><code> public function set cellPadding(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="cellSpacing"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cellSpacing</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>cellSpacing:*</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> |
| TextLayoutFormat: |
| cellSpacing specifies how much space the user agent should leave between the left side of the table and the left-hand side of the leftmost column, the top of the table and the top side of the topmost row, and so on for the right and bottom of the table. The attribute also specifies the amount of space to leave between cells. |
| <p>Legal values are numbers from 0 to 1000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get cellSpacing():*</code><br/><code> public function set cellSpacing(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="cffHinting"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cffHinting</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>cffHinting:*</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> |
| TextLayoutFormat: |
| The type of CFF hinting used for this text. CFF hinting determines whether the Flash runtime forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the <code>renderingMode</code> property is set to <code>RenderingMode.CFF</code>, and the font is embedded (<code>fontLookup</code> property is set to <code>FontLookup.EMBEDDED_CFF</code>). At small screen sizes, hinting produces a clear, legible text for human readers. |
| <p>Legal values are CFFHinting.NONE, CFFHinting.HORIZONTAL_STEM, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of CFFHinting.HORIZONTAL_STEM.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get cffHinting():*</code><br/><code> public function set cffHinting(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.CFFHinting</div></div><a name="propertyDetail"></a><a name="clearFloats"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clearFloats</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>clearFloats:*</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> |
| TextLayoutFormat: |
| Controls how text wraps around a float. A value of none allows the text to wrap most closely around a float. A value of left causes the text to skip over any portion of the container that has a left float, and a value of right causes the text to skip over any portion of the container that has a right float. A value of both causes the text to skip over any floats. |
| <p>Legal values are ClearFloats.START, ClearFloats.END, ClearFloats.LEFT, ClearFloats.RIGHT, ClearFloats.BOTH, ClearFloats.NONE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of ClearFloats.NONE.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get clearFloats():*</code><br/><code> public function set clearFloats(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/ClearFloats.html" target="">flashx.textLayout.formats.ClearFloats</a><br/><a href="../../../flashx/textLayout/formats/ClearFloats.html" target="">flashx.textLayout.formats.ClearFloats</a></div></div><a name="propertyDetail"></a><a name="color"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">color</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>color:*</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> |
| TextLayoutFormat: |
| Color of the text. A hexadecimal number that specifies three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. It can also be enum value {BLACK, GREEN, GRAY, BLUE, SILVER, LIME, OLIVE, WHITE, YELLOW, MAROON, NAVY, RED, PURPLE, TEAL, FUCHSIA, AQUA, MAGENTA, CYAN} |
| <p>Legal values as a string are ColorName.BLACK, ColorName.GREEN, ColorName.GRAY, ColorName.BLUE, ColorName.SILVER, ColorName.LIME, ColorName.OLIVE, ColorName.WHITE, ColorName.YELLOW, ColorName.MAROON, ColorName.NAVY, ColorName.RED, ColorName.PURPLE, ColorName.TEAL, ColorName.FUCHSIA, ColorName.AQUA, ColorName.MAGENTA, ColorName.CYAN, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get color():*</code><br/><code> public function set color(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/ColorName.html" target="">flashx.textLayout.formats.ColorName</a></div></div><a name="propertyDetail"></a><a name="columnBreakAfter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnBreakAfter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>columnBreakAfter:*</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> |
| TextLayoutFormat: |
| Controls column after before the element. |
| <p>Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BreakStyle.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get columnBreakAfter():*</code><br/><code> public function set columnBreakAfter(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BreakStyle.html" target="">flashx.textLayout.formats.BreakStyle</a></div></div><a name="propertyDetail"></a><a name="columnBreakBefore"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnBreakBefore</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>columnBreakBefore:*</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> |
| TextLayoutFormat: |
| Controls column break before the element. |
| <p>Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BreakStyle.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get columnBreakBefore():*</code><br/><code> public function set columnBreakBefore(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BreakStyle.html" target="">flashx.textLayout.formats.BreakStyle</a></div></div><a name="propertyDetail"></a><a name="columnCount"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>columnCount:*</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> |
| TextLayoutFormat: |
| Number of text columns (adopts default value if undefined during cascade). |
| The column number overrides the other column settings. Value is an integer, or <code>FormatValue.AUTO</code> if unspecified. If <code>columnCount</code> is not specified,<code>columnWidth</code> is used to create as many columns as can fit in the container. |
| <p>Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and from ints from 1 to 50.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of FormatValue.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get columnCount():*</code><br/><code> public function set columnCount(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/FormatValue.html" target="">flashx.textLayout.formats.FormatValue</a></div></div><a name="propertyDetail"></a><a name="columnGap"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnGap</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>columnGap:*</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> |
| TextLayoutFormat: |
| Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). |
| Value is a Number |
| <p>Legal values are numbers from 0 to 1000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 20.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get columnGap():*</code><br/><code> public function set columnGap(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="columnState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnState</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>columnState:<a href="../../../flashx/textLayout/container/ColumnState.html">ColumnState</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> |
| Returns a ColumnState object, which describes the number and characteristics of columns in |
| the container. These values are updated when the text is recomposed, either as a result |
| of <code>IFlowComposer.compose()</code> or <code>IFlowComposer.updateAllControllers()</code>. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get columnState():<a href="../../../flashx/textLayout/container/ColumnState.html">ColumnState</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ColumnState.html" target="">ColumnState</a></div></div><a name="propertyDetail"></a><a name="columnWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>columnWidth:*</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> |
| TextLayoutFormat: |
| Column width in pixels (adopts default value if undefined during cascade). |
| If you specify the width of the columns, but not the count, TextLayout will create as many columns of that width as possible, given the container width and <code>columnGap</code> settings. Any remainder space is left after the last column. Value is a Number. |
| <p>Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from 0 to 8000.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of FormatValue.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get columnWidth():*</code><br/><code> public function set columnWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/FormatValue.html" target="">flashx.textLayout.formats.FormatValue</a></div></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><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>compositionHeight:Number</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 vertical extent allowed for text inside the container. The value is specified in pixels. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get compositionHeight():Number</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ContainerController.html#setCompositionSize()" target="">setCompositionSize()</a></div></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> [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 horizontal extent allowed for text inside the container. The value is specified in pixels. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get compositionWidth():Number</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ContainerController.html#setCompositionSize()" target="">setCompositionSize()</a></div></div><a name="propertyDetail"></a><a name="computedFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">computedFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>computedFormat:<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</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> |
| Returns an ITextLayoutFormat instance with the attributes applied to this container, including the attributes inherited from its |
| root element. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get computedFormat():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ContainerController.html#rootElement" target="">rootElement</a></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 display object that holds the text lines for this ContainerController instance. |
| |
| </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#ContainerController()" target="">ContainerController()</a></div></div><a name="propertyDetail"></a><a name="containerBreakAfter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">containerBreakAfter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>containerBreakAfter:*</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> |
| TextLayoutFormat: |
| Controls container after before the element. |
| <p>Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BreakStyle.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get containerBreakAfter():*</code><br/><code> public function set containerBreakAfter(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BreakStyle.html" target="">flashx.textLayout.formats.BreakStyle</a></div></div><a name="propertyDetail"></a><a name="containerBreakBefore"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">containerBreakBefore</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>containerBreakBefore:*</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> |
| TextLayoutFormat: |
| Controls container break before the element. |
| <p>Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of BreakStyle.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get containerBreakBefore():*</code><br/><code> public function set containerBreakBefore(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BreakStyle.html" target="">flashx.textLayout.formats.BreakStyle</a></div></div><a name="propertyDetail"></a><a name="containerControllerInitialFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">containerControllerInitialFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>containerControllerInitialFormat:<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><p></p><br/><span class="label"> Implementation </span><br/><code> public static function get containerControllerInitialFormat():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><code> public static function set containerControllerInitialFormat(value:<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a>):void</code><br/></div><a name="propertyDetail"></a><a name="coreStyles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">coreStyles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>coreStyles:Object</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 <code>coreStyles</code> on this ContainerController. Note that the getter makes a copy of the core |
| styles dictionary. The returned object includes the formats that are defined by TextLayoutFormat and are in TextLayoutFormat.description. The |
| returned object consists of an array of <i>stylename-value</i> pairs. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get coreStyles():Object</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TextLayoutFormat.html" target="">flashx.textLayout.formats.TextLayoutFormat</a></div></div><a name="propertyDetail"></a><a name="digitCase"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">digitCase</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>digitCase:*</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> |
| TextLayoutFormat: |
| The type of digit case used for this text. Setting the value to <code>DigitCase.OLD_STYLE</code> approximates lowercase letterforms with varying ascenders and descenders. The figures are proportionally spaced. This style is only available in selected typefaces, most commonly in a supplemental or expert font. The <code>DigitCase.LINING</code> setting has all-cap height and is typically monospaced to line up in charts.<p><img src="../../../images/textLayout_digitcase.gif" alt="digitCase"></img></p> |
| <p>Legal values are DigitCase.DEFAULT, DigitCase.LINING, DigitCase.OLD_STYLE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DigitCase.DEFAULT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get digitCase():*</code><br/><code> public function set digitCase(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.DigitCase</div></div><a name="propertyDetail"></a><a name="digitWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">digitWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>digitWidth:*</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> |
| TextLayoutFormat: |
| Type of digit width used for this text. This can be <code>DigitWidth.PROPORTIONAL</code>, which looks best for individual numbers, or <code>DigitWidth.TABULAR</code>, which works best for numbers in tables, charts, and vertical rows.<p><img src="../../../images/textLayout_digitwidth.gif" alt="digitWidth"></img></p> |
| <p>Legal values are DigitWidth.DEFAULT, DigitWidth.PROPORTIONAL, DigitWidth.TABULAR, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DigitWidth.DEFAULT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get digitWidth():*</code><br/><code> public function set digitWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.DigitWidth</div></div><a name="propertyDetail"></a><a name="direction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">direction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>direction:*</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> |
| TextLayoutFormat: |
| Specifies the default bidirectional embedding level of the text in the text block. |
| Left-to-right reading order, as in Latin-style scripts, or right-to-left reading order, as in Arabic or Hebrew. This property also affects column direction when it is applied at the container level. Columns can be either left-to-right or right-to-left, just like text. Below are some examples:<p><img src="../../../images/textLayout_direction.gif" alt="direction"></img></p> |
| <p>Legal values are Direction.LTR, Direction.RTL, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Direction.LTR.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get direction():*</code><br/><code> public function set direction(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/Direction.html" target="">flashx.textLayout.formats.Direction</a></div></div><a name="propertyDetail"></a><a name="dominantBaseline"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dominantBaseline</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>dominantBaseline:*</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> |
| TextLayoutFormat: |
| Specifies which element baseline snaps to the <code>alignmentBaseline</code> to determine the vertical position of the element on the line. A value of <code>TextBaseline.AUTO</code> selects the dominant baseline based on the <code>locale</code> property of the parent paragraph. For Japanese and Chinese, the selected baseline value is <code>TextBaseline.IDEOGRAPHIC_CENTER</code>; for all others it is <code>TextBaseline.ROMAN</code>. These baseline choices are determined by the choice of font and the font size.<p><img src="../../../images/textLayout_baselines.jpg" alt="baselines"></img></p> |
| <p>Legal values are FormatValue.AUTO, TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get dominantBaseline():*</code><br/><code> public function set dominantBaseline(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.TextBaseline</div></div><a name="propertyDetail"></a><a name="firstBaselineOffset"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">firstBaselineOffset</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>firstBaselineOffset:*</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> |
| TextLayoutFormat: |
| Specifies the baseline position of the first line in the container. Which baseline this property refers to depends on the container-level locale. For Japanese and Chinese, it is <code>TextBaseline.IDEOGRAPHIC_BOTTOM</code>; for all others it is <code>TextBaseline.ROMAN</code>. |
| The offset from the top inset (or right inset if <code>blockProgression</code> is RL) of the container to the baseline of the first line can be either <code>BaselineOffset.ASCENT</code>, meaning equal to the ascent of the line, <code>BaselineOffset.LINE_HEIGHT</code>, meaning equal to the height of that first line, or any fixed-value number to specify an absolute distance. <code>BaselineOffset.AUTO</code> aligns the ascent of the line with the container top inset.<p><img src="../../../images/textLayout_FBO1.png" alt="firstBaselineOffset1"></img><img src="../../../images/textLayout_FBO2.png" alt="firstBaselineOffset2"></img><img src="../../../images/textLayout_FBO3.png" alt="firstBaselineOffset3"></img><img src="../../../images/textLayout_FBO4.png" alt="firstBaselineOffset4"></img></p> |
| <p>Legal values as a string are BaselineOffset.AUTO, BaselineOffset.ASCENT, BaselineOffset.LINE_HEIGHT, FormatValue.INHERIT and numbers from 0 to 1000.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of BaselineOffset.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get firstBaselineOffset():*</code><br/><code> public function set firstBaselineOffset(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/BaselineOffset.html" target="">flashx.textLayout.formats.BaselineOffset</a></div></div><a name="propertyDetail"></a><a name="flowComposer"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">flowComposer</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>flowComposer:<a href="../../../flashx/textLayout/compose/IFlowComposer.html">IFlowComposer</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> |
| Returns the flow composer object that composes and highlights text into the container that this |
| controller manages. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get flowComposer():<a href="../../../flashx/textLayout/compose/IFlowComposer.html">IFlowComposer</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/compose/IFlowComposer.html" target="">flashx.textLayout.compose.IFlowComposer</a></div></div><a name="propertyDetail"></a><a name="fontFamily"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fontFamily</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>fontFamily:*</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> |
| TextLayoutFormat: |
| The name of the font to use, or a comma-separated list of font names. The Flash runtime renders the element with the first available font in the list. For example Arial, Helvetica, _sans causes the player to search for Arial, then Helvetica if Arial is not found, then _sans if neither is found. |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Arial.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get fontFamily():*</code><br/><code> public function set fontFamily(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="fontLookup"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fontLookup</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>fontLookup:*</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> |
| TextLayoutFormat: |
| Font lookup to use. Specifying <code>FontLookup.DEVICE</code> uses the fonts installed on the system that is running the SWF file. Device fonts result in a smaller movie size, but text is not always rendered the same across different systems and platforms. Specifying <code>FontLookup.EMBEDDED_CFF</code> uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), but text is consistently displayed in the chosen font. |
| <p>Legal values are FontLookup.DEVICE, FontLookup.EMBEDDED_CFF, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontLookup.DEVICE.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get fontLookup():*</code><br/><code> public function set fontLookup(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.FontLookup</div></div><a name="propertyDetail"></a><a name="fontSize"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fontSize</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>fontSize:*</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> |
| TextLayoutFormat: |
| The size of the text in pixels. |
| <p>Legal values are numbers from 1 to 720 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 12.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get fontSize():*</code><br/><code> public function set fontSize(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="fontStyle"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fontStyle</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>fontStyle:*</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> |
| TextLayoutFormat: |
| Style of text. May be <code>FontPosture.NORMAL</code>, for use in plain text, or <code>FontPosture.ITALIC</code> for italic. This property applies only to device fonts (<code>fontLookup</code> property is set to flash.text.engine.FontLookup.DEVICE). |
| <p>Legal values are FontPosture.NORMAL, FontPosture.ITALIC, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontPosture.NORMAL.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get fontStyle():*</code><br/><code> public function set fontStyle(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.FontPosture</div></div><a name="propertyDetail"></a><a name="fontWeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fontWeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>fontWeight:*</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> |
| TextLayoutFormat: |
| Weight of text. May be <code>FontWeight.NORMAL</code> for use in plain text, or <code>FontWeight.BOLD</code>. Applies only to device fonts (<code>fontLookup</code> property is set to flash.text.engine.FontLookup.DEVICE). |
| <p>Legal values are FontWeight.NORMAL, FontWeight.BOLD, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontWeight.NORMAL.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get fontWeight():*</code><br/><code> public function set fontWeight(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.FontWeight</div></div><a name="propertyDetail"></a><a name="format"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">format</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>format:<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</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> |
| Stores the ITextLayoutFormat object that contains the attributes for this container. |
| The controller inherits the container properties from the TextFlow of which it is part. |
| This property allows different controllers in the same text flow to have, for example, |
| different column settings or padding. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get format():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><code> public function set format(value:<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html" target="">flashx.textLayout.formats.ITextLayoutFormat</a></div></div><a name="propertyDetail"></a><a name="frame"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">frame</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>frame:*</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> |
| TextLayoutFormat: |
| frame specifies which sides of the frame surrounding a table will be visible. Possible values: |
| <p>Legal values are TableFrame.VOID, TableFrame.ABOVE, TableFrame.BELOW, TableFrame.HSIDES, TableFrame.VSIDES, TableFrame.LHS, TableFrame.RHS, TableFrame.BOX, TableFrame.BORDER, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of TableFrame.VOID.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get frame():*</code><br/><code> public function set frame(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TableFrame.html" target="">flashx.textLayout.formats.TableFrame</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> |
| 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/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ScrollPolicy.html" target="">ScrollPolicy</a></div></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="interactionManager"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">interactionManager</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>interactionManager:<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</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 InteractionManager associated with this TextFlow object. |
| <p>Controls all selection and editing on the text. If the TextFlow is not selectable, |
| the interactionManager is null. To make the TextFlow editable, assign a interactionManager |
| that is both an ISelectionManager and an IEditManager. To make a TextFlow that is read-only |
| and allows selection, assign a interactionManager that is an ISelectionManager only. </p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get interactionManager():<a href="../../../flashx/textLayout/edit/ISelectionManager.html">ISelectionManager</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/TextFlow.html#interactionManager" target="">flashx.textLayout.elements.TextFlow.interactionManager</a></div></div><a name="propertyDetail"></a><a name="interactiveObjects"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">interactiveObjects</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>interactiveObjects:Dictionary</code> [read-only] <p></p><br/><span class="label"> Implementation </span><br/><code> tlf_internal function get interactiveObjects():Dictionary</code><br/></div><a name="propertyDetail"></a><a name="justificationRule"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">justificationRule</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>justificationRule:*</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> |
| TextLayoutFormat: |
| Rule used to justify text in a paragraph. |
| Default value is <code>FormatValue.AUTO</code>, which justifies text based on the paragraph's <code>locale</code> property. For all languages except Japanese and Chinese, <code>FormatValue.AUTO</code> becomes <code>JustificationRule.SPACE</code>, which adds extra space to the space characters. For Japanese and Chinese, <code>FormatValue.AUTO</code> becomes <code>JustficationRule.EAST_ASIAN</code>. In part, justification changes the spacing of punctuation. In Roman text the comma and Japanese periods take a full character's width but in East Asian text only half of a character's width. Also, in the East Asian text the spacing between sequential punctuation marks becomes tighter, obeying traditional East Asian typographic conventions. Note, too, in the example below the leading that is applied to the second line of the paragraphs. In the East Asian version, the last two lines push left. In the Roman version, the second and following lines push left.<p><img src="../../../images/textLayout_justificationrule.png" alt="justificationRule"></img></p> |
| <p>Legal values are JustificationRule.EAST_ASIAN, JustificationRule.SPACE, FormatValue.AUTO, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get justificationRule():*</code><br/><code> public function set justificationRule(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/JustificationRule.html" target="">flashx.textLayout.formats.JustificationRule</a></div></div><a name="propertyDetail"></a><a name="justificationStyle"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">justificationStyle</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>justificationStyle:*</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> |
| TextLayoutFormat: |
| The style used for justification of the paragraph. Used only in conjunction with a <code>justificationRule</code> setting of <code>JustificationRule.EAST_ASIAN</code>. |
| Default value of <code>FormatValue.AUTO</code> is resolved to <code>JustificationStyle.PUSH_IN_KINSOKU</code> for all locales. The constants defined by the JustificationStyle class specify options for handling kinsoku characters, which are Japanese characters that cannot appear at either the beginning or end of a line. If you want looser text, specify <code>JustificationStyle.PUSH-OUT-ONLY</code>. If you want behavior that is like what you get with the <code>justificationRule</code> of <code>JustificationRule.SPACE</code>, use <code>JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT</code>. |
| <p>Legal values are JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, JustificationStyle.PUSH_IN_KINSOKU, JustificationStyle.PUSH_OUT_ONLY, FormatValue.AUTO, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get justificationStyle():*</code><br/><code> public function set justificationStyle(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.JustificationStyle</div></div><a name="propertyDetail"></a><a name="kerning"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">kerning</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>kerning:*</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> |
| TextLayoutFormat: |
| Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables. |
| <p>Legal values are Kerning.ON, Kerning.OFF, Kerning.AUTO, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Kerning.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get kerning():*</code><br/><code> public function set kerning(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.Kerning</div></div><a name="propertyDetail"></a><a name="leadingModel"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">leadingModel</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>leadingModel:*</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> |
| TextLayoutFormat: |
| Specifies the leading model, which is a combination of leading basis and leading direction. |
| Leading basis is the baseline to which the <code>lineHeight</code> property refers. Leading direction determines whether the <code>lineHeight</code> property refers to the distance of a line's baseline from that of the line before it or the line after it. The default value of <code>FormatValue.AUTO</code> is resolved based on the paragraph's <code>locale</code> property. For Japanese and Chinese, it is <code>LeadingModel.IDEOGRAPHIC_TOP_DOWN</code> and for all others it is <code>LeadingModel.ROMAN_UP</code>.<p><b>Leading Basis:</b></p><p><img src="../../../images/textLayout_LB1.png" alt="leadingBasis1"></img> <img src="../../../images/textLayout_LB2.png" alt="leadingBasis2"></img> <img src="../../../images/textLayout_LB3.png" alt="leadingBasis3"></img></p><p><b>Leading Direction:</b></p><p><img src="../../../images/textLayout_LD1.png" alt="leadingDirection1"></img> <img src="../../../images/textLayout_LD2.png" alt="leadingDirection2"></img> <img src="../../../images/textLayout_LD3.png" alt="leadingDirection3"></img></p> |
| <p>Legal values are LeadingModel.ROMAN_UP, LeadingModel.IDEOGRAPHIC_TOP_UP, LeadingModel.IDEOGRAPHIC_CENTER_UP, LeadingModel.IDEOGRAPHIC_TOP_DOWN, LeadingModel.IDEOGRAPHIC_CENTER_DOWN, LeadingModel.APPROXIMATE_TEXT_FIELD, LeadingModel.ASCENT_DESCENT_UP, LeadingModel.BOX, LeadingModel.AUTO, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LeadingModel.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get leadingModel():*</code><br/><code> public function set leadingModel(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/LeadingModel.html" target="">flashx.textLayout.formats.LeadingModel</a></div></div><a name="propertyDetail"></a><a name="ligatureLevel"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ligatureLevel</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>ligatureLevel:*</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> |
| TextLayoutFormat: |
| Controls which of the ligatures that are defined in the font may be used in the text. The ligatures that appear for each of these settings is dependent on the font. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. They are used with both Latin and Non-Latin character sets. The ligatures enabled by the values of the LigatureLevel class - <code>MINIMUM</code>, <code>COMMON</code>, <code>UNCOMMON</code>, and <code>EXOTIC</code> - are additive. Each value enables a new set of ligatures, but also includes those of the previous types.<p><b>Note: </b>When working with Arabic or Syriac fonts, <code>ligatureLevel</code> must be set to MINIMUM or above.</p><p><img src="../../../images/textLayout_ligatures.png" alt="ligatureLevel"></img></p> |
| <p>Legal values are LigatureLevel.MINIMUM, LigatureLevel.COMMON, LigatureLevel.UNCOMMON, LigatureLevel.EXOTIC, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LigatureLevel.COMMON.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get ligatureLevel():*</code><br/><code> public function set ligatureLevel(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.LigatureLevel</div></div><a name="propertyDetail"></a><a name="lineBreak"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">lineBreak</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>lineBreak:*</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> |
| TextLayoutFormat: |
| Controls word wrapping within the container (adopts default value if undefined during cascade). |
| Text in the container may be set to fit the width of the container (<code>LineBreak.TO_FIT</code>), or can be set to break only at explicit return or line feed characters (<code>LineBreak.EXPLICIT</code>). |
| <p>Legal values are LineBreak.EXPLICIT, LineBreak.TO_FIT, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of LineBreak.TO_FIT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get lineBreak():*</code><br/><code> public function set lineBreak(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/LineBreak.html" target="">flashx.textLayout.formats.LineBreak</a></div></div><a name="propertyDetail"></a><a name="lineHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">lineHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>lineHeight:*</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> |
| TextLayoutFormat: |
| Leading controls for the text. The distance from the baseline of the previous or the next line (based on <code>LeadingModel</code>) to the baseline of the current line is equal to the maximum amount of the leading applied to any character in the line. This is either a number or a percent. If specifying a percent, enter a string value, like 140%.<p><img src="../../../images/textLayout_lineHeight1.jpg" alt="lineHeight1"></img><img src="../../../images/textLayout_lineHeight2.jpg" alt="lineHeight2"></img></p> |
| <p>Legal values as a number are from -720 to 720.</p> |
| <p>Legal values as a percent are numbers from -1000% to 1000%.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 120%.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get lineHeight():*</code><br/><code> public function set lineHeight(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="lineThrough"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">lineThrough</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>lineThrough:*</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> |
| TextLayoutFormat: |
| If <code>true</code>, applies strikethrough, a line drawn through the middle of the text. |
| <p>Legal values are true, false and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of false.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get lineThrough():*</code><br/><code> public function set lineThrough(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="linkActiveFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">linkActiveFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>linkActiveFormat:*</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> |
| TextLayoutFormat: |
| Defines the formatting attributes used for links in normal state. This value will cascade down the hierarchy and apply to any links that are descendants. |
| Accepts <code>inherit</code>, an <code>ITextLayoutFormat</code> or converts an array of objects with key and value as members to a TextLayoutFormat. |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get linkActiveFormat():*</code><br/><code> public function set linkActiveFormat(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="linkHoverFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">linkHoverFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>linkHoverFormat:*</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> |
| TextLayoutFormat: |
| Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. This value will cascade down the hierarchy and apply to any links that are descendants. |
| Accepts <code>inherit</code>, an <code>ITextLayoutFormat</code> or converts an array of objects with key and value as members to a TextLayoutFormat. |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get linkHoverFormat():*</code><br/><code> public function set linkHoverFormat(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="linkNormalFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">linkNormalFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>linkNormalFormat:*</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> |
| TextLayoutFormat: |
| Defines the formatting attributes used for links in normal state. This value will cascade down the hierarchy and apply to any links that are descendants. |
| Accepts <code>inherit</code>, an <code>ITextLayoutFormat</code> or converts an array of objects with key and value as members to a TextLayoutFormat. |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get linkNormalFormat():*</code><br/><code> public function set linkNormalFormat(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="listAutoPadding"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listAutoPadding</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>listAutoPadding:*</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> |
| TextLayoutFormat: |
| This specifies an auto indent for the start edge of lists when the padding value of the list on that side is <code>auto</code>. |
| <p>Legal values are numbers from -1000 to 1000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 40.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get listAutoPadding():*</code><br/><code> public function set listAutoPadding(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="listMarkerFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listMarkerFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>listMarkerFormat:*</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> |
| TextLayoutFormat: |
| Defines the formatting attributes list markers. This value will cascade down the hierarchy and apply to any links that are descendants. |
| Accepts <code>inherit</code>, an <code>IListMarkerFormat</code> or converts an array of objects with key and value as members to a ListMarkerFormat. |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get listMarkerFormat():*</code><br/><code> public function set listMarkerFormat(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="listStylePosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listStylePosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>listStylePosition:*</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> |
| TextLayoutFormat: |
| <p>Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of ListStylePosition.OUTSIDE.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get listStylePosition():*</code><br/><code> public function set listStylePosition(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/ListStylePosition.html" target="">flashx.textLayout.formats.ListStylePosition</a></div></div><a name="propertyDetail"></a><a name="listStyleType"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">listStyleType</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>listStyleType:*</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> |
| TextLayoutFormat: |
| <p>Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of ListStyleType.DISC.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get listStyleType():*</code><br/><code> public function set listStyleType(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/ListStyleType.html" target="">flashx.textLayout.formats.ListStyleType</a></div></div><a name="propertyDetail"></a><a name="locale"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">locale</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>locale:*</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> |
| TextLayoutFormat: |
| The locale of the text. Controls case transformations and shaping. Standard locale identifiers as described in Unicode Technical Standard #35 are used. For example en, en_US and en-US are all English, ja is Japanese. |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of en.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get locale():*</code><br/><code> public function set locale(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="marginBottom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">marginBottom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>marginBottom:*</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> |
| TextLayoutFormat: |
| bottom margin in pixels (adopts default value if undefined during cascade). |
| <p>Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get marginBottom():*</code><br/><code> public function set marginBottom(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="marginLeft"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">marginLeft</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>marginLeft:*</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> |
| TextLayoutFormat: |
| left margin in pixels(adopts default value if undefined during cascade). |
| <p>Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get marginLeft():*</code><br/><code> public function set marginLeft(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="marginRight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">marginRight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>marginRight:*</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> |
| TextLayoutFormat: |
| right margin in pixels (adopts default value if undefined during cascade). |
| <p>Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get marginRight():*</code><br/><code> public function set marginRight(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="marginTop"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">marginTop</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>marginTop:*</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> |
| TextLayoutFormat: |
| top margin in pixels (adopts default value if undefined during cascade). |
| <p>Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get marginTop():*</code><br/><code> public function set marginTop(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="maxCellHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maxCellHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>maxCellHeight:*</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> |
| TextLayoutFormat: |
| Maximum height of a table cell. If there is no maximum, the cell will grow in height to fit the content. Minimum and maximum of the same values will give the cell a fixed height. |
| <p>Legal values as a number are from 2 to 10000.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 2.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get maxCellHeight():*</code><br/><code> public function set maxCellHeight(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="minCellHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">minCellHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>minCellHeight:*</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> |
| TextLayoutFormat: |
| Minimum height of a table cell. If there is no maximum, the cell will grow in height to fit the content. Minimum and maximum of the same values will give the cell a fixed height. |
| <p>Legal values as a number are from 2 to 10000.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 2.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get minCellHeight():*</code><br/><code> public function set minCellHeight(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="oldInteractiveObjects"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">oldInteractiveObjects</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>oldInteractiveObjects:Array</code> [read-only] <p></p><br/><span class="label"> Implementation </span><br/><code> tlf_internal function get oldInteractiveObjects():Array</code><br/></div><a name="propertyDetail"></a><a name="paddingBottom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paddingBottom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paddingBottom:*</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> |
| TextLayoutFormat: |
| Bottom inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). |
| Space between the bottom edge of the container and the text. Value is a Number or auto. <p> With horizontal text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the bottom of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.</p> |
| <p>Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of FormatValue.AUTO.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paddingBottom():*</code><br/><code> public function set paddingBottom(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/Configuration.html#autoListElementStartPadding" target="">flashx.textLayout.elements.Configuration.autoListElementStartPadding</a><br/><a href="../../../flashx/textLayout/formats/FormatValue.html" target="">flashx.textLayout.formats.FormatValue</a></div></div><a name="propertyDetail"></a><a name="paddingLeft"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paddingLeft</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paddingLeft:*</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> |
| TextLayoutFormat: |
| Left inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). |
| Space between the left edge of the container and the text. Value is a Number or auto.<p> With vertical text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the end of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.</p> |
| <p>Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of FormatValue.AUTO.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paddingLeft():*</code><br/><code> public function set paddingLeft(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/Configuration.html#autoListElementStartPadding" target="">flashx.textLayout.elements.Configuration.autoListElementStartPadding</a><br/><a href="../../../flashx/textLayout/formats/FormatValue.html" target="">flashx.textLayout.formats.FormatValue</a></div></div><a name="propertyDetail"></a><a name="paddingRight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paddingRight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paddingRight:*</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> |
| TextLayoutFormat: |
| Right inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). |
| Space between the right edge of the container and the text. Value is a Number or auto. |
| <p>Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of FormatValue.AUTO.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paddingRight():*</code><br/><code> public function set paddingRight(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/Configuration.html#autoListElementStartPadding" target="">flashx.textLayout.elements.Configuration.autoListElementStartPadding</a><br/><a href="../../../flashx/textLayout/formats/FormatValue.html" target="">flashx.textLayout.formats.FormatValue</a></div></div><a name="propertyDetail"></a><a name="paddingTop"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paddingTop</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paddingTop:*</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> |
| TextLayoutFormat: |
| Top inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). |
| Space between the top edge of the container and the text. Value is a Number or auto. |
| <p>Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of FormatValue.AUTO.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paddingTop():*</code><br/><code> public function set paddingTop(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/Configuration.html#autoListElementStartPadding" target="">flashx.textLayout.elements.Configuration.autoListElementStartPadding</a><br/><a href="../../../flashx/textLayout/formats/FormatValue.html" target="">flashx.textLayout.formats.FormatValue</a></div></div><a name="propertyDetail"></a><a name="paragraphEndIndent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paragraphEndIndent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paragraphEndIndent:*</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> |
| TextLayoutFormat: |
| A Number that specifies, in pixels, the amount to indent the paragraph's end edge. Refers to the right edge in left-to-right text and the left edge in right-to-left text. |
| <p>Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paragraphEndIndent():*</code><br/><code> public function set paragraphEndIndent(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="paragraphSpaceAfter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paragraphSpaceAfter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paragraphSpaceAfter:*</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> |
| TextLayoutFormat: |
| A Number that specifies the amount of space, in pixels, to leave after the paragraph. |
| Collapses in tandem with <code>paragraphSpaceBefore</code>. |
| <p>Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paragraphSpaceAfter():*</code><br/><code> public function set paragraphSpaceAfter(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="paragraphSpaceBefore"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paragraphSpaceBefore</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paragraphSpaceBefore:*</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> |
| TextLayoutFormat: |
| A Number that specifies the amount of space, in pixels, to leave before the paragraph. |
| Collapses in tandem with <code>paragraphSpaceAfter</code>. |
| <p>Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paragraphSpaceBefore():*</code><br/><code> public function set paragraphSpaceBefore(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="paragraphStartIndent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">paragraphStartIndent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>paragraphStartIndent:*</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> |
| TextLayoutFormat: |
| A Number that specifies, in pixels, the amount to indent the paragraph's start edge. Refers to the left edge in left-to-right text and the right edge in right-to-left text. |
| <p>Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get paragraphStartIndent():*</code><br/><code> public function set paragraphStartIndent(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="renderingMode"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">renderingMode</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>renderingMode:*</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> |
| TextLayoutFormat: |
| The rendering mode used for this text. Applies only to embedded fonts (<code>fontLookup</code> property is set to <code>FontLookup.EMBEDDED_CFF</code>). |
| <p>Legal values are RenderingMode.NORMAL, RenderingMode.CFF, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of RenderingMode.CFF.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get renderingMode():*</code><br/><code> public function set renderingMode(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.RenderingMode</div></div><a name="propertyDetail"></a><a name="rootElement"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rootElement</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rootElement:<a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a></code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns the root element that appears in the container. The root element could be a DivElement or TextFlow |
| instance, for example. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rootElement():<a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html">ContainerFormattedElement</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/ContainerFormattedElement.html" target="">flashx.textLayout.elements.ContainerFormattedElement</a><br/><a href="../../../flashx/textLayout/elements/DivElement.html" target="">flashx.textLayout.elements.DivElement</a><br/><a href="../../../flashx/textLayout/elements/TextFlow.html" target="">flashx.textLayout.elements.TextFlow</a></div></div><a name="propertyDetail"></a><a name="rules"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rules</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rules:*</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> |
| TextLayoutFormat: |
| rules specifies which rules will appear between cells within a table. The rendering of rules is user agent dependent. Possible values: |
| <p>Legal values are TableRules.NONE, TableRules.GROUPS, TableRules.ROWS, TableRules.COLS, TableRules.ALL, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of TableRules.NONE.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rules():*</code><br/><code> public function set rules(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TableRules.html" target="">flashx.textLayout.formats.TableRules</a></div></div><a name="propertyDetail"></a><a name="styleName"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">styleName</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>styleName:*</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> |
| TextLayoutFormat: |
| Assigns an identifying class to the element, making it possible to set a style for the element by referencing the <code>styleName</code>. |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of null.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get styleName():*</code><br/><code> public function set styleName(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="styles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">styles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>styles:Object</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 styles on this ContainerController. Note that the getter makes a copy of the |
| styles dictionary. The returned object includes all styles set in the format property including core and user styles. The |
| returned object consists of an array of <i>stylename-value</i> pairs. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get styles():Object</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TextLayoutFormat.html" target="">flashx.textLayout.formats.TextLayoutFormat</a></div></div><a name="propertyDetail"></a><a name="tableColumnWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tableColumnWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tableColumnWidth:*</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> |
| TextLayoutFormat: |
| Width of table column specifies a default width for each column spanned by the current COL element. |
| <p>Legal values as a number are from 0 to 8000.</p> |
| <p>Legal values as a percent are numbers from 0% to 100%.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get tableColumnWidth():*</code><br/><code> public function set tableColumnWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="tableWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tableWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tableWidth:*</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> |
| TextLayoutFormat: |
| Width of table element specifies the desired width of the entire table and is intended for visual user agents. When the value is a percentage value, the value is relative to the user agent's available horizontal space. |
| <p>Legal values as a number are from 0 to 8000.</p> |
| <p>Legal values as a percent are numbers from 0% to 100%.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of 100%.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get tableWidth():*</code><br/><code> public function set tableWidth(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="tabStops"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tabStops</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tabStops:*</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> |
| TextLayoutFormat: |
| Specifies the tab stops associated with the paragraph. |
| Setters can take an array of TabStopFormat, a condensed string representation, undefined, or <code>FormatValue.INHERIT</code>. The condensed string representation is always converted into an array of TabStopFormat. <p>The string-based format is a list of tab stops, where each tab stop is delimited by one or more spaces.</p><p>A tab stop takes the following form: <alignment type><alignment position>|<alignment token>.</p><p>The alignment type is a single character, and can be S, E, C, or D (or lower-case equivalents). S or s for start, E or e for end, C or c for center, D or d for decimal. The alignment type is optional, and if its not specified will default to S.</p><p>The alignment position is a Number, and is specified according to FXG spec for Numbers (decimal or scientific notation). The alignment position is required.</p><p>The vertical bar is used to separate the alignment position from the alignment token, and should only be present if the alignment token is present.</p><p> The alignment token is optional if the alignment type is D, and should not be present if the alignment type is anything other than D. The alignment token may be any sequence of characters terminated by the space that ends the tab stop (for the last tab stop, the terminating space is optional; end of alignment token is implied). A space may be part of the alignment token if it is escaped with a backslash (\ ). A backslash may be part of the alignment token if it is escaped with another backslash (\\). If the alignment type is D, and the alignment token is not specified, it will take on the default value of null.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get tabStops():*</code><br/><code> public function set tabStops(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TabStopFormat.html" target="">flashx.textLayout.formats.TabStopFormat</a></div></div><a name="propertyDetail"></a><a name="textAlign"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textAlign</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textAlign:*</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> |
| TextLayoutFormat: |
| Alignment of lines in the paragraph relative to the container. |
| <code>TextAlign.LEFT</code> aligns lines along the left edge of the container. <code>TextAlign.RIGHT</code> aligns on the right edge. <code>TextAlign.CENTER</code> positions the line equidistant from the left and right edges. <code>TextAlign.JUSTIFY</code> spreads the lines out so they fill the space. <code>TextAlign.START</code> is equivalent to setting left in left-to-right text, or right in right-to-left text. <code>TextAlign.END</code> is equivalent to setting right in left-to-right text, or left in right-to-left text. |
| <p>Legal values are TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextAlign.START.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textAlign():*</code><br/><code> public function set textAlign(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TextAlign.html" target="">flashx.textLayout.formats.TextAlign</a></div></div><a name="propertyDetail"></a><a name="textAlignLast"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textAlignLast</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textAlignLast:*</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> |
| TextLayoutFormat: |
| Alignment of the last (or only) line in the paragraph relative to the container in justified text. |
| If <code>textAlign</code> is set to <code>TextAlign.JUSTIFY</code>, <code>textAlignLast</code> specifies how the last line (or only line, if this is a one line block) is aligned. Values are similar to <code>textAlign</code>. |
| <p>Legal values are TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextAlign.START.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textAlignLast():*</code><br/><code> public function set textAlignLast(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TextAlign.html" target="">flashx.textLayout.formats.TextAlign</a></div></div><a name="propertyDetail"></a><a name="textAlpha"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textAlpha</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textAlpha:*</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> |
| TextLayoutFormat: |
| Alpha (transparency) value for the text. A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with <code>textAlpha</code> set to 0 are active, even though they are invisible. |
| <p>Legal values are numbers from 0 to 1 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 1.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textAlpha():*</code><br/><code> public function set textAlpha(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="textDecoration"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textDecoration</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textDecoration:*</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> |
| TextLayoutFormat: |
| Decoration on text. Use to apply underlining; default is none. |
| <p>Legal values are TextDecoration.NONE, TextDecoration.UNDERLINE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextDecoration.NONE.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textDecoration():*</code><br/><code> public function set textDecoration(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TextDecoration.html" target="">flashx.textLayout.formats.TextDecoration</a></div></div><a name="propertyDetail"></a><a name="textFlow"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textFlow</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textFlow:<a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</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> |
| Returns the TextFlow object whose content appears in the container. Either the <code>textFlow</code> and |
| <code>rootElement</code> values are the same, or this is the root element's TextFlow object. For example, |
| if the container's root element is a DivElement, the value would be the TextFlow object to which the |
| DivElement belongs. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textFlow():<a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/elements/TextFlow.html" target="">TextFlow</a></div></div><a name="propertyDetail"></a><a name="textIndent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textIndent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textIndent:*</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> |
| TextLayoutFormat: |
| A Number that specifies, in pixels, the amount to indent the first line of the paragraph. |
| A negative indent will push the line into the margin, and possibly out of the container. |
| <p>Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textIndent():*</code><br/><code> public function set textIndent(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="textJustify"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textJustify</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textJustify:*</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> |
| TextLayoutFormat: |
| Specifies options for justifying text. |
| Default value is <code>TextJustify.INTER_WORD</code>, meaning that extra space is added to the space characters. <code>TextJustify.DISTRIBUTE</code> adds extra space to space characters and between individual letters. Used only in conjunction with a <code>justificationRule</code> value of <code>JustificationRule.SPACE</code>. |
| <p>Legal values are TextJustify.INTER_WORD, TextJustify.DISTRIBUTE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextJustify.INTER_WORD.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textJustify():*</code><br/><code> public function set textJustify(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TextJustify.html" target="">flashx.textLayout.formats.TextJustify</a></div></div><a name="propertyDetail"></a><a name="textLength"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textLength</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textLength: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> Returns the total number of characters in the container. This can include text that is not currently in view, |
| if the container is scrollable. This value is updated when the text is composed (when the IFlowComposer's <code>compose()</code> |
| or <code>updateAllControllers()</code> methods are called). |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textLength():int</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/compose/IFlowComposer.html" target="">flashx.textLayout.compose.IFlowComposer</a></div></div><a name="propertyDetail"></a><a name="textRotation"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textRotation</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textRotation:*</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> |
| TextLayoutFormat: |
| Determines the number of degrees to rotate this text. |
| <p>Legal values are TextRotation.ROTATE_0, TextRotation.ROTATE_180, TextRotation.ROTATE_270, TextRotation.ROTATE_90, TextRotation.AUTO, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextRotation.AUTO.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textRotation():*</code><br/><code> public function set textRotation(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.TextRotation</div></div><a name="propertyDetail"></a><a name="trackingLeft"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">trackingLeft</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>trackingLeft:*</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> |
| TextLayoutFormat: |
| Number in pixels (or percent of <code>fontSize</code>, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. If kerning is enabled, the <code>trackingLeft</code> value is added to the values in the kerning table for the font. If kerning is disabled, the <code>trackingLeft</code> value is used as a manual kerning value. Supports both positive and negative values. |
| <p>Legal values as a number are from -1000 to 1000.</p> |
| <p>Legal values as a percent are numbers from -1000% to 1000%.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get trackingLeft():*</code><br/><code> public function set trackingLeft(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="trackingRight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">trackingRight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>trackingRight:*</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> |
| TextLayoutFormat: |
| Number in pixels (or percent of <code>fontSize</code>, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. If kerning is enabled, the <code>trackingRight</code> value is added to the values in the kerning table for the font. If kerning is disabled, the <code>trackingRight</code> value is used as a manual kerning value. Supports both positive and negative values. |
| <p>Legal values as a number are from -1000 to 1000.</p> |
| <p>Legal values as a percent are numbers from -1000% to 1000%.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get trackingRight():*</code><br/><code> public function set trackingRight(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="propertyDetail"></a><a name="typographicCase"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">typographicCase</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>typographicCase:*</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> |
| TextLayoutFormat: |
| The type of typographic case used for this text. Here are some examples:<p><img src="../../../images/textLayout_typographiccase.png" alt="typographicCase"></img></p> |
| <p>Legal values are TLFTypographicCase.DEFAULT, TLFTypographicCase.CAPS_TO_SMALL_CAPS, TLFTypographicCase.UPPERCASE, TLFTypographicCase.LOWERCASE, TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TLFTypographicCase.DEFAULT.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get typographicCase():*</code><br/><code> public function set typographicCase(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/TLFTypographicCase.html" target="">flashx.textLayout.formats.TLFTypographicCase</a></div></div><a name="propertyDetail"></a><a name="userStyles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">userStyles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>userStyles:Object</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> Allows you to read and write user styles on a ContainerController object. Note that reading this property |
| makes a copy of the userStyles set in the format of this element. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get userStyles():Object</code><br/><code> public function set userStyles(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="usesDiscretionaryHyphens"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">usesDiscretionaryHyphens</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tlf_internal static var usesDiscretionaryHyphens:Boolean = true</code><p></p></div><a name="propertyDetail"></a><a name="verticalAlign"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalAlign</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalAlign:*</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> |
| TextLayoutFormat: |
| Vertical alignment or justification (adopts default value if undefined during cascade). |
| Determines how TextFlow elements align within the container. |
| <p>Legal values are VerticalAlign.TOP, VerticalAlign.MIDDLE, VerticalAlign.BOTTOM, VerticalAlign.JUSTIFY, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will have a value of VerticalAlign.TOP.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get verticalAlign():*</code><br/><code> public function set verticalAlign(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/VerticalAlign.html" target="">flashx.textLayout.formats.VerticalAlign</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> 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/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ScrollPolicy.html" target="">ScrollPolicy</a></div></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="propertyDetail"></a><a name="whiteSpaceCollapse"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">whiteSpaceCollapse</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>whiteSpaceCollapse:*</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> |
| TextLayoutFormat: |
| Collapses or preserves whitespace when importing text into a TextFlow. <code>WhiteSpaceCollapse.PRESERVE</code> retains all whitespace characters. <code>WhiteSpaceCollapse.COLLAPSE</code> removes newlines, tabs, and leading or trailing spaces within a block of imported text. Line break tags () and Unicode line separator characters are retained. |
| <p>Legal values are WhiteSpaceCollapse.PRESERVE, WhiteSpaceCollapse.COLLAPSE, FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of WhiteSpaceCollapse.COLLAPSE.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get whiteSpaceCollapse():*</code><br/><code> public function set whiteSpaceCollapse(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/WhiteSpaceCollapse.html" target="">flashx.textLayout.formats.WhiteSpaceCollapse</a></div></div><a name="propertyDetail"></a><a name="wordSpacing"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">wordSpacing</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>wordSpacing:*</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> |
| TextLayoutFormat: |
| Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. |
| The optimum space is used to indicate the desired size of a space, as a fraction of the value defined in the font. The minimum and maximum values are the used when textJustify is distribute to determine how wide or narrow the spaces between the words may grow before letter spacing is used to justify the line. |
| <p>Legal values as a percent are numbers from -1000% to 1000%.</p> |
| <p>Legal values include FormatValue.INHERIT.</p> |
| <p>Default value is undefined indicating not set.</p> |
| <p>If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 100%, 50%, 150%.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get wordSpacing():*</code><br/><code> public function set wordSpacing(value:any):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>RangeError </code> — when set value is not within range for this property |
| |
| </td></tr></table></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="ContainerController()"></a><a name="ContainerController(flash.display.Sprite,Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ContainerController</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function ContainerController(container:Sprite, compositionWidth:Number = 100, compositionHeight:Number = 100)</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 - creates a ContainerController instance. The ContainerController has a default <code>compositionWidth</code> |
| and <code>compositionHeight</code> so that some text appears in the container if you don't specify its width |
| height. |
| |
| </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">compositionWidth</span>:Number</code> (default = <code>100</code>)<code></code> — The initial width for composing text in the container. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">compositionHeight</span>:Number</code> (default = <code>100</code>)<code></code> — The initial height for composing text in the container. |
| |
| </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="addBackgroundShape()"></a><a name="addBackgroundShape(flash.display.Shape)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addBackgroundShape</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function addBackgroundShape(shape:Shape):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Adds a <code>flash.display.Shape</code> object on which background shapes (such as background color) are drawn. |
| The default implementation of this method, which may be overriden, adds the object to <code>container</code> |
| just before the first <code>flash.text.engine.TextLine</code> child, if one exists, and after the last exisiting |
| child otherwise. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">shape</span>:Shape</code> — <code>flash.display.Shape</code> object to add |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.Shape<br/>flash.text.engine.TextLine<br/><a href="ContainerController.html#container" target="">container</a></div></div><a name="addCellSelections()"></a><a name="addCellSelections(Array,uint,flashx.textLayout.compose.TextFlowTableBlock)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addCellSelections</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> tlf_internal function addCellSelections(cells:Array, color:uint, tableBlock:<a href="../../../flashx/textLayout/compose/TextFlowTableBlock.html">TextFlowTableBlock</a>):void</code><p></p><p></p><p> |
| Add cell selection shapes to the displaylist. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">cells</span>:Array</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">color</span>:uint</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">tableBlock</span>:<a href="../../../flashx/textLayout/compose/TextFlowTableBlock.html">TextFlowTableBlock</a></code></td></tr></table></p></div><a name="addInlineGraphicElement()"></a><a name="addInlineGraphicElement(flash.display.DisplayObjectContainer,flash.display.DisplayObject,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addInlineGraphicElement</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function addInlineGraphicElement(parent:DisplayObjectContainer, inlineGraphicElement:DisplayObject, index:int):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Adds a <code>flash.display.DisplayObject</code> object as a descendant of <code>parent</code>. |
| The default implementation of this method, which may be overriden, adds the object |
| as a direct child of <code>parent</code> at the specified index. This is called to add |
| InlineGraphicElements to the TextLine or 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">parent</span>:DisplayObjectContainer</code> — the <code>flash.display.DisplayObjectContainer</code> object to add the inlineGraphicElement to |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">inlineGraphicElement</span>:DisplayObject</code> — the <code>flash.display.DisplayObject</code> object to add |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> — insertion index of the float in its parent |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.DisplayObjectContainer<br/>flash.display.DisplayObject<br/><a href="ContainerController.html#container" target="">container</a></div></div><a name="addSelectionContainer()"></a><a name="addSelectionContainer(flash.display.DisplayObjectContainer)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addSelectionContainer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function addSelectionContainer(selectionContainer:DisplayObjectContainer):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Adds a <code>flash.display.DisplayObjectContainer</code> object to which selection shapes (such as block selection highlight, cursor etc.) are added. |
| The default implementation of this method, which may be overriden, has the following behavior: |
| The object is added just before first <code>flash.text.engine.TextLine</code> child of <code>container</code> if one exists |
| and the object is opaque and has normal blend mode. |
| In all other cases, it is added as the last child of <code>container</code>. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">selectionContainer</span>:DisplayObjectContainer</code> — <code>flash.display.DisplayObjectContainer</code> object to add |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.DisplayObjectContainer<br/>flash.text.engine.TextLine<br/><a href="ContainerController.html#container" target="">container</a></div></div><a name="addTableBlock()"></a><a name="addTableBlock(flashx.textLayout.elements.TableBlockContainer,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addTableBlock</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function addTableBlock(block:<a href="../../../flashx/textLayout/elements/TableBlockContainer.html">TableBlockContainer</a>, index:int):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Adds a <code>TableBlockContainer</code> object as a descendant of <code>container</code>. |
| The default implementation of this method, which may be overriden, adds the object |
| as a direct child of <code>container</code> at the specified index. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">block</span>:<a href="../../../flashx/textLayout/elements/TableBlockContainer.html">TableBlockContainer</a></code> — the <code>TableBlockContainer</code> object to add |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> — insertion index of the text line in its parent |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso"><a href="ContainerController.html#container" target="">container</a></div></div><a name="addTextLine()"></a><a name="addTextLine(flash.text.engine.TextLine,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addTextLine</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function addTextLine(textLine:TextLine, index:int):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Adds a <code>flash.text.engine.TextLine</code> object as a descendant of <code>container</code>. |
| The default implementation of this method, which may be overriden, adds the object |
| as a direct child of <code>container</code> at the specified index. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">textLine</span>:TextLine</code> — the <code>flash.text.engine.TextLine</code> object to add |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> — insertion index of the text line in its parent |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.TextLine<br/><a href="ContainerController.html#container" target="">container</a></div></div><a name="autoScrollIfNecessary()"></a><a name="autoScrollIfNecessary(int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">autoScrollIfNecessary</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function autoScrollIfNecessary(mouseX:int, mouseY: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> |
| Handle a scroll event during a "drag" selection. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">mouseX</span>:int</code> — The horizontal position of the mouse cursor on the stage. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">mouseY</span>:int</code> — The vertical position of the mouse cursor on the stage. |
| |
| </td></tr></table></p></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="clearStyle()"></a><a name="clearStyle(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clearStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function clearStyle(styleProp: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> Clears the style specified by <code>styleProp</code> from this FlowElement. Sets the value to |
| <code>undefined</code>. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">styleProp</span>:String</code></td></tr></table></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 context menu for the ContainerController. 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></td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">ContextMenu</div></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="dispose()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dispose</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function dispose():void</code><p></p></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="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> Processes the <code>FocusEvent.FOCUS_IN</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_IN</div></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> |
| Returns the area that the text occupies, as reflected by the last compose or update operation. |
| The width and the height might be estimated, if the container is scrollable and the text exceeds the |
| visible area. |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Rectangle</code> — describes the area that the text occupies. |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">Rectangle</div></div><a name="getFirstTextLineChildIndex()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getFirstTextLineChildIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function getFirstTextLineChildIndex():int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Gets the index at which the first text line must appear in its parent. |
| The default implementation of this method, which may be overriden, returns the child index |
| of the first <code>flash.text.engine.TextLine</code> child of <code>container</code> |
| if one exists, and that of the last child of <code>container</code> otherwise. |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>int</code> — the index at which the first text line must appear in its parent. |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.TextLine<br/><a href="ContainerController.html#container" target="">container</a></div></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="getStyle()"></a><a name="getStyle(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getStyle(styleProp: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 value of the style specified by the <code>styleProp</code> parameter. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">styleProp</span>:String</code> — The name of the style property whose value you want. |
| |
| </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>*</code> — The current value for the specified style. |
| |
| </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, AIR 1.5</td></tr></table><p></p><p></p><p> Processes the <code>IMEEvent.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">flash.events.IMEEvent.IME_START_COMPOSITION</div></div><a name="invalidateContents()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateContents</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function invalidateContents():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> |
| Marks all the text in this container as needing composing. |
| |
| </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> |
| Determines whether the container has text that requires 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> — true if the container requires composing. |
| |
| </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><p><span class="label">See also</span></p><div class="seeAlso">FocusEvent.KEY_FOCUS_CHANGE</div></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(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> 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">event</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> |
| Processes the <code>MouseEvent.MOUSE_OVER</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_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(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> 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">event</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="removeBackgroundShape()"></a><a name="removeBackgroundShape(flash.display.Shape)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeBackgroundShape</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function removeBackgroundShape(shape:Shape):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Removes a <code>flash.display.Shape</code> object on which background shapes (such as background color) are drawn. |
| The default implementation of this method, which may be overriden, removes the object from its <code>parent</code>. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">shape</span>:Shape</code> — <code>flash.display.Shape</code> object to remove |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.Shape<br/>flash.text.engine.TextLine<br/><a href="ContainerController.html#container" target="">container</a></div></div><a name="removeInlineGraphicElement()"></a><a name="removeInlineGraphicElement(flash.display.DisplayObjectContainer,flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeInlineGraphicElement</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function removeInlineGraphicElement(parent:DisplayObjectContainer, inlineGraphicElement:DisplayObject):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 2.0</td></tr></table><p></p><p></p><p> |
| Removes a <code>flash.display.DisplayObject</code> object from its parent. |
| The default implementation of this method, which may be overriden, removes the object |
| from <code>container</code> if it is a direct child of the latter. |
| |
| This method may be called even if the object is not a descendant of <code>parent</code>. |
| Any implementation of this method must ensure that no action is taken in this case. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">parent</span>:DisplayObjectContainer</code> — the <code>flash.display.DisplayObject</code> object to remove |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">inlineGraphicElement</span>:DisplayObject</code></td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.DisplayObjectContainer<br/>flash.display.DisplayObject<br/><a href="ContainerController.html#container" target="">container</a></div></div><a name="removeSelectionContainer()"></a><a name="removeSelectionContainer(flash.display.DisplayObjectContainer)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeSelectionContainer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function removeSelectionContainer(selectionContainer:DisplayObjectContainer):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Removes the <code>flash.display.DisplayObjectContainer</code> object which contains selection shapes (such as block selection highlight, cursor etc.). |
| The default implementation of this method, which may be overriden, removes the object from its parent if one exists. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">selectionContainer</span>:DisplayObjectContainer</code> — <code>flash.display.DisplayObjectContainer</code> object to remove |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.DisplayObjectContainer<br/><a href="ContainerController.html#container" target="">container</a></div></div><a name="removeTableBlock()"></a><a name="removeTableBlock(flashx.textLayout.elements.TableBlockContainer)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeTableBlock</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function removeTableBlock(block:<a href="../../../flashx/textLayout/elements/TableBlockContainer.html">TableBlockContainer</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Removes a <code>TableBlockContainer</code> object from its parent. |
| The default implementation of this method, which may be overriden, removes the object |
| from <code>container</code> if it is a direct child of the latter. |
| |
| This method may be called even if the object is not a descendant of <code>container</code>. |
| Any implementation of this method must ensure that no action is taken in this case. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">block</span>:<a href="../../../flashx/textLayout/elements/TableBlockContainer.html">TableBlockContainer</a></code> — the <code>TableBlockContainer</code> object to remove |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso"><a href="ContainerController.html#container" target="">container</a></div></div><a name="removeTextLine()"></a><a name="removeTextLine(flash.text.engine.TextLine)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeTextLine</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function removeTextLine(textLine:TextLine):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Removes a <code>flash.text.engine.TextLine</code> object from its parent. |
| The default implementation of this method, which may be overriden, removes the object |
| from <code>container</code> if it is a direct child of the latter. |
| |
| This method may be called even if the object is not a descendant of <code>container</code>. |
| Any implementation of this method must ensure that no action is taken in this case. |
| |
| </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> — the <code>flash.text.engine.TextLine</code> object to remove |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.TextLine<br/><a href="ContainerController.html#container" target="">container</a></div></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="selectRange()"></a><a name="selectRange(int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectRange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function selectRange(anchorIndex:int, activeIndex: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>AIR 1.0, Flash Player 10.0</td></tr></table><p></p><p></p><p> |
| Sets the range of selected text in a component implementing ITextSupport. |
| If either of the arguments is out of bounds the selection should not be changed. |
| Components which wish to support inline IME should call into this method. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">anchorIndex</span>:int</code> — The zero-based index value of the character at the anchor end of the selection |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">activeIndex</span>:int</code> — The zero-based index value of the character at the active end of the selection. |
| |
| </td></tr></table></p></div><a name="setCompositionSize()"></a><a name="setCompositionSize(Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setCompositionSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setCompositionSize(w:Number, h:Number):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 width and height allowed for text in the container. Width and height can be specified in pixels or <code>NaN</code> can be used for either value. <code>NaN</code> indicates measure that value. |
| This can be used to find the widest line and/or the total height of all the content. When NaN is specified as the width lines are broken with a maximum width of <code>TextLine.MAX_LINE_WIDTH</code>. |
| When <code>NaN</code> is specified as the height the container is assumed to have unlimited height. The actual measured values can be read back in <code>getContentBounds</code>. |
| When the computed <code>blockProgression</code> property of <code>TextFlow</code> |
| is <code>BlockProgression.RL</code> the meanings of width and height are exchanged. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">w</span>:Number</code> — The width in pixels that's available for text in the container. <code>NaN</code> indicates no specified width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">h</span>:Number</code> — The height in pixels that's available for text in the container. <code>NaN</code> indicates no specified height. |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.text.engine.TextLine.MAX_LINE_WIDTH<br/><a href="../../../flashx/textLayout/formats/BlockProgression.html" target="">flashx.textLayout.formats.BlockProgression</a><br/><a href="ContainerController.html#getContentBounds()" target="">getContentBounds()</a></div></div><a name="setStyle()"></a><a name="setStyle(String,any)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setStyle(styleProp:String, newValue:*):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 value of the style specified by the <code>styleProp</code> parameter to the value |
| specified by the <code>newValue</code> parameter. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">styleProp</span>:String</code> — The name of the style property whose value you want to set. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">newValue</span>:*</code> — The value that you want to assign to the style. |
| |
| </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>SoftKeyboardEvent.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="updateGraphics()"></a><a name="updateGraphics(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateGraphics</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> tlf_internal function updateGraphics(updateStart:int):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">updateStart</span>:int</code></td></tr></table></p></div><a name="updateVisibleRectangle()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateVisibleRectangle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function updateVisibleRectangle():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> |
| If scrolling, sets the scroll rectangle to the container rectangle so that any lines that are |
| halfway in view are clipped to the scrollable region. If not scrolling, clear the |
| scroll rectangle so that no clipping occurs. |
| |
| </p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
