UITextFormat

Package	mx.core
Classe	public class UITextFormat
Héritage	UITextFormat TextFormat Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

La classe UITextFormat représente des informations de formatage de caractères pour la classe UITextField. La classe UITextField définit la composante utilisée par de nombreux composants Flex composite pour afficher du texte.

La classe UITextFormat étend la classe flash.text.TextFormat pour ajouter les méthodes de mesure de texte measureText() et measureHTMLText() et pour ajouter des propriétés permettant de contrôler la fonction avancée d’anti-aliasing des polices.

Eléments de l’API associés

mx.core.UITextField

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		align : String Indique l’alignement du paragraphe.	TextFormat
		antiAliasType : String Définit le paramètre d’anti-aliasing pour la classe UITextField.	UITextFormat
		blockIndent : Object Indique l’indentation du bloc en pixels.	TextFormat
		bold : Object Spécifie si le texte est en gras.	TextFormat
		bullet : Object Indique que le texte fait partie d’une liste à puces.	TextFormat
		color : Object Indique la couleur du texte.	TextFormat
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		direction : String Direction du texte.	UITextFormat
		font : String Nom de la police pour du texte dans ce format de texte, sous forme de chaîne.	TextFormat
		gridFitType : String Définit le paramètre d’adaptation à la grille pour la classe UITextField.	UITextFormat
		indent : Object Indique l’indentation à appliquer de la marge gauche au premier caractère du paragraphe.	TextFormat
		italic : Object Indique si le texte concerné par ce format doit être en italiques.	TextFormat
		kerning : Object Valeur booléenne indiquant si le crénage est activé (true) ou désactivé (false).	TextFormat
		leading : Object Entier représentant le montant d’espace vertical (appelé interlignage) entre les lignes.	TextFormat
		leftMargin : Object Marge gauche du paragraphe, en pixels.	TextFormat
		letterSpacing : Object Nombre représentant la quantité d’espace répartie uniformément entre tous les caractères.	TextFormat
		locale : String Paramètres régionaux du texte.	UITextFormat
		moduleFactory : IFlexModuleFactory Fabrique moduleFactory utilisée en vue de créer des champs TextField pour les polices incorporées.	UITextFormat
		rightMargin : Object Marge droite du paragraphe, en pixels.	TextFormat
		sharpness : Number Définit le paramètre de netteté pour la classe UITextField.	UITextFormat
		size : Object La taille en pixels de ce format de texte.	TextFormat
		tabStops : Array Spécifie des taquets de tabulation personnalisés, sous forme d’un tableau d’entiers non négatifs.	TextFormat
		target : String Indique la fenêtre cible dans laquelle s’affiche le lien hypertexte.	TextFormat
		thickness : Number Définit le paramètre d’épaisseur pour la classe UITextField.	UITextFormat
		underline : Object Indique si le texte qui utilise ce format texte est souligné (true) ou non (false).	TextFormat
		url : String Indique l’URL cible du texte concerné par ce format.	TextFormat
		useFTE : Boolean = false Détermine la manière dont les méthodes measureText() et measureHTMLText() effectuent les mesures de texte.	UITextFormat

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		UITextFormat(systemManager:ISystemManager, font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null) Constructeur.	UITextFormat
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean 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
		measureHTMLText(htmlText:String, roundUp:Boolean = true):flash.text:TextLineMetrics Renvoie des informations de mesure pour le texte HTML spécifié pouvant contenir des balises HTML (telles que <font> et <b>), en supposant qu’il est affiché dans un champ UITextField à une seule ligne et en utilisant cet objet UITextFormat pour définir le format de texte.	UITextFormat
		measureText(text:String, roundUp:Boolean = true):flash.text:TextLineMetrics Renvoie des informations de mesure pour le texte spécifié en supposant qu’il est affiché dans un composant UITextField à une seule ligne et en utilisant cet objet UITextFormat pour définir le format de texte.	UITextFormat
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object

Détails de la propriété

antiAliasType

propriété

public var antiAliasType:String

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Définit le paramètre d’anti-aliasing pour la classe UITextField. Les valeurs possibles sont "normal" (flash.text.AntiAliasType.NORMAL) et "advanced" (flash.text.AntiAliasType.ADVANCED).

