Главная / Action Script 3
Пакетflash.events
Классpublic class KeyboardEvent
НаследованиеKeyboardEvent Inheritance Event Inheritance Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Flash® Player отправляет объекты KeyboardEvent в ответ на пользовательский ввод с клавиатуры. Существует два типа событий клавиатуры: KeyboardEvent.KEY_DOWN и KeyboardEvent.KEY_UP

Так как соответствие клавиш определенным символам варьируется в зависимости от устройства и операционной системы, для обработки ввода символов необходимо использовать тип события TextEvent.

Чтобы прослушивать события клавиш в глобальном масштабе, необходимо добавить прослушиватель события к объекту Stage для фазы захвата и для фаз цели и пузырей.

Посмотреть примеры

См. также

KEY_DOWN
KEY_UP
KeyLocation


Общедоступные свойства
 СвойствоОпределено
  altKey : Boolean
Показывает активность клавиши Alt: true — активна, false — неактивна.
KeyboardEvent
 Inheritedbubbles : Boolean
[только для чтения] Определяет, является ли событие "событием на цепочке".
Event
 Inheritedcancelable : Boolean
[только для чтения] Определяет, можно ли отключить поведение, связанное с событием.
Event
  charCode : uint
Содержит значение кода символа для нажатой или отпущенной клавиши.
KeyboardEvent
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
  ctrlKey : Boolean
Показывает активность клавиши Control: true — активна, false — неактивна.
KeyboardEvent
 InheritedcurrentTarget : Object
[только для чтения] Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
Event
 InheritedeventPhase : uint
[только для чтения] Текущая фаза в потоке событий.
Event
  keyCode : uint
Значение кода клавиши для нажатой или отпущенной клавиши.
KeyboardEvent
  keyLocation : uint
Указывает расположение клавиши на клавиатуре.
KeyboardEvent
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
  shiftKey : Boolean
Показывает, активирован ли модификатор клавиши Shift: true — активирован, false — не активирован.
KeyboardEvent
 Inheritedtarget : Object
[только для чтения] Целевой объект события.
Event
 Inheritedtype : String
[только для чтения] Тип события.
Event
Общедоступные методы
 МетодОпределено
  
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)
Создает объект Event, содержащий данные о событиях клавиатуры.
KeyboardEvent
  
Создает копию объекта KeyboardEvent и задает значение каждого свойства, совпадающее с оригиналом.
KeyboardEvent
 Inherited
formatToString(className:String, ... arguments):String
Служебная функция для реализации метода toString() в пользовательских классах ActionScript 3.0 Event.
Event
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Проверяет, выполнялся ли для события вызова метода preventDefault().
Event
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Отменяет поведение по умолчанию для события, если такое поведение можно отменить.
Event
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Отменяет обработку прослушивателей событий в текущем узле, а также во всех узлах, которые следуют в потоке событий за текущим узлом.
Event
 Inherited
Отменяет обработку прослушивателей событий в узлах, которые следуют в потоке событий за текущим узлом.
Event
  
Возвращает строку, содержащую все свойства объекта KeyboardEvent.
KeyboardEvent
  
Предписывает проигрывателю Flash Player выполнить визуализацию после обработки данного события, если список отображения был изменен
KeyboardEvent
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Общедоступные константы
 Константа Определено
 InheritedACTIVATE : String = "activate"
[статические] Константа Event.ACTIVATE определяет значение свойства type объекта события Activitate.
Event
 InheritedADDED : String = "added"
[статические] Константа Event.ADDED определяет значение свойства type добавленного объекта события.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[статические] Константа Event.ADDED_TO_STAGE определяет значение свойства type объекта события addedToStage.
Event
 InheritedCANCEL : String = "cancel"
[статические] Константа Event.CANCEL определяет значение свойства type объекта события cancel.
Event
 InheritedCHANGE : String = "change"
[статические] Константа Event.CHANGE определяет значение свойства type объекта события change.
Event
 InheritedCLEAR : String = "clear"
