Referenshandbok för ActionScript® 3.0 i Adobe® Flash®-plattformen
Hem  |  Dölj paket och klasslista |  Paket  |  Klasser  |  Nyheter  |  Index  |  Bilagor  |  Varför på engelska?
Filter: Hämtar data från servern ...
Hämtar data från servern ...
flash.events 

KeyboardEvent  - AS3

Paketflash.events
Klasspublic class KeyboardEvent
ArvKeyboardEvent Inheritance Event Inheritance Object

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Ett KeyboardEvent-objekt-id skickas som svar på användarens indata via tangentbordet. Det finns två typer av tangentbordshändelser: KeyboardEvent.KEY_DOWN och KeyboardEvent.KEY_UP

Avbildningar mellan tangenter och vissa tecken skiftar mellan enheter och operativsystem. Använd därför TextEvent-händelsetypen när du bearbetar teckeninmatning.

Om du vill avlyssna tangenthändelser globalt kan du lyssna på scenen efter hämtnings-, mål- eller bubblingsfas.

Visa exemplen

Fler exempel

Relaterade API-element



Publika egenskaper
 EgenskapDefinieras med
  altKey : Boolean
Anger om Alt-tangenten är aktiv (true) eller inaktiv (false) i Windows, och om Alternativ-tangenten är aktiv eller inaktiv i Mac OS.
KeyboardEvent
 Inheritedbubbles : Boolean
[skrivskyddad] indikerar om händelsen är en bubblande händelse.
Event
 Inheritedcancelable : Boolean
[skrivskyddad] Indikerar om beteendet som är kopplat till händelsen kan förhindras.
Event
  charCode : uint
Innehåller värdet för teckenkoden för den senaste tangenten som trycktes ned eller släpptes upp.
KeyboardEvent
  commandKey : Boolean
Anger om Kommando-tangenten är aktiv (true) eller inaktiv (false).
KeyboardEvent
 Inheritedconstructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.
Object
  controlKey : Boolean
Anger om Ctrl-tangenten är aktiv (true) eller inaktiv (false).
KeyboardEvent
  ctrlKey : Boolean
Anger om Ctrl-tangenten är aktiv (true) eller inaktiv (false) i Windows och Linux, och om Ctrl-tangenten är aktiv eller inaktiv i Mac OS.
KeyboardEvent
 InheritedcurrentTarget : Object
[skrivskyddad] Det objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
Event
 InheritedeventPhase : uint
[skrivskyddad] Den nuvarande fasen i händelseflödet.
Event
  keyCode : uint
Innehåller värdet för tangentkoden för den senaste tangenten som trycktes ned eller släpptes upp.
KeyboardEvent
  keyLocation : uint
Indikerar var tangenten finns på tangentbordet.
KeyboardEvent
  shiftKey : Boolean
Anger om skifttangentsmodifieringen är aktiv (true) eller inaktiv (false).
KeyboardEvent
 Inheritedtarget : Object
[skrivskyddad] Händelsens mål.
Event
 Inheritedtype : String
[skrivskyddad] Händelsens typ.
Event
Publika metoder
 MetodDefinieras med
  
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)
Skapar ett nytt Event-objekt som innehåller specifik information om tangentbordshändelser.
KeyboardEvent
  
[åsidosätt] Skapar en kopia av KeyboardEvent-objektet och ställer in värdet för alla egenskaper så att de matchar originalets egenskaper.
KeyboardEvent
 Inherited
formatToString(className:String, ... arguments):String
Ett verktyg som används för att implementera metoden toString() i de anpassade klasserna ActionScript 3.0.
Event
 Inherited
Anger om det finns en egenskap angiven för ett objekt.
Object
 Inherited
Kontrollerar om preventDefault()-metoden har anropats för händelsen.
Event
 Inherited
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.
Object
 Inherited
Avbryter en händelses standardbeteende om det beteendet kan avbrytas.
Event
 Inherited
