TextSnapshot - Guide de référence de l’API Adobe ActionScript® 3 (AS3 )

Package	flash.text
Classe	public class TextSnapshot
Héritage	TextSnapshot Object

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9, Flash Lite 4

Les objets TextSnapshot permettent de travailler avec du texte statique dans un clip. Vous pouvez les utiliser, par exemple, pour mettre en forme du texte avec une plus grande précision que celle permise par un texte dynamique, mais le texte est toujours en lecture seule.

Vous n’utilisez pas de constructeur pour créer un objet TextSnapshot ; il est renvoyé par la propriété flash.display.DisplayObjectContainer.textSnapshot.

Eléments de l’API associés

flash.display.DisplayObjectContainer.textSnapshot

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
		charCount : int [lecture seule] Nombre de caractères dans un objet TextSnapshot.	TextSnapshot
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int Recherche l’objet TextSnapshot spécifié et renvoie la position de la première occurrence de textToFind figurant au niveau de ou après beginIndex.	TextSnapshot
		getSelected(beginIndex:int, endIndex:int):Boolean Renvoie une valeur booléenne qui spécifie si un objet TextSnapshot contient du texte sélectionné dans la plage spécifiée.	TextSnapshot
		getSelectedText(includeLineEndings:Boolean = false):String Renvoie une chaîne qui contient tous les caractères spécifiés par la méthode setSelected() correspondante.	TextSnapshot
		getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String Renvoie une chaîne qui contient tous les caractères spécifiés par les paramètres beginIndex et endIndex.	TextSnapshot
		getTextRunInfo(beginIndex:int, endIndex:int):Array Renvoie un tableau d’objets contenant des informations sur un segment de texte.	TextSnapshot
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number Permet de déterminer lequel des caractères contenus dans un objet TextSnapshot se trouve sur ou est proche des coordonnées spécifiées x, y du clip contenant le texte dans l’objet TextSnapshot.	TextSnapshot
		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
		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
		setSelectColor(hexColor:uint = 0xFFFF00):void Spécifie la couleur à utiliser lors de la mise en surbrillance des caractères qui ont été sélectionnés avec la méthode setSelected().	TextSnapshot
		setSelected(beginIndex:int, endIndex:int, select:Boolean):void Spécifie une plage de caractères dans un objet TextSnapshot à sélectionner ou désélectionner.	TextSnapshot
		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é

charCount

propriété

charCount:int [lecture seule]

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9, Flash Lite 4

Nombre de caractères dans un objet TextSnapshot.

Implémentation
public function get charCount():int

Eléments de l’API associés

flash.text.TextSnapshot.getText()

Détails de la méthode

findText

()

méthode

public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9, Flash Lite 4

Recherche l’objet TextSnapshot spécifié et renvoie la position de la première occurrence de textToFind figurant au niveau de ou après beginIndex. Si textToFind n’est pas détecté, la méthode renvoie -1.

Paramètres

	`beginIndex:int` — Spécifie le point de départ pour la recherche du texte spécifié.

	`textToFind:String` — Spécifie le texte à rechercher. Si vous spécifiez un littérale de chaîne au lieu d’une variable de type String, mettez la chaîne entre guillemets.

	`caseSensitive:Boolean` — Spécifie si la casse du texte doit correspondre à celle de la chaîne de `textToFind`.

Valeur renvoyée

int — La position dans l’index de base zéro de la première occurrence du texte spécifié, ou -1.

Eléments de l’API associés

flash.text.TextSnapshot.getText()

getSelected

()

méthode

public function getSelected(beginIndex:int, endIndex:int):Boolean

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9, Flash Lite 4

Renvoie une valeur booléenne qui spécifie si un objet TextSnapshot contient du texte sélectionné dans la plage spécifiée.

Pour rechercher tous les caractères, transmettez une valeur 0 pour start et charCount (ou un grand nombre quelconque) pour end. Pour rechercher un seul caractère, transmettez au paramètre end une valeur égale au paramètre start plus un.

