MultimodalEvent

java.lang.Object

|---ohos.multimodalinput.event.MultimodalEvent

public abstract class MultimodalEvent
extends Object
implements Sequenceable

表示所有事件类型的基类。

此类定义了一系列表示抽象的用户行为或意图的高级事件类型。 此外，它还定义了各个子类共享的方法和信息。 如果只想捕获事件中的抽象行为，只需要重写该类中定义的回调接口即可。 如果你想获取更多的信息，那么你可以直接使用这个类中定义的方法。 如果抽象事件的回调和事件处理方法不能满足您的需求，您还可以将事件转换为更具体的事件类型。 例如，可以将MultimodalEvent转换为KeyboardEvent，从而获取更详细的信息或者使用更直接简单的回调接口。

Since:

1

嵌套类摘要

从接口 ohos.utils.Sequenceable 继承的嵌套类/接口
Sequenceable.ProducerT

字段摘要

修饰符和类型	字段	描述
static int	BUILTIN_KEY	指示内置键输入事件。
static int	DEFAULT_TYPE	OS系统支持的标准高级事件的默认值。
protected int	highLevelEvent	表示高级事件。
static int	KEYBOARD	表示键盘输入事件。
static int	MOUSE	表示鼠标输入事件。
static int	ROTATION	表示旋转组件产生的事件。
static int	SPEECH	表示 Speech 组件生成的事件。
static int	STYLUS	指示手写笔输入事件。
static int	TOUCH_PANEL	指示触摸面板 (TP) 输入事件。
static int	UNSUPPORTED_DEVICE	表示没有输入设备。
protected UUID	uuid	表示有助于将一个事件与其他事件区分开来的全局唯一 ID。

方法总结

修饰符和类型	方法	描述
abstract String	getDeviceId()	获取产生当前事件的输入设备的承载设备ID。
abstract int	getInputDeviceId()	获取产生当前事件的输入设备的ID。
abstract long	getOccurredTime()	获取当前事件的产生时间。
abstract int	getSourceDevice()	获取产生当前事件的输入设备的类型。
UUID	getUuid()	获取事件的 UUID。
boolean	isSameEvent(UUID id)	检查当前事件是否与指定 UUID 的事件相同。
boolean	marshalling(Parcel parcel)	将此 Sequenceable 对象编组为 Parcel。
boolean	unmarshalling(Parcel parcel)	从 Parcel 中解组此 Sequenceable 对象。

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口 ohos.utils.Sequenceable 继承的方法
hasFileDescriptor

字段详细信息

BUILTIN_KEY

public static final int BUILTIN_KEY

指示内置键输入事件。

Since:

1

DEFAULT_TYPE

public static final int DEFAULT_TYPE

OS系统支持的标准高级事件的默认值。

Since:

1

KEYBOARD

public static final int KEYBOARD

表示键盘输入事件。

Since:

1

MOUSE

public static final int MOUSE

表示鼠标输入事件。

Since:

1

ROTATION

public static final int ROTATION

表示旋转组件产生的事件。

Since:

3

SPEECH

public static final int SPEECH

表示 Speech 组件生成的事件。

Since:

3

STYLUS

public static final int STYLUS

指示手写笔输入事件。

Since:

1

TOUCH_PANEL

public static final int TOUCH_PANEL

指示触摸面板 (TP) 输入事件。

Since:

1

UNSUPPORTED_DEVICE

public static final int UNSUPPORTED_DEVICE

表示没有输入设备。 它通常用作默认值。

Since:

1

highLevelEvent

protected int highLevelEvent

表示高级事件。 仅当扩展 MultimodalEvent 的类的事件可以转换为高级事件时才需要设置该字段。

Since:

1

uuid

protected final UUID uuid

表示有助于将一个事件与其他事件区分开来的全局唯一 ID。

Since:

1

方法详情

isSameEvent

public boolean isSameEvent(UUID id)

检查当前事件是否与指定 UUID 的事件相同。

参数：

参数名称	参数描述
id	指定要检查的事件的 UUID。

返回:

如果当前事件与指定 UUID 的事件相同，则返回 true； 否则返回 false。

Since:

1

getSourceDevice

public abstract int getSourceDevice()

获取产生当前事件的输入设备的类型。

返回:

返回生成事件的输入设备的类型。 返回值如下： UNSUPPORTED_DEVICE：无输入设备。 通常，这是默认值。 TOUCH_PANEL：触控面板 KEYBOARD：键盘 MOUSE：鼠标 STYLUS：手写笔 BUILTIN_KEY：内置按键 ROTATION：旋转组件 SPEECH：语音组件

Since:

3

getDeviceId

public abstract String getDeviceId()

获取产生当前事件的输入设备的承载设备ID。

例如，如果两个鼠标设备连接到同一个设备，则该设备是两个鼠标设备的承载设备。

返回:

返回产生当前事件的输入设备的承载设备ID； 如果没有输入设备，则返回 null。

Since:

1

getInputDeviceId

public abstract int getInputDeviceId()

获取产生当前事件的输入设备的ID。

输入设备由唯一 ID 标识。 例如，当两个鼠标设备分别产生一个事件时，产生的事件中的设备ID是不同的。 这允许您的应用程序使用设备 ID 来识别实际的输入设备。

返回:

返回产生当前事件的输入设备的 ID； 如果没有输入设备，则返回 -1。

Since:

1

getOccurredTime

public abstract long getOccurredTime()

获取当前事件的产生时间。

返回:

返回生成当前事件的时间（以毫秒为单位）。

Since:

1

getUuid

public UUID getUuid()

获取事件的 UUID。

返回:

返回事件的 UUID。

Since:

1

marshalling

public boolean marshalling(Parcel parcel)

从接口复制的描述：Sequenceable

将此 Sequenceable 对象编组为 Parcel。

指定者：

接口 Sequenceable 中的编组

参数：

参数名称	参数描述
parcel	指示将 Sequenceable 对象编组到的 Parcel 对象。

返回:

如果编组成功，则返回 true； 否则返回 false。

unmarshalling

public boolean unmarshalling(Parcel parcel)

从接口复制的描述：Sequenceable

从 Parcel 中解组此 Sequenceable 对象。

指定者：

在接口 Sequenceable 中解组

参数：

参数名称	参数描述
parcel	指示已将 Sequenceable 对象编组到的 Parcel 对象。

返回:

如果解组成功，则返回 true； 否则返回 false。