TextConverter - API-referens för Adobe ActionScript® 3 (AS3 )

Paket	flashx.textLayout.conversion
Klass	public class TextConverter
Arv	TextConverter Object

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Detta är gateway-klassen för import- och exporthantering. Den används som en förenad åtkomstpunkt för konverteringsfunktionen i Text Layout Framework. Den innehåller ett register för fördefinierade samt användardefinierade indata- och/eller utdatakonverterare. Dessutom kommer det att finnas en uppsättning med konverteringsmetoder.

Formatet för konverterade data är inte fördefinierat. Konverterare skrivna av användare är fria att acceptera och returnera valfritt format. Vanliga format är strängar, XML och ByteArray-instanser. Den som skapar konverterare ska dokumentera vilka format som stöds.

Visa exemplen

Fler exempel

Creating a TextFlow object with the TextConverter class

Publika egenskaper

Dölj ärvda publika egenskaper

Visa ärvda publika egenskaper

	Egenskap		Definieras med
		constructor : Object En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.	Object
		numFormats : int [statisk] [skrivskyddad] Antal format.	TextConverter

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void [statisk] Registrera ett nytt format för import/export.	TextConverter
		addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void [statisk] Registrera ett nytt format för import/export vid den angivna platsen.	TextConverter
		export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object [statisk] Exporterar ett TextFlow till ett angivet format.	TextConverter
		getExporter(format:String):flashx.textLayout.conversion:ITextExporter [statisk] Skapar och returnerar en exportkonverterare som du sedan kan använda för att exportera från ett TextFlow till en källsträng eller ett XML-objekt.	TextConverter
		getFormatAt(index:int):String [statisk] Returnerar formatnamnet för formatet vid indexvärdet	TextConverter
		getFormatDescriptorAt(index:int):FormatDescriptor [statisk] Returnerar FormatDescriptor för formatet vid indexvärdet.	TextConverter
		getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter [statisk] Skapar och returnerar en importkonverterare som sedan kan användas för att importera från en källsträng, ett XML-objekt eller eventuella användardefinierade dataformat till ett TextFlow.	TextConverter
		hasOwnProperty(name:String):Boolean Anger om det finns en egenskap angiven för ett objekt.	Object
		importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow [statisk] Skapar ett TextFlow från källans innehåll i ett angivet format.	TextConverter
		isPrototypeOf(theClass:Object):Boolean Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.	Object
		propertyIsEnumerable(name:String):Boolean Anger om den angivna egenskapen finns och är uppräkningsbar.	Object
		removeFormat(format:String):void [statisk] Ta bort formatet.	TextConverter
		removeFormatAt(index:int):void [statisk] Ta bort formatet vid indexplatsen.	TextConverter
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.	Object
		toLocaleString():String Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.	Object
		toString():String Returnerar det angivna objektets strängbeteckning.	Object
		valueOf():Object Returnerar det angivna objektets primitiva värde.	Object

Publika konstanter

	Konstant		Definieras med
		PLAIN_TEXT_FORMAT : String = "plainTextFormat" [statisk] Oformaterad text.	TextConverter
		TEXT_FIELD_HTML_FORMAT : String = "textFieldHTMLFormat" [statisk] HTML-format.	TextConverter
		TEXT_LAYOUT_FORMAT : String = "textLayoutFormat" [statisk] TextLayout-format.	TextConverter

Egenskapsdetaljer

numFormats

egenskap

numFormats:int [skrivskyddad]

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Antal format.

Implementering
public static function get numFormats():int

Metoddetaljer

addFormat

()

metod

public static function addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Registrera ett nytt format för import/export. Det nya formatet kommer att läggas till i slutet med lägsta prioritet. Platser kan vara signifikanta för klienter som har flera val för vilket format som ska användas, t.ex. vid import från det externa urklippet. Det nya formatet kan ha stöd för import och/eller export. Om formatet redan har lagts till kommer det att finnas på flera platser. Det första som hittas kommer att användas.

Parametrar

	`format:String` — Importkonverterarklassen för att registrera eller null

	`importerClass:Class` — Exportkonverterarklassen för att registrera eller null

	`exporterClass:Class` — Den formatsträngstaggning som konverteraren klassar. Format kan ha valfritt namn, men det måste vara unikt.

	`clipboardFormat:String` — Strängen som används som urklippsformat vid konvertering till/från urklippet. Gör detta till null om formatet inte har stöd för urklippsåtkomst.

addFormatAt

()

metod

 public static function addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Registrera ett nytt format för import/export vid den angivna platsen. Platser kan vara signifikanta för klienter som har flera val för vilket format som ska användas, t.ex. vid import från det externa urklippet. Lägre nummer visar högre prioritet och dessa konverterare kommer att provas först. Det nya formatet kan ha stöd för import och/eller export. Om formatet redan har lagts till kommer det att finnas på flera platser. Det första som hittas kommer att användas.

Parametrar

	`index:int` — Importkonverterarklassen för att registrera eller null

	`format:String` — Exportkonverterarklassen för att registrera eller null

	`importerClass:Class` — Den formatsträngstaggning som konverteraren klasser

	`exporterClass:Class` (default = `null`) — Strängen som används som urklippsformat vid konvertering till/från urklippet. Gör detta till null om formatet inte har stöd för urklippsåtkomst.

	`clipboardFormat:String` (default = `null`)

export

()

metod

public static function export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Exporterar ett TextFlow till ett angivet format.

Använd en av de statiska konstanterna i den här klassen, en MIME-typ, eller ett användardefinierat format för användardefinierade exporterare för att ange format- parametern:

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

Ange typen för exporterade data i conversionType-parametern med en statisk konstant som finns i ConversionType-klassen eller en användardefinierad datatyp för användardefinierade exporterare:

ConversionType.STRING_TYPE
ConversionType.XML_TYPE

Returnerar en representation av TextFlow i det angivna formatet eller null vid fel.

Parametrar

	`source:flashx.textLayout.elements:TextFlow` — Källans innehåll

	`format:String` — Utdataformat

	`conversionType:String` — Typ av exporterade data

Returnerar

Object — Objektexportformulär för TextFloweller null vid fel

Relaterade API-element

TEXT_FIELD_HTML_FORMAT
PLAIN_TEXT_FORMAT
TEXT_LAYOUT_FORMAT
flashx.textLayout.conversion.ConversionType

getExporter

()

metod

public static function getExporter(format:String):flashx.textLayout.conversion:ITextExporter

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Skapar och returnerar en exportkonverterare som du sedan kan använda för att exportera från ett TextFlow till en källsträng eller ett XML-objekt. Använd den här funktionen om du har många olika exporter att utföra. Det motsvarar anropet flashx.textLayout.conversion.TextConverter.export().

Använd en av de statiska konstanterna som finns för den här klassen för att ange format-parametern:

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

Om formatet har lagts till flera gånger kommer det som hittas först att användas

Parametrar

format:String — Målformat för exporterade data

Returnerar

flashx.textLayout.conversion:ITextExporter — Textexporterare för ITextExporter som kan exporteras i det angivna formatet

Relaterade API-element

TEXT_FIELD_HTML_FORMAT
PLAIN_TEXT_FORMAT
TEXT_LAYOUT_FORMAT

Exempel ( Så här använder du exemplet )

Detta kodfragment visar hur getExporter-metoden kan användas för att utföra upprepade exporter av formaterad text.


package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ConversionType;
    import flashx.textLayout.conversion.ITextExporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class getExporter_example 
    {
        // Serialize the TextFlow into a String
        public function export(textFlow:TextFlow):String
        {
            var exporter:ITextExporter = TextConverter.getExporter(TextConverter.TEXT_LAYOUT_FORMAT);
            return exporter.export(textFlow, ConversionType.STRING_TYPE) as String;
        }
    }
}

getFormatAt

()

metod

public static function getFormatAt(index:int):String

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Returnerar formatnamnet för formatet vid indexvärdet

Parametrar

index:int

Returnerar

String

getFormatDescriptorAt

()

metod