Anger om den angivna egenskapen finns och är uppräkningsbar.
Object
 Inherited
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.
Object
 Inherited
Förhindrar behandling av händelsehanterare i den aktuella noden och alla noder som följer den aktuella noden i händelseflödet.
Event
 Inherited
Förhindrar behandling av händelsehanterare i noder som följer den aktuella noden i händelseflödet.
Event
 Inherited
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.
Object
  
[åsidosätt] Returnerar en sträng som innehåller alla egenskaper i KeyboardEvent-objektet.
KeyboardEvent
  
Anger att displayen ska återges efter att den här händelseprocessen har slutförts och om display-listan har ändrats.
KeyboardEvent
 Inherited
Returnerar det angivna objektets primitiva värde.
Object
Publika konstanter
 KonstantDefinieras med
  KEY_DOWN : String = "keyDown"
[statisk] KeyboardEvent.KEY_DOWN-konstanten definierar värdet på type-egenskapen i ett keyDown-händelseobjekt.
KeyboardEvent
  KEY_UP : String = "keyUp"
[statisk] KeyboardEvent.KEY_UP-konstanten definierar värdet på type-egenskapen i ett keyUp-händelseobjekt.
KeyboardEvent
Egenskapsdetaljer

altKey

egenskap
altKey:Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Anger om Alt-tangenten är aktiv (true) eller inaktiv (false) i Windows, och om Alternativ-tangenten är aktiv eller inaktiv i Mac OS.



Implementering
    public function get altKey():Boolean
    public function set altKey(value:Boolean):void

charCode

egenskap 
charCode:uint

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Innehåller värdet för teckenkoden för den senaste tangenten som trycktes ned eller släpptes upp. Teckenvärdena är engelska tangentbordsvärden. Om du till exempel trycker på Skift+3 är charCode # på ett japanskt tangentbord och om du trycker på Skift+2 är charCode @ på ett tyskt tangentbord (och inte "), precis som på ett engelskt tangentbord.

Obs! När ett redigeringsprogram för inmatningsmetod (IME) körs rapporterar inte charCode korrekta teckenkoder.



Implementering
    public function get charCode():uint
    public function set charCode(value:uint):void

commandKey

egenskap 
commandKey:Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Lite 4

Anger om Alt-tangenten är aktiv (true) eller inaktiv (false). Stöder enbart Mac OS. I Mac OS har commandKey-egenskapen samma värde som ctrlKey-egenskapen.



Implementering
    public function get commandKey():Boolean
    public function set commandKey(value:Boolean):void

controlKey

egenskap 
controlKey:Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Lite 4

Anger om Control-tangenten är aktiv (true) eller inaktiv (false). I Windows och Linux är detta också true när Ctrl-tangenten är aktiv.



Implementering
    public function get controlKey():Boolean
    public function set controlKey(value:Boolean):void

ctrlKey

egenskap 
ctrlKey:Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Anger om Ctrl-tangenten är aktiv (true) eller inaktiv (false) i Windows och Linux, och om Ctrl- eller Kommando-tangenten är aktiv eller inaktiv i Mac OS.



Implementering
    public function get ctrlKey():Boolean
    public function set ctrlKey(value:Boolean):void

keyCode

egenskap 
keyCode:uint

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Innehåller värdet för tangentkoden för den senaste tangenten som trycktes ned eller släpptes upp.

Obs: När ett redigeringsprogram för inmatningsmetod (IME) körs rapporterar inte keyCode korrekta tangentkoder.



Implementering
    public function get keyCode():uint
    public function set keyCode(value:uint):void

Relaterade API-element

keyLocation

egenskap 
keyLocation:uint

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Indikerar var tangenten finns på tangentbordet. Det här är användbart när man vill skilja mellan tangenter som förekommer mer än en gång på tangentbordet. Det går exempelvis att skilja mellan vänster och höger skifttangent med värdet för den här egenskapen: KeyLocation.LEFT för den vänstra och KeyLocation.RIGHT för den högra. Ett annat exempel är att man kan skilja mellan siffertangenter som trycks ned på standardtangentbordet (KeyLocation.STANDARD) och dem på det numeriska tangentbordet (KeyLocation.NUM_PAD).