La valeur par défaut est "advanced", ce qui active l’anti-aliasing avancé pour la police incorporée. Définissez la propriété sur "normal" pour désactiver l’anti-aliasing avancé.

Cette propriété n’a aucun effet pour les polices système.

Cette propriété s’applique à l’intégralité du texte d’un objet UITextField : vous ne pouvez pas l’appliquer à certains caractères seulement et non à d’autres.

La valeur par défaut est "advanced".

Eléments de l’API associés

flash.text.AntiAliasType

direction

propriété

public var direction:String

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Direction du texte.

Les valeurs autorisées sont "ltr" pour les textes rédigés de gauche à droite, comme dans les scripts de style latin et "rtl" pour les textes rédigés de droite à gauche, comme l’arabe ou l’hébreu.

FTE et TLF utilisent cette valeur dans leur algorithme de mise en forme de texte bidirectionnel, lequel mappe l’ordre des caractères Unicode sur ordre des glyphes.

Remarque : ce style s’applique uniquement lorsque cet objet UITextFormat est utilisé avec une classe UIFTETextField plutôt qu’avec une classe UITextField.

La valeur par défaut est null.

gridFitType

propriété

public var gridFitType:String

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Définit le paramètre d’adaptation à la grille pour la classe UITextField. Les valeurs possibles sont "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL) et "subpixel" (flash.text.GridFitType.SUBPIXEL).

Cette propriété s’applique uniquement lorsque vous utilisez une police imbriquée et lorsque la propriété fontAntiAliasType est définie sur "advanced".

Cette propriété n’a aucun effet pour les polices système.

Cette propriété s’applique à l’intégralité du texte d’un objet UITextField : vous ne pouvez pas l’appliquer à certains caractères seulement et non à d’autres.

La valeur par défaut est "pixel".

Eléments de l’API associés

flash.text.GridFitType

locale

propriété

public var locale:String

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Paramètres régionaux du texte.

FTE et TLF utilisent ces paramètres régionaux pour mapper des caractères Unicode à des glyphes de police et rechercher des polices de rechange.

Remarque : ce style s’applique uniquement lorsque ce UITextFormat est utilisé avec une classe UIFTETextField plutôt qu’avec une classe UITextField.

La valeur par défaut est null.

moduleFactory

propriété

moduleFactory:IFlexModuleFactory

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Fabrique moduleFactory utilisée pour la création des champs TextField pour les polices incorporées.

Implémentation
public function get moduleFactory():IFlexModuleFactory
public function set moduleFactory(value:IFlexModuleFactory):void

sharpness

propriété

public var sharpness:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Définit le paramètre de netteté pour la classe UITextField. Cette propriété spécifie la netteté du contour des glyphes. Les nombres possibles vont de -400 à 400.

Cette propriété s’applique uniquement lorsque vous utilisez une police imbriquée et lorsque la propriété fontAntiAliasType est définie sur "advanced".

Cette propriété n’a aucun effet pour les polices système.

Cette propriété s’applique à l’intégralité du texte d’un objet UITextField : vous ne pouvez pas l’appliquer à certains caractères seulement et non à d’autres.

La valeur par défaut est 0.

Eléments de l’API associés

flash.text.TextField

thickness

propriété

public var thickness:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Définit le paramètre d’épaisseur pour la classe UITextField. Cette propriété spécifie l’épaisseur du contour des glyphes. Les nombres possibles vont de -200 à 200.

Cette propriété s’applique uniquement lorsque vous utilisez une police imbriquée et lorsque la propriété fontAntiAliasType est définie sur "advanced".

Cette propriété n’a aucun effet pour les polices système.

Cette propriété s’applique à l’intégralité du texte d’un objet UITextField : vous ne pouvez pas l’appliquer à certains caractères seulement et non à d’autres.

La valeur par défaut est 0.

Eléments de l’API associés

flash.text.TextField

useFTE

propriété

public var useFTE:Boolean = false

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Détermine la manière dont les méthodes measureText() et measureHTMLText() effectuent les mesures de texte.

Si la valeur est true, elles utilisent une instance hors écran de la classe FTETextField dans Text Layout Framework. Si la valeur est false, elles utilisent une instance hors écran de la classe TextField dans le lecteur Flash.

La valeur par défaut est false.

Détails du constructeur

()

Constructeur

