blob: 4f80ba13b6154283e6032c0b156f2fa796f18dcd [file] [log] [blame]
<!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="TextInputOperation,spark.components.supportClasses.TextInputOperation,BOTTOM,BOTTOM,CONTAINS,DOWN,DROP_INDICATOR,ENDS_WITH,EXACT,FOCUS_PANE,LEFT,MASK,NONE,NOT,NOT_EMPTY,NO_SELECTION,OVER,POP,POP_ALL,POP_TO_FIRST,PUSH,REPLACE,RIGHT,STARTS_WITH,TOP,TOP,UP,_displayAsPassword,_editable,_maxChars,_multiline,_restrict,activeView,arrowKeysWrapFocus,autoCapitalize,autoCapitalize,autoCapitalize,autoCorrect,autoCorrect,autoCorrect,autoDrawBackground,autoLayout,autoRepeat,baselinePosition,baselinePosition,caretIndex,clipAndEnableScrolling,closeDropDownOnResize,closeOnResize,content,contentHeight,contentWidth,context,currentCSSState,dataField,dataTipFormatFunction,dataTipPrecision,debugId,defaultButton,defaultStyles,densityScale,displayAsPassword,displayAsPassword,displayAsPassword,down,dragging,dropDownController,editable,editable,editable,editable,enableIME,enabled,endFunction,focusEnabled,focusSkinExclusions,gap,headerStyleName,headerText,hiddenFocusStageText,hitAreaAdditions,horizontalScrollPosition,horizontalScrollPosition,hovered,hovered,icon,iconField,iconFunction,imeMode,invalidateStyleFlag,isActive,isAndroid,isDesktop,isDropDownOpen,isDropDownOpen,isFirstRow,isFirstRow,isLastRow,isLastRow,isOpen,isTruncated,isTruncated,itemIndex,itemRenderer,keyboardPressed,label,label,label,labelDisplay,labelField,labelFunction,labelFunction,lastFocusedStageText,layout,lineBreak,luminosityClip,luminosityInvert,mask,maskType,maxChars,maxChars,maxChars,maxDisplayedLines,maxDragRate,maximum,maximum,minHeight,minWidth,minimum,mouseCaptured,mouseEnabledWhereTransparent,multiline,multiline,numDisplayObjects,numElements,object,openButton,overlay,pageSize,parentNavigator,pendingValue,pendingValue,percentWidth,persistNavigatorState,persistenceManager,preventSelection,prompt,proxy,repeatFunction,requireSelection,resizeMode,restrict,restrict,restrict,returnKeyLabel,returnKeyLabel,returnKeyLabel,rollOverOpenDelay,selectable,selected,selected,selectedIndex,selectedItem,selectionActivePosition,selectionActivePosition,selectionActivePosition,selectionActivePosition,selectionAnchorPosition,selectionAnchorPosition,selectionAnchorPosition,selectionAnchorPosition,selectionHighlighting,showDataTip,showTruncationTip,showsCaret,skin,snapInterval,snapInterval,softKeyboardType,softKeyboardType,softKeyboardType,sortDescending,sortField,sortable,stageText,startFunction,state,stepSize,stickyHighlighting,stopFunction,styleDeclaration,styleName,styleName,styleName,suggestedFocusSkinExclusions,supportedStyles,systemManager,text,text,text,text,text,text,textAlign,transitionsEnabled,typicalText,updateFunction,useVirtualLayout,value,verticalScrollPosition,verticalScrollPosition,viewMenuOpen,viewport,width"><title>spark.components.supportClasses.TextInputOperation</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 = 'TextInputOperation - 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>&nbsp;|&nbsp;<a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../index.html?spark/components/supportClasses/TextInputOperation.html&amp;spark/components/supportClasses/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">TextInputOperation</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("TextInputOperation"); 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.components.supportClasses</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TextInputOperation</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">TextInputOperation <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a> <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></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 :&nbsp;</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 :&nbsp;</b></td><td>AIR 2.5</td></tr></table><p></p><p></p><p></p><p></p>
The TextInputOperation class represents a text input operation.
This class is only used by StyleableTextField when sending the
CHANGING event.
<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>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html#beginGeneration" class="signatureLink">beginGeneration</a> : uint<div class="summaryTableDescription">[read-only]
The text flow generation before the operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html#endGeneration" class="signatureLink">endGeneration</a> : uint<div class="summaryTableDescription">[read-only]
The text flow generation after the operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><img src="../../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime">&nbsp;<a href="#text" class="signatureLink">text</a> : String<div class="summaryTableDescription">
The text that was inputted.</div></td><td class="summaryTableOwnerCol">TextInputOperation</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html#textFlow" class="signatureLink">textFlow</a> : <a href="../../../flashx/textLayout/elements/TextFlow.html">TextFlow</a><div class="summaryTableDescription">
The TextFlow object to which this operation is applied.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html#userData" class="signatureLink">userData</a> : *<div class="summaryTableDescription">
Arbitrary data associated with an element.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><img src="../../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime">&nbsp;<a href="#TextInputOperation()" class="signatureLink">TextInputOperation</a>()</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">TextInputOperation</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/operations/FlowOperation.html#canUndo()" class="signatureLink">canUndo</a>():Boolean</div><div class="summaryTableDescription">
Test if this operation be placed on the undo stack.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/operations/FlowOperation.html#doOperation()" class="signatureLink">doOperation</a>():Boolean</div><div class="summaryTableDescription">
Executes the operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/operations/FlowOperation.html#redo()" class="signatureLink">redo</a>():<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a></div><div class="summaryTableDescription">
Re-executes the operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../flashx/textLayout/operations/FlowOperation.html#undo()" class="signatureLink">undo</a>():<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a></div><div class="summaryTableDescription">
Reverses the operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../flashx/textLayout/operations/FlowOperation.html">FlowOperation</a></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="text"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime">&nbsp;text</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var text:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></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 :&nbsp;</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 :&nbsp;</b></td><td>AIR 2.5</td></tr></table><p></p><p></p><p>
The text that was inputted. If the CHANGING event is not cancelled,
this text will be added to the TextFeld. If the event is cancelled,
the text will not be added.
</p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="TextInputOperation()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName"><img src="../../../images/AirIcon12x12.gif" width="12" height="12" hspace="0" vspace="0" alt="AIR-only" title="Only available in the AIR runtime">&nbsp;TextInputOperation</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function TextInputOperation()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></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 :&nbsp;</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 :&nbsp;</b></td><td>AIR 2.5</td></tr></table><p></p><p>
Constructor.
</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 -->