[статические] Задает значение свойства type для объекта события clear.
Event
 InheritedCLOSE : String = "close"
[статические] Константа Event.CLOSE определяет значение свойства type объекта события close.
Event
 InheritedAIR-only CLOSING : String = "closing"
[статические] Константа Event.CLOSING определяет значение свойства type объекта события closing.
Event
 InheritedCOMPLETE : String = "complete"
[статические] Константа Event.COMPLETE определяет значение свойства type объекта события complete.
Event
 InheritedCONNECT : String = "connect"
[статические] Константа Event.CONNECT определяет значение свойства type объекта события connect.
Event
 InheritedCOPY : String = "copy"
[статические] Задает значение свойства type для объекта события copy.
Event
 InheritedCUT : String = "cut"
[статические] Задает значение свойства type для объекта события cut.
Event
 InheritedDEACTIVATE : String = "deactivate"
[статические] Константа Event.DEACTIVATE определяет значение свойства type объекта события deactivate.
Event
 InheritedDISPLAYING : String = "displaying"
[статические] Задает значение свойства type для объекта события displaying.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[статические] Константа Event.ENTER_FRAME определяет значение свойства type объекта события enterFrame.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[статические] Определяет значение свойства type объекта exitFrame.
Event
 InheritedAIR-only EXITING : String = "exiting"
[статические] Константа Event.EXITING определяет значение свойства type объекта exiting.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[статические] Задает значение свойства type для объекта события frameConstructed.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[статические] Константа Event.FULL_SCREEN определяет значение свойства type для объекта события fullScreen.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[статические] Константа Event.HTML_BOUNDS_CHANGE определяет значение свойства type объекта htmlBoundsChange.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[статические] Константа Event.HTML_DOM_INITIALIZE определяет значение свойства type объекта события htmlDOMInitialize.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[статические] Константа Event.HTML_RENDER определяет значение свойства type объекта события htmlRender.
Event
 InheritedID3 : String = "id3"
[статические] Константа Event.ID3 определяет значение свойства type объекта id3.
Event
 InheritedINIT : String = "init"
[статические] Константа Event.INIT определяет значение свойства type объекта init.
Event
  KEY_DOWN : String = "keyDown"
[статические] Задает значение свойства type для объекта события keyDown.
KeyboardEvent
  KEY_UP : String = "keyUp"
[статические] Задает значение свойства type для объекта события keyUp.
KeyboardEvent
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[статические] Константа Event.LOCATION_CHANGE определяет значение свойства type объекта события locationChange.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[статические] Константа Event.MOUSE_LEAVE определяет значение свойства type объекта события mouseLeave.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[статические] Константа Event.NETWORK_CHANGE определяет значение свойства type объекта события networkChange.
Event
 InheritedOPEN : String = "open"
[статические] Константа Event.OPEN определяет значение свойства type объекта open.
Event
 InheritedPASTE : String = "paste"
[статические] Задает значение свойства type для объекта события paste.
Event
 InheritedREMOVED : String = "removed"
[статические] Константа Event.REMOVED определяет значение свойства type объекта события removed.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[статические] Константа REMOVED_FROM_STAGE определяет значение свойства type объекта события removedFromStage.
Event
 InheritedRENDER : String = "render"
[статические] Константа Event.RENDER определяет значение свойства type объекта события render.
Event
 InheritedRESIZE : String = "resize"
[статические] Константа Event.RESIZE определяет значение свойства type объекта события resize.
Event
 InheritedSCROLL : String = "scroll"
[статические] Константа Event.SCROLL определяет значение свойства type объекта события scroll.
Event
 InheritedSELECT : String = "select"
[статические] Константа Event.SELECT определяет значение свойства type объекта события select.
Event
 InheritedSELECT_ALL : String = "selectAll"
