適用於 Adobe® Flash® Platform 的 ActionScript® 3.0 參考
首頁  |  隱藏套件和類別清單 |  套件  |  類別  |  新增內容  |  索引  |  附錄  |  為什麼顯示英文?
篩選: 從伺服器擷取資料...
從伺服器擷取資料...
flashx.textLayout.conversion 

TextConverter  - AS3

套件flashx.textLayout.conversion
類別public class TextConverter
繼承TextConverter Inheritance Object

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

這是閘道類別,用於處理匯入與匯出。其可做為 Text Layout Framework 中轉換功能的統一存取點。它包含預先定義的登錄碼,以及使用者定義的輸入和/或輸出轉換器,還有一組轉換方法。

轉換資料的格式沒有預先定義;使用者寫入的轉換器可自由接受並傳回他們所選的任何格式。通用格式為字串、XML 和 ByteArray 實體。轉換器作者應記錄所支援的格式。

檢視範例

更多範例



公用屬性
 屬性定義自
 Inheritedconstructor : Object
類別物件的參照或是特定物件實體的建構函數。
Object
  numFormats : int
[靜態] [唯讀] 格式的數目。
TextConverter
公用方法
 方法定義自
  
addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void
[靜態] 註冊匯入/匯出的新格式。
TextConverter
  
addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void
[靜態] 在指定位置註冊匯入/匯出的新格式。
TextConverter
  
[靜態] 將 TextFlow 匯出成指定的格式。
TextConverter
  
[靜態] 建立並傳回匯出轉換器,然後您可以使用該轉換器從 TextFlow 匯出至來源字串或 XML 物件。
TextConverter
  
[靜態] 傳回索引格式的格式名稱。
TextConverter
  
[靜態] 傳回索引格式的 FormatDescriptor。
TextConverter
  
[靜態] 建立並傳回匯入轉換器,然後您可以使用該轉換器從來源字串、XML 物件或任何使用者定義的資料格式匯入至 TextFlow。
TextConverter
 Inherited
指出物件是否有已定義的指定屬性。
Object
  
[靜態] 使用指定格式從來源內容建立 TextFlow。
TextConverter
 Inherited
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。
Object
 Inherited
指出指定的屬性是否存在,以及是否可列舉。
Object
  
[靜態] 移除格式。
TextConverter
  
[靜態] 移除索引位置的格式。
TextConverter
 Inherited
為迴圈作業設定動態屬性的可用性。
Object
 Inherited
傳回代表此物件的字串,根據地區特定慣例進行格式化。
Object
 Inherited
會傳回指定之物件的字串形式。
Object
 Inherited
會傳回指定之物件的基本值。
Object
公用常數
 常數定義自
  PLAIN_TEXT_FORMAT : String = "plainTextFormat"
[靜態] 純文字格式。
TextConverter
  TEXT_FIELD_HTML_FORMAT : String = "textFieldHTMLFormat"
[靜態] HTML 格式。
TextConverter
  TEXT_LAYOUT_FORMAT : String = "textLayoutFormat"
[靜態] TextLayout 格式。
TextConverter
屬性詳細資訊

numFormats

屬性
numFormats:int  [唯讀]

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

格式的數目。



實作
    public static function get numFormats():int
方法詳細資訊

addFormat

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

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

註冊匯入/匯出的新格式。新的格式會最後新增,因為其優先權最低。位置對於有多種可用格式選擇的用戶端來說非常重要,例如從外部剪貼簿匯入時。新的格式可支援匯入和/或匯出。如果已新增格式,則該格式會出現在多個位置中。將會使用找到的第一個。

參數

format:String — 要註冊的匯入轉換器類別或 null
 
importerClass:Class — 要註冊的匯出轉換器類別或 null
 
exporterClass:Class — 標記轉換器類別的格式字串。格式可以是任何名稱,但必須是唯一的。
 
