| <!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="Configuration,flashx.textLayout.elements.Configuration,ACTIVE,ERROR,FIT_ANY,FIT_DESCENDERS,HOVER,LINK,LOADING,LOAD_PENDING,READY,SHIFT_RETURN_AS_HARD,SHIFT_RETURN_AS_HARD_IN_LIST,SHIFT_RETURN_AS_SOFT,SIZE_PENDING,_textFlow,absoluteEnd,absoluteStart,activeCoordinates,activePosition,actualHeight,actualWidth,alignmentBaseline,anchorCoordinates,anchorPosition,backgroundAlpha,backgroundColor,baselineShift,beyondParcel,blockProgression,borderBottomColor,borderBottomPriority,borderBottomWidth,borderLeftColor,borderLeftPriority,borderLeftWidth,borderRightColor,borderRightPriority,borderRightWidth,borderTopColor,borderTopPriority,borderTopWidth,breakOpportunity,cellPadding,cellSpacing,cellSpacing,cells,cells,cffHinting,clearFloats,colIndex,colIndex,color,column,columnBreakAfter,columnBreakBefore,columnCount,columnGap,columnIndex,columnSpan,columnWidth,composedHeight,computedFormat,computedFormat,computedFormat,configuration,containerBreakAfter,containerBreakBefore,container,controller,coreStyles,cursorFunction,cursorFunction,defaultColumnFormat,defaultConfiguration,defaultLinkActiveFormat,defaultLinkActiveFormat,defaultLinkHoverFormat,defaultLinkHoverFormat,defaultLinkNormalFormat,defaultLinkNormalFormat,defaultListMarkerFormat,defaultListMarkerFormat,defaultRowFormat,defaultShiftEnterLevel,digitCase,digitWidth,direction,dominantBaseline,element,enableAccessibility,enableAccessibility,enableIME,enableIME,enableSearch,firstBaselineOffset,float,flowComposer,flowComposerClass,flowComposerClass,focusedSelectionFormat,focusedSelectionFormat,fontFamily,fontLookup,fontMapperFunction,fontSize,fontStyle,fontWeight,footerRowCount,format,formatResolver,frame,generation,graphic,hasCellDamage,hasTouchScreen,headerRowCount,height,height,height,height,height,hostFormat,href,iMaxRowDepth,id,imeMode,inactiveSelectionFormat,inactiveSelectionFormat,includeDescentInCellBounds,inlineGraphicResolverFunction,inlineGraphicResolverFunction,interactionManager,interactiveChildrenCount,isMaxHeight,justificationRule,justificationStyle,kerning,leadingModel,ligatureLevel,lineBreak,lineHeight,lineThrough,linkActiveFormat,linkHoverFormat,linkNormalFormat,linkState,listAutoPadding,listMarkerFormat,listStylePosition,listStyleType,locale,manageEnterKey,manageEnterKey,manageTabKey,manageTabKey,marginBottom,marginLeft,marginRight,marginTop,maxCellHeight,measuredHeight,measuredWidth,minCellHeight,mxmlChildren,mxmlChildren,numCells,numCells,numCells,numChildren,numColumns,numRows,overflowPolicy,overflowPolicy,paddingBottom,paddingLeft,paddingRight,paddingTop,paragraphEndIndent,paragraphSpaceAfter,paragraphSpaceBefore,paragraphStartIndent,parcelIndex,parcelIndex,parent,parentElement,parentRelativeEnd,parentRelativeStart,parent,releaseLineCreationData,releaseLineCreationData,renderingMode,resolveFontLookupFunction,resourceStringFunction,row,rowIndex,rowIndex,rowSpan,rules,scrollDragDelay,scrollDragDelay,scrollDragPixels,scrollDragPixels,scrollMouseWheelMultiplier,scrollMouseWheelMultiplier,scrollPagePercentage,scrollPagePercentage,shiftEnterLevel,shiftEnterLevel,source,status,styleName,styles,tabStops,table,table,tableBlocks,tableColumnWidth,tableWidth,table,target,terminatorSpan,text,text,textAlign,textAlignLast,textAlpha,textDecoration,textFlow,textFlowInitialFormat,textFlowInitialFormat,textFlow,textIndent,textJustify,textLength,textLength,textLength,textRotation,totalHeight,tracking,trackingLeft,trackingRight,typeName,typographicCase,unfocusedSelectionFormat,unfocusedSelectionFormat,userData,userStyles,verticalAlign,whiteSpaceCollapse,width,width,width,wordSpacing,x,x,x,x,y,y,y,addCell,addCellAt,addCellToBlock,addChild,addChild,addChildAt,addColumn,addColumnAt,addEventListener,addEventListener,addRow,addRowAt,areEqual,clearStyle,clone,clone,clone,compose,composeCells,createColumnElement,createContentElement,createRowElement,damage,decInteractiveChildrenCount,deepCopy,dispatchEvent,dispatchEvent,equalUserStyles,findCell,findChildIndexAtPosition,findLeaf,findLeaf,findNextAtomBoundary,findNextWordBoundary,findPreviousAtomBoundary,findPreviousWordBoundary,getAbsoluteStart,getBackgroundManager,getBodyRows,getCellAt,getCellAt,getCellBlock,getCells,getCells,getCellsArray,getCellsForColumn,getCellsForColumnAt,getCellsForRow,getCellsForRowArray,getCellsForRowAt,getCellsForRowAtArray,getCellsInRange,getCharAtPosition,getCharCodeAtPosition,getChildAt,getChildIndex,getColumnAt,getColumnCount,getColumnWidth,getComposedHeight,getComputedFontMetrics,getElementByID,getElementRelativeStart,getElementRelativeStart,getElementsByStyleName,getElementsByTypeName,getFirstBlock,getFirstLeaf,getFirstLeaf,getFooterHeight,getFooterRows,getHeaderHeight,getHeaderRows,getLastLeaf,getLastLeaf,getNextBlock,getNextCell,getNextCell,getNextLeaf,getNextLeaf,getNextParagraph,getNextRow,getNextSibling,getParagraph,getParagraph,getParentCellElement,getPreviousCell,getPreviousCell,getPreviousLeaf,getPreviousLeaf,getPreviousParagraph,getPreviousSibling,getResolverForNewFlow,getRow,getRowAt,getRowHeight,getRowIndex,getStyle,getTable,getTableBlocksInRange,getTableWidth,getText,getTextBlockAbsoluteStart,getTextBlockStart,getTextBlocks,getTextFlow,getTextFlow,getText,getTotalPaddingHeight,getTotalPaddingWidth,hasEventListener,hasEventListener,hasInteractiveChildren,hasMergedCells,incInteractiveChildrenCount,initialized,insertColumn,insertColumnAt,insertRow,insertRowAt,invalidate,invalidateAll,invalidateAllFormats,isDamaged,isInTable,isValid,nestedInTable,normalizeCells,normalizeColumnWidths,normalizeRange,removeAllRows,removeAllRowsWithContent,removeChild,removeChild,removeChildAt,removeColumn,removeColumnAt,removeColumnWithContent,removeColumnWithContentAt,removeEmptyTerminator,removeEventListener,removeEventListener,removeRow,removeRowAt,removeRowWithContent,removeRowWithContentAt,removed,removed,replaceChildren,replaceText,resolveExplicitFormat,resolveFormat,resolveUserFormat,setBorderColor,setBorderWidth,setColumnWidth,setRowHeight,setStyle,shallowCopy,splitAtIndex,splitAtPosition,splitAtPosition,update,updateAdornments,updateCompositionShapes,updateRange,updateRange,willTrigger,willTrigger"><title>flashx.textLayout.elements.Configuration</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 = 'Configuration - 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/elements/Configuration.html&flashx/textLayout/elements/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">Configuration</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#constantSummary">Constants</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("Configuration"); titleBar_setSubNav(true,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.elements</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Configuration</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Configuration <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/elements/IConfiguration.html">IConfiguration</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 Configuration class is a primary point of integration between the Text Layout Framework and an application. You can |
| include a Configuration object as a parameter to the <code>TextFlow()</code> constructor when you create a new TextFlow |
| instance. It allows the application to initially control how the Text Layout Framework behaves. |
| |
| <p>The Configuration class allows you to specify initial, paragraph and container formats for the text flow |
| through the <code>textFlowInitialFormat</code> property. It also allows you to specify initial format attributes for links, selection, |
| scrolling, and for handling the Tab and Enter keys.</p> |
| |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html" target="">ITextLayoutFormat</a><br/><a href="../../../flashx/textLayout/edit/SelectionFormat.html" target="">SelectionFormat</a><br/><a href="TextFlow.html" target="">TextFlow</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#cursorFunction" class="signatureLink">cursorFunction</a> : Function<div class="summaryTableDescription"> Specifies the callback used for custom cursor.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#defaultLinkActiveFormat" class="signatureLink">defaultLinkActiveFormat</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription"> |
| Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text |
| flow.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#defaultLinkHoverFormat" class="signatureLink">defaultLinkHoverFormat</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription"> |
| Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when |
| the cursor hovers over it.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#defaultLinkNormalFormat" class="signatureLink">defaultLinkNormalFormat</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription"> |
| Specifies the initial link attributes for all LinkElement objects in the text flow.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#defaultListMarkerFormat" class="signatureLink">defaultListMarkerFormat</a> : <a href="../../../flashx/textLayout/formats/IListMarkerFormat.html">IListMarkerFormat</a><div class="summaryTableDescription"> |
| Specifies the active character format attributes that initially apply for all ListItems in the text |
| flow.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#enableAccessibility" class="signatureLink">enableAccessibility</a> : Boolean<div class="summaryTableDescription"> |
| Specifies whether accessibility support is turned on or not.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#flowComposerClass" class="signatureLink">flowComposerClass</a> : Class<div class="summaryTableDescription"> Specifies the type of flow composer to attach to a new TextFlow object by default.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#focusedSelectionFormat" class="signatureLink">focusedSelectionFormat</a> : <a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a><div class="summaryTableDescription"> |
| The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#inactiveSelectionFormat" class="signatureLink">inactiveSelectionFormat</a> : <a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a><div class="summaryTableDescription"> |
| The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#inlineGraphicResolverFunction" class="signatureLink">inlineGraphicResolverFunction</a> : Function<div class="summaryTableDescription"> Specifies the callback used for resolving an inline graphic element.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#manageEnterKey" class="signatureLink">manageEnterKey</a> : Boolean<div class="summaryTableDescription"> |
| Specifies whether the Enter / Return key is entered as text by Text Layout Framework, to split a paragraph for example, |
| or the client code handles it.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#manageTabKey" class="signatureLink">manageTabKey</a> : Boolean<div class="summaryTableDescription"> |
| Specifies whether the TAB key is entered as text by Text Layout Framework, or Flash Player or AIR handles it and |
| turns it into a tabbed panel event.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#overflowPolicy" class="signatureLink">overflowPolicy</a> : String<div class="summaryTableDescription"> |
| Policy used for deciding whether the last line of a container fits in the container, or whether it overflows.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#releaseLineCreationData" class="signatureLink">releaseLineCreationData</a> : Boolean<div class="summaryTableDescription"> Requests that the process of composing text release line creation data after composing each paragraph.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scrollDragDelay" class="signatureLink">scrollDragDelay</a> : Number<div class="summaryTableDescription"> |
| Specifies a timed delay between one scroll and the next to prevent scrolling from going |
| too fast.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scrollDragPixels" class="signatureLink">scrollDragPixels</a> : Number<div class="summaryTableDescription"> Specifies the default number of pixels to scroll when the user initiates auto scrolling by dragging |
| the selection.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scrollMouseWheelMultiplier" class="signatureLink">scrollMouseWheelMultiplier</a> : Number<div class="summaryTableDescription"> Specifies the default number of pixels to scroll for Mouse wheel events.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scrollPagePercentage" class="signatureLink">scrollPagePercentage</a> : Number<div class="summaryTableDescription"> |
| Specifies the default percentage of the text flow to scroll for page scrolls.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#shiftEnterLevel" class="signatureLink">shiftEnterLevel</a> : int<div class="summaryTableDescription"> |
| Determines how shift-enter is treated.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#textFlowInitialFormat" class="signatureLink">textFlowInitialFormat</a> : <a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a><div class="summaryTableDescription"> |
| Specifies the initial format TextLayoutFormat configuration for a text flow (TextFlow object).</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#unfocusedSelectionFormat" class="signatureLink">unfocusedSelectionFormat</a> : <a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a><div class="summaryTableDescription"> |
| The initial selection format that Text Layout Framework uses to draw the selection when the window is active but none of the containers |
| in the TextFlow have focus.</div></td><td class="summaryTableOwnerCol">Configuration</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="#Configuration()" class="signatureLink">Configuration</a>(initializeWithDefaults:Boolean = true)</div><div class="summaryTableDescription"> Constructor - creates a default configuration.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#clone()" class="signatureLink">clone</a>():<a href="../../../flashx/textLayout/elements/Configuration.html">Configuration</a></div><div class="summaryTableDescription"> Creates a clone of the Configuration object.</div></td><td class="summaryTableOwnerCol">Configuration</td></tr></table></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#SHIFT_RETURN_AS_HARD" class="signatureLink">SHIFT_RETURN_AS_HARD</a> : int = 0<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#SHIFT_RETURN_AS_HARD_IN_LIST" class="signatureLink">SHIFT_RETURN_AS_HARD_IN_LIST</a> : int = 1<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">Configuration</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#SHIFT_RETURN_AS_SOFT" class="signatureLink">SHIFT_RETURN_AS_SOFT</a> : int = 2<div class="summaryTableDescription">[static] </div></td><td class="summaryTableOwnerCol">Configuration</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="cursorFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cursorFunction</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>cursorFunction:Function</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> Specifies the callback used for custom cursor. |
| The callback takes a <code>String</code> object, string is cursor name and returns the value to |
| be used in MouseCursor.cursor. |
| |
| This callback provides the user to customize the cursor |
| |
| |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get cursorFunction():Function</code><br/><code> public function set cursorFunction(value:Function):void</code><br/></div><a name="propertyDetail"></a><a name="defaultLinkActiveFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">defaultLinkActiveFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>defaultLinkActiveFormat:<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> |
| Specifies the active character format attributes that initially apply for all links (LinkElement objects) in the text |
| flow. These are defaults for new LinkElement objects that don't specify values for these attributes. |
| |
| <p>Default is <code>null</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get defaultLinkActiveFormat():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><code> public function set defaultLinkActiveFormat(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="FlowElement.html#linkActiveFormat" target="">FlowElement.linkActiveFormat</a><br/><a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html" target="">ITextLayoutFormat</a><br/><a href="LinkElement.html" target="">LinkElement</a></div></div><a name="propertyDetail"></a><a name="defaultLinkHoverFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">defaultLinkHoverFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>defaultLinkHoverFormat:<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> |
| Specifies the initial character format attributes that apply to a link (LinkElement) in the text flow when |
| the cursor hovers over it. These are defaults for new LinkElement objects that don't specify values |
| for these attributes. |
| |
| <p>Default is <code>null</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get defaultLinkHoverFormat():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><code> public function set defaultLinkHoverFormat(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="FlowElement.html#linkHoverFormat" target="">FlowElement.linkHoverFormat</a><br/><a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html" target="">ITextLayoutFormat</a><br/><a href="LinkElement.html" target="">LinkElement</a></div></div><a name="propertyDetail"></a><a name="defaultLinkNormalFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">defaultLinkNormalFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>defaultLinkNormalFormat:<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> |
| Specifies the initial link attributes for all LinkElement objects in the text flow. These are default |
| values for new LinkElement objects that don't specify values for these attributes. |
| |
| The default normal format displays the link in blue with underlining. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get defaultLinkNormalFormat():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><code> public function set defaultLinkNormalFormat(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="FlowElement.html#linkNormalFormat" target="">FlowElement.linkNormalFormat</a><br/><a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html" target="">ITextLayoutFormat</a><br/><a href="LinkElement.html" target="">LinkElement</a></div></div><a name="propertyDetail"></a><a name="defaultListMarkerFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">defaultListMarkerFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>defaultListMarkerFormat:<a href="../../../flashx/textLayout/formats/IListMarkerFormat.html">IListMarkerFormat</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> |
| Specifies the active character format attributes that initially apply for all ListItems in the text |
| flow. These are defaults for new ListItemElements objects that don't specify values for these attributes. |
| |
| <p>Default is <code>null</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get defaultListMarkerFormat():<a href="../../../flashx/textLayout/formats/IListMarkerFormat.html">IListMarkerFormat</a></code><br/><code> public function set defaultListMarkerFormat(value:<a href="../../../flashx/textLayout/formats/IListMarkerFormat.html">IListMarkerFormat</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="FlowElement.html#listMarkerFormat" target="">FlowElement.listMarkerFormat</a><br/><a href="../../../flashx/textLayout/formats/IListMarkerFormat.html" target="">IListMarkerFormat</a><br/><a href="LinkElement.html" target="">LinkElement</a></div></div><a name="propertyDetail"></a><a name="defaultShiftEnterLevel"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">defaultShiftEnterLevel</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tlf_internal static var defaultShiftEnterLevel:int = 2</code><p></p></div><a name="propertyDetail"></a><a name="enableAccessibility"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">enableAccessibility</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>enableAccessibility: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> |
| Specifies whether accessibility support is turned on or not. If <code>true</code>, screen readers can read the TextFlow contents. |
| |
| <p>Default value is <code>false</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get enableAccessibility():Boolean</code><br/><code> public function set enableAccessibility(value:Boolean):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="TextFlow.html" target="">TextFlow</a></div></div><a name="propertyDetail"></a><a name="flowComposerClass"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">flowComposerClass</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>flowComposerClass:Class</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 type of flow composer to attach to a new TextFlow object by default. Default value is StandardFlowComposer. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get flowComposerClass():Class</code><br/><code> public function set flowComposerClass(value:Class):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/compose/StandardFlowComposer.html" target="">StandardFlowComposer</a><br/><a href="TextFlow.html" target="">TextFlow</a></div></div><a name="propertyDetail"></a><a name="focusedSelectionFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusedSelectionFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>focusedSelectionFormat:<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window has focus. |
| Text Layout Framework uses <code>focusedSelectionFormat</code> to draw the selection when the window is active and one of |
| the containers in the TextFlow has focus. You can override this format using |
| <code>SelectionManager.focusedSelectionFormat</code>, if desired. |
| |
| <p>The SelectionFormat class specifies the default values, which invert the color of the text and its background.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get focusedSelectionFormat():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><br/><code> public function set focusedSelectionFormat(value:<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/SelectionFormat.html" target="">SelectionFormat</a><br/><a href="../../../flashx/textLayout/edit/SelectionManager.html#focusedSelectionFormat" target="">SelectionManager.focusedSelectionFormat</a><br/><a href="TextFlow.html" target="">TextFlow</a></div></div><a name="propertyDetail"></a><a name="inactiveSelectionFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">inactiveSelectionFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>inactiveSelectionFormat:<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| The initial selection format (SelectionFormat) for a text flow (TextFlow) when its window is inactive. Text Layout Framework uses |
| <code>inactiveSelectionFormat</code> for drawing the selection when the window is inactive. You can override |
| this format using <code>SelectionManager.inactiveSelectionFormat</code>, if desired. |
| |
| <p>If you do not override <code>unfocusedSelectionFormat</code> the SelectionFormat values used are:</p> |
| <ul> |
| <li><code>color = 0xffffff</code> (white)</li> |
| <li><code>alpha = 0</code></li> |
| <li><code>blendMode = flash.display.BlendMode.DIFFERENCE</code></li> |
| </ul> |
| <p>The result is no selection is displayed.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get inactiveSelectionFormat():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><br/><code> public function set inactiveSelectionFormat(value:<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/SelectionFormat.html" target="">SelectionFormat</a><br/><a href="../../../flashx/textLayout/edit/SelectionManager.html#inactiveSelectionFormat" target="">SelectionManager.inactiveSelectionFormat</a><br/><a href="TextFlow.html" target="">TextFlow</a></div></div><a name="propertyDetail"></a><a name="inlineGraphicResolverFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">inlineGraphicResolverFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>inlineGraphicResolverFunction:Function</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 callback used for resolving an inline graphic element. |
| The callback takes a <code>flashx.textLayout.elements.InlineGraphicElement</code> object and returns |
| the value to be used as the element's <code>flashx.textLayout.elements.InlineGraphicElement#source</code>. |
| |
| This callback provides the mechanism to delay providing an inline graphic element's source until just before it is composed. |
| <p><b>Note:</b> this callback will be invoked only if a |
| placeholder source of String type is already set. Moreover, it may be invoked |
| multiple times. </p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get inlineGraphicResolverFunction():Function</code><br/><code> public function set inlineGraphicResolverFunction(value:Function):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="InlineGraphicElement.html" target="">InlineGraphicElement</a></div></div><a name="propertyDetail"></a><a name="manageEnterKey"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">manageEnterKey</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>manageEnterKey: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> |
| Specifies whether the Enter / Return key is entered as text by Text Layout Framework, to split a paragraph for example, |
| or the client code handles it. The client code might handle it by committing a form that has a default button |
| for that purpose, for example. |
| |
| <p>Default value is <code>true</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get manageEnterKey():Boolean</code><br/><code> public function set manageEnterKey(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="manageTabKey"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">manageTabKey</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>manageTabKey: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> |
| Specifies whether the TAB key is entered as text by Text Layout Framework, or Flash Player or AIR handles it and |
| turns it into a tabbed panel event. |
| |
| <p>Default value is <code>false</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get manageTabKey():Boolean</code><br/><code> public function set manageTabKey(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="overflowPolicy"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">overflowPolicy</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>overflowPolicy: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> |
| Policy used for deciding whether the last line of a container fits in the container, or whether it overflows. |
| Use the constants of the OverflowPolicy class to set this property. |
| |
| <p>Default value is OverflowPolicy.FIT_DESCENDERS, which fits the line in the composition area if the area |
| from the top to the baseline fits.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get overflowPolicy():String</code><br/><code> public function set overflowPolicy(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="OverflowPolicy.html" target="">OverflowPolicy</a></div></div><a name="propertyDetail"></a><a name="releaseLineCreationData"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">releaseLineCreationData</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>releaseLineCreationData: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> Requests that the process of composing text release line creation data after composing each paragraph. |
| This request saves memory but slows down the composing process. |
| |
| <p>Default value is <code>false</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get releaseLineCreationData():Boolean</code><br/><code> public function set releaseLineCreationData(value:Boolean):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/compose/StandardFlowComposer.html" target="">StandardFlowComposer</a><br/>TextBlock.releaseLineCreationData()</div></div><a name="propertyDetail"></a><a name="scrollDragDelay"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scrollDragDelay</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scrollDragDelay: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 a timed delay between one scroll and the next to prevent scrolling from going |
| too fast. This value specifies what the delay is in milliseconds. The default value is 35. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get scrollDragDelay():Number</code><br/><code> public function set scrollDragDelay(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="scrollDragPixels"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scrollDragPixels</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scrollDragPixels: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 default number of pixels to scroll when the user initiates auto scrolling by dragging |
| the selection. Default value is 20. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get scrollDragPixels():Number</code><br/><code> public function set scrollDragPixels(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="scrollMouseWheelMultiplier"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scrollMouseWheelMultiplier</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scrollMouseWheelMultiplier: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 default number of pixels to scroll for Mouse wheel events. Default value is 20. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get scrollMouseWheelMultiplier():Number</code><br/><code> public function set scrollMouseWheelMultiplier(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="scrollPagePercentage"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scrollPagePercentage</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scrollPagePercentage: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 default percentage of the text flow to scroll for page scrolls. Default value is |
| 7.0 / 8.0, or .875. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get scrollPagePercentage():Number</code><br/><code> public function set scrollPagePercentage(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="shiftEnterLevel"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">shiftEnterLevel</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>shiftEnterLevel: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> |
| Determines how shift-enter is treated. Shift-enter can be treated as a soft return or hard return. |
| There are three possible levels. Level 0 means all shift-returns will be hard returns. |
| Level 1 means shift-returns inside lists will be treated as hard returns. Otherwise they will be treated as hard returns. |
| Level 2 means all shift-returns will be treated as soft returns. |
| |
| <p>Default value is <code>2</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get shiftEnterLevel():int</code><br/><code> public function set shiftEnterLevel(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="textFlowInitialFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textFlowInitialFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>textFlowInitialFormat:<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> |
| Specifies the initial format TextLayoutFormat configuration for a text flow (TextFlow object). |
| |
| <p>Default is <code>null</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get textFlowInitialFormat():<a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html">ITextLayoutFormat</a></code><br/><code> public function set textFlowInitialFormat(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="TextFlow.html" target="">TextFlow</a><br/><a href="../../../flashx/textLayout/formats/ITextLayoutFormat.html" target="">ITextLayoutFormat</a></div></div><a name="propertyDetail"></a><a name="unfocusedSelectionFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">unfocusedSelectionFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>unfocusedSelectionFormat:<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| The initial selection format that Text Layout Framework uses to draw the selection when the window is active but none of the containers |
| in the TextFlow have focus. You can override this format using <code>SelectionManager.unfocusedSelectionFormat</code>, if desired. |
| |
| <p>If you do not override <code>unfocusedSelectionFormat</code> the SelectionFormat values used are:</p> |
| |
| <ul> |
| <li><code>color = 0xffffff</code> (white)</li> |
| <li><code>alpha = 0</code></li> |
| <li><code>blendMode = flash.display.BlendMode.DIFFERENCE</code></li> |
| </ul> |
| <p>The result is no selection is displayed.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get unfocusedSelectionFormat():<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a></code><br/><code> public function set unfocusedSelectionFormat(value:<a href="../../../flashx/textLayout/edit/SelectionFormat.html">SelectionFormat</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/SelectionFormat.html" target="">SelectionFormat</a><br/><a href="../../../flashx/textLayout/edit/SelectionManager.html#unfocusedSelectionFormat" target="">SelectionManager.unfocusedSelectionFormat</a><br/><a href="TextFlow.html" target="">TextFlow</a></div></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="Configuration()"></a><a name="Configuration(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">Configuration</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function Configuration(initializeWithDefaults:Boolean = true)</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 default configuration. |
| |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">initializeWithDefaults</span>:Boolean</code> (default = <code>true</code>)<code></code> — Specifies whether to initialize the configuration with |
| the default values. Default is <code>true</code>. If set to <code>false</code>, initializes |
| without default values, thereby saving some objects. The <code>clone()</code> method sets this |
| to <code>false</code> and copies the properties from the original object. |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/SelectionFormat.html" target="">SelectionFormat</a><br/><a href="../../../flashx/textLayout/compose/StandardFlowComposer.html" target="">StandardFlowComposer</a></div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="clone()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clone</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function clone():<a href="../../../flashx/textLayout/elements/Configuration.html">Configuration</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> Creates a clone of the Configuration object. |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../../flashx/textLayout/elements/Configuration.html">Configuration</a></code></td></tr></table></div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="hasTouchScreen"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasTouchScreen</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>tlf_internal static const hasTouchScreen:Boolean</code><p></p></div><a name="constantDetail"></a><a name="SHIFT_RETURN_AS_HARD"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">SHIFT_RETURN_AS_HARD</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const SHIFT_RETURN_AS_HARD:int = 0</code><p></p></div><a name="constantDetail"></a><a name="SHIFT_RETURN_AS_HARD_IN_LIST"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">SHIFT_RETURN_AS_HARD_IN_LIST</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const SHIFT_RETURN_AS_HARD_IN_LIST:int = 1</code><p></p></div><a name="constantDetail"></a><a name="SHIFT_RETURN_AS_SOFT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">SHIFT_RETURN_AS_SOFT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const SHIFT_RETURN_AS_SOFT:int = 2</code><p></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 --> |