public function UITextFormat(systemManager:ISystemManager, font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Constructeur.

Paramètres

	`systemManager:ISystemManager` — Objet SystemManager. La propriété SystemManager conserve la liste des polices incorporées. En règle générale, elle est obtenue à partir de la propriété `systemManager` de UIComponent.

	`font:String` (default = `null`) — Chaîne spécifiant le nom d’une police, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`size:Object` (default = `null`) — Nombre spécifiant une taille de police en pixels, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`color:Object` (default = `null`) — Entier non signé indiquant la couleur RVB du texte, par exemple 0xFF0000 pour le rouge, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`bold:Object` (default = `null`) — Indicateur à valeur booléenne spécifiant si le texte est en gras, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`italic:Object` (default = `null`) — Indicateur à valeur booléenne spécifiant si le texte est en italique, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`underline:Object` (default = `null`) — Indicateur à valeur booléenne spécifiant si le texte est souligné, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`url:String` (default = `null`) — Chaîne indiquant l’URL à laquelle le texte est lié, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`target:String` (default = `null`) — Chaîne spécifiant la fenêtre cible pour l’affichage de l’URL de l’hyperlien. Si la fenêtre cible correspond à `null` ou à une chaîne vide, la page liée s’affiche dans la même fenêtre de navigateur. Si le paramètre `urlString` correspond à `null`ou à une chaîne vide, cette propriété n’a aucun effet. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`align:String` (default = `null`) — Chaîne spécifiant l’alignement du paragraphe en tant que valeur flash.text.TextFormatAlign, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`leftMargin:Object` (default = `null`) — Nombre spécifiant la marge gauche du paragraphe en pixels, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`rightMargin:Object` (default = `null`) — Nombre spécifiant la marge droite du paragraphe en pixels, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`indent:Object` (default = `null`) — Nombre spécifiant le retrait en pixels à appliquer de la marge gauche au premier caractère du paragraphe, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

	`leading:Object` (default = `null`) — Nombre spécifiant l’espace vertical supplémentaire entre les lignes, ou `null` pour indiquer que cette classe UITextFormat ne spécifie pas cette propriété. Ce paramètre est facultatif, avec la valeur par défaut `null`.

Eléments de l’API associés

flash.text.TextFormatAlign

Détails de la méthode

measureHTMLText

()

méthode

public function measureHTMLText(htmlText:String, roundUp:Boolean = true):flash.text:TextLineMetrics

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Renvoie des informations de mesure pour le texte HTML spécifié pouvant contenir des balises HTML (telles que <font> et <b>), en supposant qu’il est affiché dans un champ UITextField à une seule ligne et en utilisant cet objet UITextFormat pour définir le format de texte.

Paramètres

	`htmlText:String` — Chaîne spécifiant le texte HTML à mesurer.

	`roundUp:Boolean` (default = `true`) — Indicateur à valeur booléenne spécifiant l’arrondi ou non de la largeur et de la hauteur mesurées au nombre entier le plus proche. L’arrondi est approprié dans la plupart des cas.

Valeur renvoyée

flash.text:TextLineMetrics — Objet TextLineMetrics contenant les mesures du texte.

Eléments de l’API associés

flash.text.TextLineMetrics

measureText

()

méthode

public function measureText(text:String, roundUp:Boolean = true):flash.text:TextLineMetrics

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Renvoie des informations de mesure pour le texte spécifié en supposant qu’il est affiché dans un composant UITextField à une seule ligne et en utilisant cet objet UITextFormat pour définir le format de texte.

Paramètres

	`text:String` — Chaîne spécifiant le texte à mesurer.

	`roundUp:Boolean` (default = `true`) — Indicateur à valeur booléenne spécifiant l’arrondi ou non de la largeur et de la hauteur mesurées au nombre entier le plus proche. L’arrondi est approprié dans la plupart des cas.

Valeur renvoyée

flash.text:TextLineMetrics — Objet TextLineMetrics contenant les mesures du texte.

Eléments de l’API associés

flash.text.TextLineMetrics

Informations juridiques | Politique de confidentialité en ligne

UITextFormat - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package mx.core

antiAliasType

direction

gridFitType

locale

moduleFactory

sharpness

thickness

useFTE

UITextFormat

measureHTMLText

measureText