Package | flash.events |
Classe | public class KeyboardEvent |
Héritage | KeyboardEvent Event Object |
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
KeyboardEvent.KEY_DOWN
et KeyboardEvent.KEY_UP
Les correspondances entre les touches et des caractères spécifiques sont fonction du périphérique et du système d’exploitation de l’utilisateur. Choisissez donc le type d’événement TextEvent pour traiter les saisies de caractères.
Pour écouter globalement les événements de touche, écoutez, sur la scène, la phase de capture et la phase cible ou la phase de propagation vers le haut (bubbling).
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
altKey : Boolean
Indique si la touche Alt est activée (true) ou non (false) sur Windows ; indique si la touche Option est activée sur Mac OS. | KeyboardEvent | ||
bubbles : Boolean [lecture seule]
Indique si un événement peut se propager vers le haut (bubbling). | Event | ||
cancelable : Boolean [lecture seule]
Indique si le comportement associé à l’événement peut être évité. | Event | ||
charCode : uint
Contient la valeur du code de caractère associé à la touche enfoncée ou relâchée. | KeyboardEvent | ||
commandKey : Boolean
Indique si la touche Command est activée (true) ou non (false). | KeyboardEvent | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
controlKey : Boolean
Indique si la touche Ctrl est activée (true) ou non (false). | KeyboardEvent | ||
ctrlKey : Boolean
Sous Windows et Linux, indique si la touche Ctrl est activée (true) ou non (false) ; sous Mac OS, indique si la touche Ctrl ou Commande est activée. | KeyboardEvent | ||
currentTarget : Object [lecture seule]
L’objet qui traite activement l’objet Event avec un écouteur d’événements. | Event | ||
eventPhase : uint [lecture seule]
Phase actuelle du flux d’événements. | Event | ||
keyCode : uint
Valeur de code correspondant à la touche enfoncée ou relâchée. | KeyboardEvent | ||
keyLocation : uint
Emplacement de la touche sur le clavier. | KeyboardEvent | ||
shiftKey : Boolean
Indique si la touche Maj de modification est activée (true) ou non (false). | KeyboardEvent | ||
target : Object [lecture seule]
Cible de l’événement. | Event | ||
type : String [lecture seule]
Type d’événement. | Event |
Méthode | Défini par | ||
---|---|---|---|
KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCodeValue:uint = 0, keyCodeValue:uint = 0, keyLocationValue:uint = 0, ctrlKeyValue:Boolean = false, altKeyValue:Boolean = false, shiftKeyValue:Boolean = false, controlKeyValue:Boolean = false, commandKeyValue:Boolean = false)
Crée un objet Event contenant des informations spécifiques sur les événements clavier. | KeyboardEvent | ||
[override]
Crée une copie de l’objet KeyboardEvent et définit la valeur de chaque propriété de sorte qu’elle corresponde à la valeur d’origine. | KeyboardEvent | ||
Fonction d’un utilitaire permettant d’implémenter la méthode toString() dans des classes Event ActionScript 3.0 personnalisées. | Event | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Vérifie si la méthode preventDefault() a été appelée pour l’événement. | Event | ||
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 | ||
Annule le comportement par défaut d’un événement si cette opération est possible. | Event | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Bloque le traitement des écouteurs d’événement dans le nœud actuel et les suivants dans le flux d’événements. | Event | ||
Bloque le traitement des écouteurs d’événement dans les nœuds qui suivent le nœud actuel dans le flux d’événements. | Event | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
[override]
Renvoie une chaîne répertoriant toutes les propriétés de l’objet KeyboardEvent. | KeyboardEvent | ||
Indique que l’affichage doit être rendu à la fin du traitement de cet événement, si la liste d’affichage a été modifiée
| KeyboardEvent | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
Constante | Défini par | ||
---|---|---|---|
KEY_DOWN : String = "keyDown" [statique]
La constante ScreenMouseEvent.MOUSE_DOWN définit la valeur de la propriété type d’un objet événement keyDown. | KeyboardEvent | ||
KEY_UP : String = "keyUp" [statique]
La constante KeyboardEvent.KEY_UP définit la valeur de la propriété type d’un objet d’événement keyUp. | KeyboardEvent |
altKey | propriété |
altKey:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Indique si la touche Alt est activée (true
) ou non (false
) sur Windows ; indique si la touche Option est activée sur Mac OS.
Implémentation
public function get altKey():Boolean
public function set altKey(value:Boolean):void
charCode | propriété |
charCode:uint
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Contient la valeur du code de caractère associé à la touche enfoncée ou relâchée. Les valeurs renvoyées sont celles du clavier anglais. Par exemple, si vous appuyez sur Maj+3, le caractère charCode
correspondant est # sur un clavier japonais, si vous appuyez sur Maj+2, le caractère charCode
est @ sur un clavier allemand (et non pas "), comme c’est le cas sur un clavier anglais.
Remarque : Lorsqu’un éditeur IME (Input Method Editor) est en cours d’exécution, les codes de caractères renvoyés par charCode
sont incorrects.
Implémentation
public function get charCode():uint
public function set charCode(value:uint):void
commandKey | propriété |
commandKey:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Lite 4 |
Indique si la touche Command est activée (true
) ou non (false
). Pris en charge pour Mac OS uniquement. Sur Mac OS, la propriété commandKey
a la même valeur que la propriété ctrlKey
.
Implémentation
public function get commandKey():Boolean
public function set commandKey(value:Boolean):void
controlKey | propriété |
controlKey:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Lite 4 |
Indique si la touche Ctrl est activée (true
) ou non (false
). Sous Windows et Linux, cette propriété est également true lorsque la touche Ctrl est activée.
Implémentation
public function get controlKey():Boolean
public function set controlKey(value:Boolean):void
ctrlKey | propriété |
ctrlKey:Boolean
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Sous Windows et Linux, indique si la touche Ctrl est activée (true
) ou non (false
) ; sous Mac OS, indique si la touche Ctrl ou Commande est activée.
Implémentation
public function get ctrlKey():Boolean
public function set ctrlKey(value:Boolean):void
keyCode | propriété |
keyCode:uint
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Valeur de code correspondant à la touche enfoncée ou relâchée.
Remarque : lorsqu’un éditeur IME (Input Method Editor) est en cours d’exécution, les codes de caractères renvoyés par keyCode
sont incorrects.
Implémentation
public function get keyCode():uint
public function set keyCode(value:uint):void
Eléments de l’API associés
keyLocation | propriété |
keyLocation:uint
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Emplacement de la touche sur le clavier. Cette propriété vous permet de différencier des touches qui figurent plusieurs fois sur un clavier. Sa valeur vous permet par exemple de faire la différence entre les touches Maj de gauche et de droite : KeyLocation.LEFT
représente la touche de gauche et KeyLocation.RIGHT
celle de droite. Vous pouvez aussi, par exemple distinguer les touches numériques du clavier standard (KeyLocation.STANDARD
) de celles du pavé numérique (KeyLocation.NUM_PAD
).
Implémentation
public function get keyLocation():uint
public function set keyLocation(value:uint):void
shiftKey | propriété |
KeyboardEvent | () | Constructeur |
public function KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCodeValue:uint = 0, keyCodeValue:uint = 0, keyLocationValue:uint = 0, ctrlKeyValue:Boolean = false, altKeyValue:Boolean = false, shiftKeyValue:Boolean = false, controlKeyValue:Boolean = false, commandKeyValue:Boolean = false)
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Crée un objet Event contenant des informations spécifiques sur les événements clavier. Les objets Event sont transmis en tant que paramètres aux écouteurs d’événements.
Paramètrestype:String — Type de l’événement. Les valeurs possibles sont les suivantes : KeyboardEvent.KEY_DOWN et KeyboardEvent.KEY_UP
| |
bubbles:Boolean (default = true ) — Détermine si l’objet Event prend part à la phase de propagation vers le haut du flux d’événements.
| |
cancelable:Boolean (default = false ) — Détermine si l’objet d’événement peut être annulé.
| |
charCodeValue:uint (default = 0 ) — Valeur du code de caractère associé à la touche enfoncée ou relâchée. Les valeurs renvoyées sont des valeurs du clavier anglais. Par exemple, si vous appuyez sur Maj+3, la propriété Keyboard.charCode() renvoie # sur un clavier japonais ou allemand, de la même manière que sur un clavier anglais.
| |
keyCodeValue:uint (default = 0 ) — Valeur de code correspondant à la touche enfoncée ou relâchée.
| |
keyLocationValue:uint (default = 0 ) — Emplacement de la touche sur le clavier.
| |
ctrlKeyValue:Boolean (default = false ) — Sur Windows, indique si la touche Ctrl est activée. Sous Mac, indique si la touche Ctrl ou la touche Commande est activée.
| |
altKeyValue:Boolean (default = false ) — Indique si la touche de modification Alt est activée (Windows uniquement).
| |
shiftKeyValue:Boolean (default = false ) — Indique si la touche de modification Maj est activée.
| |
controlKeyValue:Boolean (default = false ) — Indique si la touche Contrôle et activée sous Mac, et si la touche Ctrl ou Contrôle est activée sous Windows et Linux.
| |
commandKeyValue:Boolean (default = false ) — Indique si la touche Commande est activée (Mac uniquement).
|
Eléments de l’API associés
clone | () | méthode |
override public function clone():Event
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Crée une copie de l’objet KeyboardEvent et définit la valeur de chaque propriété de sorte qu’elle corresponde à la valeur d’origine.
Valeur renvoyéeEvent — Nouvel objet KeyboardEvent dont les propriétés ont la même valeur que celles de l’objet d’origine.
|
toString | () | méthode |
override public function toString():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 répertoriant toutes les propriétés de l’objet KeyboardEvent. La chaîne est écrite au format suivant :
[KeyboardEvent type=valeur bubbles=valeur cancelable=valeur ... shiftKey=valeur]
String — Chaîne répertoriant toutes les propriétés de l’objet KeyboardEvent.
|
updateAfterEvent | () | méthode |
public function updateAfterEvent():void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9 |
Indique que l’affichage doit être rendu à la fin du traitement de cet événement, si la liste d’affichage a été modifiée
KEY_DOWN | Constante |
public static const KEY_DOWN:String = "keyDown"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
La constante KeyboardEvent.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. |
Eléments de l’API associés
KEY_UP | Constante |
public static const KEY_UP:String = "keyUp"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
La constante KeyboardEvent.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. |
Eléments de l’API associés
KeyboardEventExample
pour montrer les événements clavier et leurs fonctions d’écouteur. L’exemple exécute les tâches suivantes :
- Il créé une nouvelle occurrence de Sprite nommée
child
. - Il déclare les propriétés à utiliser pour paramétrer la taille et la couleur d’arrière-plan d’un carré.
- A l’aide des méthodes de Sprite, il trace un carré bleu clair qui apparaît sur la scène aux coordonnées par défaut (0,0) en appelant à méthode
addChild()
. - Il ajoute un événement mouse et deux écouteurs d’événements de type keyboard :
click
/clickHandler
qui est distribué lorsque vous cliquez sur le carré pour définir le focus sur le spritechild
de façon à ce qu’il puisse écouter des événements keyboard.keyDown
/keyDownHandler
distribué à chaque appui de l’utilisateur sur une touche. La méthode d’abonné imprime des informations sur l’événement à l’aide de l’instructiontrace()
.keyUp
/keyUpHandler
distribué chaque fois que l’utilisateur relâche une touche.
Lorsque vous testez cet exemple, vous devez cliquer sur le carré d’abord pour que les événements keyboard fonctionnent.
De plus, si vous utilisez la commande Test Movie dans Flash, l’interface de programmation peut répondre à certaines touches au lieu des écouteurs d’événements associés au sprite enfant.
package { import flash.display.Sprite; import flash.display.DisplayObject; import flash.events.*; public class KeyboardEventExample extends Sprite { private var child:Sprite = new Sprite(); private var bgColor:uint = 0x00CCFF; private var size:uint = 80; public function KeyboardEventExample() { child.graphics.beginFill(bgColor); child.graphics.drawRect(0, 0, size, size); child.graphics.endFill(); addChild(child); child.addEventListener(MouseEvent.CLICK, clickHandler); child.addEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler); child.addEventListener(KeyboardEvent.KEY_UP, keyUpHandler); } private function clickHandler(event:MouseEvent):void { stage.focus = child; } private function keyDownHandler(event:KeyboardEvent):void { trace("keyDownHandler: " + event.keyCode); trace("ctrlKey: " + event.ctrlKey); trace("keyLocation: " + event.keyLocation); trace("shiftKey: " + event.shiftKey); trace("altKey: " + event.altKey); } private function keyUpHandler(event:KeyboardEvent):void { trace("keyUpHandler: " + event.keyCode); } } }
Tue Jun 12 2018, 09:30 AM Z