Implementering
    public function get keyLocation():uint
    public function set keyLocation(value:uint):void

shiftKey

egenskap 
shiftKey:Boolean

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Anger om skifttangentmodifieraren är aktiv (true) eller inaktiv (false).



Implementering
    public function get shiftKey():Boolean
    public function set shiftKey(value:Boolean):void
Konstruktordetaljer

KeyboardEvent

()Konstruktor
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)

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Skapar ett nytt Event-objekt som innehåller specifik information om tangentbordshändelser. Event-objekt skickas som parametrar till händelseavlyssnare.

Parametrar
type:String — Händelsens typ. Möjliga värden är: KeyboardEvent.KEY_DOWN och KeyboardEvent.KEY_UP
 
bubbles:Boolean (default = true) — Bestämmer om Event-objektet deltar i bubblingssteget av händelseflödet.
 
cancelable:Boolean (default = false) — Avgör om Event-objektet kan avbrytas.
 
charCodeValue:uint (default = 0) — Innehåller värdet för teckenkoden för den senaste tangenten som trycktes ned eller släpptes upp. Teckenvärdena som returneras är engelska tangentbordsvärden. Om du till exempel trycker Skift+3 returnerar egenskapen Keyboard.charCode() # på japanska och tyska tangentbord, vilket även görs på ett engelskt tangentbord.
 
keyCodeValue:uint (default = 0) — Innehåller värdet för tangentkoden för den senaste tangenten som trycktes ned eller släpptes upp.
 
keyLocationValue:uint (default = 0) — Tangentens placering på tangentbordet.
 
ctrlKeyValue:Boolean (default = false) — Anger om Ctrl-tangenten är aktiv i Windows. Anger om Ctrl-tangenten eller Kommando-tangenten är aktiv i Macintosh.
 
altKeyValue:Boolean (default = false) — Anger om Alt-tangentmodifieringen är aktiverad (endast Windows).
 
shiftKeyValue:Boolean (default = false) — Anger om skifttangentmodifieringen är aktiverad.
 
controlKeyValue:Boolean (default = false) — Anger om Ctrl-tangenten är aktiv i Macintosh, Windows eller Linux.
 
commandKeyValue:Boolean (default = false) — Anger om kommandotangenten är aktiverad (endast Macintosh).

Relaterade API-element

Metoddetaljer

clone

()metod
override public function clone():Event

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Skapar en kopia av KeyboardEvent-objektet och ställer in värdet för alla egenskaper så att de matchar originalets egenskaper.

Returnerar
Event — Ett nytt KeyboardEvent-objekt med egenskapsvärden som matchar originalet.

toString

()metod 
override public function toString():String

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Returnerar en sträng som innehåller alla egenskaper i KeyboardEvent-objektet. Strängen är i följande format:

[KeyboardEvent type=värde bubbles=värde cancelable=värde ... shiftKey=värde]

Returnerar
String — En sträng som innehåller alla KeyboardEvent-objektets egenskaper.

updateAfterEvent

()metod 
public function updateAfterEvent():void

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9

Anger att displayen ska återges efter att den här händelseprocessen har slutförts och om display-listan har ändrats.

Konstantdetaljer

KEY_DOWN

Konstant
public static const KEY_DOWN:String = "keyDown"

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

