| { "type": "class", | |
| "qname": "org.apache.royale.textLayout.conversion.TextConverter", | |
| "baseClassname": "" | |
| , | |
| "description": "This is the gateway class for handling import and export. It serves as a unified access point to the conversion functionality in the Text Layout Framework. It contains a registry for predefined as well as user defined input and/or output converters, plus a set of conversion methods. <p> The format of the converted data is not predefined; user written converters are free to accept and return any format of their choice. Common formats are strings, XML, and ByteArray instances. Converter authors should document which formats are supported. </p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "field", | |
| "qname": "TEXT_FIELD_HTML_FORMAT", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "HTML format. Use this for importing from, or exporting to, a TextFlow using the HTML fomat. The Text Layout Framework HTML supports a subset of the tags and attributes supported by the TextField class in the <code>flash.text</code> package. <p>The following table lists the HTML tags and attributes supported for the import and export process (tags and attributes supported by TextField, but not supported by the Text Layout Framework are specifically described as not supported):</p> <table class="innertable" width="640"> <tr> <th> Tag </th> <th> Description </th> </tr> <tr> <td> Anchor tag </td> <td> The <code><a></code> tag creates a hypertext link and supports the following attributes: <ul> <li> <code>target</code>: Specifies the name of the target window where you load the page. Options include <code>_self</code>, <code>_blank</code>, <code>_parent</code>, and <code>_top</code>. The <code>_self</code> option specifies the current frame in the current window, <code>_blank</code> specifies a new window, <code>_parent</code> specifies the parent of the current frame, and <code>_top</code> specifies the top-level frame in the current window. </li> <li> <code>href</code>: Specifies a URL. The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is <code>http://www.adobe.com</code>; an example of a relative reference is <code>/index.html</code>. Absolute URLs must be prefixed with http://; otherwise, Flash treats them as relative URLs. <strong>Note: Unlike the TextField class, </strong>ActionScript <code>link</code> events are not supported. Neither are <code>a:link</code>, <code>a:hover</code>, and <code>a:active</code> styles. </li> </ul> </td> </tr> <tr> <td> Bold tag </td> <td> The <code><b></code> tag renders text as bold. A bold typeface must be available for the font used. </td> </tr> <tr> <td> Break tag </td> <td> The <code><br></code> tag creates a line break in the text. </td> </tr> <tr> <td> Font tag </td> <td> The <code><font></code> tag specifies a font or list of fonts to display the text.The font tag supports the following attributes: <ul> <li> <code>color</code>: Only hexadecimal color (<code>#FFFFFF</code>) values are supported. </li> <li> <code>face</code>: Specifies the name of the font to use. As shown in the following example, you can specify a list of comma-delimited font names, in which case Flash Player selects the first available font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, Flash Player selects a substitute font. </li> <li> <code>size</code>: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18 or relative point sizes, such as +2 or -4. </li> <li> <code>letterspacing</code>: Specifies the tracking (manual kerning) in pixels to be applied to the right of each character. </li> <li> <code>kerning</code>: Specifies whether kerning is enabled or disabled. A non-zero value enables kerning, while zero disables it. </li> </ul> </td> </tr> <tr> <td> Image tag </td> <td> The <code><img></code> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text. <p>The <code><img></code> tag supports the following attributes: </p> <ul > <li> <code>src</code>: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, and SWF files) do not show until they are downloaded completely. </li> <li> <code>width</code>: The width of the image, SWF file, or movie clip being inserted, in pixels. </li> <li> <code>height</code>: The height of the image, SWF file, or movie clip being inserted, in pixels. </li> </ul> <p><strong>Note: </strong> Unlike the TextField class, the following attributes are not supported: <code>align</code>, <code>hspace</code>, <code>vspace</code>, <code>id</code>, and <code>checkPolicyFile</code>.</p> </td> </tr> <tr> <td> Italic tag </td> <td> The <code><i></code> tag displays the tagged text in italics. An italic typeface must be available for the font used. </td> </tr> <tr> <td> <em>List item tag</em> </td> <td> <strong>Note: </strong> Unlike the TextField class, the List item tag is not supported. </td> </tr> <tr> <td> Paragraph tag </td> <td> The <code><p></code> tag creates a new paragraph. The <code><p></code> tag supports the following attributes: <ul > <li> align: Specifies alignment of text within the paragraph; valid values are <code>left</code>, <code>right</code>, <code>justify</code>, and <code>center</code>. </li> <li> class: Specifies a class name that can be used for styling </li> </ul> </td> </tr> <tr> <td> Span tag </td> <td> The <code><span></code> tag supports the following attributes: <ul> <li> class: Specifies a class name that can be used for styling. While span tags are often used to set a style defined in a style sheet, TLFTextField instances do not support style sheets. The span tag is available for TLFTextField instances to refer to a class with style properties.</li> <li> You can also put properties directly in the span tag: <code><span fontFamily="Arial">Hi there</span></code>. However, nested span tags are not supported. </li> </ul> </td> </tr> <tr> <td> Text format tag </td> <td> <p>The <code><textformat></code> tag lets you use a subset of paragraph formatting properties of the TextFormat class within text fields, including line leading, indentation, margins, and tab stops. You can combine <code><textformat></code> tags with the built-in HTML tags. </p> <p>The <code><textformat></code> tag has the following attributes: </p> <ul > <li> <code>indent</code>: Specifies the indentation from the left margin to the first character in the paragraph; corresponds to <code>TextFormat.indent</code>. Both positive and negative numbers are acceptable. </li> <li> <code>blockindent</code>: Specifies the indentation applied to all lines of the paragraph. </li> <li> <code>leftmargin</code>: Specifies the left margin of the paragraph, in points; corresponds to <code>TextFormat.leftMargin</code>. </li> <li> <code>rightmargin</code>: Specifies the right margin of the paragraph, in points; corresponds to <code>TextFormat.rightMargin</code>. </li> <li> <code>leading</code>: Specifies the leading (line height) measured in pixels between a line's ascent and the previous line's descent </li> <li> <code>tabstops</code>: Specifies a comma-separated list of tab stop positions for the paragraph. </li> </ul> </td> </tr> <tr> <td> Underline tag </td> <td> The <code><u></code> tag underlines the tagged text. </td> </tr> </table> <p>When an unknown tag is imported the <code>textFieldHTMLFormat</code> importer will either set a single FlowElement's typeName property to that tag name or create a DivElement or a SubParagraphGroupElement with its typeName property set to the tag name.</p> <p>The <code>textFieldHTMLFormat</code> exporter will export <code>typeName</code> as the XML tag when it is different from the default.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["org.apache.royale.textLayout.elements.FlowElement#typeName"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "PLAIN_TEXT_FORMAT", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Plain text format. Use this for creating a TextFlow from a simple, unformatted String, or for creating a simple, unformatted String from a TextFlow.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "TEXT_LAYOUT_FORMAT", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "TextLayout Format. Use this for importing from, or exporting to, a TextFlow using the TextLayout markup format. Text Layout format will detect the following errors: <ul> <li>Unexpected namespace</li> <li>Unknown element</li> <li>Unknown attribute</li> </ul>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "Array", | |
| "qname": "descArray", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}}, | |
| { "type": "method", | |
| "qname": "importToFlow", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Creates a TextFlow from source content in a specified format. <p>Use one of the static constants supplied with this class, a MIME type, to specify the <code>format</code> parameter, or use a user defined value for user-registered importers: <ul> <li>TextConverter.TEXT_FIELD_HTML_FORMAT</li> <li>TextConverter.PLAIN_TEXT_FORMAT</li> <li>TextConverter.TEXT_LAYOUT_FORMAT</li> </ul> </p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#TEXT_FIELD_HTML_FORMAT", "#PLAIN_TEXT_FORMAT", "#TEXT_LAYOUT_FORMAT"]}, | |
| { "tagName": "param", | |
| "values": ["source Source content", "format Format of source content", "config IConfiguration to use when creating new TextFlows"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "return", | |
| "values": ["TextFlow that was created from the source, or null on errors."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "org.apache.royale.textLayout.elements.ITextFlow", | |
| "params": [{ "name": "source", "type": "Object"}, | |
| { "name": "format", "type": "String"}, | |
| { "name": "config", "type": "org.apache.royale.textLayout.elements.IConfiguration"}]} | |
| , | |
| { "type": "method", | |
| "qname": "export", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Exports a TextFlow to a specified format. <p>Use one of the static constants supplied with this class, a MIME type, or a user defined format for user defined exporters to specify the <code>format</code> parameter: <ul> <li>TextConverter.TEXT_FIELD_HTML_FORMAT</li> <li>TextConverter.PLAIN_TEXT_FORMAT</li> <li>TextConverter.TEXT_LAYOUT_FORMAT</li> </ul> </p> <p>Specify the type of the exported data in the <code>conversionType</code> parameter with one of the static constants supplied by the ConversionType class, or a user defined data type for user defined exporters: <ul> <li>ConversionType.STRING_TYPE</li> <li>ConversionType.XML_TYPE</li> </ul> </p> Returns a representation of the TextFlow in the specified format, or null on errors.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#TEXT_FIELD_HTML_FORMAT", "#PLAIN_TEXT_FORMAT", "#TEXT_LAYOUT_FORMAT", "org.apache.royale.textLayout.conversion.ConversionType"]}, | |
| { "tagName": "param", | |
| "values": ["source Source content", "format Output format", "conversionType Type of exported data"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "return", | |
| "values": ["Object Exported form of the TextFlow, or null on errors"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Object", | |
| "params": [{ "name": "source", "type": "org.apache.royale.textLayout.elements.TextFlow"}, | |
| { "name": "format", "type": "String"}, | |
| { "name": "conversionType", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "getImporter", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Creates and returns an import converter, which you can then use to import from a source string, an XML object, or any user defined data formats to a TextFlow. Use this method if you have many separate imports to perform, or if you want to handle errors during import. It is equivalent to calling <code>org.apache.royale.textLayout.conversion.TextConverter.importToFlow()</code>. <p>Use one of the static constants supplied with this class to specify the <code>format</code> parameter, a MIME type, or a user defined data format. <ul> <li>TextConverter.TEXT_FIELD_HTML_FORMAT</li> <li>TextConverter.PLAIN_TEXT_FORMAT</li> <li>TextConverter.TEXT_LAYOUT_FORMAT</li> </ul> </p> <p>If the format has been added multiple times, the first one found will be used.</p> org.apache.royale.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, TEXT_FIELD_HTML_FORMAT etc, a MIME type, or a user defined format. You can also set the configuration via the <code>ITextImporter.configuration</code> property.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#TEXT_FIELD_HTML_FORMAT", "#PLAIN_TEXT_FORMAT", "#TEXT_LAYOUT_FORMAT"]}, | |
| { "tagName": "param", | |
| "values": ["format Format of source content. Use constants from", "config configuration to use during this import. null means take the current default."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "return", | |
| "values": ["ITextImporter Text importer that can import the source data"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "org.apache.royale.textLayout.conversion.ITextImporter", | |
| "params": [{ "name": "format", "type": "String"}, | |
| { "name": "config", "type": "org.apache.royale.textLayout.elements.IConfiguration"}]} | |
| , | |
| { "type": "method", | |
| "qname": "getExporter", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Creates and returns an export converter, which you can then use to export from a TextFlow to a source string or XML object. Use this function if you have many separate exports to perform. It is equivalent to calling <code>org.apache.royale.textLayout.conversion.TextConverter.export()</code>. <p>Use one of the static constants supplied with this class to specify the <code>format</code> parameter: <ul> <li>TextConverter.TEXT_FIELD_HTML_FORMAT</li> <li>TextConverter.PLAIN_TEXT_FORMAT</li> <li>TextConverter.TEXT_LAYOUT_FORMAT</li> </ul> </p> <p>If the format has been added multiple times, the first one found will be used.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#TEXT_FIELD_HTML_FORMAT", "#PLAIN_TEXT_FORMAT", "#TEXT_LAYOUT_FORMAT"]}, | |
| { "tagName": "param", | |
| "values": ["format Target format for exported data"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "return", | |
| "values": ["ITextExporter Text exporter that can export in the specified format"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "org.apache.royale.textLayout.conversion.ITextExporter", | |
| "params": [{ "name": "format", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "addFormatAt", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Register a new format for import/export, at the specified location. Location can be significant for clients that have multiple choices for which format to use, such as when importing from the external clipboard. Lower numbers indicate higher priority; these converters will be tried first. The new format may support importing and/or exporting. If the format has already been added, then it will be present in multiple locations. The first one found will be used.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["importClass The import converter class to register or null", "exportClass The export converter class to register or null", "format The format string tagging the converter classes", "clipboardFormat The string used as the clipboard format when converting to/from the clipboard. Make this null if the format doesn't support clipboard access."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "index", "type": "int"}, | |
| { "name": "format", "type": "String"}, | |
| { "name": "importerClass", "type": "Class"}, | |
| { "name": "exporterClass", "type": "Class"}, | |
| { "name": "clipboardFormat", "type": "String"}, | |
| { "name": "arr", "type": "Array"}]} | |
| , | |
| { "type": "method", | |
| "qname": "addFormat", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Register a new format for import/export. The new format will be added at the end, as the lowest priority. Location can be significant for clients that have multiple choices for which format to use, such as when importing from the external clipboard. The new format may support importing and/or exporting. If the format has already been added, then it will be present in multiple locations. The first one found will be used.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["importClass The import converter class to register or null", "exportClass The export converter class to register or null", "format The format string tagging the converter classes. Formats can be any name, but must be unique.", "clipboardFormat The string used as the clipboard format when converting to/from the clipboard. Make this null if the format doesn't support clipboard access."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "format", "type": "String"}, | |
| { "name": "importerClass", "type": "Class"}, | |
| { "name": "exporterClass", "type": "Class"}, | |
| { "name": "clipboardFormat", "type": "String"}, | |
| { "name": "arr", "type": "Array"}]} | |
| , | |
| { "type": "method", | |
| "qname": "removeFormatAt", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Remove the format at the index location.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["index The format to remove"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "index", "type": "int"}]} | |
| , | |
| { "type": "method", | |
| "qname": "removeFormat", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Remove the format. If a format was added multiple times, only the first one found is removed.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["format The converter format string to remove"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "format", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "getFormatAt", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Returns the format name for the index'th format.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "String", | |
| "params": [{ "name": "index", "type": "int"}]} | |
| , | |
| { "type": "method", | |
| "qname": "getFormatDescriptorAt", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Returns the FormatDescriptor for the index'th format.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "org.apache.royale.textLayout.conversion.FormatDescriptor", | |
| "params": [{ "name": "index", "type": "int"}]} | |
| , | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "int", | |
| "qname": "numFormats", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Number of formats.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |