| /* |
| * Copyright (C) 2010 The Android Open Source Project |
| * |
| * 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 android.view; |
| |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| |
| /** |
| * Common base class for input events. |
| */ |
| public abstract class InputEvent implements Parcelable { |
| /** @hide */ |
| protected static final int PARCEL_TOKEN_MOTION_EVENT = 1; |
| /** @hide */ |
| protected static final int PARCEL_TOKEN_KEY_EVENT = 2; |
| |
| /*package*/ InputEvent() { |
| } |
| |
| /** |
| * Gets the id for the device that this event came from. An id of |
| * zero indicates that the event didn't come from a physical device |
| * and maps to the default keymap. The other numbers are arbitrary and |
| * you shouldn't depend on the values. |
| * |
| * @return The device id. |
| * @see InputDevice#getDevice |
| */ |
| public abstract int getDeviceId(); |
| |
| /** |
| * Gets the device that this event came from. |
| * |
| * @return The device, or null if unknown. |
| */ |
| public final InputDevice getDevice() { |
| return InputDevice.getDevice(getDeviceId()); |
| } |
| |
| /** |
| * Gets the source of the event. |
| * |
| * @return The event source or {@link InputDevice#SOURCE_UNKNOWN} if unknown. |
| * @see InputDevice#getSourceInfo |
| */ |
| public abstract int getSource(); |
| |
| /** |
| * Modifies the source of the event. |
| * |
| * @param source The new source. |
| * @hide |
| */ |
| public abstract void setSource(int source); |
| |
| /** |
| * Copies the event. |
| * |
| * @return A deep copy of the event. |
| * @hide |
| */ |
| public abstract InputEvent copy(); |
| |
| /** |
| * Recycles the event. |
| * This method should only be used by the system since applications do not |
| * expect {@link KeyEvent} objects to be recycled, although {@link MotionEvent} |
| * objects are fine. See {@link KeyEvent#recycle()} for details. |
| * @hide |
| */ |
| public abstract void recycle(); |
| |
| /** |
| * Gets a private flag that indicates when the system has detected that this input event |
| * may be inconsistent with respect to the sequence of previously delivered input events, |
| * such as when a key up event is sent but the key was not down or when a pointer |
| * move event is sent but the pointer is not down. |
| * |
| * @return True if this event is tainted. |
| * @hide |
| */ |
| public abstract boolean isTainted(); |
| |
| /** |
| * Sets a private flag that indicates when the system has detected that this input event |
| * may be inconsistent with respect to the sequence of previously delivered input events, |
| * such as when a key up event is sent but the key was not down or when a pointer |
| * move event is sent but the pointer is not down. |
| * |
| * @param tainted True if this event is tainted. |
| * @hide |
| */ |
| public abstract void setTainted(boolean tainted); |
| |
| /** |
| * Returns the time (in ns) when this specific event was generated. |
| * The value is in nanosecond precision but it may not have nanosecond accuracy. |
| * @hide |
| */ |
| public abstract long getEventTimeNano(); |
| |
| public int describeContents() { |
| return 0; |
| } |
| |
| public static final Parcelable.Creator<InputEvent> CREATOR |
| = new Parcelable.Creator<InputEvent>() { |
| public InputEvent createFromParcel(Parcel in) { |
| int token = in.readInt(); |
| if (token == PARCEL_TOKEN_KEY_EVENT) { |
| return KeyEvent.createFromParcelBody(in); |
| } else if (token == PARCEL_TOKEN_MOTION_EVENT) { |
| return MotionEvent.createFromParcelBody(in); |
| } else { |
| throw new IllegalStateException("Unexpected input event type token in parcel."); |
| } |
| } |
| |
| public InputEvent[] newArray(int size) { |
| return new InputEvent[size]; |
| } |
| }; |
| } |