Packageflash.events
Classepublic class KeyboardEvent
HéritageKeyboardEvent Inheritance Event Inheritance Object

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

Flash® Player distribue des objets KeyboardEvent en réponse à une saisie de l'utilisateur au clavier. Il existe deux types d’événements clavier : 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).

Consulter les exemples

Voir aussi

KEY_DOWN
KEY_UP
KeyLocation


Propriétés publiques
 PropriétéDéfini par
  altKey : Boolean
Indique si la touche Alt est active (true) ou non (false).
KeyboardEvent
 Inheritedbubbles : Boolean
[lecture-seule] Indique si un événement peut se propager vers le haut (bubbling).
Event
 Inheritedcancelable : Boolean
[lecture-seule] Indique si le comportement associé à l’événement peut être annulé.
Event
  charCode : uint
Contient la valeur du code de caractère associé à la touche enfoncée ou relâchée.
KeyboardEvent
 Inheritedconstructor : Object
Référence à l'objet de classe ou à la fonction constructeur d'une occurrence donnée d'un objet.
Object
  ctrlKey : Boolean
Indique si la touche Ctrl est activée (true) ou non (false).
KeyboardEvent
 InheritedcurrentTarget : Object
[lecture-seule] L’objet qui traite activement l’objet Event avec un écouteur d’événements.
Event
 InheritedeventPhase : 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
 Inheritedprototype : Object
[static] Référence à l’objet prototype d’un objet de classe ou fonction.
Object
  shiftKey : Boolean
Indique si la touche Maj de modification est activée (true) ou non (false).
KeyboardEvent
 Inheritedtarget : Object
[lecture-seule] Cible de l’événement.
Event
 Inheritedtype : String
[lecture-seule] Type d’événement.
Event
Méthodes publiques
 MéthodeDéfini par
  
KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCode:uint = 0, keyCode:uint = 0, keyLocation:uint = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)
Crée un objet Event contenant des informations spécifiques sur les événements clavier.
KeyboardEvent
  
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
 Inherited
formatToString(className:String, ... arguments):String
Fonction d’un utilitaire permettant d'implémenter la méthode toString() dans votre classe Event personnalisée.
Event
 Inherited
Indique si la propriété spécifiée d'un objet est définie.
Object
 Inherited
Vérifie si preventDefault() a été appelée pour l’événement.
Event
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l'objet spécifié en tant que paramètre.
Object
 Inherited
Annule le comportement par défaut d’un événement si cette opération est possible.
Event
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d'une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Bloque le traitement des écouteurs d’événement dans le nœud actuel et les suivants dans le flux d'événements.
Event
 Inherited
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 une chaîne répertoriant toutes les propriétés de l'objet KeyboardEvent.
KeyboardEvent
  
Demande à Flash Player d’effectuer un rendu après le traitement de cet événement, si la liste d’affichage a été modifiée.
KeyboardEvent
 Inherited
Renvoie la valeur primitive de l'objet spécifié.
Object
Constantes publiques
 ConstanteDéfini par
 InheritedACTIVATE : String = "activate"
[static] Définit la valeur de la propriété type d'un objet événement activate.
Event
 InheritedADDED : String = "added"
[static] Définit la valeur de la propriété type d'un objet événement added.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Définit la valeur de la propriété type d'un objet événement addedToStage.
Event
 InheritedCANCEL : String = "cancel"
[static] Définit la valeur de la propriété type d'un objet événement cancel.
Event
 InheritedCHANGE : String = "change"
[static] Définit la valeur de la propriété type d'un objet événement change.
Event
 InheritedCLOSE : String = "close"
[static] Définit la valeur de la propriété type d'un objet événement close.
Event
 InheritedCOMPLETE : String = "complete"
[static] Définit la valeur de la propriété type d'un objet événement complete.
Event
 InheritedCONNECT : String = "connect"