Paramètres

	`beginIndex:int` — Indique la position du premier caractère à examiner. Les valeurs valides pour `beginIndex` vont de `0` à `TextSnapshot.charCount - 1`. Si `beginIndex` est une valeur négative, `0` est utilisé.

	`endIndex:int` — Valeur supérieure à l’index du dernier caractère à examiner. Les valeurs valides de `endIndex` sont comprises entre `0` et `charCount`. Le caractère indexé par le paramètre `endIndex` n’est pas inclus dans la chaîne extraite. Si ce paramètre est omis, `charCount` est utilisé. Lorsque cette valeur est inférieure ou égale à la valeur de `beginIndex`, `beginIndex + 1` est utilisé.

Valeur renvoyée

Boolean — Valeur booléenne indiquant si, dans la plage donnée, au moins un caractère a été sélectionné par la méthode setSelected() correspondante (true) ; sinon, false.

Eléments de l’API associés

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.getText()
flash.text.TextSnapshot.getSelectedText()
flash.text.TextSnapshot.setSelected()

getSelectedText

()

méthode

public function getSelectedText(includeLineEndings:Boolean = false):String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9., Flash Lite 4

Renvoie une chaîne qui contient tous les caractères spécifiés par la méthode setSelected() correspondante. Si aucun caractère n’est spécifié par la méthode setSelected(), une chaîne vide est renvoyée.

Si vous transmettez true pour includeLineEndings, des caractères de nouvelle ligne sont insérés dans la chaîne de renvoi et cette dernière peut être plus longue que la plage d’entrée. Si includeLineEndings est false ou omis, la méthode renvoie le texte sélectionné sans ajouter de caractères.

Paramètres

includeLineEndings:Boolean (default = false) — Une valeur booléenne qui spécifie si des caractères de nouvelle ligne sont insérés dans la chaîne renvoyée, le cas échéant. La valeur par défaut est false.

Valeur renvoyée

String — Chaîne qui contient tous les caractères spécifiés par la commande setSelected() correspondante.

Eléments de l’API associés

flash.text.TextSnapshot.getSelected()
flash.text.TextSnapshot.setSelected()

getText

()

méthode

public function getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9., Flash Lite 4

Renvoie une chaîne qui contient tous les caractères spécifiés par les paramètres beginIndex et endIndex. Si aucun caractère n’est sélectionné, une chaîne vide est renvoyée.

Pour renvoyer tous les caractères, transmettez une valeur 0 pour beginIndex et charCount (ou un grand nombre quelconque) pour endIndex. Pour renvoyer un seul caractère, transmettez une valeur de beginIndex + 1 pour endIndex.

Si vous transmettez une valeur true pour includeLineEndings, des caractères de nouvelle ligne sont insérés dans la chaîne renvoyée à l’emplacement jugé nécessaire. Dans ce cas, la chaîne renvoyée risque de dépasser la plage de saisie. Si includeLineEndings est false ou omis, le texte sélectionné est renvoyé sans caractères supplémentaires.

Paramètres

	`beginIndex:int` — Indique la position du premier caractère à inclure dans la chaîne renvoyée. Les valeurs valides pour `beginIndex` vont de `0` à `charCount - 1`. Si `beginIndex` est une valeur négative, `0` est utilisé.

	`endIndex:int` — Valeur supérieure à l’index du dernier caractère à examiner. Les valeurs valides de `endIndex` sont comprises entre `0` et `charCount`. Le caractère indexé par le paramètre `endIndex` n’est pas inclus dans la chaîne extraite. Si ce paramètre est omis, `charCount` est utilisé. Lorsque cette valeur est inférieure ou égale à la valeur de `beginIndex`, `beginIndex + 1` est utilisé.

	`includeLineEndings:Boolean` (default = `false`) — Valeur booléenne qui spécifie si les caractères de nouvelle ligne sont insérés (`true`) ou s’ils ne sont pas insérés (`false`) dans la chaîne renvoyée. La valeur par défaut est `false`.

Valeur renvoyée

String — Chaîne contenant les caractères dans la plage spécifiée, ou une chaîne vide si aucun caractère n’est détecté dans la plage spécifiée.

Eléments de l’API associés

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.getSelectedText()

getTextRunInfo

()

méthode

public function getTextRunInfo(beginIndex:int, endIndex:int):Array

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9, Flash Lite 4

Renvoie un tableau d’objets contenant des informations sur un segment de texte. Chaque objet correspond à un caractère dans la plage de caractères spécifiée par les deux paramètres de méthode.