clipboardFormat:String — 當轉換到剪貼簿,或從剪貼簿轉換時,用來做為剪貼簿格式的字串。如果格式不支援剪貼簿存取,請設為 null。

addFormatAt

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

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

在指定位置註冊匯入/匯出的新格式。位置對於有多種可用格式選擇的用戶端來說非常重要,例如從外部剪貼簿匯入時。較小的數字代表較高的優先權,因為將先嘗試這些轉換器。新的格式可支援匯入和/或匯出。如果已新增格式,則該格式會出現在多個位置中。將會使用找到的第一個。

參數

index:int — 要註冊的匯入轉換器類別或 null
 
format:String — 要註冊的匯出轉換器類別或 null
 
importerClass:Class — 標記轉換器類別的格式字串
 
exporterClass:Class (default = null) — 當轉換到剪貼簿,或從剪貼簿轉換時,用來做為剪貼簿格式的字串。如果格式不支援剪貼簿存取,請設為 null。
 
clipboardFormat:String (default = null)

export

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

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

將 TextFlow 匯出成指定的格式。

使用此類別提供的靜態常數之一、MIME 類型或使用者定義匯出器的使用者定義格式,來指定 format 參數:

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

使用 ConversionType 類別提供的靜態常數之一或使用者定義匯出器的使用者定義資料類型,來指定 conversionType 參數中的匯出資料類型:

  • ConversionType.STRING_TYPE
  • ConversionType.XML_TYPE

以指定格式傳回 TextFlow 的形式,或造成錯誤的 null。

參數

source:flashx.textLayout.elements:TextFlow — 來源內容
 
format:String — 輸出格式
 
conversionType:String — 匯出資料的類型

傳回值
Object — TextFlow 的物件匯出格式,或造成錯誤的 null

相關 API 元素

getExporter

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

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

建立並傳回匯出轉換器,然後您可以使用該轉換器從 TextFlow 匯出至來源字串或 XML 物件。如果您要執行許多個別的匯出作業,請使用此函數。其作用相當於呼叫 flashx.textLayout.conversion.TextConverter.export()

使用此類別提供的靜態常數之一來指定 format 參數:

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

如果已多次新增格式,將會使用找到的第一個。

參數

format:String — 匯出資料的目標格式

傳回值
flashx.textLayout.conversion:ITextExporter — 可以指定格式匯出的 ITextExporter 文字匯出器

相關 API 元素


範例  ( 如何使用本範例 )

這個程式碼片段顯示利用 getExporter 方法來執行格式化文字的重複匯出。

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

()方法 
public static function getFormatAt(index:int):String

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

傳回索引格式的格式名稱。

參數

index:int

傳回值
String

getFormatDescriptorAt

()方法 
public static function getFormatDescriptorAt(index:int):FormatDescriptor

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

傳回索引格式的 FormatDescriptor。

參數

index:int

傳回值
FormatDescriptor

getImporter

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

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

建立並傳回匯入轉換器,然後您可以使用該轉換器從來源字串、XML 物件或任何使用者定義的資料格式匯入至 TextFlow。如果您要執行許多個別的匯入作業,或者您想在匯入時處理錯誤,請使用此方法。其作用相當於呼叫 flashx.textLayout.conversion.TextConverter.importToFlow()

使用此類別提供的靜態常數之一來指定 format 參數、MIME 類型或使用者定義的資料格式。

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

如果已多次新增格式,將會使用找到的第一個。

參數

format:String — 來源內容的格式。使用來自於 flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT、PLAIN_TEXT_FORMAT 和 TEXT_FIELD_HTML_FORMAT 等的常數、MIME 類型或使用者定義格式。
 
config:IConfiguration (default = null) — 執行此匯入時要使用的組態。null 表示使用目前的預設值。您也可以透過 ITextImporter.configuration 屬性來設定組態。

傳回值
flashx.textLayout.conversion:ITextImporter — 可以匯入來源資料的 ITextImporter 文字匯入器

相關 API 元素


