ElementFormat  - AS3

指定包含元素的基線類型，具有此格式之元素的主基線將會對齊此基線。請針對此屬性使用 TextBaseline 常數。

字行中的最大垂直元素會決定基線的對齊，除非 TextBlock.baselineFontDescription 和 TextBlock.baselineFontSize 設定為覆寫該邏輯。

預設值是 TextBaseline.USE_DOMINANT_BASELINE。

若要設定此屬性，請使用下列字串值：

相關 API 元素

指定此物件影響的文字行元素的透明度。有效值是 0 (完全透明) 到 1 (完全不透明)。alpha 設為 0 的顯示物件「都是」作用中的狀態，即使看不見它們亦然。

預設值為 1。

相關 API 元素

指出元素的基線位移 (以像素為單位)。

元素將會從 dominantBaseline 位移這個數量。元素成員的 y 位置會加入位移，因此在非旋轉的文字中，基線的正位移會將元素往下移動，則基線的負位移則會將元素往上移動。

預設值為 0.0，表示沒有任何位移。

套用到此文字的斷行機會。這個屬性會決定當換行文字斷成多行時哪些字元可用於斷行。請針對此屬性使用 BreakOpportunity 常數。

預設值為 BreakOpportunity.AUTO。

若要設定此屬性，請使用下列字串值：

相關 API 元素

指出文字的顏色。 包含三個 8 位元 RGB 組件的整數；例如 0xFF0000 是紅色，而 0x00FF00 是綠色。

預設值為 0x000000 (黑色)。

用於此文字的位數情況。數字大小寫會影響數值字元群組的樣式和定位。請針對此屬性使用 DigitCase 常數。

預設值是 DigitCase.DEFAULT。

若要設定此屬性，請使用下列字串值：

相關 API 元素

用於此文字的位數寬度。請針對此屬性使用 DigitWidth 常數。

預設值是 DigitWidth.DEFAULT。

若要設定此屬性，請使用下列字串值：

相關 API 元素

指定要做為主基線的基線類型。主基線會與對齊基線對齊以決定文字行中元素的垂直位置。請針對此屬性使用 TextBaseline 常數。

元素的內容會決定基線。如果是 TextElement，字體和字級會決定基線。如果是 GraphicElement，元素的高度會決定基線。

預設值為 TextBaseline.ROMAN。

若要設定此屬性，請使用下列字串值：

相關 API 元素

其屬性描述字體的物件。

預設值是預設建構的 FontDescription 物件。

設定 fontDescription 屬性時，就會鎖定所提供的 FontDescription 物件：其 locked 屬性設定為 true。已鎖定的 FontDescription 不得修改。

相關 API 元素

文字的像素大小。

預設值為 12.0。

字距微調會調整某些字元組之間的像素，以改善可讀性。具有字距微調表的所有字體都支援字距微調。

預設值是 Kerning.ON。

若要設定這個屬性的值，使用以下 Kerning 類別的常數。

相關 API 元素

用於此文字的連字層級。當兩個以上的字母形式接合為單一字符時，會發生連字。連字通常會取代共享相同組件的連續字元，如字母組「fi」、「fl」或「ae」。連字可用於拉丁文和非拉丁文字元集。請針對此屬性使用 LigatureLevel 常數。

預設值是 LigatureLevel.COMMON。

若要設定此屬性，請使用下列字串值：

相關 API 元素

文字的地區。控制大小寫轉換和形狀。會使用標準地區識別名稱。例如，「en」、「en_US」和「en-US」都是代表英文，而「ja」則是日文。請參閱 iso639-2 code list 取得地區代碼清單。

預設值為 "en"。

指出 ElementFormat 是否已鎖定。如果是 true，則 ElementFormat 不得修改。呼叫 ElementFormat.clone() 取得 ElementFormat 物件的未鎖定副本。

設定已套用到個別文字的旋轉。請針對此屬性使用 TextRotation 類別中定義的常數。

預設值為 TextRotation.AUTO。

任何字符的最終旋轉都是 ElementFormat.textRotation、ContentElement.textRotation 和 TextBlock.lineRotation 的總和。

通常對於字元必須旋轉才能在垂直版面中適當顯示的亞洲字元，您可以使用這個屬性。使用 TextRotation.AUTO 結合 TextBlock.lineRotation = TextRotation.ROTATE_90 以完成這個目標。

在不含垂直版面資訊的字體上設定這個屬性時，可能會產生不想要的結果。包含 vmtx 或 VORG 表的字體 (如日文字體「MS Mincho」) 會正常運作，因為這些表提供了版面配置引擎進行正確版面配置所需的資料。不含必要資訊的字體 (如 Verdana) 則無法正常運作。

若要設定此屬性，請使用下列字串值：

相關 API 元素

套用至每個字符左方的字距或手動字距微調 (以像素為單位)。如果已啟用 kerning，trackingLeft 值就會加入到該字體之字距微調表中的值。如果已停用 kerning，trackingLeft 值會當做手動字距微調值來使用。同時支援正值與負值。

所需的字距值通常會在 trackingRight 和 trackingLeft 之間均分。否則，在混合方向的文字中，其中一個雙向界限會有雙倍字距，而另一個雙向界限則沒有字距。

預設值為 0.0。