Remarque : l’utilisation de la méthode getTextRunInfo() pour une plage de texte volumineuse peut générer le renvoi d’un objet volumineux. Adobe recommande de limiter la plage de texte définie par les paramètres beginIndex et endIndex.

Paramètres

	`beginIndex:int` — La valeur d’index du premier caractère dans une la plage de caractères d’un objet TextSnapshot.

	`endIndex:int` — La valeur d’index du dernier caractère dans une la plage de caractères d’un objet TextSnapshot.

Valeur renvoyée

Array — Un tableau d’objets dans lequel chaque objet contient des informations sur un caractère spécifique qui est contenu dans la plage de caractères spécifiée par les paramètres beginIndex et endIndex. Chaque objet contient les onze propriétés suivantes :

indexInRun Index d’entiers à base zéro du caractère (par rapport à l’ensemble de la chaîne plutôt qu’au segment de texte sélectionné).
selected Valeur booléenne indiquant si le caractère est sélectionné comme true ; false dans le cas contraire.
font Le nom de la police de caractère.
color La valeur combinée alpha et couleur du caractère. Les deux premiers nombres hexadécimaux représentent la valeur alpha, les autres nombres représentent la valeur couleur.
height La hauteur des caractères, en pixels.
matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx et matrix_ty Valeurs de la matrice qui définit la transformation géométrique du caractère. La matrice d’un texte normal, droit est toujours de la forme [1 0 0 1 x y], où x et y sont les positions du caractère dans le clip parent, indépendamment de la hauteur du texte. La matrice se trouve dans le système de coordonnées du clip parent et ne contient aucune transformations susceptibles de se trouver sur ce clip même (ou son parent).
corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x et corner3y Les coins du cadre de sélection du caractère, en fonction du système de coordonnées du clip parent. Ces valeurs ne sont disponibles que si la police utilisée par le caractère est intégrée dans le fichier SWF.

Eléments de l’API associés

Classe Matrix

hitTestTextNearPos

()

méthode

public function hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9., Flash Lite 4

Permet de déterminer lequel des caractères contenus dans un objet TextSnapshot se trouve sur ou est proche des coordonnées spécifiées x, y du clip contenant le texte dans l’objet TextSnapshot.

Si vous omettez ou transmettez une valeur 0 pour maxDistance, l’emplacement spécifié par les coordonnées x, y doit se trouver à l’intérieur du cadre de sélection de l’objet TextSnapshot.

Cette méthode fonctionne correctement uniquement pour les polices qui incluent des informations métriques de caractères ; par défaut cependant, l’outil de création de Flash n’inclut pas ces informations pour les champs de texte statique. Par conséquent, il se peut que la méthode renvoie -1 au lieu d’une valeur d’index. Pour garantir qu’une valeur d’indexation est renvoyée, vous pouvez forcer l’outil de création de Flash à inclure les informations métriques de caractères pour une police. Pour ce faire, ajoutez un champ de texte dynamique qui utilise cette police, sélectionnez les options des caractères pour ce champ de texte dynamique et spécifiez que les polices vectorielles doivent être intégrées pour au moins un caractère. (le choix des caractères spécifiés et la présence ou non des caractères utilisés dans les champs de texte statique en question importent peu).

Paramètres

	`x:Number` — Nombre qui représente la coordonnée `x` du clip qui contient le texte.

	`y:Number` — Nombre qui représente la coordonnée `y` du clip qui contient le texte.

	`maxDistance:Number` (default = `0`) — Nombre qui représente la distance maximale de `x`, `y` dans laquelle une recherche de texte peut être lancée. Cette distance est mesurée à partir du point central de chaque caractère. La valeur par défaut est `0`.

Valeur renvoyée

Number — Nombre représentant la valeur d’index du caractère qui est le plus proche des coordonnées x, y spécifiées. Renvoie -1 si aucun caractère n’est détecté ou si la police ne contient pas d’informations métriques de caractères.

Eléments de l’API associés

flash.display.DisplayObject.x
flash.display.DisplayObject.y

setSelectColor

()

méthode

public function setSelectColor(hexColor:uint = 0xFFFF00):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9., Flash Lite 4

Spécifie la couleur à utiliser lors de la mise en surbrillance des caractères qui ont été sélectionnés avec la méthode setSelected(). La couleur est toujours opaque ; vous ne pouvez pas spécifier de valeur de transparence.