[статические] Задает значение свойства type для объекта события selectAll.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[статические] Константа Event.SOUND_COMPLETE определяет значение свойства type объекта события soundComplete.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[статические] Константа Event.TAB_CHILDREN_CHANGE определяет значение свойства type объекта события tabChildrenChange.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[статические] Константа Event.TAB_ENABLED_CHANGE определяет значение свойства type объекта события tabEnabledChange.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[статические] Константа Event.TAB_INDEX_CHANGE определяет значение свойства type объекта события tabIndexChange.
Event
 InheritedUNLOAD : String = "unload"
[статические] Константа Event.UNLOAD определяет значение свойства type объекта unload.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[статические] Константа Event.USER_IDLE определяет значение свойства type объекта события userIdle.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[статические] Константа Event.USER_PRESENT определяет значение свойства type объекта события userPresent.
Event
Сведения о свойстве
altKeyсвойство
altKey:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Показывает активность клавиши Alt: true — активна, false — неактивна. Поддерживается только для операционных систем Windows.



Реализация
    public function get altKey():Boolean
    public function set altKey(value:Boolean):void
charCodeсвойство 
charCode:uint  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Содержит значение кода символа для нажатой или отпущенной клавиши. Значения кодов символов являются значениями английской раскладки клавиатуры. Например, если нажать "Shift+3", charCode — это символ "#" японской раскладке клавиатуры так же, как на английской.

Примечание. Если работает редактор метода ввода (IME), charCode не сообщает точные коды символов.



Реализация
    public function get charCode():uint
    public function set charCode(value:uint):void

См. также

ctrlKeyсвойство 
ctrlKey:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Показывает активность клавиши Control: true — активна, false — неактивна.

Примечание. Клавиша Command в системах Macintosh должна представляться с использованием этого модификатора клавиши.



Реализация
    public function get ctrlKey():Boolean
    public function set ctrlKey(value:Boolean):void
keyCodeсвойство 
keyCode:uint  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Значение кода клавиши для нажатой или отпущенной клавиши.

Примечание. Если работает редактор метода ввода (IME), charCode не сообщает точные коды клавиш.



Реализация
    public function get keyCode():uint
    public function set keyCode(value:uint):void

См. также

keyLocationсвойство 
keyLocation:uint  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Указывает расположение клавиши на клавиатуре. Это полезно для дифференциации клавиш, встречающихся на клавиатуре несколько раз. Например, можно дифференцировать левую и правую клавиши Shift по значению этого свойства: KeyLocation.LEFT — левая, а KeyLocation.RIGHT — правая. Другой пример — дифференциация клавиш с цифрами, нажатых на стандартной клавиатуре (KeyLocation.STANDARD) и на числовой панели (KeyLocation.NUM_PAD).



Реализация
    public function get keyLocation():uint
    public function set keyLocation(value:uint):void
shiftKeyсвойство 
shiftKey:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Показывает, активирован ли модификатор клавиши Shift: true — активирован, false — не активирован.



Реализация
    public function get shiftKey():Boolean
    public function set shiftKey(value:Boolean):void
Сведения о конструкторе
KeyboardEvent()Конструктор
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)

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает объект Event, содержащий данные о событиях клавиатуры. Объекты Event передаются прослушивателям событий в качестве параметров.

Параметры
type:String — Тип события. Допустимые значения: KeyboardEvent.KEY_DOWN и KeyboardEvent.KEY_UP
 
bubbles:Boolean (default = true) — Определяет, участвует ли объект Event на этапе восходящей цепочки процесса события.
 
cancelable:Boolean (default = false) — Определяет, можно ли отменить объект Event.
 
charCode:uint (default = 0) — Значение кода символа для нажатой или отпущенной клавиши. Возвращаемые значения кодов символов являются значениями англоязычной раскладки клавиатуры. Например, если нажать "Shift+3", метод getASCIICode() возвращает символ "#" на японской раскладке клавиатуры так же, как на английской.
 
keyCode:uint (default = 0) — Значение кода клавиши для нажатой или отпущенной клавиши.
 
keyLocation:uint (default = 0) — Расположение клавиши на клавиатуре.
 
