KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > buchuki > ensmer > input > event > KeyPressEvent


1 /*
2  * Copyright 2004 Dusty Phillips
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.buchuki.ensmer.input.event;
17
18 import java.awt.event.*;
19
20 /**
21  * Represents a KeyPress for a specific key. It can model an event that has
22  * occured or an event that can occur. If no actual event is represented,
23  * getInputEvent() will return null;
24  *
25  * @author Dusty Phillips [dusty@buchuki.com]
26  */
27 public class KeyPressEvent extends EnsmerKeyEvent {
28
29     /**
30      * Create a KeyPressEvent that matches all key events. This constructor
31      * is used when a generic KeyPressEvent should be matched.
32      */
33     public KeyPressEvent() {
34         super(-1);
35     }
36     
37     /**
38      * Create a KeyPressEvent with a reference to the KeyCode it should
39      * model. This constructor is used when no actual InputEvent was
40      * generated.
41      *
42      * @param keycode One of the constants from the java.awt.KeyEvent class
43      * representing a key that was pressed
44      */
45     public KeyPressEvent(int keycode) {
46         super(keycode);
47     }
48
49     /**
50      * Create a KeyPressEvent with a reference to the actual KeyEvent that
51      * occured. This constructor is used when an actual InputEvent has been
52      * generated. The keycode is retrieved from the event itself.
53      *
54      * @param event an InputEvent that was generated
55      */
56     public KeyPressEvent(KeyEvent event) {
57         super(event);
58     }
59 }
60
Popular Tags