範例  ( 如何使用本範例 )

這個程式碼片段會顯示利用 getImporter 方法來執行格式化文字的重複匯入。注意:每次開始呼叫 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

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

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

使用指定格式從來源內容建立 TextFlow。

使用此類別提供的靜態常數之一和 MIME 類型來指定 format 參數,或使用使用者註冊匯入器的使用者定義值。

  • TextConverter.TEXT_FIELD_HTML_FORMAT
  • TextConverter.PLAIN_TEXT_FORMAT
  • TextConverter.TEXT_LAYOUT_FORMAT

參數

source:Object — 來源內容
 
format:String — 來源內容的格式
 
config:IConfiguration (default = null) — 建立新的 TextFlow 時要使用的 IConfiguration

傳回值
flashx.textLayout.elements:TextFlow — 從來源建立的 TextFlow,或造成錯誤的 null。

相關 API 元素

removeFormat

()方法 
public static function removeFormat(format:String):void

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

移除格式。如果多次新增格式,僅會移除找到的第一個。

參數

format:String — 要移除的轉換器格式字串

removeFormatAt

()方法 
public static function removeFormatAt(index:int):void

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

移除索引位置的格式。

參數

index:int — 要移除的格式。

常數詳細資訊

PLAIN_TEXT_FORMAT

常數
public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

純文字格式。可用於從簡單、未格式化的字串建立 TextFlow,或用於從 TextFlow 建立簡單、未格式化的字串。

TEXT_FIELD_HTML_FORMAT

常數 
public static const TEXT_FIELD_HTML_FORMAT:String = "textFieldHTMLFormat"

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

HTML 格式。可用來執行 HTML 格式之 TextFlow 的匯入或匯出。Text Layout Framework HTML 支援 flash.text 套件中 TextField 類別所支援標籤與特質的子集。

下列表格列出支援匯入與匯出過程的 HTML 標籤與特質 (TextField 支援的標籤與特質,但是 Text Layout Framework 不支援的標籤與特質將特別描述為不支援):

標籤 說明
錨點標籤 <a> 標籤會建立超連結,並支援下列特質:
  • target:指定載入頁面所在的目標視窗名稱。 選項包括 _self_blank_parent_top_self 選項會指定目前視窗中的目前頁框、_blank 會指定新的視窗、_parent 會指定目前頁框的父輩,而 _top 則會指定目前視窗中最上層的頁框。
  • href:指定 URL。此 URL 可以是將該頁面載入之 SWF 檔的絕對或相對位置。URL 之絕對參照的範例為 http://www.adobe.com;相對參照的範例則為 /index.html。 絕對 URL 必須以 http:// 開頭,否則 Flash 會視為相對 URL。 注意:與 TextField 類別不同,並不支援 ActionScript link 事件。也不支援 a:linka:hovera:active 樣式。