[static] Définit la valeur de la propriété type d'un objet événement connect.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Définit la valeur de la propriété type d'un objet événement deactivate.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Définit la valeur de la propriété type d'un objet événement enterFrame.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Définit la valeur de la propriété type d'un objet événement fullScreen.
Event
 InheritedID3 : String = "id3"
[static] Définit la valeur de la propriété type d'un objet événement id3.
Event
 InheritedINIT : String = "init"
[static] Définit la valeur de la propriété type d'un objet événement init.
Event
  KEY_DOWN : String = "keyDown"
[static] Définit la valeur de la propriété type d'un objet événement keyDown.
KeyboardEvent
  KEY_UP : String = "keyUp"
[static] Définit la valeur de la propriété type d'un objet événement keyUp.
KeyboardEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Définit la valeur de la propriété type d'un objet événement mouseLeave.
Event
 InheritedOPEN : String = "open"
[static] Définit la valeur de la propriété type d'un objet événement open.
Event
 InheritedREMOVED : String = "removed"
[static] Définit la valeur de la propriété type d'un objet événement removed.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Définit la valeur de la propriété type d'un objet événement removedFromStage.
Event
 InheritedRENDER : String = "render"
[static] Définit la valeur de la propriété type d'un objet événement render.
Event
 InheritedRESIZE : String = "resize"
[static] Définit la valeur de la propriété type d'un objet événement resize.
Event
 InheritedSCROLL : String = "scroll"
[static] Définit la valeur de la propriété type d'un objet événement scroll.
Event
 InheritedSELECT : String = "select"
[static] Définit la valeur de la propriété type d'un objet événement select.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Définit la valeur de la propriété type d'un objet événement soundComplete.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Définit la valeur de la propriété type d'un objet événement tabChildrenChange.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Définit la valeur de la propriété type d'un objet événement tabEnabledChange.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Définit la valeur de la propriété type d'un objet événement tabIndexChange.
Event
 InheritedUNLOAD : String = "unload"
[static] Définit la valeur de la propriété type d'un objet événement unload.
Event
Détails des propriétés
altKeypropriété
altKey:Boolean  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

Indique si la touche Alt est active (true) ou non (false). Pris en charge uniquement pour les systèmes d'exploitation Windows.


Implémentation
    public function get altKey():Boolean
    public function set altKey(value:Boolean):void
charCodepropriété 
charCode:uint  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

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. Si vous appuyez sur Maj + 3, par exemple, la méthode charCode renvoie # sur un clavier japonais, comme 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

Voir aussi

ctrlKeypropriété 
ctrlKey:Boolean  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

Indique si la touche Ctrl est activée (true) ou non (false).

Remarque : sur les systèmes Macintosh, la touche de modification Commande doit être représentée par le biais de cette touche de modification.


Implémentation
    public function get ctrlKey():Boolean
    public function set ctrlKey(value:Boolean):void
keyCodepropriété 
keyCode:uint  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

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

Voir aussi

keyLocationpropriété 
keyLocation:uint  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

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
shiftKeypropriété 
shiftKey:Boolean  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

Indique si la touche de modification Maj est activée (true) ou non (false).


Implémentation
    public function get shiftKey():Boolean
    public function set shiftKey(value:Boolean):void
Détails du constructeur
KeyboardEvent()Constructeur
public function KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCode:uint = 0, keyCode:uint = 0, keyLocation:uint = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

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ètres
type: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 (bubbling) du flux d’événements.
 
cancelable:Boolean (default = false) — Détermine si l’objet Event peut être annulé.
 
charCode: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. Si vous appuyez sur Maj + 3, par exemple, la méthode getASCIICode() renvoie # sur un clavier japonais, ce qui correspond à ce qu'elle renvoie sur un clavier anglais.
 
keyCode:uint (default = 0) — Valeur de code correspondant à la touche enfoncée ou relâchée.
 
keyLocation:uint (default = 0) — Emplacement de la touche sur le clavier.
 
ctrlKey:Boolean (default = false) — Indique si la touche de modification Ctrl est activée.
 
