Packageflashx.textLayout.conversion
Classpublic class PlainTextExporter
InheritancePlainTextExporter Inheritance ConverterBase Inheritance Object
Implements IPlainTextExporter

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Export converter for plain text format. This class provides an alternative to the TextConverter.export() static method for exporting plain text. The PlainTextExporter class's export() method results in the same output string as the TextConverter.export() static method if the two properties of the PlainTextExporter class, the PARAGRAPH_SEPARATOR_PROPERTY and the STRIP_DISCRETIONARY_HYPHENS_PROPERTY properties, contain their default values of "\n" and true, respectively.


Public Properties
 PropertyDefined By
 Inheritedconfig : ImportExportConfiguration
Returns the import and export configuration.
ConverterBase
 Inheritederrors : Vector.<String>
[read-only] Errors encountered while parsing.
ConverterBase
  paragraphSeparator : String
Specifies the character sequence used (in a text flow's plain-text equivalent) to separate paragraphs.
PlainTextExporter
  stripDiscretionaryHyphens : Boolean
This property indicates whether discretionary hyphens in the text should be stripped during the export process.
PlainTextExporter
 InheritedthrowOnError : Boolean
ConverterBase
 InheriteduseClipboardAnnotations : Boolean
ConverterBase
Public Methods
 MethodDefined By
  
PlainTextExporter()
Constructor
PlainTextExporter
  
export(source:TextFlow, conversionType:String):Object
Export text content from a TextFlow instance in String, or XML, or a user defined format.
PlainTextExporter
Public Constants
 ConstantDefined By
 InheritedMERGE_TO_NEXT_ON_PASTE : String = mergeToNextOnPaste
[static] A converter that converts clipboard data into a TextFlow should use the MERGE_TO_NEXT_ON_PASTE property to control how the elements are treated when they are merged into an existing TextFlow on paste.
ConverterBase
Property Detail
paragraphSeparatorproperty
paragraphSeparator:String

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Specifies the character sequence used (in a text flow's plain-text equivalent) to separate paragraphs. The paragraph separator is not added after the last paragraph.

This property applies to the PLAIN_TEXT_FORMAT exporter.

The default value is "\n".


Implementation
    public function get paragraphSeparator():String
    public function set paragraphSeparator(value:String):void
stripDiscretionaryHyphensproperty 
stripDiscretionaryHyphens:Boolean

Language Version : ActionScript 3.0-
Runtime Versions : Flash Player 10, AIR 1.5

This property indicates whether discretionary hyphens in the text should be stripped during the export process. Discretionary hyphens, also known as "soft hyphens", indicate where to break a word in case the word must be split between two lines. The Unicode character for discretionary hyphens is \u00AD.

If this property is set to true, discretionary hyphens that are in the original text will not be in the exported text, even if they are part of the original text. If false, discretionary hyphens will be in the exported text.


Implementation
    public function get stripDiscretionaryHyphens():Boolean
    public function set stripDiscretionaryHyphens(value:Boolean):void
Constructor Detail
PlainTextExporter()Constructor
public function PlainTextExporter()

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Constructor

Method Detail
export()method
public function export(source:TextFlow, conversionType:String):Object

Export text content from a TextFlow instance in String, or XML, or a user defined format.

Set the conversionType parameter to either of the following values, or a user defined format in user-defined exporters.

Parameters

source:TextFlow — The TextFlow to export
 
conversionType:String — Return a String (STRING_TYPE) or XML (XML_TYPE), or any user defined format.

Returns
Object — Object The exported content



The Apache Software Foundation

Wed Mar 25 2015, 07:57 PM +01:00