| <!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="FlowTextOperation,flashx.textLayout.operations.FlowTextOperation,absoluteEnd,absoluteStart,allowMerge,beginGeneration,characterFormat,containerFormat,containerFormat,deleteSelectionState,deleteSelectionState,destination,destinationIndex,endGeneration,extendToLinkBoundary,format,format,format,format,height,height,href,leafFormat,leafFormat,listFormat,newDivElement,newElement,newID,newInlineGraphicElement,newLinkElement,newListElement,newStyleName,newSubParagraphGroupElement,newTCYElement,newValue,numChildren,operation,operation,operations,options,options,originalSelectionState,paragraphFormat,paragraphFormat,parent,parent,parent,relativeEnd,relativeStart,scrapToCut,source,source,source,sourceIndex,styleName,target,targetElement,targetElement,tcyOn,text,textFlow,textScrap,typeName,userData,width,width,addOperation,canUndo,doOperation,redo,redo,redo,redo,redo,redo,undo"><title>flashx.textLayout.operations.FlowTextOperation</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 = 'FlowTextOperation - 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/operations/FlowTextOperation.html&flashx/textLayout/operations/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">FlowTextOperation</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("FlowTextOperation"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">flashx.textLayout.operations</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class FlowTextOperation</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">FlowTextOperation <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><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../../flashx/textLayout/operations/ApplyFormatOperation.html">ApplyFormatOperation</a>, <a href="../../../flashx/textLayout/operations/ApplyLinkOperation.html">ApplyLinkOperation</a>, <a href="../../../flashx/textLayout/operations/ApplyTCYOperation.html">ApplyTCYOperation</a>, <a href="../../../flashx/textLayout/operations/ClearFormatOperation.html">ClearFormatOperation</a>, <a href="../../../flashx/textLayout/operations/CopyOperation.html">CopyOperation</a>, <a href="../../../flashx/textLayout/operations/CreateDivOperation.html">CreateDivOperation</a>, <a href="../../../flashx/textLayout/operations/CreateListOperation.html">CreateListOperation</a>, <a href="../../../flashx/textLayout/operations/CreateSubParagraphGroupOperation.html">CreateSubParagraphGroupOperation</a>, <a href="../../../flashx/textLayout/operations/CutOperation.html">CutOperation</a>, <a href="../../../flashx/textLayout/operations/DeleteTextOperation.html">DeleteTextOperation</a>, <a href="../../../flashx/textLayout/operations/FlowElementOperation.html">FlowElementOperation</a>, <a href="../../../flashx/textLayout/operations/InsertInlineGraphicOperation.html">InsertInlineGraphicOperation</a>, <a href="../../../flashx/textLayout/operations/InsertTableElementOperation.html">InsertTableElementOperation</a>, <a href="../../../flashx/textLayout/operations/InsertTextOperation.html">InsertTextOperation</a>, <a href="../../../flashx/textLayout/operations/ModifyInlineGraphicOperation.html">ModifyInlineGraphicOperation</a>, <a href="../../../flashx/textLayout/operations/MoveChildrenOperation.html">MoveChildrenOperation</a>, <a href="../../../flashx/textLayout/operations/PasteOperation.html">PasteOperation</a>, <a href="../../../flashx/textLayout/operations/SplitElementOperation.html">SplitElementOperation</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 FlowTextOperation is the base class for operations that transform a range of text. |
| |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../flashx/textLayout/edit/EditManager.html" target="">flashx.textLayout.edit.EditManager</a></div><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="#absoluteEnd" class="signatureLink">absoluteEnd</a> : int<div class="summaryTableDescription"> |
| The absolute end point of the range of text to which this operation is applied.</div></td><td class="summaryTableOwnerCol">FlowTextOperation</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#absoluteStart" class="signatureLink">absoluteStart</a> : int<div class="summaryTableDescription"> |
| The absolute start point of the range of text to which this operation is applied.</div></td><td class="summaryTableOwnerCol">FlowTextOperation</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="../../../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"> </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"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#originalSelectionState" class="signatureLink">originalSelectionState</a> : <a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a><div class="summaryTableDescription"> |
| The selection state at the start of the operation.</div></td><td class="summaryTableOwnerCol">FlowTextOperation</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="../../../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"> </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> </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="#FlowTextOperation()" class="signatureLink">FlowTextOperation</a>(operationState:<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a>)</div><div class="summaryTableDescription"> |
| Creates the FlowTextOperation object.</div></td><td class="summaryTableOwnerCol">FlowTextOperation</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </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"> </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=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#redo()" class="signatureLink">redo</a>():<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a></div><div class="summaryTableDescription">[override] |
| |
| Re-executes the operation.</div></td><td class="summaryTableOwnerCol">FlowTextOperation</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </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="absoluteEnd"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">absoluteEnd</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>absoluteEnd: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> |
| The absolute end point of the range of text to which this operation is applied. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get absoluteEnd():int</code><br/><code> public function set absoluteEnd(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="absoluteStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">absoluteStart</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>absoluteStart:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><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 absolute start point of the range of text to which this operation is applied. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get absoluteStart():int</code><br/><code> public function set absoluteStart(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="originalSelectionState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">originalSelectionState</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>originalSelectionState:<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</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 selection state at the start of the operation. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get originalSelectionState():<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a></code><br/><code> public function set originalSelectionState(value:<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a>):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="FlowTextOperation()"></a><a name="FlowTextOperation(flashx.textLayout.edit.SelectionState)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">FlowTextOperation</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function FlowTextOperation(operationState:<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</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> |
| Creates the FlowTextOperation object. |
| |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">operationState</span>:<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a></code> — Specifies the relevant selection. If relevant to the operation, the |
| <code>operationState</code> describes the text range to which this operation applies. |
| Otherwise, <code>operationState</code> is used to save the current selection state so that |
| it can be restored when the operation is undone. |
| |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="redo()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">redo</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code>override public function redo():<a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</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> |
| |
| Re-executes the operation. |
| |
| <p>This method must be overridden in derived classes. The base class method does nothing. |
| You should not call <code>redo()</code> directly. The edit manager |
| calls the method when it re-executes the operation. </p> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../../flashx/textLayout/edit/SelectionState.html">SelectionState</a></code> — The SelectionState object passed to the operation when it was performed. This |
| SelectionState object can be the current selection or a selection created specifically |
| for the operation. |
| |
| </td></tr></table></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 --> |
