• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 事件独占控制
2<!--Kit: ArkUI-->
3<!--Subsystem: ArkUI-->
4<!--Owner: @jiangtao92-->
5<!--Designer: @piggyguy-->
6<!--Tester: @songyanhong-->
7<!--Adviser: @HelloCrease-->
8
9设置组件是否独占事件,事件范围包括组件自带的事件和开发者自定义的点击、触摸、手势事件。<br />
10在一个窗口内,设置了独占控制的组件上的事件如果首先响应,则本次交互只允许此组件上设置的事件响应,窗口内其他组件上的事件不会响应。
11
12>  **说明:**
13>
14>  从API version 11开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
15
16## monopolizeEvents
17
18monopolizeEvents(monopolize: boolean): T
19
20设置组件是否独占事件。
21
22**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
23
24**系统能力:** SystemCapability.ArkUI.ArkUI.Full
25
26**参数:**
27
28| 参数名   | 类型 | 必填 | 说明                  |
29| ----------- | -------- | ------------------------ | ------------------------ |
30| monopolize | boolean  | 是 | 设置组件是否独占事件。true表示组件独占事件,false表示组件不独占事件。<br />默认值:false <br />**说明:**<br />1、如果第一根手指触发了组件事件独占,在抬起前又按下了一根手指,则第二根手指的交互继续处于组件独占状态,依次类推。<br />2、如果开发者通过[parallelGesture](ts-gesture-settings.md)绑定了与子组件同时触发的手势,如[PanGesture](ts-basic-gestures-pangesture.md),子组件设置了独占控制且首个响应事件,则父组件的手势不会响应。|
31
32**返回值:**
33
34| 类型 | 说明 |
35| -------- | -------- |
36| T | 返回当前组件。 |
37
38## 示例
39
40该示例通过配置monopolizeEvents实现组件是否独占事件。
41
42```ts
43// xxx.ets
44@Entry
45@Component
46struct Index {
47  @State message: string = 'set monopolizeEvents false';
48  @State messageOut: string = ' ';
49  @State messageInner: string = ' ';
50  @State monopolize: boolean = false;
51
52  build() {
53    Column() {
54      Text(this.message)
55        .fontSize(22)
56        .margin(10)
57      Text(this.messageOut)
58        .fontSize(22)
59        .margin(10)
60      Text(this.messageInner)
61        .fontSize(22)
62        .margin(10)
63      Button('clean')
64        .fontSize(22)
65        .margin(10)
66        // 通过button的点击事件来切换内层column的独占控制属性
67        .onClick(()=>{
68          this.messageOut = " "
69          this.messageInner = " "
70        })
71      Button('change monopolizeEvents')
72        .fontSize(22)
73        .margin(10)
74        // 通过button的点击事件来切换内层column的独占控制属性
75        .onClick(()=>{
76          this.monopolize = !this.monopolize
77          if (!this.monopolize) {
78            this.message = "set monopolizeEvents false"
79          } else {
80            this.message = "set monopolizeEvents true"
81          }
82        })
83      Column() {
84        Column(){}
85        // this.monopolize是true时,点击内层column只会触发自身的触摸事件,不会触发外层column的触摸事件
86        // this.monopolize是false时,点击内层column会同时触发自身的触摸事件和外层column的触摸事件
87        .monopolizeEvents(this.monopolize)
88        .width('100%')
89        .height('40%')
90        .backgroundColor(Color.Blue)
91        // 内层column绑定触摸事件
92        .onTouch((event:TouchEvent)=>{
93          if (event.type == TouchType.Down) {
94            console.info("inner column touch down")
95            this.messageInner = "inner column touch down"
96          }
97        })
98      }
99      .backgroundColor(Color.Gray)
100      .height('100%')
101      .width('100%')
102      // 外层column绑定触摸事件
103      .onTouch((event)=>{
104        if (event.type == TouchType.Down) {
105          console.info("outside column touch down")
106          this.messageOut = "outside column touch down"
107        }
108      })
109    }
110    .height('100%')
111  }
112}
113```
114![obscured](figures/monopolize-events.gif)