| <!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="TextFlowUtil,spark.utils.TextFlowUtil,export,getMultiSource,getSnapshot,getSnapshotWithPadding,getSource,importFromString,importFromXML,itemToLabel,uint2hex"><title>spark.utils.TextFlowUtil</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 = 'TextFlowUtil - 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/utils/TextFlowUtil.html&spark/utils/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">TextFlowUtil</td><td class="titleTableSubNav" id="subNav" align="right"><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("TextFlowUtil"); titleBar_setSubNav(false,false,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.utils</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TextFlowUtil</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">TextFlowUtil <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 : </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</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> |
| TextFlowUtil is a utility class which provides methods |
| for importing a TextFlow from, and exporting a TextFlow to, |
| the markup language used by the Text Layout Framework. |
| |
| <p></p><br/><hr></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="#export()" class="signatureLink">export</a>(textFlow:<a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</a>):XML</div><div class="summaryTableDescription">[static] |
| Exports a TextFlow into the markup language |
| used by the Text Layout Framework, in the form of XML.</div></td><td class="summaryTableOwnerCol">TextFlowUtil</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#importFromString()" class="signatureLink">importFromString</a>(markup:String, whiteSpaceCollapse:String = collapse):<a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></div><div class="summaryTableDescription">[static] |
| Creates a TextFlow by importing (i.e., parsing) a String |
| containing the markup language used by the Text Layout Framework.</div></td><td class="summaryTableOwnerCol">TextFlowUtil</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#importFromXML()" class="signatureLink">importFromXML</a>(markup:XML, whiteSpaceCollapse:String = collapse):<a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></div><div class="summaryTableDescription">[static] |
| Creates a TextFlow by importing (parsing) XML |
| that contains the markup language used by the Text Layout Framework.</div></td><td class="summaryTableOwnerCol">TextFlowUtil</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="export()"></a><a name="export(flashx.textLayout.elements.TextFlow)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">export</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public static function export(textFlow:<a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</a>):XML</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</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> |
| Exports a TextFlow into the markup language |
| used by the Text Layout Framework, in the form of XML. |
| <p>The root tag of the exported XML will be |
| <pre> |
| <TextFlow xmlns="http://ns.adobe.com/textLayout/2008" ...> |
| </pre> |
| </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">textFlow</span>:<a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></code> — The TextFlow to be exported |
| in Text Layout Framework markup language. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>XML</code> — XML containing Text Layout Framework |
| markup language. |
| |
| </td></tr></table></div><a name="importFromString()"></a><a name="importFromString(String,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">importFromString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public static function importFromString(markup:String, whiteSpaceCollapse:String = collapse):<a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</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> Product Version : </b></td><td>Flex 4</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 TextFlow by importing (i.e., parsing) a String |
| containing the markup language used by the Text Layout Framework. |
| |
| <p>An example of a markup string is |
| <pre> |
| "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'> |
| <p><span>Hello, </span><span>World!</span></p></TextFlow>" |
| </pre> |
| </p> |
| <p>However, you can use terser markup such as |
| <pre>"Hello, <span>World!</span>"</pre>. |
| It will get wrapped with a TextFlow tag in the proper namespace, |
| and span and paragraph tags will get automatically inserted |
| where needed to comply with the structure of a TextFlow.</p> |
| <p>If you specify the TextFlow tag yourself, |
| it must be in the correct XML namespace |
| for runtime Text Layout Framework markup, which is |
| <code>"http://ns.adobe.com/textLayout/2008"</code>.</p> |
| <p>Incorrect markup will cause this method to throw |
| various exceptions. |
| The error message will contain information |
| about why it could not be parsed.</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">markup</span>:String</code> — The markup String to be imported. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">whiteSpaceCollapse</span>:String</code> (default = <code>collapse</code>)<code></code> — A String indicating whether |
| the whitespace in the markup should be collapsed or preserved. |
| The possible values are |
| <code>WhiteSpaceCollapse.COLLAPSE</code> and |
| <code>WhiteSpaceCollapse.PRESERVE</code> in the |
| flashx.textLayout.formats.WhiteSpaceCollapse class. |
| The default value is <code>WhiteSpaceCollapse.COLLAPSE</code>. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></code> — A new TextFlow instance created from the markup. |
| |
| </td></tr></table></div><a name="importFromXML()"></a><a name="importFromXML(XML,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">importFromXML</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public static function importFromXML(markup:XML, whiteSpaceCollapse:String = collapse):<a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</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> Product Version : </b></td><td>Flex 4</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 TextFlow by importing (parsing) XML |
| that contains the markup language used by the Text Layout Framework. |
| |
| <p>An example of markup XML is |
| <pre> |
| <TextFlow xmlns='http://ns.adobe.com/textLayout/2008'> |
| <p><span>Hello, </span><span>World!</span></p> |
| </TextFlow> |
| </pre> |
| </p> |
| <p>You can also use terser markup such as the following: |
| <pre> |
| "Hello, <span fontWeight='bold'>World!</span>" |
| </pre> |
| The parser wraps the markup with a <code><TextFlow></code> tag in the proper namespace. |
| The parser also inserts <span> and <paragraph> tags |
| where needed to comply with the structure of a TextFlow object.</p> |
| <p>If you specify the TextFlow tag yourself, |
| it must be in the correct XML namespace |
| for runtime Text Layout Framework markup, which is |
| <code>"http://ns.adobe.com/textLayout/2008"</code>.</p> |
| <p>Incorrect markup causes this method to throw |
| various exceptions. |
| The error message contains information |
| about why it could not be parsed.</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">markup</span>:XML</code> — The markup XML to be imported. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">whiteSpaceCollapse</span>:String</code> (default = <code>collapse</code>)<code></code> — A String indicating whether |
| the whitespace in the markup should be collapsed or preserved. |
| The possible values are |
| <code>WhiteSpaceCollapse.COLLAPSE</code> and |
| <code>WhiteSpaceCollapse.PRESERVE</code> in the |
| flashx.textLayout.formats.WhiteSpaceCollapse class. |
| The default value is <code>WhiteSpaceCollapse.COLLAPSE</code>. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../flashx/textLayout/elements/TextFlow.html">TextFlow</a></code> — A new TextFlow instance created from the markup. |
| |
| </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 --> |