public static function getFormatDescriptorAt(index:int):FormatDescriptor

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Returnerar FormatDescriptor för formatet vid indexvärdet.

Parametrar

index:int

Returnerar

FormatDescriptor

getImporter

()

metod

 public static function getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Skapar och returnerar en importkonverterare som sedan kan användas för att importera från en källsträng, ett XML-objekt eller eventuella användardefinierade dataformat till ett TextFlow. Använd den här metoden om du har många olika importer att utföra eller om du vill hantera fel under importen. Det motsvarar anropet flashx.textLayout.conversion.TextConverter.importToFlow().

Använd en av de statiska konstanterna som medföljer klassen för att ange parametern format, en MIME-typ eller ett användardefinierat format.

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

Om formatet har lagts till flera gånger kommer det som hittas först att användas

Parametrar

	`format:String` — Format för källinnehåll Använd konstanter från flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, TEXT_FIELD_HTML_FORMAT, osv. en MIME-typ eller ett användardefinierat format.

	`config:IConfiguration` (default = `null`) — konfiguration som ska användas under denna import. null innebär att aktuell standard används. Du kan även ange konfigurationen via egenskapen `ITextImporter.configuration`.

Returnerar

flashx.textLayout.conversion:ITextImporter — Textimporterare för ITextImporter som kan importera källdata

Relaterade API-element

TEXT_FIELD_HTML_FORMAT
PLAIN_TEXT_FORMAT
TEXT_LAYOUT_FORMAT

Exempel ( Så här använder du exemplet )

Detta kodfragment visar hur getImporter-metoden kan användas för att utföra upprepade importer av formaterad text. Observera att fel tas bort i början av varje anrop till importToFlow.


package flashx.textLayout.conversion.examples
{
    import flashx.textLayout.conversion.ITextImporter;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.elements.TextFlow;
    
    public class getImporter_example 
    {
        public function importAndCheckErrors():TextFlow
        {
            var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
            var importer:ITextImporter = TextConverter.getImporter(TextConverter.TEXT_LAYOUT_FORMAT);
            importer.throwOnError = false;
            var textFlow:TextFlow = importer.importToFlow(markup);
            if (!textFlow)
            {
                var errors:Vector.<String> = importer.errors;
                //deal with import errors
            }
            return textFlow;
        }
    }
}

importToFlow

()

metod

 public static function importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Skapar ett TextFlow från källans innehåll i ett angivet format.

Använd en av de statiska konstanterna som medföljer den här klassen, en MIME-typ, för att ange parametern format eller använd ett användardefinierat värde för användarregistrerade importerare:

TextConverter.TEXT_FIELD_HTML_FORMAT
TextConverter.PLAIN_TEXT_FORMAT
TextConverter.TEXT_LAYOUT_FORMAT

Parametrar

	`source:Object` — Källans innehåll

	`format:String` — Format för källinnehåll

	`config:IConfiguration` (default = `null`) — Den IConfiguration som ska används för att skapa nya TextFlows

Returnerar

flashx.textLayout.elements:TextFlow — TextFlow som skapades från källan eller null vid fel.

Relaterade API-element

TEXT_FIELD_HTML_FORMAT
PLAIN_TEXT_FORMAT
TEXT_LAYOUT_FORMAT

removeFormat

()

metod

public static function removeFormat(format:String):void

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Ta bort formatet. Om ett format har lagts till flera gånger kommer endast det som hittas först att tas bort.

Parametrar

format:String — Konverterarformatsträngen som ska tas bort

removeFormatAt

()

metod

public static function removeFormatAt(index:int):void

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Ta bort formatet vid indexplatsen.

Parametrar

index:int — Det format som ska tas bort

Konstantdetaljer

PLAIN_TEXT_FORMAT

Konstant

public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

Oformaterad text. Använd detta för att skapa ett TextFlow av en enkel, oformaterad sträng eller för att skapa en enkel oformaterad sträng av ett TextFlow.

TEXT_FIELD_HTML_FORMAT

Konstant

