Pakiet | flashx.textLayout.conversion |
Klasa | public class TextConverter |
Dziedziczenie | TextConverter Object |
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Format konwertowanych danych nie jest predefiniowany — moduły konwersji napisane przez użytkownika mogą akceptować i zwracać dowolnie wybrany format. Typowymi formatami są ciągi, zawartość XML i wystąpienia klasy ByteArray. Autorzy modułów konwersji powinni udokumentować, które formaty są obsługiwane.
Właściwość | Zdefiniowane przez | ||
---|---|---|---|
constructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu. | Object | ||
numFormats : int [statyczny] [tylko do odczytu] Liczba formatów. | TextConverter |
Metoda | Zdefiniowane przez | ||
---|---|---|---|
[statyczny]
Należy zarejestrować nowy format przeznaczony do importowania/eksportowania. | TextConverter | ||
addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void [statyczny]
Nowy format przeznaczony do importowania/eksportowania należy zarejestrować w określonym położeniu. | TextConverter | ||
[statyczny]
Eksportuje obiekt TextFlow do określonego formatu. | TextConverter | ||
[statyczny]
Tworzy i zwraca moduł konwersji eksportu, którego można następnie użyć do eksportowania z obiektu TextFlow do źródłowego ciągu znaków lub obiektu XML. | TextConverter | ||
[statyczny] Zwraca nazwę formatu o numerze określonym przez indeks. | TextConverter | ||
[statyczny] Zwraca obiekt FormatDescriptor dla formatu o numerze określonym przez indeks. | TextConverter | ||
[statyczny]
Tworzy i zwraca moduł konwersji importu, za pomocą którego można następnie przeprowadzić importowanie do obiektu TextFlow z ciągu źródłowego, z obiektu XML lub z dowolnych formatów danych zdefiniowanych przez użytkownika. | TextConverter | ||
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość. | Object | ||
importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow [statyczny]
Tworzy obiekt TextFlow z treści źródłowej w określonym formacie. | TextConverter | ||
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr. | Object | ||
Wskazuje, czy określona właściwość istnieje i jest przeliczalna. | Object | ||
[statyczny]
Usuwa format. | TextConverter | ||
[statyczny]
Usuwa format o podanym indeksie. | TextConverter | ||
Ustawia dostępność właściwości dynamicznej używanej w pętlach. | Object | ||
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych. | Object | ||
Zwraca ciąg reprezentujący określony obiekt. | Object | ||
Zwraca pierwotną wartość dla określonego obiektu. | Object |
Stała | Zdefiniowane przez | ||
---|---|---|---|
PLAIN_TEXT_FORMAT : String = "plainTextFormat" [statyczny]
Format zwykłego tekstu. | TextConverter | ||
TEXT_FIELD_HTML_FORMAT : String = "textFieldHTMLFormat" [statyczny]
Format HTML. | TextConverter | ||
TEXT_LAYOUT_FORMAT : String = "textLayoutFormat" [statyczny]
Format TextLayout. | TextConverter |
numFormats | właściwość |
addFormat | () | metoda |
public static function addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Należy zarejestrować nowy format przeznaczony do importowania/eksportowania. Nowy format zostanie dodany na końcu — jako format o najniższym priorytecie. Położenie może mieć znaczenie dla klientów mających do wyboru liczne opcje dotyczące tego, którego formatu używać, na przykład podczas importowania ze schowka zewnętrznego. Nowy format może obsługiwać importowanie i/lub eksportowanie. Jeśli format został już dodany, będzie on występować w wielu położeniach. Zostanie użyte pierwsze znalezione położenie.
Parametry
format:String — Klasa modułu konwersji importu do zarejestrowania lub wartość null.
| |
importerClass:Class — Klasa modułu konwersji eksportu do zarejestrowania lub wartość null.
| |
exporterClass:Class — Ciąg formatu oznaczający klasy modułów konwersji. Dowolna nazwa może być formatem, ale musi ona być unikatowa.
| |
clipboardFormat:String — Ciąg używany jako format schowka w przypadku konwersji do/ze schowka. Jeśli format nie obsługuje dostępu do schowka, tej właściwości należy nadać wartość null.
|
addFormatAt | () | metoda |
public static function addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Nowy format przeznaczony do importowania/eksportowania należy zarejestrować w określonym położeniu. Położenie może mieć znaczenie dla klientów mających do wyboru liczne opcje dotyczące tego, którego formatu używać, na przykład podczas importowania ze schowka zewnętrznego. Niższe liczby oznaczają wyższy priorytet; te moduły konwersji zostaną wypróbowane w pierwszej kolejności. Nowy format może obsługiwać importowanie i/lub eksportowanie. Jeśli format został już dodany, będzie on występować w wielu położeniach. Zostanie użyte pierwsze znalezione położenie.
Parametry
index:int — Klasa modułu konwersji importu do zarejestrowania lub wartość null.
| |
format:String — Klasa modułu konwersji eksportu do zarejestrowania lub wartość null.
| |
importerClass:Class — Ciąg formatu oznaczający klasy metod konwersji.
| |
exporterClass:Class (default = null ) — Ciąg używany jako format schowka w przypadku konwersji do/ze schowka. Jeśli format nie obsługuje dostępu do schowka, tej właściwości należy nadać wartość null.
| |
clipboardFormat:String (default = null )
|
export | () | metoda |
public static function export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Eksportuje obiekt TextFlow do określonego formatu.
W celu określenia wartości parametru format
należy użyć jednej ze stałych statycznych dostarczanych z tą klasą, typu MIME lub formatu zdefiniowanego przez użytkownika dla modułów eksportu zdefiniowanych przez użytkownika.
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
W parametrze conversionType
należy określić typ eksportowanych danych za pomocą jednej ze stałych statycznych podawanych przez klasę ConversionType lub typu danych zdefiniowanego przez użytkownika dla funkcji eksportu zdefiniowanych przez użytkownika.
- ConversionType.STRING_TYPE
- ConversionType.XML_TYPE
Parametry
source:flashx.textLayout.elements:TextFlow — Treść źródłowa
| |
format:String — Format wyjściowy
| |
conversionType:String — Typ eksportowanych danych
|
Object — Obiekt wyeksportowany z obiektu TextFlow lub null w przypadku błędów.
|
Powiązane elementy interfejsu API
getExporter | () | metoda |
public static function getExporter(format:String):flashx.textLayout.conversion:ITextExporter
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Tworzy i zwraca moduł konwersji eksportu, którego można następnie użyć do eksportowania z obiektu TextFlow do źródłowego ciągu znaków lub obiektu XML. Z tej funkcji należy skorzystać, jeśli istnieje wiele osobnych operacji eksportu do wykonania. Użycie jej jest równoważne wywołaniu flashx.textLayout.conversion.TextConverter.export()
.
W celu określenia parametru format
należy użyć stałej statycznej udostępnionej razem z klasą.
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Jeśli format został dodany wiele razy, zostanie użyte pierwsze znalezione wystąpienie.
Parametry
format:String — Format docelowy dla eksportowanych danych.
|
flashx.textLayout.conversion:ITextExporter — Moduł eksportu tekstu, który może eksportować w określonym formacie.
|
Powiązane elementy interfejsu API
Przykład ( Sposób korzystania z tego przykładu )
Ten urywek kodu przedstawia użycie metody getExporter
w celu przeprowadzenia powtarzalnych operacji eksportu sformatowanego tekstu.
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 | () | metoda |
getFormatDescriptorAt | () | metoda |
public static function getFormatDescriptorAt(index:int):FormatDescriptor
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Zwraca obiekt FormatDescriptor dla formatu o numerze określonym przez indeks.
Parametry
index:int |
FormatDescriptor |
getImporter | () | metoda |
public static function getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Tworzy i zwraca moduł konwersji importu, za pomocą którego można następnie przeprowadzić importowanie do obiektu TextFlow z ciągu źródłowego, z obiektu XML lub z dowolnych formatów danych zdefiniowanych przez użytkownika. Z tej metody należy korzystać, jeśli istnieje wiele osobnych operacji importowania do wykonania lub podczas importowania jest wymagana obsługa błędów. Użycie jej jest równoważne wywołaniu flashx.textLayout.conversion.TextConverter.importToFlow()
.
W celu określenia parametru format
należy użyć jednej ze stałych statycznych podawanych przez tę klasę, typu MIME lub formatu danych zdefiniowanego przez użytkownika.
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Jeśli format został dodany wiele razy, zostanie użyte pierwsze znalezione wystąpienie.
Parametry
format:String — Format zawartości źródłowej. Należy użyć stałych flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, TEXT_FIELD_HTML_FORMAT itd., typu MIME lub formatu zdefiniowanego przez użytkownika.
| |
config:IConfiguration (default = null ) — Konfiguracja do użycia podczas importu. Wartość null oznacza przyjęcie aktualnych wartości domyślnych. Konfigurację można również ustawiać za pomocą właściwości ITextImporter.configuration .
|
flashx.textLayout.conversion:ITextImporter — Moduł importu tekstu, który może importować dane źródłowe.
|
Powiązane elementy interfejsu API
Przykład ( Sposób korzystania z tego przykładu )
Ten urywek kodu przedstawia użycie metody getImporter
w celu przeprowadzenia powtarzalnych operacji importu sformatowanego tekstu. Błędy są kasowane na początku każdego wywołania metody 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 | () | metoda |
public static function importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Tworzy obiekt TextFlow z zawartości ródłowej w określonym formacie.
W celu określenia parametru format
należy użyć jednej ze stałych statycznych podawanych przez tę klasę, typu MIME lub wartości zdefiniowanej przez użytkownika w przypadku funkcji importowania zarejestrowanych przez użytkownika.
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Parametry
source:Object — Zawartość ródłowa
| |
format:String — Format treści źródłowej
| |
config:IConfiguration (default = null ) — Interfejs IConfiguration do użycia podczas tworzenia nowych obiektów TextFlow
|
flashx.textLayout.elements:TextFlow — Obiekt TextFlow, który został utworzony ze źródła, lub null w przypadku błędów.
|
Powiązane elementy interfejsu API
removeFormat | () | metoda |
public static function removeFormat(format:String):void
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Usuwa format. Jeśli format został dodany wiele razy, zostanie usunięte tylko jego pierwsze znalezione wystąpienie.
Parametry
format:String — Ciąg formatu modułu konwersji do usunięcia.
|
removeFormatAt | () | metoda |
PLAIN_TEXT_FORMAT | Stała |
public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Format zwykłego tekstu. Służy do tworzenia obiektów TextFlow z prostego, niesformatowanego ciągu znaków lub do utworzenia prostego, niesformatowanego ciągu znaków z obiektu TextFlow.
TEXT_FIELD_HTML_FORMAT | Stała |
public static const TEXT_FIELD_HTML_FORMAT:String = "textFieldHTMLFormat"
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Format HTML. Służy do importowania z lub eksportowania do obiektu TextFlow treści w formacie HTML. W podzbiorze języka HTML obsługiwanym przez architekturę Text Layout Framework można stosować znaczniki i atrybuty obsługiwane przez klasę TextField w pakiecie flash.text
.
W poniższej tabeli wymieniono znaczniki i atrybuty HTML obsługiwane przez proces importowania i eksportowania (znaczniki i atrybuty obsługiwane przez klasę TextField, ale nieobsługiwane przez architekturę Text Layout Framework, są wyraźnie opisane jako nieobsługiwane):
Znacznik | Opis |
---|---|
Znacznik zakotwiczenia |
Znacznik <a> służy do tworzenia łącza hipertekstowego i obsługuje następujące atrybuty:
|
Znacznik pogrubienia |
Znacznik <b> renderuje tekst jako pogrubiony. Użyta czcionka musi być dostępna w typie pogrubiona.
|
Znacznik podziału |
Znacznik <br> tworzy podział wiersza w tekście.
|
Znacznik czcionki |
Znacznik czcionki <font> określa czcionkę lub listę czcionek wyświetlanego tekstu. Znacznik czcionek obsługuje następujące atrybuty:
|
Znacznik obrazu |
Znacznik <img> umożliwia osadzenie zewnętrznych plików obrazu (JPEG, GIF, PNG), plików SWF oraz klipów filmowych wewnątrz tekstu.
Znacznik
Uwaga: Inaczej niż w klasie TextField, następujące atrybuty nie są obsługiwane: |
Znacznik kursywy |
Znacznik kursywy <i> wyświetla oznaczony tekst w kursywie. Użyta czcionka musi być dostępna w typie kursywa.
|
Znacznik elementu listy | Uwaga: inaczej niż w klasie TextField, znacznik elementu listy (LI) nie jest obsługiwany. |
Znacznik akapitu |
Znacznik paragrafu <p> umożliwia utworzenie nowego akapitu. Znacznik <p> obsługuje następujące atrybuty:
|
Znacznik zakresu |
Znacznik <span> obsługuje następujące atrybuty:
|
Znacznik formatu tekstu |
Znacznik formatu tekstu Znacznik
|
Znacznik podkreślenia |
Znacznik podkreślenia <u> Ustawia podkreślenie dla tekstu oznaczonego tym znacznikiem.
|
Gdy jest importowany nieznany znacznik, moduł importu textFieldHTMLFormat
ustawia dla pojedynczej właściwości typeName elementu FlowElement nazwę tego znacznika albo tworzy element DivElement lub SubParagraphGroupElement, dla którego we właściwości typeName jest ustawiana nazwa znacznika.
Moduł eksportu textFieldHTMLFormat
eksportuje właściwość typeName
jako znacznik XML, gdy różni się ona różnić od domyślnego.
Powiązane elementy interfejsu API
TEXT_LAYOUT_FORMAT | Stała |
public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"
Wersja języka: | ActionScript 3.0 |
Wersje środowiska wykonawczego: | Flash Player 10, AIR 1.5 |
Format TextLayout. Służy do importowania z lub eksportowania do obiektu TextFlow treści w formacie TextLayout ze znacznikami. Format Text Layout wykryje następujące błędy:
- Nieoczekiwana przestrzeń nazw
- Nieznany element
- Nieznany atrybut
Ten przykład ilustruje użycie klasy konwersji TextConverter
. Tekst w standardowym formacie ze znacznikami został zaimportowany do obiektu TextFlow
, a następnie wyświetlony. Następnie tekst został wyeksportowany w formacie XML.
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, 12:06 PM Z