粗體標籤 <b> 標籤會使文字呈現粗體。 所使用的字體必須具有粗體字樣。
斷行標籤 <br> 標籤會在文字中建立斷行。
字體標籤 <font> 標籤會指定字體或字體清單以顯示文字。字體標籤支援下列特質:
  • color:僅支援十六進位顏色 (#FFFFFF) 值。
  • face:指定要使用的字體名稱。 如下列範例所示,您可以指定一份以逗點分隔字體名稱的清單,在此情況下,Flash Player 會選取第一種可用的字體: 如果指定的字體並未安裝在本機電腦系統上,或是未內嵌在 SWF 檔中,Flash Player 便會選取替代的字體。
  • size:指定字體大小。 您可以使用絕對像素大小,如 16 或 18;或是相對點大小,如 +2 或 -4。
  • letterspacing:以像素為單位指定要套用至每個字元右方的字距 (手動字距微調)。
  • kerning:指定要啟用或停用字距微調。非零值代表啟用字距微調,零則代表停用。
影像標籤 <img> 標籤可讓您將外部影像檔 (JPEG、GIF、PNG)、SWF 檔及影片片段嵌入文字中。

<img> 標籤支援下列特質:

  • src:指定影像檔、SWF 檔或元件庫中影片片段元件之連結識別名稱的 URL。 這個特質是必要的;其他所有特質都是選用的。 外部檔案 (JPEG、GIF、PNG 和 SWF 檔) 必須等到下載完成之後才會顯示。
  • width:所插入之影像、SWF 檔案或影片片段的寬度 (以像素為單位)。
  • height:所插入之影像、SWF 檔或影片片段的高度 (以像素為單位)。

注意:與 TextField 類別不同,不支援下列特質:alignhspacevspaceidcheckPolicyFile

斜體標籤 <i> 標籤會將加上標籤的文字以斜體顯示。 所使用的字體必須具有斜體字樣。
清單項目標籤 注意:與 TextField 類別不同,不支援 List 項目標籤。
段落標籤 <p> 標籤會建立新的段落。 <p> 標籤支援下列特質:
  • align:指定段落內文字的對齊方式;有效值為 leftrightjustifycenter
  • class:指定樣式可以使用的類別名稱
Span 標籤 <span> 標籤支援下列特質:
  • class:指定樣式可以使用的類別名稱。雖然 span 標籤時常用於設定樣式表定義的樣式,但 TLFTextField 實體不支援樣式表。span 標籤可供 TLFTextField 實體用於參照具有樣式屬性的類別。
  • 您也可以直接將屬性放置於 span 標籤:<span fontFamily="Arial">Hi there</span>。不過並不支援巢狀 span 標籤。
文字格式標籤

<textformat> 標籤可讓您在文字欄位內使用 TextFormat 類別的段落格式屬性之子集,包括行距、縮排、邊界及定位停駐點。 您可以將 <textformat> 標籤與內建的 HTML 標籤組合使用。

<textformat> 標籤具有下列特質:

  • indent:指定段落中從左方邊界到第一個字元的縮排,對應於 TextFormat.indent。 正值與負值均可接受。
  • blockindent:指定縮排套用至段落的所有文字行。
  • leftmargin:以點為單位指定段落的左邊界;對應於 TextFormat.leftMargin
  • rightmargin:以點為單位指定段落的右邊界,對應於 TextFormat.rightMargin
  • leading:以像素為單位指定文字行上緣與前一行下緣之間的行距 (行高)
  • tabstops:指定段落定位停駐點位置的逗號分隔清單。
底線標籤 <u> 標籤會為標籤內的文字加上底線。

將不明標籤匯入到 textFieldHTMLFormat 時,匯入器會將單一 FlowElement 的 typeName 屬性設定為該標籤名稱,或建立 typeName 屬性設為標籤名稱的 DivElement 或 SubParagraphGroupElement。

當不同於預設值時,textFieldHTMLFormat 匯出器會匯出 typeName 做為 XML 標籤。

相關 API 元素

TEXT_LAYOUT_FORMAT

常數 
public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"

語言版本: ActionScript 3.0
執行階段版本: Flash Player 10, AIR 1.5

TextLayout 格式。可用來執行 TextLayout 標記格式之 TextFlow 的匯入或匯出。「文字版面」格式會偵測以下錯誤:

  • 未預期的名稱空間
  • 不明的元素
  • 不明的特質

TextConverter_example.as

此範例顯示 TextConverter 轉換類別的用法。標準標記格式的文字會匯入 TextFlow 物件,然後再顯示。接著文字會以 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;
        }
    }
}




[ X ]為什麼顯示英文?
「ActionScript 3.0 參考」的內容是以英文顯示

並非所有「ActionScript 3.0 參考」的內容都翻譯為所有語言。當語言元素未翻譯時,就會以英文顯示。例如,ga.controls.HelpBox 類別並沒有翻譯為任何語言。因此在參考的繁體中文版本中,ga.controls.HelpBox 類別就會以英文顯示。