Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
flash.text.engine 

FontDescription  - AS3

Packageflash.text.engine
Classepublic final class FontDescription
HéritageFontDescription Inheritance Object

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

La classe FontDescription représente les informations requises pour décrire une police.

Un objet FontDescription est appliqué à un ElementFormat, qui à son tour est appliqué à un ContentElement dans un TextBlock. Après avoir appliqué un objet FontDescription à un ElementFormat, sa propriété locked est définie sur true. Les propriétés d’un objet FontDescription 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 à ElementFormat.

Remarque : FTE (Flash Text Engine) ne prend pas en charge les polices Type 1 ou les polices bitmap, telles que Type 3, ATC, CID ou CID basées sur SFNT.

Consulter les exemples

Plus d’exemples

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
  cffHinting : String
Type de repère CFF utilisé pour ce texte.
FontDescription
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
  fontLookup : String
Spécifie comment la police doit être recherchée.
FontDescription
  fontName : String
Nom de la police à utiliser, ou liste de noms de police séparés par une virgule.
FontDescription
  fontPosture : String
Spécifie la posture de la police.
FontDescription
  fontWeight : String
Spécifie l’épaisseur de la police.
FontDescription
  locked : Boolean
Indique si l’objet FontDescription est bloqué ou non.
FontDescription
  renderingMode : String
Mode de rendu utilisé pour ce texte.
FontDescription
Méthodes publiques
 MéthodeDéfini par
  
FontDescription(fontName:String = "_serif", fontWeight:String = "normal", fontPosture:String = "normal", fontLookup:String = "device", renderingMode:String = "cff", cffHinting:String = "horizontalStem")
Crée un objet FontDescription.
FontDescription
  
Crée une copie non verrouillée et clonée de l’objet FontDescription.
FontDescription
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
  
isDeviceFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean
[statique] Renvoie la valeur true si une police de périphérique utilisable est disponible avec les classes fontName, fontWeight et fontPosture spécifiées.
FontDescription
  
isFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean
[statique] Renvoie true si une police incorporée est disponible avec les paramètres fontName, fontWeight et fontPosture spécifiés, où Font.fontType correspond à flash.text.FontType.EMBEDDED_CFF.
FontDescription
 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 de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
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é

cffHinting

propriété
cffHinting:String

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

Type de repère CFF utilisé pour ce texte. Utilisez les constantes CFFHinting pour cette propriété. Cette propriété s’applique uniquement si la propriété RenderingMode du texte est définie sur RenderingMode.CFF.

Le type de repère CFF (Compact Font Format) utilisé détermine si le moteur d’exécution de Flash force les épaisseurs horizontales fortes à s’aligner sur une grille de sous-pixels ou non.

S’applique uniquement aux polices incorporées.

La valeur par défaut est CFFHinting.HORIZONTAL_STEM.

Pour la propriété CFFHinting, vous pouvez utiliser les constantes suivantes de la classe CFFHinting :

Valeur de chaîneDescription
CFFHinting.NONESpécifie aucun repère CFF Les épaisseurs horizontales des glyphes ne sont pas alignées sur la grille de sous-pixels. Ce paramètre convient aux animations ou aux grandes polices.
CFFHinting.HORIZONTAL_STEMSpécifie un repère CFF. Les épaisseurs horizontales fortes sont adaptées à la grille de sous-pixels sur un écran. Pour utiliser ce paramètre, la propriété RenderingMode doit être définie sur RenderingMode.CFF.



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

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à CFFHinting.
 
IllegalOperationError — Si elle est définie une fois l’objet FontDescription bloqué (la propriété locked est définie sur true).

Plus d’exemples

Eléments de l’API associés

fontLookup

propriété 
fontLookup:String

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

Spécifie comment la police doit être recherchée.

La valeur par défaut est FontLookup.DEVICE.

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

Valeur de chaîneDescription
FontLookup.DEVICELe moteur d’exécution recherche une police de périphérique portant le nom spécifié sur le système local et l’utilise pour restituer le texte.
FontLookup.EMBEDDED_CFFLe moteur d’exécution recherche une police CFF incorporée portant le nom à utiliser pour restituer le texte. Seules les polices de type flash.text.Font.fontType.EMBEDDED_CFF sont prises en compte. Si la police CFF spécifiée n’est pas incorporée à l’application, le moteur d’exécution tente d’utiliser une police de périphérique par défaut pour chaque glyphe. Cette méthode est moins efficace que la sélection directe d’une police de périphérique.



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

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

Plus d’exemples

Eléments de l’API associés

fontName

propriété 
fontName:String

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

Nom de la police à utiliser, ou liste de noms de police séparés par une virgule. Pour le rendu de l’élément, le moteur d’exécution sélectionne la première police disponible dans la liste. Par exemple "Arial, Helvetica, _sans" envoie le lecteur chercher Arial, puis Helvetica s’il ne trouve pas Arial, puis _sans si aucune des deux n’est trouvée.