public static const TEXT_FIELD_HTML_FORMAT:String = "textFieldHTMLFormat"

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

HTML-format. Använd detta för att importera från eller exportera till ett TextFlow med HTML-formatet. HTML-formatet i Text Layout Framework (TLF) har stöd för en underuppsättning av de taggar och attribut som stöds av klassen TextField i flash.text-paketet.

Följande tabell visar de HTML-taggar och -attribut som stöds för import och export (för taggar och attribut som stöds av TextField, men inte av Text Layout Framework, anges detta särskilt):

Tagg	Beskrivning
Ankartagg	Med `<a>`-taggen skapas en hypertextlänk och den används med följande attribut: `target`: Anger namnet på målfönstret där sidan läses in. Alternativen är `_self`, `_blank`, `_parent` och `_top`. Med alternativet `_self` anges den aktuella bildrutan i aktuellt fönster. `_blank` anger ett nytt fönster, `_parent` anger den aktuella bildrutans överordnade bildruta och `_top` anger bildrutan på översta nivån i aktuellt fönster. `href`: Anger en webbadress. Webbadressen kan vara antingen absolut eller relativ i förhållande till placeringen av den SWF-fil som läser in sidan. Ett exempel på en absolut referens till en URL är `http://www.adobe.com`; ett exempel på en relativ referens är `/index.html`. Absoluta URL-adresser måste inledas med http://, annars behandlas de som relativa URL-adresser. Obs! Till skillnad från klassen TextField stöds inte `link`-händelser i ActionScript. Formaten `a:link`, `a:hover` och `a:active` stöds inte heller.
Tagg för fetstil	Taggen `<b>` visar text i fetstil. Det måste finnas ett tillgängligt typsnitt för fetstil.
Tagg för radbrytning	Med `<br>`-taggen skapas en radbrytning i texten.
Tagg för teckensnitt	Med `<font>`-taggen anges ett teckensnitt eller lista med flera teckensnitt för textvisningen. Teckensnittstaggen kan användas med följande attribut: `color`: Endast hexadecimala färgvärden (`#FFFFFF`) används. `face`: Anger namnet på teckensnittet som används. Du kan ange en lista med kommaseparerade teckensnittsnamn från vilken Flash Player väljer det första tillgängliga teckensnittet. Om angivet teckensnitt inte är installerat på det lokala datorsystemet eller inte finns inbäddat i SWF-filen väljer Flash Player ett ersättningsteckensnitt. `size`: Anger teckensnittets storlek. Du kan använda absoluta pixelstorlekar, t.ex. 16 eller 18, eller relativa teckenstorlekar som +2 eller -4. `letterspacing`: Anger den spårning (manuella kerning) som ska användas till höger om varje tecken i pixlar. `kerning`: Anger om kerning är aktiverat eller inte. Ett värde som inte är noll aktiverar kerning, och noll inaktiverar det.
Tagg för bild	Med `<img>`-taggen bäddar du in externa bildfiler (JPEG, GIF, PNG), SWF-filer och filmklipp i texten. `<img>`-taggen kan användas med följande attribut: `src`: Anger URL:en till en bild- eller SWF-fil eller till länknings-ID:t för en filmklippssymbol i biblioteket. Det här attributet är obligatoriskt, de övriga är valfria. Externa filer (JPEG-, GIF-, PNG- och SWF-filer) visas inte förrän de är nedladdade. `width`: Bredden (antal pixlar) på bilden, SWF-filen eller filmklippet som ska infogas. `height`: Höjden (antal pixlar) på bilden, SWF-filen eller filmklippet som ska infogas. Obs! Till skillnad från klassen TextField stöds inte följande attribut: `align`, `hspace`, `vspace`, `id` och `checkPolicyFile`.
Tagg för kursiv text	Taggen `<i>` visar texten i kursiv stil. Det måste finnas ett tillgängligt teckensnitt för kursiv text.
Tagg för punktlista	Obs! Till skillnad från klassen TextField stöds taggen för punktlista inte.
Tagg för stycke	Med `<p>`-taggen skapar du ett nytt stycke. `<p>`-taggen kan användas med följande attribut: align: Anger textjusteringen inom stycket. Giltiga värden är `left`, `right`, `justify` och `center`. class: Anger ett klassnamn som kan användas för format.
Tagg för textspann	`<span>`-taggen kan användas med följande attribut: class: Anger ett klassnamn som kan användas för format. Span-taggar används ofta för att ställa in ett format som definieras i en formatmall, men TLFTextField-instanser saknar stöd för formatmallar. Span-taggen är tillgänglig för TLFTextField-instanser för att referera till en klass med formategenskaper. Du kan även placera egenskaper direkt i span-taggen: `<span fontFamily="Arial">Hi there</span>`. Kapslade span-taggar stöds emellertid inte.
Tagg för textformat	Med `<textformat>`-taggen kan du använda en delmängd av egenskaper för textstyckeformatering i TextFormat-klassen inom textfält; vilket ger radavstånd, indrag, marginaler och tabbstopp. Du kan kombinera `<textformat>`-taggar med inbyggda HTML-taggar. `<textformat>`-taggen kan användas med följande attribut: `indent`: Anger indrag från vänstermarginalen till det första tecknet i stycket; motsvarar `TextFormat.indent`. Både positiva och negativa tal kan användas. `blockindent`: Anger det indrag som ska användas på alla rader i stycket. `leftmargin`: Anger vänstermarginal för textstycket i antal punkter; motsvarar `TextFormat.leftMargin`. `rightmargin`: Anger högermarginal för textstycket i antal punkter; motsvarar `TextFormat.rightMargin`. `leading`: Anger radavståndet (radhöjd) mätt i pixlar mellan en rads uppstapel och föregående rads nedstapel. `tabstops`: Anger en kommaavgränsad lista över tabbstopp för stycket.
Tagg för understruken text	Taggen `<u>` visar texten understruken.