範例：

          //positive tracking added to kerning
          var ef1:ElementFormat = new ElementFormat();
          ef1.kerning = flash.text.engine.Kerning.ON;
          ef1.trackingLeft = 0.5;
     
          //negative manual kerning
          var ef2:ElementFormat = new ElementFormat();
          ef2.kerning = flash.text.engine.Kerning.OFF;
          ef2.trackingLeft = -1.0;
     

套用至每個字符右方的字距或手動字距微調 (以像素為單位)。如果已啟用 kerning，trackingRight 值就會加入到該字體之字距微調表中的值。如果已停用 kerning，trackingRight 值會當做手動字距微調值來使用。同時支援正值與負值。

所需的字距值通常會在 trackingRight 和 trackingLeft 之間均分。否則，在混合方向的文字中，其中一個雙向界限會有雙倍字距，而另一個雙向界限則沒有字距。

預設值為 0.0。

範例：

          //positive tracking added to kerning
          var ef1:ElementFormat = new ElementFormat();
          ef1.kerning = flash.text.engine.Kerning.ON;
          ef1.trackingRight = 0.5;
     
          //negative manual kerning
          var ef2:ElementFormat = new ElementFormat();
          ef2.kerning = flash.text.engine.Kerning.OFF;
          ef2.trackingRight = -1.0;
     

用於此文字的印刷情況。請針對此屬性使用 TypographicCase 類別中定義的常數。

預設值是 TypographicCase.DEFAULT。

若要設定此屬性，請使用下列字串值：

相關 API 元素

建立 ElementFormat 物件。

建構 ElementFormat 的未鎖定、已複製副本。

package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class ElementFormat_cloneExample extends Sprite {
        private var ef1:ElementFormat;
        private var ef2:ElementFormat;
        
        public function ElementFormat_cloneExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
            fd.fontName = "Palatino";

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize=20;
            
            var str:String = "This is flash text 0123456789";
            var tb:TextBlock = new TextBlock();
            var te1:TextElement = new TextElement(str, ef1);
            tb.content = te1;
            var line1:TextLine = tb.createTextLine(null, 600);
            addChild(line1);
            
            ef2 = (ef1.locked) ? ef1.clone() : ef1;    
            ef2.fontSize = 32;

            tb.content.elementFormat=ef2;
            var line2:TextLine = tb.createTextLine(null, 600);
            addChild(line2);
            
        }
    }    
}

傳回 FontMetrics 物件，其中包含的屬性可針對 fontDescription 與 fontSize 指定的字體來描述 emBox、刪除線位置、刪除線粗細、底線位置及底線粗細。

相關 API 元素

package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class FontMetricsExample extends Sprite {
        
        public function FontMetricsExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontName = "Garamond";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize = 24;            
            var fm1:FontMetrics = ef1.getFontMetrics();

            trace(fm1.emBox);
            trace(fm1.strikethroughOffset);
            trace(fm1.strikethroughThickness);
            trace(fm1.subscriptScale);
            trace(fm1.subscriptOffset);
            trace(fm1.superscriptScale);
            trace(fm1.superscriptOffset);
            trace(fm1.underlineOffset);
            trace(fm1.underlineThickness);
            
            
        }
    }    
}

此範例會建立兩個 ElementFormat 物件並分別為每個物件設定好幾個屬性。接著，它會將新的 ElementFormats 指定給 TextElement 物件，後者先前已經指定為 TextBlock 的內容。請注意，變更 TextElement 的 ElementFormat 不會影響先前由父輩 TextBlock 所建立的 TextLines。

package {

    import flash.display.Sprite;
    import flash.text.engine.*;

    
    public class ElementFormatExample extends Sprite {
        
        public function ElementFormatExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontName = "Garamond";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize = 30;
            ef1.color = 0xFF0000;
            ef1.alpha = 100;
            ef1.kerning = flash.text.engine.Kerning.ON;
            ef1.trackingRight = 2;
            ef1.typographicCase = flash.text.engine.TypographicCase.UPPERCASE;
            ef1.alignmentBaseline = flash.text.engine.TextBaseline.DESCENT;
            ef1.ligatureLevel = flash.text.engine.LigatureLevel.EXOTIC;
            
            var ef2:ElementFormat = new ElementFormat(fd);
            ef2.fontSize = 30;
            ef2.color = 0xFF0000;
            ef2.alpha = 0.3;
            ef2.kerning = flash.text.engine.Kerning.OFF;
            ef2.typographicCase = flash.text.engine.TypographicCase.LOWERCASE;
            ef2.digitCase = flash.text.engine.DigitCase.OLD_STYLE;
            ef2.textRotation = flash.text.engine.TextRotation.ROTATE_180;
            
            var str:String = "This is flash text 0123456789";
            var tb:TextBlock = new TextBlock();
            var te1:TextElement = new TextElement(str, ef1);
            tb.content = te1;
            var line1:TextLine = tb.createTextLine(null, 600);
            addChild(line1);
            line1.x = 15;
            line1.y = 30;

            tb.content.elementFormat = ef2;
            var line2:TextLine = tb.createTextLine(null, 600);
            addChild(line2);
            line2.x = 15;
            line2.y = 60;
            
        }
    }    
}