ctrlKey:Boolean (default = false) — Указывает, активирован ли модификатор клавиши Control.
 
altKey:Boolean (default = false) — Указывает, активирован ли модификатор клавиши Alt (только для Windows).
 
shiftKey:Boolean (default = false) — Указывает, активирован ли модификатор клавиши Shift.

См. также

Сведения о методе
clone()метод
override public function clone():Event

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает копию объекта KeyboardEvent и задает значение каждого свойства, совпадающее с оригиналом.

Возвращает
Event — Новый объект KeyboardEvent, значения свойств которого соответствуют значениям оригинала.
toString()метод 
override public function toString():String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает строку, содержащую все свойства объекта KeyboardEvent. Строка имеет следующий формат:

[KeyboardEvent type=значение bubbles=значение cancelable=значение ... shiftKey=значение]

Возвращает
String — Строка, содержащая все свойства объекта KeyboardEvent.
updateAfterEvent()метод 
public function updateAfterEvent():void

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Предписывает проигрывателю Flash Player выполнить визуализацию после обработки данного события, если список отображения был изменен

Сведения о константе
KEY_DOWNКонстанта
public static const KEY_DOWN:String = "keyDown"

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает значение свойства type для объекта события keyDown.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblestrue
cancelablefalse; нет поведения по умолчанию для отмены.
charCodeЗначение кода символа для нажатой или отпущенной клавиши.
ctrlKeytrue, если клавиша Control активна; иначе — false.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
keyCodeЗначение кода клавиши для нажатой или отпущенной клавиши.
keyLocationРасположение клавиши на клавиатуре.
shiftKeytrue, если клавиша Shift активна; иначе — false.
targetЭкземпляр InteractiveObject, находящийся в фокусе. Свойство target не всегда является объектом из списка отображения, для которого зарегистрирован прослушиватель событий. Используйте свойство currentTarget, чтобы обратиться к объекту в списке отображения, обрабатывающему событие в данный момент.

См. также

KEY_UPКонстанта  
public static const KEY_UP:String = "keyUp"

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает значение свойства type для объекта события keyUp.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblestrue
cancelablefalse; нет поведения по умолчанию для отмены.
charCodeСодержит значение кода символа для нажатой или отпущенной клавиши.
ctrlKeytrue, если клавиша Control активна; иначе — false.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
keyCodeЗначение кода клавиши для нажатой или отпущенной клавиши.
keyLocationРасположение клавиши на клавиатуре.
shiftKeytrue, если клавиша Shift активна; иначе — false.
targetЭкземпляр InteractiveObject, находящийся в фокусе. Свойство target не всегда является объектом из списка отображения, для которого зарегистрирован прослушиватель событий. Используйте свойство currentTarget, чтобы обратиться к объекту в списке отображения, обрабатывающему событие в данный момент.

См. также

Примеры Как пользоваться примерами
KeyboardEventExample.as

В следующем примере используется класс KeyboardEventExample для демонстрации событий клавиатуры и их функций прослушивателей. Этот код выполняет следующие задачи.
  1. Создается новый экземпляр Sprite с именем child.
  2. Объявляются свойства для последующего использования при задании фонового цвета и размера квадрата.
  3. С помощью методов объекта Sprite рисуется голубой квадрат, отображаемый в рабочей области в точке по умолчанию с координатами (0,0) путем вызова метода addChild().
  4. Добавляется один прослушиватель событий мыши и два прослушивателя событий клавиатуры:
    • click/clickHandler отправляется при щелчке по квадрату с целью перевода фокуса на спрайт child, чтобы он мог прослушивать события клавиатуры;
    • keyDown/keyDownHandler отправляется при нажатии любой клавиши; Метод подписчика печатает сведения о событии с помощью инструкции trace();
    • keyUp/keyUpHandler отправляется, когда клавиша отпускается.

При тестировании этого примера сначала необходимо щелкнуть по квадрату, чтобы заработали события клавиатуры.

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