Les moteurs d’exécution de Flash prennent en charge trois noms de polices de périphérique génériques : _sans (pour les polices sans serif), _serif (pour les polices serif) et _typewriter (pour les polices à espacement fixe). Ces noms sont associés aux polices de périphérique propres à la plateforme.

La valeur par défaut est "_serif".

Les moteurs d’exécution de Flash fournissent des polices par défaut pour les glyphes introuvables dans la police sélectionnée. Que la police utilisée soit incorporée ou de périphérique, lorsque le glyphe à restituer y est introuvable, le moteur d’exécution tente de le restituer à l’aide d’une autre police de périphérique susceptible de le contenir.



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

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

Eléments de l’API associés

fontPosture

propriété 
fontPosture:String

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

Spécifie la posture de la police.

La valeur par défaut est FontPosture.NORMAL.

Pour définir les valeurs pour cette propriété, utilisez les constantes suivantes de la classe FontPosture :

ValeurDescription
FontPosture.NORMALPosture de police normale.
FontPosture.ITALICPosture de police italique.



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

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à FontPosture.
 
IllegalOperationError — Si elle est définie une fois l’objet FontDescription bloqué (la propriété locked est définie sur true).

Eléments de l’API associés

fontWeight

propriété 
fontWeight:String

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

Spécifie l’épaisseur de la police.

La valeur par défaut est FontWeight.NORMAL.

Pour définir les valeurs pour cette propriété, utilisez les constantes suivantes de la classe FontWeight :

Valeur de chaîneDescription
FontWeight.NORMALEpaisseur de police normale.
FontWeight.BOLDEpaisseur de police gras.



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

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à FontWeight.
 
IllegalOperationError — Si elle est définie une fois l’objet FontDescription bloqué (la propriété locked est définie sur true).

Eléments de l’API associés

locked

propriété 
locked:Boolean

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

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



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 FontDescription bloqué (la propriété locked est définie sur true).

Plus d’exemples

renderingMode

propriété 
renderingMode:String

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

Mode de rendu utilisé pour ce texte. Utilisez les constantes RenderingMode pour cette propriété.

S’applique uniquement aux polices incorporées.

La valeur par défaut est RenderingMode.CFF.

Pour définir les valeurs de cette propriété, utilisez les constantes suivantes de la classe RenderingMode :

Valeur de chaîneDescription
RenderingMode.NORMALApplique un rendu de texte normal, correspondant au type de rendu utilisé par Flash Player 7 et les versions précédentes.
RenderingMode.CFFApplique le rendu CFF (Compact Font Format) qui rend le texte plus lisible. (cette fonctionnalité est disponible depuis Flash Player 10). Le rendu CFF permet d’obtenir la qualité du rendu des polices de petite taille.



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

Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à RenderingMode.
 
IllegalOperationError — Si elle est définie une fois l’objet FontDescription bloqué (la propriété locked est définie sur true).

Plus d’exemples

Eléments de l’API associés

Détails du constructeur

FontDescription

()Constructeur
public function FontDescription(fontName:String = "_serif", fontWeight:String = "normal", fontPosture:String = "normal", fontLookup:String = "device", renderingMode:String = "cff", cffHinting:String = "horizontalStem")

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

Crée un objet FontDescription.

Paramètres
fontName:String (default = "_serif") — Nom de la police à utiliser, ou liste de noms de police séparés par une virgule.
 
fontWeight:String (default = "normal") — Spécifie l’épaisseur de la police.
 
fontPosture:String (default = "normal") — Spécifie la posture de la police.
 
fontLookup:String (default = "device") — Spécifie comment rechercher la police.
 
renderingMode:String (default = "cff") — Mode de rendu utilisé pour ce texte. Utilisez les constantes RenderingMode pour cette propriété.
 
cffHinting:String (default = "horizontalStem") — Type de repère CFF (Compact Font Format) utilisé pour ce texte. Utilisez les constantes CFFHinting pour cette propriété.

Valeur émise
ArgumentError — Le paramètre fontWeight spécifié n’appartient pas à FontWeight.
 
ArgumentError — Le paramètre fontPosture spécifié n’appartient pas à FontPosture.
 
ArgumentError — Le paramètre fontLookup spécifié n’appartient pas à FontLookup.
 
ArgumentError — Le paramètre renderingMode spécifié n’appartient pas à RenderingMode.
 
ArgumentError — Le paramètre cffHinting spécifié n’appartient pas à CFFHinting.
Détails de la méthode

clone

()méthode
public function clone():FontDescription

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

Crée une copie non verrouillée et clonée de l’objet FontDescription.

Valeur renvoyée
FontDescription — Une copie non verrouillée de l’objet FontDescription.

Plus d’exemples


Exemple  ( Comment utiliser cet exemple )

