Package | flash.text |
Classe | public final class StageText |
Héritage | StageText EventDispatcher Object |
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Cette classe permet aux applications mobiles d’obtenir les entrées de l’utilisateur à l’aide de commandes de saisie de texte natives sur les périphériques mobiles. Les commandes d’entrée sur les périphériques mobiles disposent souvent d’interfaces utilisateur complètes et prennent en charge des comportements qui n’existent pas sur les périphériques de bureau. Par exemple, de nombreux périphériques mobiles prennent en charge certaines fonctions de saisie de texte, à savoir :
- le remplissage automatique
- la correction automatique
- la sélection de texte par mouvement tactile
- les claviers programmables personnalisables
Le système d’exploitation sous-jacent (ou une bibliothèque de composant fournie avec le système d’exploitation) trace des champs de saisie de texte natifs. Les champs de saisie de texte natifs fournissent une expérience familière à toute personne ayant utilisé d’autres applications sur le même périphérique. Toutefois, étant donné que c’est le système d’exploitation qui trace les champs de saisie de texte (et non le lecteur), vous ne pouvez pas utiliser de polices incorporées.
Prise en charge du profil AIR : cette fonctionnalité est prise en charge sur les plates-formes iOS et Android. StageText utilise des champs de saisie de texte natifs sur les périphériques mobiles Android et iOS. Sur d’autres plates-formes, StageText utilise la classe TextField du moteur d’exécution de Flash.
Lors de l’utilisation des saisies natives, les objets StageText ne sont pas des objets d’affichage et ne peuvent donc pas être ajoutés à la liste d’affichage de Flash. Par contre, vous pouvez afficher un objet StageText en l’associant directement à une scène à l’aide de la propriété stage
. L’occurrence de StageText associée à une scène s’affiche au-dessus de n’importe quel objet d’affichage Flash. Vous pouvez contrôler la taille et la position de la zone de rendu avec la propriété viewPort
. Il n’existe aucun moyen de contrôler l’ordre de profondeur de différents objets StageText. Le chevauchement de deux instances n’est pas recommandé.
Lorsqu’un objet StageText a le focus, il a pour la première fois l’occasion de gérer la saisie au clavier. La scène à laquelle l’objet StageText objet est lié ne distribue aucun événement de saisie au clavier.
Etant donné que la classe StageText englobe un autre contrôle natif sur chaque plate-forme, ses fonctionnalités sont prises en charge à différents degrés par chaque plate-forme. Lorsque les fonctions sont prises en charge, il est possible que leur comportement diffère en fonction de la plate-forme. Lorsque vous tentez d’utiliser un élément particulier sur une plate-forme, il est préférable de tester le comportement. Le comportement de la classe StageText est similaire à celui du texte du moteur d’exécution de Flash uniquement sur les plates-formes de bureau sur lesquelles les contrôles natifs ne sont pas utilisés.
StageText sur Apple TV prend le focus par défaut. Pour gérer le focus entre différents objets dans votre application, notez les points ci-dessous :
- Pour remplacer le focus par défaut à partir de StageText ou attribuer le focus à un autre objet d’affichage, utilisez stage.focus.
- Pour attribuer le focus à StageText, utilisez stageText.assignFocus().
Propriété | Défini par | ||
---|---|---|---|
autoCapitalize : String
Contrôle la façon dont un périphérique applique la mise en majuscules automatique à l’entrée de l’utilisateur. | StageText | ||
autoCorrect : Boolean
Indique si un périphérique corrige automatiquement l’entrée utilisateur en cas d’erreurs orthographiques ou de ponctuation. | StageText | ||
clearButtonMode : String [écriture seule]
Mode de clearButton pour l’objet StageText actuel. | StageText | ||
color : uint
Spécifie la couleur du texte. | StageText | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
displayAsPassword : Boolean
Indique si le champ de texte est un champ de texte de mot de passe. | StageText | ||
editable : Boolean
Indique si l’utilisateur peut modifier le champ de texte. | StageText | ||
fontFamily : String
Indique le nom de la famille de polices de caractères en cours d’utilisation. | StageText | ||
fontPosture : String
Spécifie la position de police à l’aide des constantes définies dans la classe FontPosture. | StageText | ||
fontSize : int
Taille de la famille de polices en cours d’utilisation, en pixels. | StageText | ||
fontWeight : String
Spécifie l’épaisseur de la police à l’aide des constantes définies dans la classe FontWeight. | StageText | ||
locale : String
Indique les paramètres régionaux du texte. | StageText | ||
maxChars : int
Indique le nombre de caractères maximum qu’un utilisateur peut entrer dans le champ de texte. | StageText | ||
multiline : Boolean [lecture seule]
Indique si l’objet StageText peut afficher plus d’une ligne de texte. | StageText | ||
restrict : String
Limite le jeu de caractères qu’un utilisateur peut entrer dans le champ de texte. | StageText | ||
returnKeyLabel : String
Indique l’étiquette sur la touche Retour pour les périphériques qui disposent d’un clavier logiciel. | StageText | ||
selectionActiveIndex : int [lecture seule]
Valeur d’index de base zéro du dernier caractère de la sélection actuelle. | StageText | ||
selectionAnchorIndex : int [lecture seule]
Valeur d’index de base zéro du premier caractère de la sélection actuelle. | StageText | ||
softKeyboardType : String
Contrôle l’aspect du clavier logiciel. | StageText | ||
stage : Stage
Scène sur laquelle cet objet StageText est affiché. | StageText | ||
text : String
Texte actuel dans le champ de texte. | StageText | ||
textAlign : String
Indique l’alignement du paragraphe. | StageText | ||
viewPort : Rectangle
Zone sur la scène dans laquelle l’objet StageText est affiché. | StageText | ||
visible : Boolean
Indique si l’objet StageText est visible. | StageText |
Méthode | Défini par | ||
---|---|---|---|
Crée un objet StageText. | StageText | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | ||
Attribue le focus à l’objet StageText. | StageText | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Supprime l’objet StageText. | StageText | ||
Crée la fenêtre d’affichage de l’objet StageText sur un bitmap. | StageText | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
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 | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | ||
Sélectionne le texte spécifié par les valeurs d’index des premier et dernier caractères. | StageText | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object | ||
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher |
Evénement | Synthèse | Défini par | ||
---|---|---|---|---|
[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active. | EventDispatcher | |||
Distribué après la modification du contenu du texte. | StageText | |||
Distribué après la définition d’une scène non-nulle et d’une fenêtre d’affichage non vide. | StageText | |||
[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive. | EventDispatcher | |||
Distribué lorsque l’utilisateur modifie le texte et que le contrôle a le focus clavier. | StageText | |||
Distribué lorsque l’utilisateur ne modifie plus le texte et que le contrôle n’a plus le focus clavier. | StageText | |||
Distribué lorsque l’utilisateur appuie sur une touche. | StageText | |||
Distribué lorsque l’utilisateur relâche une touche. | StageText | |||
Distribué après l’activation du clavier logiciel, suite à l’obtention du focus de l’objet StageText. | StageText | |||
Distribué avant l’activation du clavier logiciel, suite à l’obtention du focus de l’objet StageText. | StageText | |||
Distribué après la désactivation du clavier logiciel, suite à la perte de focus de l’objet StageText. | StageText |
autoCapitalize | propriété |
autoCapitalize:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Contrôle la façon dont un périphérique applique la mise en majuscules automatique à l’entrée de l’utilisateur. Les valeurs valides sont définies comme constantes dans la classe AutoCapitalize.
- "aucun"
- "word"
- "sentence"
- "all"
Cette propriété est uniquement un conseil à la plate-forme sous-jacente, car tous les périphériques et systèmes d’exploitation ne prennent pas en charge cette fonctionnalité.
Remarque : si vous activez autoCapitalize
lorsque du texte est en cours d’édition ou est sélectionné, le changement de comportement ne s’applique pas tant que le focus n’a pas quitté le champ de texte et n’a pas été rétabli.
La valeur par défaut est AutoCapitalize.NONE.
Implémentation
public function get autoCapitalize():String
public function set autoCapitalize(value:String):void
Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à AutoCapitalize
|
Eléments de l’API associés
autoCorrect | propriété |
autoCorrect:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique si un périphérique corrige automatiquement l’entrée utilisateur en cas d’erreurs orthographiques ou de ponctuation.
Cette propriété est uniquement un conseil à la plate-forme sous-jacente, car tous les périphériques et systèmes d’exploitation ne prennent pas en charge cette fonctionnalité.
Remarque : si vous activez autoCorrect
lorsque du texte est en cours d’édition ou est sélectionné, le changement de comportement ne s’applique pas tant que le focus n’a pas quitté le champ de texte et n’a pas été rétabli.
La valeur par défaut est false.
Implémentation
public function get autoCorrect():Boolean
public function set autoCorrect(value:Boolean):void
clearButtonMode | propriété |
clearButtonMode:String
[écriture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 23 |
Mode de clearButton pour l’objet StageText actuel. Quatre modes sont associés à cette propriété :
-
Pour afficher clearButton pendant la modification :
StageTextClearButtonMode.WHILE_EDITING
-
Pour ne jamais afficher clearButton :
StageTextClearButtonMode.NEVER
-
Pour toujours afficher clearButton :
StageTextClearButtonMode.ALWAYS
-
Pour afficher clearButton, sauf en cas de modification :
StageTextClearButtonMode.UNLESS_EDITING
clearButtonMode
est définie en tant que StageTextClearButtonMode.WHILE_EDITING
.
Remarque : Cette propriété est prise en charge uniquement pour iOS.
Implémentation
public function set clearButtonMode(value:String):void
color | propriété |
color:uint
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Spécifie la couleur du texte. Spécifiez la couleur du texte sous forme de nombre contenant trois composants RVB 8 bits. Le premier composant représente le rouge, le deuxième représente le vert et le troisième le bleu. Par exemple, 0xFF0000
spécifie la couleur rouge, 0x00FF00
spécifie la couleur verte et 0x0000FF
spécifie la couleur bleue. La couleur par défaut est le noir (0x000000
).
La valeur par défaut est 0x000000.
Implémentation
public function get color():uint
public function set color(value:uint):void
displayAsPassword | propriété |
displayAsPassword:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique si le champ de texte est un champ de texte de mot de passe. Si la valeur est définie sur true
, le champ de texte masque les caractères d’entrée à l’aide d’un caractère de remplacement (par exemple, un astérisque).
Remarque : si vous activez displayAsPassword
lorsque du texte est en cours d’édition ou est sélectionné, le changement de comportement ne s’applique pas tant que le focus n’a pas quitté le champ de texte et n’a pas été rétabli.
Important : sur iOS, un objet de texte de scène multiligne n’affiche pas les caractères de remplacement lorsque la valeur de cette propriété est true
.
La valeur par défaut est false.
Implémentation
public function get displayAsPassword():Boolean
public function set displayAsPassword(value:Boolean):void
editable | propriété |
fontFamily | propriété |
fontFamily:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique le nom de la famille de polices de caractères en cours d’utilisation. La valeur null indique la valeur par défaut du système. Pour énumérer les polices disponibles, utilisez flash.text.Font.enumerateFonts()
. Si la famille de polices est inconnue, la famille de polices par défaut est utilisée.
La valeur par défaut est null.
Implémentation
public function get fontFamily():String
public function set fontFamily(value:String):void
fontPosture | propriété |
fontPosture:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Spécifie la position de police à l’aide des constantes définies dans la classe FontPosture.
La valeur par défaut est FontPosture.NORMAL.
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
|
Eléments de l’API associés
fontSize | propriété |
fontWeight | propriété |
fontWeight:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Spécifie l’épaisseur de la police à l’aide des constantes définies dans la classe FontWeight.
La valeur par défaut est FontWeight.NORMAL.
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
|
Eléments de l’API associés
locale | propriété |
locale:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique les paramètres régionaux du texte. StageText utilise les identificateurs de paramètres régionaux standard. Par exemple « en », « en_US » et « en-US » pour l’anglais, « ja » pour le japonais. Voir la liste des codes ISO 639-2 pour obtenir la liste des codes de paramètres régionaux.
La valeur par défaut est en.
Implémentation
public function get locale():String
public function set locale(value:String):void
maxChars | propriété |
maxChars:int
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique le nombre de caractères maximum qu’un utilisateur peut entrer dans le champ de texte. Un script peut insérer plus de texte que ne le permet maxChars
. Si maxChars
est égal à zéro, l’utilisateur peut entrer un nombre illimité de texte dans le champ de texte.
La valeur par défaut est 0.
Implémentation
public function get maxChars():int
public function set maxChars(value:int):void
multiline | propriété |
multiline:Boolean
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique si l’objet StageText peut afficher plus d’une ligne de texte. Lecture seule. Cette valeur correspond à celle de la propriété multiline
de l’objet StageTextInitOptions utilisé pendant la construction.
Implémentation
public function get multiline():Boolean
Eléments de l’API associés
restrict | propriété |
restrict:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Limite le jeu de caractères qu’un utilisateur peut entrer dans le champ de texte. Le système analyse la chaîne restrict
de gauche à droite.
La valeur de restrict
spécifie les règles de restriction d’entrée de texte suivantes :
- Si la valeur est
null
, l’utilisateur peut entrer n’importe quel caractère. - Si la valeur est une chaîne vide, l’utilisateur ne peut pas saisir aucun caractère.
- Si la valeur est une chaîne de caractères, l’utilisateur peut entrer uniquement les caractères de la chaîne.
- Si la valeur inclut un caret (^), l’utilisateur ne peut saisir aucun des caractères qui suivent le caret.
- La valeur peut spécifier une plage de caractères d’entrée autorisés à l’aide d’un tiret (-).
- La valeur peut utiliser la séquence d’échappement
\u
pour construire une chaînerestrict
.
Caractères spéciaux :
Insérez une barre oblique pour saisir un caret (^) ou un tiret (-). Les séquences acceptables sont \-, \^ et \\. La barre oblique inverse doit être un caractère existant dans la chaîne. Lorsque vous spécifiez une barre oblique inverse dans ActionScript, utilisez une double barre oblique inverse.
Exemples de paramétrage de la propriété restrict
:
L’exemple suivant permet à l’utilisateur d’entrer uniquement le tiret (-) et le caret (^) :
my_txt.restrict = "\\-\\^";
L’exemple suivant permet à l’utilisateur d’entrer uniquement les caractères en majuscules, les espaces et des nombres :
my_txt.restrict = "A-Z 0-9";
L’exemple suivant exclut uniquement des minuscules :
my_txt.restrict = "^a-z";
L’exemple suivant permet à l’utilisateur d’entrer uniquement des lettres en majuscules, mais exclut la lettre Q en majuscules :
my_txt.restrict = "A-Z^Q";
L’exemple suivant permet à l’utilisateur d’entrer uniquement les caractères de ASCII 32 (espace) au format ASCII 126 (tilde).
my_txt.restrict = "\u0020-\u007E";
Remarque : les restrictions s’appliquent uniquement à l’entrée utilisateur ; un script peut insérer n’importe quel caractère dans le champ de texte.
La valeur par défaut est null.
Implémentation
public function get restrict():String
public function set restrict(value:String):void
returnKeyLabel | propriété |
returnKeyLabel:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique l’étiquette sur la touche Retour pour les périphériques qui disposent d’un clavier logiciel. Les valeurs disponibles sont les constantes définies dans la classe ReturnKeyLabel
:
- "default"
- "done"
- "go"
- "next"
- "search"
Cette propriété est uniquement un conseil à la plate-forme sous-jacente, car tous les périphériques et systèmes d’exploitation ne prennent pas en charge ces valeurs. Cette propriété n’a aucun effet sur les périphériques qui ne disposent pas d’un clavier logiciel.
La valeur par défaut est ReturnKeyLabel.DEFAULT.
Implémentation
public function get returnKeyLabel():String
public function set returnKeyLabel(value:String):void
Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à ReturnKeyLabel
|
Eléments de l’API associés
selectionActiveIndex | propriété |
selectionActiveIndex:int
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Valeur d’index de base zéro du dernier caractère de la sélection actuelle. Par exemple, le premier caractère est 0, le deuxième est 1, etc.
Si aucun texte n’est sélectionné, cette méthode renvoie le point d’insertion. Si l’occurrence de StageText n’a pas de focus, cette méthode renvoie -1.
Sur iOS, cette propriété n'est pas prise en charge pour des objets StageText non multilignes et renvoie -1.
Implémentation
public function get selectionActiveIndex():int
Eléments de l’API associés
selectionAnchorIndex | propriété |
selectionAnchorIndex:int
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Valeur d’index basée sur zéro du premier caractère de la sélection actuelle. Par exemple, le premier caractère est 0, le deuxième est 1, etc.
Si aucun texte n’est sélectionné, cette méthode renvoie le point d’insertion. Si l’occurrence de StageText n’a pas de focus, cette méthode renvoie -1.
Sur iOS, cette propriété n'est pas prise en charge pour des objets StageText non multilignes et renvoie -1.
Implémentation
public function get selectionAnchorIndex():int
Eléments de l’API associés
softKeyboardType | propriété |
softKeyboardType:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Contrôle l’aspect du clavier logiciel.
Les périphériques disposant de claviers logiciels peuvent personnaliser les touches du clavier afin de répondre au type d’entrée prévu. Par exemple, si une entrée numérique est attendue, un périphérique peut utiliser SoftKeyboardType.NUMBER
pour afficher uniquement des chiffres sur le clavier logiciel. Les valeurs valides sont définies comme constantes dans la classe SoftKeyboardType.
- "default"
- "punctuation"
- "url"
- "nombre"
- "contact"
- "e-mail"
- "phone"
- "decimalpad"
Ces valeurs sont utilisées comme conseils pour aider un périphérique à afficher le clavier le mieux adapté à l’opération en cours.
La valeur par défaut est SoftKeyboardType.DEFAULT.
Implémentation
public function get softKeyboardType():String
public function set softKeyboardType(value:String):void
Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à SoftKeyboardType
|
Eléments de l’API associés
stage | propriété |
stage:Stage
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Scène sur laquelle cet objet StageText est affiché.
Définissez stage
sur null
pour masquer cet objet StageText.
La valeur par défaut est null.
Implémentation
public function get stage():Stage
public function set stage(value:Stage):void
text | propriété |
text:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Texte actuel dans le champ de texte. Le caractère de retour chariot (’\r’
, ASCII 13) sépare les lignes de texte. Le texte contenu dans cette propriété n’est pas mis en forme (il ne dispose d’aucune balise de formatage).
La valeur par défaut est null.
Implémentation
public function get text():String
public function set text(value:String):void
textAlign | propriété |
textAlign:String
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Indique l’alignement du paragraphe. Les valeurs valides sont définies comme constantes dans la classe TextFormatAlign.
- "left"
- "centre"
- "droit"
- "justifier"
- "start"
- "end"
Toutes les plates-formes ne prennent pas en charge toutes les valeurs textAlign
. Pour les valeurs textAlign
non prises en charge, les plates-formes utilisent la valeur par défaut (TextFormatAlign.START
).
La valeur par défaut est TextFormatAlign.START.
Implémentation
public function get textAlign():String
public function set textAlign(value:String):void
Valeur émise
ArgumentError — Si la propriété est définie sur une valeur n’appartenant pas à TextFormatAlign
|
Eléments de l’API associés
viewPort | propriété |
viewPort:Rectangle
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Zone sur la scène dans laquelle l’objet StageText est affiché. La valeur par défaut est le rectangle zéro.
Implémentation
public function get viewPort():Rectangle
public function set viewPort(value:Rectangle):void
Valeur émise
RangeError — La valeur Rectangle n’est pas valide.
|
visible | propriété |
StageText | () | Constructeur |
public function StageText(initOptions:flash.text:StageTextInitOptions = null)
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Crée un objet StageText.
L’objet StageText est invisible tant qu’il n’est pas joint à une scène et tant que la propriété viewPort
n’est pas définie.
initOptions:flash.text:StageTextInitOptions (default = null )
|
assignFocus | () | méthode |
public function assignFocus():void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Attribue le focus à l’objet StageText. assignFocus()
n’a aucun effet sur les objets non modifiables.
dispose | () | méthode |
public function dispose():void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Supprime l’objet StageText.
L’appel de la méthode dispose()
est facultatif. Si vous ne maintenez pas une référence à cette occurrence de StageText, elle est susceptible d’être nettoyée. L’appel de la méthode dispose()
peut accélérer le nettoyage ou le faire intervenir à un moment plus opportun.
drawViewPortToBitmapData | () | méthode |
public function drawViewPortToBitmapData(bitmap:BitmapData):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3.0 |
Crée la fenêtre d’affichage de l’objet StageText sur un bitmap.
Capturez l’image bitmap et définissez la scène sur null
pour afficher le contenu au-dessus de l’objet StageText.
Le bitmap a généralement la même largeur et la même hauteur que la fenêtre d’affichage. Depuis AIR 15.0, lorsque le lecteur est sur des écrans HiDPI, la largeur et la hauteur du bitmap peuvent éventuellement être égales à contentsScaleFactor
fois la largeur et la hauteur de la fenêtre d’affichage. Par exemple, sur un écran Mac Retina, contentsScaleFactor
est égal à 2, car la résolution en pixels de la scène est doublée, donc le bitmap peut également être deux fois plus grand que la fenêtre d’affichage.
Si vous appelez cette méthode avant l’événement Event.COMPLETE
, la méthode risque de ne pas tracer la fenêtre d’affichage correctement.
Paramètres
bitmap:BitmapData — Objet BitmapData sur lequel créer la partie visible de la fenêtre d’affichage de l’objet StageText.
|
Valeur émise
ArgumentError — La largeur ou la hauteur de l’image bitmap est différente de celle de la fenêtre d’affichage.
| |
Error — Le paramètre bitmap est défini sur null.
|
selectRange | () | méthode |
public function selectRange(anchorIndex:int, activeIndex:int):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Sélectionne le texte spécifié par les valeurs d’index des premier et dernier caractères. Spécifiez le premier et le dernier caractère de la sélection dans les paramètres anchorIndex
et activeIndex
. Si les valeurs de ces paramètres sont identiques, cette méthode définit le point d’insertion.
Pour les objets StageText non multilignes sur iOS, cette fonction n’est pas prise en charge et renvoie toujours -1. Si vous appelez cette méthode en sélectionnant la chaîne de texte complète, la sélection est visible. Toutefois, si vous appelez cette méthode en sélectionnant un sous-ensemble de la chaîne de texte, la sélection n’est pas visible.
Pour certains périphériques ou systèmes d’exploitation, la sélection est uniquement visible lorsque l’objet StageText a le focus.
Paramètres
anchorIndex:int — Valeur d’index de base zéro du premier caractère de la sélection (la valeur d’index du premier caractère est 0).
| |
activeIndex:int — Valeur d’index basée sur zéro du dernier caractère de la sélection.
|
Eléments de l’API associés
change | Evénement |
flash.events.Event
propriété Event.type =
flash.events.Event.CHANGE
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué après la modification du contenu du texte. Cet événement peut être distribué lors de chaque modification, ou pas avant qu’un ensemble de modifications soit terminé.
La constante Event.CHANGE
définit la valeur de la propriété type
de l’objet d’événement change
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | true |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | Objet dont la valeur a été modifiée. La propriété target ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement. |
complete | Evénement |
flash.events.Event
propriété Event.type =
flash.events.Event.COMPLETE
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué après la définition d’une scène non-nulle et d’une fenêtre d’affichage non vide. Indique que l’application a terminé la disposition de l’objet StageText et vous pouvez maintenant appeler la méthode drawViewPortToBitmapData
. Selon la plate-forme, cet événement pourrait être distribué en mode synchrone ou asynchrone avec le paramètre stage
, viewPort
ou les deux.
Event.COMPLETE
définit la valeur de la propriété type
d’un objet événement complete
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | Objet réseau dont le chargement est terminé. |
focusIn | Evénement |
flash.events.FocusEvent
propriété FocusEvent.type =
flash.events.FocusEvent.FOCUS_IN
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué lorsque l’utilisateur modifie le texte et que le contrôle a le focus clavier.
Définit la valeur de la propriététype
d’un objet événement focusIn
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | true |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
keyCode | 0 ; s’applique uniquement aux événements keyFocusChange . |
relatedObject | Occurrence complémentaire d’InteractiveObject affectée par le déplacement du focus. |
shiftKey | false ; s’applique uniquement aux événements keyFocusChange . |
target | Occurrence d’InteractiveObject qui vient de recevoir le focus. La propriété target ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement.
|
direction | La direction à partir de laquelle le focus a été attribué. Cette propriété signale la valeur du paramètre direction de la méthode assignFocus() de la scène. Si le focus a changé par d’autres moyens, la valeur est toujours FocusDirection.NONE . S’applique uniquement aux événements focusIn . Pour tous les autres événements focus, la valeur est FocusDirection.NONE . |
focusOut | Evénement |
flash.events.FocusEvent
propriété FocusEvent.type =
flash.events.FocusEvent.FOCUS_OUT
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué lorsque l’utilisateur ne modifie plus le texte et que le contrôle n’a plus le focus clavier.
Définit la valeur de la propriététype
d’un objet événement focusOut
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | true |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
keyCode | 0 ; s’applique uniquement aux événements keyFocusChange . |
relatedObject | Occurrence complémentaire d’InteractiveObject affectée par le déplacement du focus. |
shiftKey | false ; s’applique uniquement aux événements keyFocusChange . |
target | Occurrence d’InteractiveObject qui vient de perdre le focus. La propriété target ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement.
|
keyDown | Evénement |
flash.events.KeyboardEvent
propriété KeyboardEvent.type =
flash.events.KeyboardEvent.KEY_DOWN
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué lorsque l’utilisateur appuie sur une touche.
La concordance entre les touches et des caractères spécifiques dépend du périphérique et du système d’exploitation. Ce type d’événement est généré lors du mappage, mais avant le traitement d’un éditeur de méthode d’entrée (IME). Les IME sont utiles pour la saisie de caractères que le clavier AZERTY standard ne permet pas de produire (par exemple, des idéogrammes chinois).
Cet événement se produit avant l’événement keyUp
.
Cet événement n’est pas distribué pour toutes les touches. Les touches qui entraînent la distribution de cet événement varient en fonction de la plate-forme.
Dans AIR, l’annulation de cet événement empêche le caractère d’être inséré dans un champ de texte.
La constanteKeyboardEvent.KEY_DOWN
définit la valeur de la propriété type
d’un objet événement keyDown
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | true |
cancelable | true dans AIR, false dans Flash Player ; dans AIR, l’annulation de cet événement empêche l’insertion du caractère dans un champ de texte. |
charCode | Valeur du code de caractère associé à la touche enfoncée ou relâchée. |
commandKey | true sous Mac si la touche Commande est activée. Autrement, false |
controlKey | true sous Windows et Linux si la touche Ctrl est activée. true sous Mac si la touche Contrôle est activée. Autrement, false |
ctrlKey | true sous Windows et Linux si la touche Ctrl est activée. true sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur false est renvoyée. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
keyCode | Valeur de code correspondant à la touche enfoncée ou relâchée. |
keyLocation | Emplacement de la touche sur le clavier. |
shiftKey | true si la touche Maj est activée ; false si elle ne l’est pas. |
target | Occurrence d’InteractiveObject possédant le focus. La propriété target ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement. |
keyUp | Evénement |
flash.events.KeyboardEvent
propriété KeyboardEvent.type =
flash.events.KeyboardEvent.KEY_UP
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué lorsque l’utilisateur relâche une touche.
La concordance entre les touches et des caractères spécifiques dépend du périphérique et du système d’exploitation. Ce type d’événement est généré lors du mappage, mais avant le traitement d’un éditeur de méthode d’entrée (IME). Les IME permettent d’entrer des caractères que le clavier AZERTY standard ne permet pas de produire (par exemple, des idéogrammes chinois).
Cet événement se produit après un événement keyDown
.
Cet événement n’est pas distribué pour toutes les touches. Les touches qui entraînent la distribution de cet événement varient en fonction de la plate-forme.
La constanteKeyboardEvent.KEY_UP
définit la valeur de la propriété type
d’un objet d’événement keyUp
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | true |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
charCode | Contient la valeur du code de caractère associé à la touche enfoncée ou relâchée. |
commandKey | true sous Mac si la touche Commande est activée. Autrement, false |
controlKey | true sous Windows et Linux si la touche Ctrl est activée. true sous Mac si la touche Contrôle est activée. Autrement, false |
ctrlKey | true sur Windows si la touche Ctrl est enfoncée. true sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur false est renvoyée. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
keyCode | Valeur de code correspondant à la touche enfoncée ou relâchée. |
keyLocation | Emplacement de la touche sur le clavier. |
shiftKey | true si la touche Maj est activée ; false si elle ne l’est pas. |
target | Occurrence d’InteractiveObject possédant le focus. La propriété target ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement. |
softKeyboardActivate | Evénement |
flash.events.SoftKeyboardEvent
propriété SoftKeyboardEvent.type =
flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué après l’activation du clavier logiciel, suite à l’obtention du focus de l’objet StageText.
La constanteSoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE
définit la valeur de la propriété type
de l’objet SoftKeyboardEvent lors de l’affichage d’un clavier logiciel. Pour cet événement, cancellable = false
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
type | SOFT_KEYBOARD_ACTIVATE |
bubbles | true |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
relatedObjectVal | Référence à un objet de la liste d’affichage qui est associé à l’événement. |
triggerTypeVal | Indique si l’événement de clavier a été déclenché par une application ou un utilisateur. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
softKeyboardActivating | Evénement |
flash.events.SoftKeyboardEvent
propriété SoftKeyboardEvent.type =
flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué avant l’activation du clavier logiciel, suite à l’obtention du focus de l’objet StageText.
La constanteSoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING
définit la valeur de la propriété type
de l’objet SoftKeyboardEvent immédiatement avant l’affichage d’un clavier logiciel. Pour cet événement, cancellable = true
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
type | SOFT_KEYBOARD_ACTIVATING |
bubbles | true |
cancelable | true , à moins que l’événement soit distribué par un objet StageText. Pour les objets StageText, l’événement n’est pas annulable. |
relatedObjectVal | Référence à un objet de la liste d’affichage qui est associé à l’événement. |
triggerTypeVal | Indique si l’événement de clavier a été déclenché par une application ou un utilisateur. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
softKeyboardDeactivate | Evénement |
flash.events.SoftKeyboardEvent
propriété SoftKeyboardEvent.type =
flash.events.SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 3 |
Distribué après la désactivation du clavier logiciel, suite à la perte de focus de l’objet StageText.
La constanteSoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE
définit la valeur de la propriété type
de l’objet SoftKeyboardEvent lors de la disparition ou du masquage d’un clavier logiciel. Pour cet événement, cancellable = false
.
Les propriétés de cet événement sont les suivantes :
Propriété | Valeur |
---|---|
type | SOFT_KEYBOARD_DEACTIVATE |
bubbles | true |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
relatedObjectVal | Référence à un objet de la liste d’affichage qui est associé à l’événement. |
triggerTypeVal | Indique si l’événement de clavier a été déclenché par une application ou un utilisateur. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
Tue Jun 12 2018, 09:30 AM Z