Cette méthode fonctionne correctement uniquement pour les polices qui incluent des informations métriques de caractères ; par défaut cependant, l’outil de création de Flash n’inclut pas ces informations pour les champs de texte statique. Par conséquent, il se peut que la méthode renvoie -1 au lieu d’une valeur d’index. Pour garantir qu’une valeur d’index est renvoyée, vous pouvez forcer l’outil de création de Flash à inclure les informations métriques de caractères pour une police. Pour ce faire, ajoutez un champ de texte dynamique qui utilise cette police, sélectionnez les options des caractères pour ce champ de texte dynamique et spécifiez que les polices vectorielles doivent être intégrées pour au moins un caractère. (le choix des caractères spécifiés et la présence ou non des caractères utilisés dans les champs de texte statique en question importent peu).

Paramètres

hexColor:uint (default = 0xFFFF00) — La couleur utilisée pour la bordure placée autour des caractères qui ont été sélectionnés avec la commande setSelected() correspondante, exprimée au format hexadécimal (0xRRGGBB).

Eléments de l’API associés

flash.text.TextSnapshot.setSelected()

setSelected

()

méthode

public function setSelected(beginIndex:int, endIndex:int, select:Boolean):void

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0, Flash Player 9., Flash Lite 4

Spécifie une plage de caractères dans un objet TextSnapshot à sélectionner ou désélectionner. Les caractères qui sont sélectionnés sont dessinés sur fond de rectangle coloré, correspondant au cadre de sélection du caractère. La couleur du cadre de sélection est défini par setSelectColor().

Pour sélectionner ou désélectionner tous les caractères, transmettez la valeur 0 pour beginIndex et charCount (ou un grand nombre quelconque) pour endIndex. Pour spécifier un seul caractère, transmettez une valeur de start + 1 pour endIndex.

Les caractères étant individuellement marqués comme sélectionnés, vous pouvez appeler cette méthode plusieurs fois pour sélectionner plusieurs caractères ; c’est-à-dire, l’utilisation de cette méthode ne désélectionne pas les autres caractères qui ont été définis par cette méthode.

Le rectangle de couleur qui indique qu’une sélection s’affiche uniquement pour les polices qui incluent des informations sur les unités de mesure des caractères. Par défaut, Flash n’inclut pas ces informations pour les champs de texte statiques. Dans la plupart des cas, ce comportement signifie que le texte qui est sélectionné ne semblera pas sélectionné à l’écran. Pour garantir que l’ensemble du texte sélectionné s’affiche comme tel, vous pouvez forcer l’outil de création de Flash à inclure les informations métriques de caractères pour une police. Pour ce faire, ajoutez un champ de texte dynamique qui utilise cette police, sélectionnez les options des caractères pour ce champ de texte dynamique et spécifiez que les polices vectorielles doivent être intégrées pour au moins un caractère. Le choix des caractères spécifiés et la présence ou non des caractères utilisés dans les champs de texte statique en question importent peu.

Paramètres

	`beginIndex:int` — Indique la position du premier caractère à sélectionner. Les valeurs valides pour `beginIndex` vont de `0` à `charCount - 1`. Si `beginIndex` est une valeur négative, `0` est utilisé.

	`endIndex:int` — Entier qui correspond à 1+ l’index du dernier caractère à examiner. Les valeurs valides de `end` sont comprises entre `0` et `charCount`. Le caractère indexé par le paramètre `end` n’est pas inclus dans la chaîne extraite. Si vous omettez ce paramètre, `TextSnapshot.charCount` est utilisé. Si la valeur de `beginIndex` est inférieure ou égale à la valeur `endIndex`, `beginIndex + 1` est utilisée.

	`select:Boolean` — Une valeur booléenne qui spécifie si le texte doit être sélectionné (`true`) ou désélectionné (`false`).

Eléments de l’API associés

flash.text.TextSnapshot.charCount
flash.text.TextSnapshot.setSelectColor()

Informations juridiques | Politique de confidentialité en ligne

TextSnapshot - AS3

Packagesx

Eléments du langage

Annexes

Package flash.text

charCount

findText

getSelected

getSelectedText

getText

getTextRunInfo

hitTestTextNearPos

setSelectColor

setSelected