ElementFormat  - AS3

Geeft het type van de basislijn in het element aan, waarop de dominante basislijnen van elementen met deze indeling worden uitgelijnd. Gebruik TextBaseline-constanten voor deze eigenschap.

Het grootste verticale element op de regel bepaalt de uitlijning van de basislijnen, tenzij TextBlock.baselineFontDescription en TextBlock.baselineFontSize zijn ingesteld om die logica te overschrijven.

De standaardwaarde is TextBaseline.USE_DOMINANT_BASELINE.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

Geeft de transparantie aan van de lijnelementen die door dit object worden beïnvloed. Geldige waarden liggen tussen 0 (volledig transparant) en 1 (volledig dekkend). Weergaveobjecten met alpha ingesteld op 0 zijn actief, ook al zijn ze onzichtbaar.

De standaardwaarde is 1.

Verwante API-elementen

Geeft de basislijnverschuiving voor het element in pixels aan.

Het element wordt met dit aantal pixels verschoven ten opzichte van de dominantBaseline. De verschuiving wordt opgeteld bij de y-positie van de leden van het element, zodat, bij niet-gedraaide tekst, het element bij een positieve verschuiving omlaag schuift en bij een negatieve verschuiving omhoog schuift.

De standaardwaarde is 0,0, hetgeen geen verschuiving betekent.

De regeleindeoptie die op deze tekst wordt toegepast. Deze eigenschap bepaalt welke karakters voor afbreking kunnen worden gebruikt wanneer doorlopende tekst op meerdere regels wordt afgebroken. Gebruik BreakOpportunity-constanten voor deze eigenschap.

De standaardwaarde is BreakOpportunity.AUTO.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

Geeft de kleur van de tekst aan. Een geheel getal bestaande uit drie 8-bits RGB-componenten, 0xFF0000 is bijvoorbeeld rood en 0x00FF00 is groen.

De standaardwaarde is 0x000000 (zwart).

Het cijfertype dat voor deze tekst wordt gebruikt. Cijfertype bepaalt de stijl en plaatsing van groepen numerieke tekens. Gebruik DigitCase-constanten voor deze eigenschap.

De standaardwaarde is DigitCase.DEFAULT.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

De cijferbreedte die voor deze tekst wordt gebruikt. Gebruik DigitWidth-constanten voor deze eigenschap.

De standaardwaarde is DigitWidth.DEFAULT.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

Geeft het type basislijn aan, dat u als dominante basislijn moet gebruiken. De dominante basislijn wordt uitgelijnd op de uitlijningsbasislijn, zodat de verticale positie van het element op de regel kan worden vastgesteld. Gebruik TextBaseline-constanten voor deze eigenschap.

De inhoud van het element bepaalt de basislijnen. Bij een TextElement bepalen lettertype en lettergrootte de basislijnen. Bij een GraphicElement worden de basislijnen bepaald door de hoogte van het element.

De standaardwaarde is TextBaseline.ROMAN.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

Een object waarvan de eigenschappen een lettertype beschrijven.

De standaardwaarde is een standaard geconstrueerd FontDescription-object.

Als de eigenschap fontDescription is ingesteld, wordt het aangeboden object FontDescription vergrendeld: de eigenschap locked van het object is ingesteld op true. Een vergrendeld object FontDescription kan niet worden gewijzigd.

Verwante API-elementen

De grootte van de tekst, in pixels

De standaardwaarde is 12,0.

Met tekenspatiëring worden de pixels tussen bepaalde tekenparen aangepast om de leesbaarheid te verbeteren. Tekenspatiëring wordt ondersteund voor alle lettertypen die tabellen voor tekenspatiëring hebben.

De standaardwaarde is Kerning.ON.

Als u waarden wilt instellen voor deze eigenschap, kunt u de volgende constanten in de Kerning-klasse gebruiken:

Verwante API-elementen

Het ligatuurniveau dat voor deze tekst wordt gebruikt. Een ligatuur ontstaat wanneer twee of meer lettervormen samen één glyph vormen. Ligaturen vervangen normaal gesproken opeenvolgende tekens die gemeenschappelijke componenten hebben, zoals de letterparen 'fi', 'fl' of 'ae'. Deze worden in Latijnse en niet-Latijnse tekensets gebruikt. Gebruik LigatureLevel-constanten voor deze eigenschap.

De standaardwaarde is LigatureLevel.COMMON.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

De landinstelling van de tekst. Bepaalt transformaties en vormen van letters. Er wordt gebruik gemaakt van standaardlandinstellings-id's. Bijvoorbeeld 'en', 'en_US' en 'en-US' zijn id's voor Engels en 'ja' voor Japans. Raadpleeg iso639-2 code list voor een lijst met landinstellingscodes.