KeyboardEvent.KEY_DOWN-konstanten definierar värdet på type-egenskapen i ett keyDown-händelseobjekt.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblestrue
cancelabletrue i AIR, false i Flash Player. I AIR går det inte att skriva tecknet i ett textfält om händelsen avbryts.
charCodeInnehåller värdet för teckenkoden för den senaste tangenten som trycktes ned eller släpptes upp.
commandKeytrue i Macintosh om Kommando-tangenten är aktiv. Annars false
controlKeytrue i Windows och Linux om Ctrl-tangenten är aktiv. true i Macintosh om Ctrl-tangenten är aktiv. Annars false
ctrlKeytrue i Windows och Linux om Ctrl-tangenten är aktiv. true om antingen Ctrl-tangenten eller Kommando-tangenten är aktiv i Macintosh. Annars false.
currentTargetDet objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
keyCodeInnehåller värdet för tangentkoden för den senaste tangenten som trycktes ned eller släpptes upp.
keyLocationTangentens placering på tangentbordet.
shiftKeytrue om skifttangenten är aktiverad eller false om den är inaktiverad.
targetDen InteractiveObject-instans som är i fokus. target är inte alltid det objekt i visningslistan som har registrerat händelseavlyssnaren. Använd egenskapen currentTarget om du vill komma åt det objekt i visningslistan som bearbetar händelsen.

Relaterade API-element

KEY_UP

Konstant 
public static const KEY_UP:String = "keyUp"

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

KeyboardEvent.KEY_UP-konstanten definierar värdet på type-egenskapen i ett keyUp-händelseobjekt.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblestrue
cancelablefalse; det finns inget standardbeteende att avbryta.
charCodeInnehåller värdet för teckenkoden för den senaste tangenten som trycktes ned eller släpptes upp.
commandKeytrue i Macintosh om Kommando-tangenten är aktiv. Annars false
controlKeytrue i Windows och Linux om Ctrl-tangenten är aktiv. true i Macintosh om Ctrl-tangenten är aktiv. Annars false
ctrlKeytrue i Windows om Ctrl-tangenten är aktiv. true om antingen Ctrl-tangenten eller Kommando-tangenten är aktiv i Macintosh. Annars false.
currentTargetDet objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
keyCodeInnehåller värdet för tangentkoden för den senaste tangenten som trycktes ned eller släpptes upp.
keyLocationTangentens placering på tangentbordet.
shiftKeytrue om skifttangenten är aktiverad eller false om den är inaktiverad.
targetDen InteractiveObject-instans som är i fokus. target är inte alltid det objekt i visningslistan som har registrerat händelseavlyssnaren. Använd egenskapen currentTarget om du vill komma åt det objekt i visningslistan som bearbetar händelsen.

Relaterade API-element

KeyboardEventExample.as

I följande exempel används klassen KeyboardEventExample för att visa tangentbordshändelser och deras avlyssningsfunktioner. I exemplen utförs följande uppgifter:
  1. Skapar en ny Sprite-instans med namnet child.
  2. Det deklarerar egenskaper för senare användning vid inställning av en fyrkants bakgrundsfärg och storlek.
  3. Med hjälp av Sprite-metoder ritar den en ljusblå fyrkant och visar den på scenen med standardkoordinaterna (0,0) genom att anropa metoden addChild().
  4. Den lägger till en mouse-händelse och två keyboard type-händelseavlyssnare:
    • Klicka på /clickHandler som skickas när du klickar på fyrkanten och ställ samtidigt in fokus på child sprite så att den kan avlyssna tangentbordshändelser.
    • keyDown/keyDownHandler som skickas varje gång en tangent trycks ned. Mottagarmetoden skriver ut information om händelsen med satsen trace().
    • keyUp/keyUpHandler som skickas varje gång en tangent släpps upp.

När du provar det här exemplet måste du klicka på fyrkanten först för att tangentbordshändelserna ska fungera.

Och om du använder Test Movie-kommandot i Flash, kan utvecklingsgränssnittet svara på särskilda tangenter instället för på händelseavlyssnaren som är kopplad till sprite-objektet.

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




[ X ]Varför på engelska?
Innehåll i Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen är på engelska

Det är inte alla delar av Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen som översätts till alla språk. Om ett språkelement inte översätts visas det på engelska. Klassen ga.controls.HelpBox översätts till exempel inte till något språk. I den svenska versionen av referenshandboken visas därför klassen ga.controls.HelpBox på engelska.