| <!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="IEditableText,spark.core.IEditableText,ALPHA,AUTO,CLIP,DOWN,END,HOME,LEFT,LUMINOSITY,NEVER,OWNS_SHARED_OBJECT,OWNS_UNSHARED_OBJECT,PAGE_DOWN,PAGE_LEFT,PAGE_RIGHT,PAGE_UP,RIGHT,UNTRUSTED,UP,USES_SHARED_OBJECT,accessibilityProperties,activeRequests,baseline,baselinePosition,blendMode,bottom,cacheEntries,cachedData,clipAndEnableScrolling,complete,content,contentHeight,contentWidth,depth,designLayer,displayAsPassword,displayObject,displayObjectSharingMode,editable,enableCaching,enableQueueing,enabled,focusEnabled,hasLayoutMatrix3D,horizontalCenter,horizontalScrollPosition,horizontalScrollPosition,id,includeInLayout,is3D,isTruncated,layoutDirection,left,lineBreak,luminosityClip,luminosityInvert,mask,maskType,maxActiveRequests,maxCacheEntries,maxChars,moduleFactory,multiline,numCacheEntries,owner,percentHeight,percentWidth,postLayoutTransformOffsets,priorityGroup,redrawRequested,requestQueue,restrict,right,rotationX,rotationY,selectable,selectionActivePosition,selectionAnchorPosition,tabIndex,text,top,transformX,transformY,transformZ,verticalCenter,verticalScrollPosition,verticalScrollPosition,viewHeight,viewWidth,visible,addCacheEntry,appendText,canShareWithNext,canShareWithPrevious,createDisplayObject,getBoundsXAtSize,getBoundsYAtSize,getCacheEntry,getHorizontalScrollPositionDelta,getLayoutBoundsHeight,getLayoutBoundsWidth,getLayoutBoundsX,getLayoutBoundsY,getLayoutMatrix,getLayoutMatrix3D,getMaxBoundsHeight,getMaxBoundsWidth,getMinBoundsHeight,getMinBoundsWidth,getPreferredBoundsHeight,getPreferredBoundsWidth,getVerticalScrollPositionDelta,initialized,insertText,invalidateGraphicElementDisplayList,invalidateGraphicElementProperties,invalidateGraphicElementSharing,invalidateGraphicElementSize,invalidateLayoutDirection,invalidateParentSizeAndDisplayList,isNavigationUnit,keepSoftKeyboardActive,load,load,parentChanged,prepareForTouchScroll,prioritize,removeAllCacheEntries,removeAllQueueEntries,removeCacheEntry,scrollToRange,selectAll,selectRange,setFocus,setLayoutBoundsPosition,setLayoutBoundsSize,setLayoutMatrix,setLayoutMatrix3D,setSharedDisplayObject,transformAround,transformHeightForLayout,transformPointToParent,transformWidthForLayout,validateDisplayList,validateProperties,validateSize"><title>spark.core.IEditableText</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 = 'IEditableText - 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?spark/core/IEditableText.html&spark/core/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">IEditableText</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("IEditableText"); 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')">spark.core</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IEditableText extends <a href="../../spark/core/IDisplayText.html">IDisplayText</a>, flash.events.IEventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../spark/components/RichEditableText.html">RichEditableText</a>, <a href="../../spark/components/supportClasses/StyleableTextField.html">StyleableTextField</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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p></p><p></p> |
| The IEditableText interface defines the properties and methods |
| for editable text. |
| |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#accessibilityProperties" class="signatureLink">accessibilityProperties</a> : AccessibilityProperties<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#displayAsPassword" class="signatureLink">displayAsPassword</a> : Boolean<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#editable" class="signatureLink">editable</a> : Boolean<div class="summaryTableDescription"> |
| Flag that indicates whether the text is editable.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#enabled" class="signatureLink">enabled</a> : Boolean<div class="summaryTableDescription"> |
| Whether the component can accept user interaction.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#focusEnabled" class="signatureLink">focusEnabled</a> : Boolean<div class="summaryTableDescription"> |
| Indicates whether the component can receive focus when tabbed to.</div></td><td class="summaryTableOwnerCol">IEditableText</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"> |
| The horizontal scroll position of the text.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/core/IDisplayText.html#isTruncated" class="signatureLink">isTruncated</a> : Boolean<div class="summaryTableDescription">[read-only] |
| A flag that indicates whether the text has been truncated.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/core/IDisplayText.html">IDisplayText</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#lineBreak" class="signatureLink">lineBreak</a> : String<div class="summaryTableDescription"> |
| Controls word wrapping within the text.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#maxChars" class="signatureLink">maxChars</a> : int<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#multiline" class="signatureLink">multiline</a> : Boolean<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#restrict" class="signatureLink">restrict</a> : String<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#selectable" class="signatureLink">selectable</a> : Boolean<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#selectionActivePosition" class="signatureLink">selectionActivePosition</a> : int<div class="summaryTableDescription">[read-only] |
| The active, or last clicked position, of the selection.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#selectionAnchorPosition" class="signatureLink">selectionAnchorPosition</a> : int<div class="summaryTableDescription">[read-only] |
| The anchor, or first clicked position, of the selection.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#tabIndex" class="signatureLink">tabIndex</a> : int<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../spark/core/IDisplayText.html#text" class="signatureLink">text</a> : String<div class="summaryTableDescription"> |
| The text displayed by this text component.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/core/IDisplayText.html">IDisplayText</a></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"> |
| The vertical scroll position of the text.</div></td><td class="summaryTableOwnerCol">IEditableText</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="#appendText()" class="signatureLink">appendText</a>(text:String):void</div><div class="summaryTableDescription"> |
| Appends the specified text to the end of the text component, |
| as if you had clicked at the end and typed.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#insertText()" class="signatureLink">insertText</a>(text:String):void</div><div class="summaryTableDescription"> |
| Inserts the specified text into the text component |
| as if you had typed it.</div></td><td class="summaryTableOwnerCol">IEditableText</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>(anchorPosition:int, activePosition:int):void</div><div class="summaryTableDescription"> |
| Scroll so the specified range is in view.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#selectAll()" class="signatureLink">selectAll</a>():void</div><div class="summaryTableDescription"> |
| Selects all of the text.</div></td><td class="summaryTableOwnerCol">IEditableText</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"> |
| Selects a specified range of characters.</div></td><td class="summaryTableOwnerCol">IEditableText</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setFocus()" class="signatureLink">setFocus</a>():void</div><div class="summaryTableDescription"> |
| Set focus to this text field.</div></td><td class="summaryTableOwnerCol">IEditableText</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="accessibilityProperties"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">accessibilityProperties</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>accessibilityProperties:AccessibilityProperties</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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get accessibilityProperties():AccessibilityProperties</code><br/><code> public function set accessibilityProperties(value:AccessibilityProperties):void</code><br/></div><a name="propertyDetail"></a><a name="displayAsPassword"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">displayAsPassword</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>displayAsPassword: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get displayAsPassword():Boolean</code><br/><code> public function set displayAsPassword(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="editable"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">editable</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>editable: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Flag that indicates whether the text is editable. |
| |
| </p><p> The default value is <code>false</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get editable():Boolean</code><br/><code> public function set editable(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="enabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">enabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>enabled: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Whether the component can accept user interaction. After setting the <code>enabled</code> |
| property to <code>false</code>, some components still respond to mouse interactions such |
| as mouseOver. As a result, to fully disable UIComponents, |
| you should also set the value of the <code>mouseEnabled</code> property to <code>false</code>. |
| If you set the <code>enabled</code> property to <code>false</code> |
| for a container, Flex dims the color of the container and of all |
| of its children, and blocks user input to the container |
| and to all of its children. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get enabled():Boolean</code><br/><code> public function set enabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="focusEnabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>focusEnabled: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Indicates whether the component can receive focus when tabbed to. |
| You can set <code>focusEnabled</code> to <code>false</code> |
| when a UIComponent is used as a subcomponent of another component |
| so that the outer component becomes the focusable entity. |
| If this property is <code>false</code>, focus is transferred to |
| the first parent that has <code>focusEnable</code> |
| set to <code>true</code>. |
| <p>The default value is <code>true</code>, except for the |
| spark.components.Scroller component. |
| For that component, the default value is <code>false</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get focusEnabled():Boolean</code><br/><code> public function set focusEnabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="horizontalScrollPosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">horizontalScrollPosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>horizontalScrollPosition:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| The horizontal scroll position of the text. |
| |
| </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="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: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Controls word wrapping within the text. This property corresponds |
| to the lineBreak style. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get lineBreak():String</code><br/><code> public function set lineBreak(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../flashx/textLayout/formats/ITextLayoutFormat.html#lineBreak" target="">flashx.textLayout.formats.ITextLayoutFormat.lineBreak</a></div></div><a name="propertyDetail"></a><a name="maxChars"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maxChars</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>maxChars: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get maxChars():int</code><br/><code> public function set maxChars(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="multiline"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">multiline</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>multiline: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get multiline():Boolean</code><br/><code> public function set multiline(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="restrict"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">restrict</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>restrict: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get restrict():String</code><br/><code> public function set restrict(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="selectable"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectable</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>selectable: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get selectable():Boolean</code><br/><code> public function set selectable(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="selectionActivePosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectionActivePosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>selectionActivePosition: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| The active, or last clicked position, of the selection. |
| If the implementation does not support selection anchor |
| this is the last character of the selection. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get selectionActivePosition():int</code><br/></div><a name="propertyDetail"></a><a name="selectionAnchorPosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectionAnchorPosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>selectionAnchorPosition: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| The anchor, or first clicked position, of the selection. |
| If the implementation does not support selection anchor |
| this is the first character of the selection. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get selectionAnchorPosition():int</code><br/></div><a name="propertyDetail"></a><a name="tabIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tabIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tabIndex: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get tabIndex():int</code><br/><code> public function set tabIndex(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="verticalScrollPosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalScrollPosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalScrollPosition:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| The vertical scroll position of the text. |
| |
| </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="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="appendText()"></a><a name="appendText(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">appendText</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function appendText(text:String):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Appends the specified text to the end of the text component, |
| as if you had clicked at the end and typed. |
| <p>An insertion point is then set after the new text. |
| If necessary, the text will scroll to ensure |
| that the insertion point is 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">text</span>:String</code> — The text to be appended. |
| |
| </td></tr></table></p></div><a name="insertText()"></a><a name="insertText(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">insertText</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function insertText(text:String):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Inserts the specified text into the text component |
| as if you had typed it. |
| <p>If a range was selected, the new text replaces the selected text. |
| If there was an insertion point, the new text is inserted there.</p> |
| <p>An insertion point is then set after the new text. |
| If necessary, the text will scroll to ensure |
| that the insertion point is 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">text</span>:String</code> — The text to be inserted. |
| |
| </td></tr></table></p></div><a name="scrollToRange()"></a><a name="scrollToRange(int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scrollToRange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function scrollToRange(anchorPosition:int, activePosition: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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Scroll so the specified range is in view. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">anchorPosition</span>:int</code> — The anchor position of the selection range. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">activePosition</span>:int</code> — The active position of the selection range. |
| |
| </td></tr></table></p></div><a name="selectAll()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function selectAll():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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Selects all of the text. |
| |
| </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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Selects a specified range of characters. |
| <p>If either position is negative, it will deselect the text range.</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">anchorIndex</span>:int</code> — The character position specifying the end |
| of the selection that stays fixed when the selection is extended. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">activeIndex</span>:int</code> — The character position specifying the end |
| of the selection that moves when the selection is extended. |
| |
| </td></tr></table></p></div><a name="setFocus()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setFocus():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> Product Version : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10.1, AIR 2.0</td></tr></table><p></p><p></p><p> |
| Set focus to this text field. |
| |
| </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 --> |
