Packageflash.text.engine
Classepublic final class ElementFormat
HéritageElementFormat Inheritance Object

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

La classe ElementFormat représente les informations de mise en forme pouvant être appliquées à un ContentElement. Utilisez la classe ElementFormat pour créer une mise en forme de texte spécifique pour les différentes sous-classes de ContentElement. Les propriétés de la classe ElementFormat s'appliquent aux polices de périphérique et intégrées.

Un objet ElementFormat appliqué à un ContentElement dans un TextBlock n'invalide pas le TextBlock. Après avoir appliqué un objet ElementFormat à un ContentElement, sa propriété locked est définie sur true. Les propriétés d'un objet ElementFormat bloqué ne peuvent pas être modifiées. Utilisez plutôt la méthode clone() pour créer une copie non verrouillée de l'objet, qu'il est possible de modifier et d'affecter au ContentElement.

Consulter les exemples

Voir aussi

flash.text.engine.ContentElement.elementFormat
Mise en forme du texte


Propriétés publiques
 PropriétéDéfini par
  alignmentBaseline : String
Spécifie les lignes de base de la ligne contenant l'élément auxquelles dominantBaseline s'accroche, déterminant ainsi la position verticale de l'élément dans la ligne.
ElementFormat
  alpha : Number
Permet à l'auteur de définir automatiquement la propriété alpha de tous les atomes de ligne basés sur la mise en forme d'élément sur le nombre spécifié.
ElementFormat
  baselineShift : Number
Indique le décalage de la ligne de base pour l'élément, en pixels.
ElementFormat
  breakOpportunity : String
Opportunité de saut de ligne appliquée à ce texte.
ElementFormat
  color : uint
Indique la couleur du texte.
ElementFormat
 Inheritedconstructor : Object
Référence à l'objet de classe ou à la fonction constructeur d'une occurrence donnée d'un objet.
Object
  digitCase : String
Casse de chiffres utilisée pour ce texte.
ElementFormat
  digitWidth : String
Largeur de chiffres utilisée pour ce texte.
ElementFormat
  dominantBaseline : String
Spécifie les lignes de base de l'élément s'accrochant à alignmentBaseline pour déterminer la position verticale de l'élément sur la ligne.
ElementFormat
  fontDescription : FontDescription
Objet qui encapsule les propriétés nécessaires pour décrire une police.
ElementFormat
  fontSize : Number
La taille du texte, en pixels.
ElementFormat
  kerning : String
Crénage utilisé pour ce texte.
ElementFormat
  ligatureLevel : String
Niveau de ligature utilisé pour ce texte.
ElementFormat
  locale : String
Variable locale du texte.
ElementFormat
  locked : Boolean
Indique si l'objet ElementFormat est bloqué.
ElementFormat
 Inheritedprototype : Object
[statique] Référence à l'objet prototype d'un objet de classe ou fonction.
Object
  textRotation : String
Définit la rotation appliquée aux glyphes individuelles.
ElementFormat
  trackingLeft : Number
Interlettrage ou crénage manuel à appliquer à gauche de chaque glyphe, en pixels.
ElementFormat
  trackingRight : Number
Interlettrage ou crénage manuel à appliquer à droite de chaque glyphe, en pixels.
ElementFormat
  typographicCase : String
Casse typographique utilisée pour ce texte.
ElementFormat
Méthodes publiques
 MéthodeDéfini par
  
ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")
Crée un objet ElementFormat.
ElementFormat
  
Crée une copie non verrouillée et clonée de l'objet ElementFormat.
ElementFormat
  
Renvoie un objet FontMetrics avec des propriétés qui décrivent la valeur emBox, la position et l'épaisseur du barré et du soulignement pour la police spécifiée par fontDescription et fontSize.
ElementFormat
 Inherited
Indique si la propriété spécifiée d'un objet est définie.
Object
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l'objet spécifié en tant que paramètre.
Object
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d'une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l'objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l'objet spécifié.
Object
Détails de la propriété
alignmentBaselinepropriété
alignmentBaseline:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Spécifie les lignes de base de la ligne contenant l'élément auxquelles dominantBaseline s'accroche, déterminant ainsi la position verticale de l'élément dans la ligne. Utilisez les constantes flash.text.engine.TextBaseline pour cette propriété.

