Paket | flashx.textLayout.conversion |
Klasse | public class TextConverter |
Vererbung | TextConverter Object |
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Das Format der konvertierten Daten ist nicht vordefiniert. Von Benutzern erstellte Konverter können beliebige Formate akzeptieren und zurückgeben. Gängige Formate sind Strings, XML und ByteArray-Instanzen. Die Autoren von Konvertern sollten dokumentieren, welche Formate unterstützt werden.
Eigenschaft | Definiert von | ||
---|---|---|---|
constructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz. | Object | ||
numFormats : int [statisch] [schreibgeschützt] Anzahl von Formaten. | TextConverter |
Methode | Definiert von | ||
---|---|---|---|
[statisch]
Registriert ein neues Format für den Import/Export. | TextConverter | ||
addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void [statisch]
Registriert am angegebenen Speicherort ein neues Format für Import/Export. | TextConverter | ||
[statisch]
Exportiert einen TextFlow in ein angegebenes Format. | TextConverter | ||
[statisch]
Erstellt einen Exportkonverter und gibt ihn zurück. Diesen können Sie anschließend für den Export aus einem TextFlow in einen Quellstring oder ein XML-Objekt verwenden. | TextConverter | ||
[statisch] Gibt den Formatnamen für das index'th-Format zurück. | TextConverter | ||
[statisch] Gibt den FormatDescriptor für das index'th-Format zurück. | TextConverter | ||
[statisch]
Erstellt einen Importkonverter und gibt ihn zurück. Diesen können Sie anschließend für den Import aus einem Quellstring, einem XML-Objekt oder beliebigen benutzerdefinierten Datenformaten in einen TextFlow verwenden. | TextConverter | ||
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde. | Object | ||
importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow [statisch]
Erstellt einen TextFlow aus Quellinhalt in einem angegebenen Format. | TextConverter | ||
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde. | Object | ||
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann. | Object | ||
[statisch]
Entfernt das Format. | TextConverter | ||
[statisch]
Entfernt das Format an der Indexposition. | TextConverter | ||
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest. | Object | ||
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas. | Object | ||
Gibt das angegebene Objekt als String zurück. | Object | ||
Gibt den Grundwert des angegebenen Objekts zurück. | Object |
Konstante | Definiert von | ||
---|---|---|---|
PLAIN_TEXT_FORMAT : String = "plainTextFormat" [statisch]
Nur-Text-Format. | TextConverter | ||
TEXT_FIELD_HTML_FORMAT : String = "textFieldHTMLFormat" [statisch]
HTML-Format. | TextConverter | ||
TEXT_LAYOUT_FORMAT : String = "textLayoutFormat" [statisch]
TextLayout-Format. | TextConverter |
numFormats | Eigenschaft |
addFormat | () | Methode |
public static function addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Registriert ein neues Format für den Import/Export. Das neue Format wird am Ende hinzugefügt und erhält die niedrigste Priorität. Der Speicherort kann wichtig für Clients sein, die mehrere Formate z. B. für das Importieren aus der externen Zwischenablage zur Auswahl bereitstellen. Das neue Format unterstützt ggf. Import- und/oder Exportfunktionen. Wenn das Format bereits hinzugefügt wurde, ist es an verschiedenen Speicherorten vorhanden. Das Format, das als Erstes gefunden wird, wird verwendet.
Parameter
format:String — Die zu registrierende Importkonverter-Klasse oder „null“
| |
importerClass:Class — Die zu registrierende Exportkonverter-Klasse oder „null“
| |
exporterClass:Class — Der Format-String zur Kennzeichnung der Konverterklassen. Für Formate können beliebige Namen festgelegt werden; diese müssen jedoch eindeutig sein.
| |
clipboardFormat:String — Der als Zwischenablageformat verwendete String beim Konvertieren in die/aus der Zwischenablage. Wird auf „null“ gesetzt, wenn das Format den Zugriff auf die Zwischenablage nicht unterstützt.
|
addFormatAt | () | Methode |
public static function addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Registriert am angegebenen Speicherort ein neues Format für Import/Export. Der Speicherort kann wichtig für Clients sein, die mehrere Formate z. B. für das Importieren aus der externen Zwischenablage zur Auswahl bereitstellen. Konverter mit niedrigen Nummern haben eine höhere Priorität und werden zuerst ausprobiert. Das neue Format unterstützt ggf. Import- und/oder Exportfunktionen. Wenn das Format bereits hinzugefügt wurde, ist es an verschiedenen Speicherorten vorhanden. Das Format, das als Erstes gefunden wird, wird verwendet.
Parameter
index:int — Die zu registrierende Importkonverter-Klasse oder „null“
| |
format:String — Die zu registrierende Exportkonverter-Klasse oder „null“
| |
importerClass:Class — Der Format-String zur Kennzeichnung der Konverterklassen
| |
exporterClass:Class (default = null ) — Der als Zwischenablageformat verwendete String beim Konvertieren in die/aus der Zwischenablage. Wird auf „null“ gesetzt, wenn das Format den Zugriff auf die Zwischenablage nicht unterstützt.
| |
clipboardFormat:String (default = null )
|
export | () | Methode |
public static function export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Exportiert einen TextFlow in ein angegebenes Format.
Legen Sie mithilfe einer der in dieser Klasse bereitgestellten statischen Konstanten, eines MIME-Typs oder eines benutzerdefinierten Formats für benutzerdefinierte Exportprogramme den format
-Parameter fest:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Legen Sie den Typ der Exportdaten im conversionType
-Parameter mithilfe einer der durch die ConversionType-Klasse bereitgestellten statischen Konstanten bzw. einen benutzerdefinierten Datentyp für benutzerdefinierte Exportprogramme fest:
- ConversionType.STRING_TYPE
- ConversionType.XML_TYPE
Parameter
source:flashx.textLayout.elements:TextFlow — Quellinhalt
| |
format:String — Ausgabeformat
| |
conversionType:String — Typ der exportierten Daten
|
Object — TextFlow in als Objekt exportierter Formoder null bei Fehlern
|
Verwandte API-Elemente
getExporter | () | Methode |
public static function getExporter(format:String):flashx.textLayout.conversion:ITextExporter
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Erstellt einen Exportkonverter und gibt ihn zurück. Diesen können Sie anschließend für den Export aus einem TextFlow in einen Quellstring oder ein XML-Objekt verwenden. Verwenden Sie diese Funktion, wenn Sie viele separate Exporte durchführen müssen. Dies entspricht dem Aufrufen von flashx.textLayout.conversion.TextConverter.export()
.
Mit einer der in dieser Klasse bereitgestellten statischen Konstanten können Sie den format
-Parameter angeben:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Wenn das Format mehrere Male hinzugefügt wurde, wird das Format verwendet, das als Erstes gefunden wird.
Parameter
format:String — Zielformat für exportierte Daten
|
flashx.textLayout.conversion:ITextExporter — ITextExporter-Textexportprogramm für den Export im angegebenen Format
|
Verwandte API-Elemente
Beispiel ( Verwendung dieses Beispiels )
Dieses Codefragment zeigt die Verwendung der getExporter
-Methode, um wiederholte Exporte formatierten Texts durchzuführen.
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 | () | Methode |
getFormatDescriptorAt | () | Methode |
public static function getFormatDescriptorAt(index:int):FormatDescriptor
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Gibt den FormatDescriptor für das index'th-Format zurück.
Parameter
index:int |
FormatDescriptor |
getImporter | () | Methode |
public static function getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Erstellt einen Importkonverter und gibt ihn zurück. Diesen können Sie anschließend für den Import aus einem Quellstring, einem XML-Objekt oder beliebigen benutzerdefinierten Datenformaten in einen TextFlow verwenden. Verwenden Sie diese Methode, wenn Sie viele separate Importe durchführen müssen oder Fehler während des Imports verarbeiten möchten. Dies entspricht dem Aufrufen von flashx.textLayout.conversion.TextConverter.importToFlow()
.
Mithilfe der in dieser Klasse bereitgestellten statischen Konstanten können Sie den format
-Parameter, einen MIME-Typ oder ein benutzerdefiniertes Datenformat angeben.
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Wenn das Format mehrere Male hinzugefügt wurde, wird das Format verwendet, das als Erstes gefunden wird.
Parameter
format:String — Format des Quellinhalts. Möglich sind Konstanten aus flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, TEXT_FIELD_HTML_FORMAT usw., MIME-Typen oder benutzerdefinierte Formate.
| |
config:IConfiguration (default = null ) — Die Konfiguration, die während dieses Imports verwendet werden soll. „null“ steht für das Übernehmen der aktuellen Standardeinstellung. Sie können die Konfiguration auch mithilfe der ITextImporter.configuration -Eigenschaft festlegen.
|
flashx.textLayout.conversion:ITextImporter — ITextImporter-Textimportprogramm, das die Quelldaten importieren kann
|
Verwandte API-Elemente
Beispiel ( Verwendung dieses Beispiels )
Dieses Codefragment zeigt die Verwendung der getImporter
-Methode, um wiederholte Importe formatierten Texts durchzuführen. Beachten Sie, dass Fehler zu Beginn jedes Aufrufs von importToFlow
gelöscht werden.
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 | () | Methode |
public static function importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Erstellt einen TextFlow aus Quellinhalt in einem angegebenen Format.
Legen Sie mithilfe einer der in dieser Klasse bereitgestellten statischen Konstanten, eines MIME-Typs, den format
-Parameter fest oder verwenden Sie einen benutzerdefinierten Wert für vom Benutzer registrierte Importprogramme:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Parameter
source:Object — Quellinhalt
| |
format:String — Format des Quellinhalts
| |
config:IConfiguration (default = null ) — IConfiguration, die beim Erstellen neuer TextFlows verwendet werden soll
|
flashx.textLayout.elements:TextFlow — Aus der Quelle erstellter TextFlow oder null bei Fehlern.
|
Verwandte API-Elemente
removeFormat | () | Methode |
public static function removeFormat(format:String):void
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Entfernt das Format. Wenn ein Format mehrfach hinzugefügt wurde, wird nur die erste gefundene Instanz entfernt.
Parameter
format:String — Der zu entfernende Konverter-Formatstring
|
removeFormatAt | () | Methode |
PLAIN_TEXT_FORMAT | Konstante |
public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
Nur-Text-Format. Verwenden Sie dies zum Erstellen eines TextFlow aus einem einfachen, unformatierten String oder zum Erstellen eines einfachen, unformatierten Strings aus einem TextFlow.
TEXT_FIELD_HTML_FORMAT | Konstante |
public static const TEXT_FIELD_HTML_FORMAT:String = "textFieldHTMLFormat"
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
HTML-Format. Verwenden Sie dies zum Importieren aus oder Exportieren in einen TextFlow mithilfe des HTML-Fomats. Das Text Layout Framework HTML unterstützt einen Teil der Tags und Attribute, die von der TextField-Klasse im flash.text
-Paket unterstützt werden.
In der folgenden Tabelle werden die HTML-Tags und Attribute aufgeführt, die beim Importieren und Exportieren unterstützt werden (Tags und Attribute, die von TextField, jedoch nicht von Text Layout Framework unterstützt werden, gelten als nicht unterstützt):
Tag | Beschreibung |
---|---|
Anker-Tag |
Mit dem Tag <a> wird ein Hyperlink erstellt. Das Tag unterstützt die folgenden Attribute:
|
Fettdruck-Tag |
Mit dem Tag <b> wird Text fett dargestellt. Für die verwendete Schriftart muss ein fettes Schriftbild vorhanden sein.
|
Zeilenumbruch-Tag |
Das Tag <br> fügt einen Zeilenumbruch in den Text ein.
|
Schriftart-Tag |
Mit dem Tag <font> legen Sie fest, welche Schriftarten für die Textanzeige verwendet werden. Die folgenden Attribute werden vom font-Tag unterstützt::
|
Bild-Tag |
Mit dem Tag <img> können Sie externe Bilddateien (JPEG, GIF, PNG), SWF-Dateien und Movieclips in Text einbetten.
Die folgenden Attribute werden vom
Hinweis: Anders als bei der TextField-Klasse werden die folgenden Attribute nicht unterstützt: |
Kursiv-Tag |
Mit dem <i> -Tag markierter Text wird kursiv angezeigt. Für die verwendete Schriftart muss ein kursives Schriftbild vorhanden sein.
|
Listenelement-Tag | Hinweis: Im Unterschied zur TextField-Klasse wird das Listenelement-Tag nicht unterstützt. |
Absatz-Tag |
Mit dem Tag <p> wird ein neuer Absatz erstellt. Die folgenden Attribute werden vom <p> -Tag unterstützt:
|
Bereichs-Tag |
Das <span> -Tag unterstützt folgende Attribute:
|
Textformat-Tag |
Mit dem Tag Die folgenden Attribute werden vom Tag
|
Unterstreichungs-Tag |
Mit dem <u> -Tag markierter Text wird unterstrichen angezeigt.
|
Wenn ein unbekanntes Tag importiert wird, legt das textFieldHTMLFormat
-Importprogramm entweder den Namen dieses Tags für die typeName-Eigenschaft eines einzelnen FlowElement fest oder erstellt ein DivElement oder ein SubParagraphGroupElement und legt den Namen des Tags für dessen typeName-Eigenschaft fest.
Das textFieldHTMLFormat
-Exportprogramm exportiert typeName
als das XML-Tag, wenn ein anderer als der Standardwert angegeben wurde.
Verwandte API-Elemente
TEXT_LAYOUT_FORMAT | Konstante |
public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"
Sprachversion: | ActionScript 3.0 |
Laufzeitversionen: | Flash Player 10, AIR 1.5 |
TextLayout-Format. Verwenden Sie dies zum Importieren aus oder Exportieren in einen TextFlow mithilfe des TextLayout-Markup-Formats. Das Text Layout-Format erkennt die folgenden Fehler:
- Unerwarteter Namespace
- Unbekanntes Element
- Unbekanntes Attribut
Dieses Beispiel zeigt die Verwendung der TextFilter
-Konvertierungsklasse. Text in einem Standard-Markup-Format wird in ein TextFlow
-Objekt importiert und anschließend angezeigt. Der Text wird anschließend in das XML-Format exportiert.
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; } } }
Tue Jun 12 2018, 10:04 AM Z