När en okänd tagg importeras kommer importeraren textFieldHTMLFormat antingen att ange en enskild typeName-egenskap för FlowElement till taggnamnet, eller skapa ett DivElement eller ett SubParagraphGroupElement med dess typeName-egenskap angedd som taggnamnet.

Exporteraren textFieldHTMLFormat kommer att exportera typeName som XML-taggen när den inte är lika som standardvärdet.

Relaterade API-element

flashx.textLayout.elements.FlowElement.typeName

TEXT_LAYOUT_FORMAT

Konstant

public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"

Språkversion:

ActionScript 3.0

Körningsmiljöversioner:

Flash Player 10, AIR 1.5

TextLayout-format. Använd detta för att importera från eller exportera till ett TextFlow där TextLayout-kod används. I TextLayout-format upptäcks följande fel:

Oväntat namnutrymme
Okänt element
Okänt attribut

Exempel Så här använder du exemplet

TextConverter_example.as

Det här exemplet visar hur konverteringsklassen TextConverter kan användas. Texten i standardkodformat importeras till ett TextFlow-objekt och visas därefter. Texten exporteras därefter till XML-format.

package flashx.textLayout.conversion.examples 
{
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.conversion.ConversionType;

    public class TextConverter_example extends Sprite
    {
        public function TextConverter_example()
        {
            var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>";
            var textFlow:TextFlow = TextConverter.importToFlow(markup, TextConverter.TEXT_LAYOUT_FORMAT);
            textFlow.flowComposer.addController(new ContainerController(this, 200, 50));
            textFlow.flowComposer.updateAllControllers();
            //export to XML
            var xmlOut:XML = TextConverter.export(textFlow,TextConverter.TEXT_LAYOUT_FORMAT, ConversionType.XML_TYPE) as XML;
        }
    }
}

Juridiska meddelanden | Onlinesekretesspolicy

TextConverter - AS3

Klasser x

numFormats

addFormat

addFormatAt

export

getExporter

getFormatAt

getFormatDescriptorAt

getImporter

importToFlow

removeFormat

removeFormatAt

PLAIN_TEXT_FORMAT

TEXT_FIELD_HTML_FORMAT

TEXT_LAYOUT_FORMAT