Le plus grand élément de la ligne détermine les lignes de base sauf si TextBlock.baselineFontDescription et TextBlock.baselineFontSize sont définis pour un autre comportement.

La valeur par défaut est flash.text.engine.TextBaseline.USE_DOMINANT_BASELINE.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
TextBaseline.ROMAN La dominantBaseline s'aligne sur la ligne de base des caractères romains de la ligne.
TextBaseline.ASCENT La dominantBaseline s'aligne sur la ligne de base des caractères ascendants de la ligne.
TextBaseline.DESCENT La dominantBaseline s'aligne sur la ligne de base des caractères descendants de la ligne.
TextBaseline.IDEOGRAPHIC_TOP La dominantBaseline s'aligne sur la ligne de base du haut des caractères idéographiques de la ligne.
TextBaseline.IDEOGRAPHIC_CENTER La dominantBaseline s'aligne sur la ligne de base du centre des caractères idéographiques de la ligne.
TextBaseline.IDEOGRAPHIC_BOTTOM La dominantBaseline s'aligne sur la ligne de base du bas des caractères idéographiques de la ligne.
TextBaseline.USE_DOMINANT_BASELINE La dominantBaseline s'aligne sur la même ligne de base de la ligne.

Sous-classeEffet de la définition des propriétés
GraphicElement Définit la ligne de base de l'alignement de la ligne sur celle sur laquelle s'aligne la dominantBaseline de l'élément graphique.
GroupElement N'a aucun effet.
TextElement Définit la ligne de base de l'alignement de la ligne sur celle sur laquelle s'aligne la dominantBaseline de l'élément de texte.