Cet exemple crée un objet FontDescription, lui affecte une police de périphérique, définit diverses propriétés de police et affecte le nouvel objet à un objet ElementFormat tout en le bloquant. Un nouvel objet TextElement est créé, à 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 FontDescription, 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 FontDescription, modifiez ses propriétés, puis affectez-la à un nouvel objet ElementFormat. Ensuite, 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 FontDescription_cloneExample extends Sprite {
        private var fd:FontDescription;
        private var fd2:FontDescription;
        
        public function FontDescription_cloneExample():void {
            fd = new FontDescription();
            fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
            fd.fontName = "Palatino";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;
            fd.fontPosture = flash.text.engine.FontPosture.ITALIC;

            var ef1:ElementFormat = new ElementFormat(fd);
            
            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);
            
            fd2 = (fd.locked) ? fd.clone() : fd;    
            fd2.fontWeight = flash.text.engine.FontWeight.NORMAL;
            var ef2:ElementFormat = new ElementFormat(fd2);

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

isDeviceFontCompatible

()méthode 
public static function isDeviceFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean

Version du langage: ActionScript 3.0
Versions du moteur d’exécution: Flash Player 10.1, AIR 2

Renvoie la valeur true si une police de périphérique utilisable est disponible avec fontName, fontWeight et fontPosture.

Les classes flash.text.engine ne peuvent utiliser que des polices de périphérique OpenType et TrueType. Si vous utilisez une police basée sur une ancienne technologie de polices, le moteur d’exécution revient à des polices de périphériques en restituant le texte glyphe par glyphe.

Paramètres

fontName:String — Nom de la police de périphérique à vérifier.
 
fontWeight:String — Spécifie l’épaisseur de la police. Utilisez FontWeight.
 
fontPosture:String — Spécifie la posture de la police. Utilisez FontPosture.

Valeur renvoyée
Booleantrue si une police de périphérique compatible est disponible, false dans le cas contraire.

Valeur émise
ArgumentError — Le paramètre fontWeight spécifié n’appartient pas à FontWeight.
 
ArgumentError — Le paramètre fontPosture spécifié n’appartient pas à FontPosture.

Eléments de l’API associés

isFontCompatible

()méthode 
public static function isFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean

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

Renvoie true si une police incorporée est disponible avec les paramètres fontName, fontWeight et fontPosture spécifiés, où Font.fontType correspond à flash.text.FontType.EMBEDDED_CFF. Depuis Flash Player 10, le contenu d’une application peut disposer de deux sortes de polices incorporées. Les polices incorporées normales ne sont utilisées que par les objets TextField. Les polices CFF intégrées ne sont utilisées que par les classes flash.text.engine. Les deux types sont différenciés par la propriété fontType de la classe Font, telle que renvoyée par la fonction enumerateFonts().

Les classes flash.text.engine ne peuvent pas utiliser une police de type EMBEDDED. Si fontLookup est défini sur FontLookup.EMBEDDED_CFF et que l’unique police disponible au moment de l’exécution avec le nom, l’épaisseur et la posture spécifiés est de type EMBEDDED, le moteur d’exécution de Flash revient à des polices de périphériques en restituant le texte glyphe par glyphe, comme si aucune police incorporée ne correspondait au nom et au style spécifiés.

Si des polices EMBEDDED et EMBEDDED_CFF sont disponibles avec le même nom, la même épaisseur et la même posture, la police EMBEDDED_CFF est sélectionnée et le texte est restitué avec la police EMBEDDED_CFF.

Paramètres

fontName:String — Nom de la police incorporée à vérifier.
 
fontWeight:String — Spécifie l’épaisseur de la police. Utilisez FontWeight.
 
fontPosture:String — Spécifie la posture de la police. Utilisez FontPosture.

Valeur renvoyée
Booleantrue si une police incorporée compatible est disponible, sinon false.

Valeur émise
ArgumentError — Le paramètre fontWeight spécifié n’appartient pas à FontWeight.
 
ArgumentError — Le paramètre fontPosture spécifié n’appartient pas à FontPosture.

Eléments de l’API associés

FontDescriptionExample.as

Cet exemple crée un objet FontDescription, lui affecte une police de périphérique, définit diverses propriétés de police et affecte le nouvel objet à un objet ElementFormat. D’autres mises en forme de police sont effectuées dans ElementFormat. Un nouvel objet TextElement est créé, à l’aide d’ElementFormat et TextElement est utilisé comme contenu pour un TextBlock. Une ligne de texte est créée à partir du TextBlock.

package {

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

    
    public class FontDescriptionExample extends Sprite {
        
        public function FontDescriptionExample():void {
            var fd:FontDescription = new FontDescription();
            fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
            fd.fontName = "Palatino";
            fd.fontWeight = flash.text.engine.FontWeight.BOLD;
            fd.fontPosture = flash.text.engine.FontPosture.ITALIC;

            var ef1:ElementFormat = new ElementFormat(fd);
            ef1.fontSize = 30;
            ef1.color = 0xFF0000;
            
            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);
            
        }
    }    
}




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.