/*
* Copyright 2008 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.gwt.topspin.ui.client;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.events.client.Event;
import com.google.gwt.events.client.EventListener;
import com.google.gwt.events.client.EventListenerRemover;
/**
* An event fired when a key is pressed within a widget.
*
* This event represents the native 'onkeypress' event.
*/
public class KeyPressEvent extends NativeEvent {
public static final String NAME = "keypress";
/**
* Adds a keypress listener to the given native object.
*
* @param source the associated event source
* @param nativeSource the native object that will fire the event
* @param listener the listener to be notified of the event
* @return a handle that may be used to remove this listener
*/
public static EventListenerRemover addKeyPressListener(final Object source,
JavaScriptObject nativeSource, final KeyPressListener listener) {
return Event.addEventListener(KeyPressEvent.NAME, nativeSource,
new EventListener() {
public void handleEvent(Event event) {
listener.onKeyPress(new KeyPressEvent(source, event));
}
});
}
/**
* Creates a new keypress event with the given source and browser event.
*
* @param sender the event source
* @param nativeEvent the browser event
*/
public KeyPressEvent(Object sender, Event nativeEvent) {
super(sender, nativeEvent);
}
/**
* Gets the key-code of the key pressed.
*
* @return the key-code
*/
public int getKeyCode() {
return this.getNativeEvent().getKeyCode();
}
}