• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Class (EventResult)
2<!--Kit: ArkWeb-->
3<!--Subsystem: Web-->
4<!--Owner: @zourongchun-->
5<!--Designer: @zhufenghao-->
6<!--Tester: @ghiker-->
7<!--Adviser: @HelloCrease-->
8
9通知Web组件同层事件消费结果,支持的事件:[触摸事件的类型](../apis-arkui/arkui-ts/ts-appendix-enums.md#touchtype)和[鼠标事件的类型](../apis-arkui/arkui-ts/ts-appendix-enums.md#mouseaction8),鼠标仅支持[左中右按键](../apis-arkui/arkui-ts/ts-appendix-enums.md#mousebutton8)。
10
11如果应用不消费该事件,则应设置消费结果为false,事件将会被Web组件消费;反之如果应用消费了该事件,则应将消费结果设置为true,Web组件将不消费该事件。若应用设置消费结果不符合以上使用规格,可能将产生和开发者预期不匹配的现象。
12
13触摸事件示例代码参考[onNativeEmbedGestureEvent事件](./arkts-basic-components-web-events.md#onnativeembedgestureevent11)。
14鼠标事件示例代码参考[onNativeEmbedMouseEvent事件](./arkts-basic-components-web-events.md#onnativeembedmouseevent20)。
15
16> **说明:**
17>
18> - 该组件首批接口从API version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
19>
20> - 本Class首批接口从API version 12开始支持。
21>
22> - 示例效果请以真机运行为准,当前DevEco Studio预览器不支持。
23
24## constructor<sup>12+</sup>
25
26constructor()
27
28EventResult的构造函数。
29
30**系统能力:** SystemCapability.Web.Webview.Core
31
32## setGestureEventResult<sup>12+</sup>
33
34setGestureEventResult(result: boolean): void
35
36设置手势事件消费结果。
37
38**系统能力:** SystemCapability.Web.Webview.Core
39
40**参数:**
41
42| 参数名          | 类型 | 必填  | 说明             |
43| --------------- | -------- | ----  |------- |
44| result          | boolean  | 是    | 是否消费该手势事件。<br>true表示消费该手势事件,false表示不消费该手势事件。默认值为true。 |
45
46**示例:**
47
48请参考[onNativeEmbedGestureEvent事件](./arkts-basic-components-web-events.md#onnativeembedgestureevent11)。
49
50## setGestureEventResult<sup>14+</sup>
51
52setGestureEventResult(result: boolean, stopPropagation: boolean): void
53
54设置手势事件消费结果。
55
56**系统能力:** SystemCapability.Web.Webview.Core
57
58**参数:**
59
60| 参数名          | 类型 | 必填  | 说明             |
61| --------------- | -------- | ----  |------- |
62| result          | boolean  | 是    | 是否消费该手势事件。<br>true表示消费该手势事件,false表示不消费该手势事件。<br>默认值为true。 |
63| stopPropagation | boolean  | 是   | 是否阻止冒泡,在result为true时生效。<br>true表示阻止冒泡,false表示不阻止冒泡。<br>默认值为true。 |
64
65**示例:**
66
67请参考[onNativeEmbedGestureEvent事件](./arkts-basic-components-web-events.md#onnativeembedgestureevent11)。
68
69## setMouseEventResult<sup>20+</sup>
70
71setMouseEventResult(result: boolean, stopPropagation?: boolean): void
72
73设置鼠标事件消费结果。
74
75**系统能力:** SystemCapability.Web.Webview.Core
76
77**参数:**
78
79| 参数名          | 类型 | 必填  | 说明             |
80| --------------- | -------- | ----  |------- |
81| result          | boolean  | 是    | 是否消费该鼠标事件。<br>true表示消费该鼠标事件,false表示不消费该鼠标事件。<br>默认值为true。 |
82| stopPropagation | boolean  | 否   | 是否阻止冒泡,在result为true时生效。<br>true表示阻止冒泡,false表示不阻止冒泡。<br>默认值为true。 |
83
84**示例:**
85
86请参考[onNativeEmbedMouseEvent事件](./arkts-basic-components-web-events.md#onnativeembedmouseevent20)。