Implémentation
    public function get alignmentBaseline():String
    public function set alignmentBaseline(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.TextBaseline.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

alphapropriété 
alpha:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Permet à l'auteur de définir automatiquement la propriété alpha de tous les atomes de ligne basés sur la mise en forme d'élément sur le nombre spécifié.

Indique la valeur de transparence alpha de l'objet spécifié. Les valeurs gérées sont comprises entre 0 (entièrement transparent) et 1 (entièrement opaque). La valeur par défaut est 1. Les objets d'affichage où alpha est défini sur 0 sont actifs, même s'ils sont invisibles.

La valeur par défaut est 1.0.

Sous-classeEffet de la définition des propriétés
GraphicElement Applique l'alpha spécifié à l'élément graphique. Fait une combinaison par multiplication avec tout alpha défini sur le graphique DisplayObject lui-même ou sur la TextLine.
GroupElement N'a aucun effet.
TextElement Applique l'alpha spécifié à l'élément de texte. Fait une combinaison par multiplication avec tout alpha défini sur la TextLine.



Implémentation
    public function get alpha():Number
    public function set alpha(value:Number):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

baselineShiftpropriété 
baselineShift:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Indique le décalage de la ligne de base pour l'élément, en pixels.

L'élément est éloigné d'autant de la dominantBaseline. Le décalage étant ajouté à la position y des membres de l'élément, dans un texte qui ne pivote pas, un décalage de ligne de base positif déplace l'élément vers le bas et un décalage de ligne de base négatif déplace l'élément vers le haut.

La valeur par défaut est 0.0, ce qui signifie aucun décalage.

Sous-classeEffet de la définition des propriétés
GraphicElement Eloigne le graphique de la ligne de base.
GroupElement N'a aucun effet.
TextElement Eloigne le texte de la ligne de base.



Implémentation
    public function get baselineShift():Number
    public function set baselineShift(value:Number):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

breakOpportunitypropriété 
breakOpportunity:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Opportunité de saut de ligne appliquée à ce texte. Cette propriété détermine quels caractères peuvent être utilisés pour effectuer un saut de ligne lorsque le texte est scindé en plusieurs lignes. Utilisez les constantes flash.text.engine.BreakOpportunity pour cette propriété.

La valeur par défaut est flash.text.engine.BreakOpportunity.AUTO.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
BreakOpportunity.AUTO Les possibilités de saut de ligne sont basées sur les propriétés des caractères Unicode standard, par exemple les séparations de mots et les tirets.
BreakOpportunity.ANY Tout caractère de l'objet ContentElement est traité comme une possibilité de saut de ligne. Cette valeur est généralement utilisée lorsque du texte Romain est intégré dans du texte asiatique et qu'il est préférable que les sauts de ligne interviennent au milieu des mots.
BreakOpportunity.NONE Aucun caractère de la plage n'est traité comme une possibilité de saut de ligne.
BreakOpportunity.ALL Tous les caractères de la plage sont traités comme des possibilités de saut de ligne. Cela est utile pour la création d'effets tels qu'un texte sur un tracé.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement Détermine la possibilité de séparation entre les éléments de texte adjacents du groupe. Si l'elementFormat du groupe est null, le format du premier des éléments adjacents est utilisé.
TextElement Détermine la possibilité de séparation entre les caractères de l'élément de texte.



Implémentation
    public function get breakOpportunity():String
    public function set breakOpportunity(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.BreakOpportunity.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

colorpropriété 
color:uint  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Indique la couleur du texte. Nombre entier contenant trois composants RVB 8 bits ; par exemple, 0xFF0000 correspond au rouge et 0x00FF00 au vert.

La valeur par défaut est 0x000000, ce qui signifie que Flash Player utilise la couleur noire.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Définit la couleur du texte.



Implémentation
    public function get color():uint
    public function set color(value:uint):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).
digitCasepropriété 
digitCase:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Casse de chiffres utilisée pour ce texte. La casse des chiffres affecte le style et le positionnement des groupes de caractères numériques. Utilisez les constantes flash.text.engine.DigitCase pour cette propriété.

La valeur par défaut est flash.text.engine.DigitCase.DEFAULT.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
DigitCase.DEFAULT Applique une casse de chiffres par défaut au texte.
DigitCase.LINING Applique la casse de chiffres des lignes au texte.
DigitCase.OLD_STYLE Applique l'ancienne casse de chiffres de style au texte.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Détermine le casse des chiffres utilisée pour le texte dans l'élément.



Implémentation
    public function get digitCase():String
    public function set digitCase(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.DigitCase.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

digitWidthpropriété 
digitWidth:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Largeur de chiffres utilisée pour ce texte. Utilisez les constantes flash.text.engine.DigitWidth pour cette propriété.

La valeur par défaut est flash.text.engine.DigitWidth.DEFAULT.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
DigitWidth.DEFAULT Applique une largeur de chiffres par défaut au texte.
DigitWidth.PROPORTIONAL Applique une largeur de chiffres proportionnelle au texte.
DigitWidth.TABULAR Applique une largeur de chiffres tabulaire au texte.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Détermine l'épaisseur des chiffres utilisée pour le texte dans l'élément.



Implémentation
    public function get digitWidth():String
    public function set digitWidth(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.DigitWidth.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

dominantBaselinepropriété 
dominantBaseline:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Spécifie les lignes de base de l'élément s'accrochant à alignmentBaseline pour déterminer la position verticale de l'élément sur la ligne. Utilisez les constantes flash.text.engine.TextBaseline pour cette propriété.

Le contenu de l'élément détermine les lignes de base. Dans le cas d'un TextElement, la police et la taille de la police déterminent les lignes de base. Dans le cas d'un ForeignElement, la hauteur de l'élément détermine les lignes de base.

La valeur par défaut est flash.text.engine.TextBaseline.ROMAN.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
TextBaseline.ROMAN La ligne de base des caractères romains de l'élément s'aligne avec alignmentBaseline.
TextBaseline.ASCENT La ligne de base des caractères ascendants de l'élément s'aligne avec alignmentBaseline.
TextBaseline.DESCENT La ligne de base des caractères descendants de l'élément s'aligne avec alignmentBaseline.
TextBaseline.IDEOGRAPHIC_TOP La ligne de base du haut des caractères idéographiques de l'élément s'aligne avec alignmentBaseline.
TextBaseline.IDEOGRAPHIC_CENTER La ligne de base du centre des caractères idéographiques de l'élément s'aligne avec alignmentBaseline.
TextBaseline.IDEOGRAPHIC_BOTTOM La ligne de base du bas des caractères idéographiques de l'élément s'aligne avec alignmentBaseline.

Sous-classeEffet de la définition des propriétés
GraphicElement Détermine quelles lignes de base de l'élément graphique s'alignent sur le alignmentBaseline.
GroupElement N'a aucun effet.
TextElement Détermine quelles lignes de base de l'élément de texte s'alignent sur le alignmentBaseline.



Implémentation
    public function get dominantBaseline():String
    public function set dominantBaseline(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.TextBaseline.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

fontDescriptionpropriété 
fontDescription:FontDescription  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Objet qui encapsule les propriétés nécessaires pour décrire une police.

La valeur par défaut est un objet FontDescription créé par défaut.

Lorsque la propriété fontDescription est définie, l'objet FontDescription fourni est bloqué : sa propriété locked est définie sur true. Il est impossible de modifier un objet FontDescription bloqué.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Détermine la police utilisée pour le texte dans l'élément.



Implémentation
    public function get fontDescription():FontDescription
    public function set fontDescription(value:FontDescription):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

fontSizepropriété 
fontSize:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

La taille du texte, en pixels.

La valeur par défaut est 12.0.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Détermine la taille pour le texte de l'élément, en pixels.



Implémentation
    public function get fontSize():Number
    public function set fontSize(value:Number):void

Valeur émise
ArgumentError — Si défini sur une valeur inférieure à zéro.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).
kerningpropriété 
kerning:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Crénage utilisé pour ce texte. Utilisez les constantes flash.text.engine.Kerning pour cette propriété. Le crénage ajuste les pixels entre certaines paires de caractères pour améliorer la lisibilité. Le crénage est pris en charge pour toutes les polices qui disposent de tables de crénage.

La valeur par défaut est flash.text.engine.Kerning.ON.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
Kerning.ON Le crénage est activé.
Kerning.OFF Le crénage est désactivé.
Kerning.AUTO Le crénage n'est activé que pour les caractères appropriés à une typographie asiatique. Le crénage est appliqué entre deux caractères lorsque aucun d'eux n'est un caractère Kanji, Hiragana ou Katakana.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement Détermine si le crénage est appliqué entre les éléments de texte adjacents du groupe. Si l'elementFormat du groupe est null, le format du premier des éléments adjacents est utilisé.
TextElement Détermine si le crénage est appliqué entre les caractères dans l'élément de texte.



Implémentation
    public function get kerning():String
    public function set kerning(value:String):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

ligatureLevelpropriété 
ligatureLevel:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Niveau de ligature utilisé pour ce texte. Une ligature se produit lorsque plusieurs formes de lettres sont unies dans un seul glyphe. Les ligatures remplacent généralement des caractères consécutifs partageant des composants communs, par exemple les paires de lettres 'fi', 'fl' ou 'ae'. Elles sont utilisées avec les jeux de caractères latins et non latins. Utilisez les constantes flash.text.engine.LigatureLevel pour cette propriété.

La valeur par défaut est flash.text.engine.LigatureLevel.COMMON.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
LigatureLevel.NONE Aucune ligature n'est créée.
LigatureLevel.MINIMUM Des ligatures minimales sont créées.
LigatureLevel.COMMON Des ligatures courantes sont créées.
LigatureLevel.UNCOMMON Des ligatures rares sont créées.
LigatureLevel.EXOTIC Des ligatures exotiques sont créées.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement Détermine le niveau de ligature entre les éléments de texte adjacents du groupe. Si l'elementFormat du groupe est null, le format du premier des éléments adjacents est utilisé.
TextElement Détermine le niveau de ligature entre les caractères de l'élément de texte.



Implémentation
    public function get ligatureLevel():String
    public function set ligatureLevel(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.LigatureLevel.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

localepropriété 
locale:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Variable locale du texte. Contrôle les formes et les transformations de casse. Les identifiants locaux standards sont utilisés. Par exemple « en », « en_US » et « en-US » pour l'anglais, « ja » pour le japonais.

La valeur par défaut est "en".

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Détermine les transformations et les formes du texte dans l'élément.



Implémentation
    public function get locale():String
    public function set locale(value:String):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).
lockedpropriété 
locked:Boolean  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5.

Indique si l'objet ElementFormat est bloqué. Si la propriété est définie sur true, l'objet ElementFormat ne peut pas être modifié. Appelez ElementFormat.clone() pour obtenir une copie non verrouillée de l'objet ElementFormat.



Implémentation
    public function get locked():Boolean
    public function set locked(value:Boolean):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

textRotationpropriété 
textRotation:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Définit la rotation appliquée aux glyphes individuelles. Utilisez les constantes flash.text.engine.TextRotation pour cette propriété.

La valeur par défaut est flash.text.engine.TextRotation.AUTO.

La rotation finale des glyphes est la somme de , ElementFormat.textRotation, ContentElement.textRotation et TextBlock.lineRotation.

ElementFormat.textRotation est généralement utilisé pour le texte asiatique, où les caractères doivent pivoter pour s'afficher correctement verticalement, en combinant la valeur flash.text.engine.TextRotation.AUTO avec TextBlock.lineRotation = flash.text.engine.ROTATE_90.

La définition de cette propriété sur des polices qui ne contiennent pas d'informations de disposition verticale risque de donner des résultats inattendus. Les polices qui contiennent une table vmtx ou VORG, telles que la police japonaise « MS Mincho », fonctionnent correctement. En effet, ces tables fournissent les données dont le moteur de disposition a besoin pour effectuer une mise en forme appropriée. Les polices comme Verdana, qui ne contiennent pas les informations nécessaires, ne fonctionnent pas correctement.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
TextRotation.ROTATE_0 Les glyphes ne pivotent pas.
TextRotation.ROTATE_90 Les glyphes pivotent de 90 degrés vers la droite.
TextRotation.ROTATE_180 Les glyphes pivotent de 180 degrés.
TextRotation.ROTATE_270 Les glyphes pivotent de 270 degrés vers la droite.
TextRotation.AUTO Spécifie une rotation de 90 degrés vers la gauche pour les glyphes larges et de pleine épaisseur uniquement, tels que déterminés par les propriétés Unicode du glyphe. Cette valeur est généralement utilisée avec du texte asiatique pour ne faire pivoter que les glyphes requérant une rotation. Cette rotation est uniquement appliquée au texte vertical pour orienter verticalement les caractères larges et de pleine épaisseur sans affecter les autres caractères.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Détermine la rotation des glyphes dans l'élément de texte.



Implémentation
    public function get textRotation():String
    public function set textRotation(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.TextRotation.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

trackingLeftpropriété 
trackingLeft:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5.

Interlettrage ou crénage manuel à appliquer à gauche de chaque glyphe, en pixels. Si kerning est activé, la valeur trackingLeft est ajoutée aux valeurs dans la table de crénage de la police. Si kerning est désactivé, la valeur trackingLeft est utilisée comme valeur de crénage manuel. Prend en charge les valeurs positives et négatives.

De façon générale, la valeur de suivi désirée est divisée entre trackingRight et trackingLeft. Autrement, dans le cas de texte combinant plusieurs directions, le suivi est double au niveau d'une limite bidirectionnelle et nul pour l'autre.

La valeur par défaut est 0.0.

Sous-classeEffet de la définition des propriétés
GraphicElement Détermine le suivi appliqué à gauche du graphique.
GroupElement N'a aucun effet.
TextElement Détermine le suivi appliqué à gauche des caractères dans l'élément de texte.

Exemple :

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



Implémentation
    public function get trackingLeft():Number
    public function set trackingLeft(value:Number):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

trackingRightpropriété 
trackingRight:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5.

Interlettrage ou crénage manuel à appliquer à droite de chaque glyphe, en pixels. Si kerning est activé, la valeur trackingRight est ajoutée aux valeurs dans la table de crénage de la police. Si kerning est désactivé, la valeur trackingRight est utilisée comme valeur de crénage manuel. Prend en charge les valeurs positives et négatives.

De façon générale, la valeur de suivi désirée est divisée entre trackingRight et trackingLeft. Autrement, dans le cas de texte combinant plusieurs directions, le suivi est double au niveau d'une limite bidirectionnelle et nul pour l'autre.

La valeur par défaut est 0.0.

Sous-classeEffet de la définition des propriétés
GraphicElement Détermine le suivi appliqué à droite du graphique.
GroupElement N'a aucun effet.
TextElement Détermine le suivi appliqué à droite des caractères dans l'élément de texte.

Exemple :

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



Implémentation
    public function get trackingRight():Number
    public function set trackingRight(value:Number):void

Valeur émise
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

typographicCasepropriété 
typographicCase:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Casse typographique utilisée pour ce texte. Utilisez les constantes flash.text.engine.TypographicCase pour cette propriété.

La valeur par défaut est flash.text.engine.TypographicCase.DEFAULT.

Pour définir les valeurs pour cette propriété, utilisez les valeurs de chaîne suivantes :

Valeur de chaîneDescription
TypographicCase.DEFAULT Applique une casse typographique par défaut au texte.
TypographicCase.TITLE Spécifie que les caractères majuscules utilisent des glyphes de titre en sortie.
TypographicCase.CAPS Spécifie que l'espacement est ajusté pour les caractères majuscules en sortie.
TypographicCase.SMALL_CAPS Spécifie que les caractères majuscules utilisent des glyphes de petites majuscules en sortie.
TypographicCase.UPPERCASE Spécifie que tous les caractères utilisent des glyphes majuscules en sortie.
TypographicCase.LOWERCASE Spécifie que tous les caractères utilisent des glyphes minuscules en sortie.
TypographicCase.CAPS_AND_SMALL_CAPS Spécifie que les caractères minuscules utilisent des glyphes de petites majuscules en sortie.

Sous-classeEffet de la définition des propriétés
GraphicElement N'a aucun effet.
GroupElement N'a aucun effet.
TextElement Détermine la casse typographique utilisée pour le texte dans l'élément.



Implémentation
    public function get typographicCase():String
    public function set typographicCase(value:String):void

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n'appartenant pas à flash.text.engine.TypographicCase.
 
IllegalOperationError — Si elle est définie une fois l'objet ElementFormat bloqué (la propriété locked est définie sur true ).

Voir aussi

Détails du constructeur
ElementFormat()Constructeur
public function ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Crée un objet ElementFormat.

Paramètres
fontDescription:FontDescription (default = null) — Objet FontDescription identifiant la police utilisée avec cette mise en forme d'élément. La valeur par défaut est null. Lorsque aucune description de police n'est fournie, une description de police par défaut est construite.
 
fontSize:Number (default = 12.0) — La taille du texte, en pixels.
 
color:uint (default = 0x000000) — Couleur du texte. Nombre contenant trois composants RVB 8 bits ; par exemple, 0xFF0000 correspond au rouge et 0x00FF00 au vert.
 
alpha:Number (default = 1.0) — Propriété alpha appliquée à tous les atomes de ligne sur la base de la mise en forme des éléments.
 
textRotation:String (default = "auto") — rotation appliquée aux glyphes individuelles. Utilisez les constantes flash.text.engine.TextRotation pour cette propriété.
 
dominantBaseline:String (default = "roman") — Ligne de base à laquelle les glyphes du texte s'accrochent. Utilisez les constantes flash.text.engine.TextBaseline pour cette propriété.
 
alignmentBaseline:String (default = "useDominantBaseline") — Ligne de base sur la ligne conteneur à laquelle la ligne de base dominante s'accroche. Utilisez les constantes flash.text.engine.TextBaseline pour cette propriété.
 
baselineShift:Number (default = 0.0) — Décalage de la ligne de base pour le texte, en pixels em.
 
kerning:String (default = "on") — Crénage utilisé pour ce texte. Utilisez flash.text.engine.Kerning.
 
trackingRight:Number (default = 0.0) — Interlettrage ou crénage manuel à appliquer à droite de chaque glyphe, en pixels.
 
trackingLeft:Number (default = 0.0) — Interlettrage ou crénage manuel à appliquer à gauche de chaque glyphe, en pixels.
 
locale:String (default = "en") — Variable locale du texte.
 
breakOpportunity:String (default = "auto") — Opportunité de saut de ligne appliquée à ce texte. Utilisez les constantes flash.text.engine.BreakOpportunity pour cette propriété.
 
digitCase:String (default = "default") — Casse de chiffres utilisée pour ce texte. Utilisez les constantes flash.text.engine.DigitCase pour cette propriété.
 
digitWidth:String (default = "default") — Largeur de chiffres utilisée pour ce texte. Utilisez les constantes flash.text.engine.DigitWidth pour cette propriété.
 
ligatureLevel:String (default = "common") — Niveau de ligature utilisé pour ce texte. Utilisez les constantes flash.text.engine.LigatureLevel pour cette propriété.
 
typographicCase:String (default = "default") — Casse typographique utilisée pour ce texte. Utilisez les constantes flash.text.engine.TypographicCase pour cette propriété.

Valeur émise
ArgumentError — Le paramètre fontSize spécifié est inférieur à 0.
 
ArgumentError — Le paramètre textRotation spécifié n'appartient pas à flash.text.engine.TextRotation.
 
ArgumentError — Le paramètre dominantBaseline spécifié n'appartient pas à flash.text.engine.TextBaseline.
 
ArgumentError — Le paramètre alignmentBaseline spécifié n'appartient pas à flash.text.engine.TextBaseline.
 
ArgumentError — Le paramètre kerning spécifié n'appartient pas à flash.text.engine.Kerning.
 
ArgumentError — Le paramètre breakOpportunity spécifié n'appartient pas à flash.text.engine.BreakOpportunity.
 
ArgumentError — Le paramètre digitCase spécifié n'appartient pas à flash.text.engine.DigitCase.
 
ArgumentError — Le paramètre digitWidth spécifié n'appartient pas à flash.text.engine.DigitWidth.
 
ArgumentError — Le paramètre ligatureLevel spécifié n'appartient pas à flash.text.engine.LigatureLevel.
 
ArgumentError — Le paramètre typographicCase spécifié n'appartient pas à flash.text.engine.TypographicCase.
Détails de la méthode
clone()méthode
public function clone():ElementFormat

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Crée une copie non verrouillée et clonée de l'objet ElementFormat.

Valeur renvoyée
ElementFormat — Une copie non verrouillée de l'objet ElementFormat.

Voir aussi


Exemple

Cet exemple crée un objet ElementFormat et définit la propriété FontSize. Un nouvel objet TextElement est créé (et bloqué), à l'aide d'ElementFormat, et TextElement est utilisé comme contenu pour un TextBlock. Une ligne de texte est créée à partir du TextBlock.

Pour modifier l'objet ElementFormat, vous devez tout d'abord vérifier sa propriété locked. Si elle est définie sur true, utilisez la méthode clone() pour créer une copie non verrouillée de l'objet ElementFormat, modifiez ses propriétés, puis associez à nouveau le nouvel objet ElementFormat au TextBlock. Lorsque les lignes sont de nouveau scindées, les nouvelles récupèrent les nouveaux paramètres de police.

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);
            
        }
    }    
}
getFontMetrics()méthode 
public function getFontMetrics():FontMetrics

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: Flash Player 10, AIR 1.5

Renvoie un objet FontMetrics avec des propriétés qui décrivent la valeur emBox, la position et l'épaisseur du barré et du soulignement pour la police spécifiée par fontDescription et fontSize.

Valeur renvoyée
FontMetrics — Objet FontMetrics décrivant les propriétés de la police spécifiée par fontDescription.

Voir aussi


Exemple

Cet exemple crée un objet ElementFormat avec un FontDescription affecté et utilise la méthode getFontMetrics pour afficher les mesures de la police choisie.
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);
            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);
            
            
        }
    }    
}
Exemples Utilisation des exemples
ElementFormatExample.as

Cet exemple crée deux objets ElementFormat et définit plusieurs de leurs propriétés. Il affecte ensuite le nouvel ElementFormats à un objet TextElement, qui a été affecté en tant que contenu d'un TextBlock. Notez que la modification du ElementFormat d'un TextElement n'affecte pas les TextLines créés précédemment par le TextBlock parent.

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