De standaardwaarde is 'en'.

Hiermee wordt aangegeven of het object ElementFormat al dan niet vergrendeld is. true betekent dat het object ElementFormat niet kan worden gewijzigd. Roep ElementFormat.clone() aan om een niet-vergrendelde versie van het object ElementFormat te maken.

Stelt de rotatie in die wordt toegepast op individuele glyphs. Gebruik constanten die zijn gedefinieerd in de TextRotation-klasse voor deze eigenschap.

De standaardwaarde is TextRotation.AUTO.

De laatste rotatie van een glyph is de som van , ElementFormat.textRotation, ContentElement.textRotation en TextBlock.lineRotation.

Deze eigenschap wordt voornamelijk gebruikt voor Aziatische tekst waarbij de karakters moeten worden gedraaid voor een correcte weergave bij een verticale indeling. Gebruik TextRotation.AUTO in combinatie met TextBlock.lineRotation = TextRotation.ROTATE_90 om dit te bewerkstelligen.

Als u deze eigenschappen instelt op lettertypen die geen verticale-opmaakinformatie bevatten, kan dit ongewenste resultaten geven. Lettertypen met een vmtx- of VORG-tabel, zoals het Japanse lettertype 'MS Mincho', werken goed omdat die tabellen de gegevens verschaffen die de opmaakengine nodig heeft om de opmaak correct uit te voeren. Lettertypen als Verdana, die niet de benodigde informatie bevatten, doen dit niet.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

De (handmatige) tekstspatiëring die links van elke glyph wordt toegepast, in pixels. Als tekenspatiëring is ingeschakeld, wordt de waarde voor trackingLeft opgeteld bij de waarden in de tekenspatiëringstabel voor het lettertype. Als tekenspatiëring is uitgeschakeld, wordt de waarde voor trackingLeft gebruikt als een waarde voor handmatige tekenspatiëring. Ondersteunt zowel positieve als negatieve waarden.

De gewenste waarde voor tekstspatiëring wordt normaal gesproken gesplitst tussen trackingRight en trackingLeft. Anders is er, bij tekst met gemengde richtingen, tweemaal de tekstspatiëring bij de ene bidirectionele begrenzing en geen bij de andere.

De standaardwaarde is 0.0.

Voorbeeld:

          //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;
     

De (handmatige) tekstspatiëring die rechts van elke glyph wordt toegepast, in pixels. Als tekenspatiëring is ingeschakeld, wordt de waarde voor trackingRight opgeteld bij de waarden in de tekenspatiëringstabel voor het lettertype. Als tekenspatiëring is uitgeschakeld, wordt de waarde voor trackingRight gebruikt als een waarde voor handmatige tekenspatiëring. Ondersteunt zowel positieve als negatieve waarden.

De gewenste waarde voor tekstspatiëring wordt normaal gesproken gesplitst tussen trackingRight en trackingLeft. Anders is er, bij tekst met gemengde richtingen, tweemaal de tekstspatiëring bij de ene bidirectionele begrenzing en geen bij de andere.

De standaardwaarde is 0.0.

Voorbeeld:

          //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;
     

De typografische optie die voor deze tekst wordt gebruikt. Gebruik constanten die zijn gedefinieerd in de TypographicCase-klasse voor deze eigenschap.

De standaardwaarde is TypographicCase.DEFAULT.

Wanneer u waarden voor deze eigenschap wilt instellen, gebruikt u de volgende tekenreekswaarden:

Verwante API-elementen

Maakt een ElementFormat-object.

Hiermee wordt een niet-vergrendelde, gekloonde kopie van het ElementFormat-object gemaakt.

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);
            
        }
    }    
}

Retourneert een FontMetrics-object met eigenschappen die de emBox, doorhalingspositie, doorhalingsdikte, onderstrepingspositie en onderstrepingsdikte voor het lettertype beschrijven die zijn opgegeven door fontDescription en fontSize

Verwante API-elementen

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);
            
            
        }
    }    
}

In dit voorbeeld worden twee ElementFormat-objecten gemaakt en diverse eigenschappen voor die objecten ingesteld. Daarna worden de nieuwe ElementFormat-objecten toegewezen aan een TextElement-object dat is toegewezen als de inhoud van een TextBlock. Let erop dat als u de ElementFormat van een TextElement wijzigt, dit niet van invloed is op tekstregels die al eerder zijn gemaakt met het bovenliggende TextBlock.

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;
            
        }
    }    
}