altKey:Boolean (default = false) — Indique si la touche de modification Alt est activée (Windows uniquement).
 
shiftKey:Boolean (default = false) — Indique si la touche de modification Maj est activée.

Voir aussi

Détails des méthodes
clone()méthode
public override function clone():Event

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

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ée
Event — Nouvel objet KeyboardEvent dont les propriétés ont la même valeur que celles de l’objet d'origine.
toString()méthode 
public override function toString():String

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

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]

Valeur renvoyée
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
Version du lecteur : Flash Player 9

Demande à Flash Player d’effectuer un rendu après le traitement de cet événement, si la liste d’affichage a été modifiée.

Détails de la constante
KEY_DOWNConstante
public static const KEY_DOWN:String = "keyDown"

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

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
bubblestrue
cancelablefalse ; il n’existe aucun comportement par défaut à annuler.
charCodeValeur du code de caractère associé à la touche enfoncée ou relâchée.
ctrlKeytrue si la touche Ctrl est activée ; false si elle ne l'est pas.
currentTargetL’objet qui traite activement l’objet Event avec un écouteur d’événements.
keyCodeValeur de code correspondant à la touche enfoncée ou relâchée.
keyLocationEmplacement de la touche sur le clavier.
shiftKeytrue si la touche Maj est activée ; false si elle ne l'est pas.
targetOccurrence 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énements. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d'affichage qui traite actuellement l'événement.

Voir aussi

KEY_UPConstante 
public static const KEY_UP:String = "keyUp"

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

Définit la valeur de la propriété type d'un objet événement keyUp.

Les propriétés de cet événement sont les suivantes :

PropriétéValeur
bubblestrue
cancelablefalse ; il n’existe aucun comportement par défaut à annuler.
charCodeContient la valeur du code de caractère associé à la touche enfoncée ou relâchée.
ctrlKeytrue si la touche Ctrl est activée ; false si elle ne l'est pas.
currentTargetL’objet qui traite activement l’objet Event avec un écouteur d’événements.
keyCodeValeur de code correspondant à la touche enfoncée ou relâchée.
keyLocationEmplacement de la touche sur le clavier.
shiftKeytrue si la touche Maj est activée ; false si elle ne l'est pas.
targetOccurrence 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énements. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d'affichage qui traite actuellement l'événement.

Voir aussi

Exemples Utilisation des exemples
KeyboardEventExample.as

L'exemple suivant utilise la classe KeyboardEventExample pour montrer les événements clavier et leurs fonctions d'écouteur. L'exemple exécute les tâches suivantes :
  1. Il déclare les propriétés à utiliser pour paramétrer la taille et la couleur d'arrière-plan d'un carré.
  2. Il créé une nouvelle occurrence de Sprite nommée child.
  3. 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().
  4. Il ajoute deux écouteurs d'événements de type clavier :
    • 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'instruction trace().
    • keyUp / keyUpHandler distribué chaque fois que l'utilisateur relâche une touche.

Dans certains cas, il peut être nécessaire de cliquer sur la scène pour que les événements clavier fonctionnent.

package {
    import flash.display.Sprite;
    import flash.display.DisplayObject;
    import flash.events.*;

    public class KeyboardEventExample extends Sprite {
        private var bgColor:uint = 0x00CCFF;
        private var size:uint = 80;

        public function KeyboardEventExample() {
            var child:Sprite = new Sprite();
            child.graphics.beginFill(bgColor);
            child.graphics.drawRect(0, 0, size, size);
            child.graphics.endFill();
            addChild(child);
            stage.focus = child;
            child.addEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler);
            child.addEventListener(KeyboardEvent.KEY_UP, keyUpHandler);
        }

        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);
        }
    }
}




 

M'envoyer un message électronique lorsque des commentaires sont ajoutés à cette page | Rapport de commentaire

Page en cours: http://livedocs.adobe.com/flash/9.0_fr/ActionScriptLangRefV3/flash/events/KeyboardEvent.html