js-apis-window.md 82.7 KB
Newer Older
Z
zengyawen 已提交
1 2 3
# 窗口

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
4
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
5 6 7 8 9 10 11

## 导入模块

```
import window from '@ohos.window';
```

C
chyyy0213 已提交
12 13 14 15
## WindowType<sup>7+</sup><a name="windowtype"></a>

窗口类型。

C
chyyy0213 已提交
16 17 18 19 20 21
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称              | 默认值 | 说明               |
| ----------------- | ------ | ------------------ |
| TYPE_APP          | 0      | 表示应用子窗口。   |
| TYPE_SYSTEM_ALERT | 1      | 表示系统告警窗口。 |
Z
zengyawen 已提交
22

C
chyyy0213 已提交
23
## AvoidAreaType<sup>7+</sup><a name="avoidareatype"></a>
陈海莹 已提交
24

C
chyyy0213 已提交
25
窗口内容需要规避区域的类型。
陈海莹 已提交
26

C
chyyy0213 已提交
27 28 29 30 31 32
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称        | 默认值 | 说明               |
| ----------- | ------ | ------------------ |
| TYPE_SYSTEM | 0      | 表示系统默认区域。 |
| TYPE_CUTOUT | 1      | 表示刘海屏区域。   |
陈海莹 已提交
33

C
chyyy0213 已提交
34
## WindowMode<sup>7+</sup><a name="windowmode"></a>
Z
zengyawen 已提交
35

C
chyyy0213 已提交
36
窗口模式。
Z
zengyawen 已提交
37

C
chyyy0213 已提交
38 39 40 41 42 43 44 45 46 47 48
此接口为系统接口,三方应用不支持调用。

**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称       | 默认值 | 说明                          |
| ---------- | ------ | ----------------------------- |
| UNDEFINED  | 1      | 表示APP未定义窗口模式。       |
| FULLSCREEN | 2      | 表示APP全屏模式。             |
| PRIMARY    | 3      | 表示APP分屏多窗口主要模式。   |
| SECONDARY  | 4      | 表示APP分屏多窗口次要模式。   |
| FLOATING   | 5      | 表示APP自由悬浮形式窗口模式。 |
Z
zengyawen 已提交
49

C
chyyy0213 已提交
50
## SystemBarProperties<a name="systembarproperties"></a>
Z
zengyawen 已提交
51 52 53

状态栏导航栏的属性。

C
chyyy0213 已提交
54 55
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

C
chyyy0213 已提交
56 57
| 名称                                   | 参数类型 | 可读 | 可写 | 说明                                                         |
| -------------------------------------- | -------- | ---- | ---- | ------------------------------------------------------------ |
C
chyyy0213 已提交
58 59 60 61 62 63
| statusBarColor                         | string   | 是   | 是   | 状态栏背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。 |
| isStatusBarLightIcon<sup>7+</sup>      | boolean  | 否   | 是   | 状态栏图标是否为高亮状态。                                   |
| statusBarContentColor<sup>8+</sup>     | string   | 否   | 是   | 状态栏文字颜色。                                             |
| navigationBarColor                     | string   | 是   | 是   | 导航栏背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。 |
| isNavigationBarLightIcon<sup>7+</sup>  | boolean  | 否   | 否   | 导航栏图标是否为高亮状态。                                   |
| navigationBarContentColor<sup>8+</sup> | string   | 否   | 是   | 导航栏文字颜色。                                             |
C
chyyy0213 已提交
64 65 66 67 68

## SystemBarRegionTint <sup>8+</sup><a name="systembartegiontint"></a>

单个导航栏或状态栏回调信息。

C
chyyy0213 已提交
69 70 71 72
此接口为系统接口,三方应用不支持调用。

**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

C
chyyy0213 已提交
73 74
| 名称            | 参数类型                  | 可读 | 可写 | 说明                                                         |
| --------------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
C
chyyy0213 已提交
75 76 77 78 79
| type            | [WindowType](#windowtype) | 是   | 是   | 当前属性改变的系统栏类型,仅支持类型为导航栏、状态栏的系统栏。 |
| isEnable        | boolean                   | 是   | 是   | 当前系统栏是否显示。                                         |
| region          | [Rect](#rect)             | 是   | 是   | 当前系统栏的位置及大小。                                     |
| backgroundColor | string                    | 是   | 是   | 系统栏背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。 |
| contentColor    | string                    | 是   | 是   | 系统栏文字颜色。                                             |
Z
zengyawen 已提交
80

C
chyyy0213 已提交
81 82 83 84
## SystemBarTintState <sup>8+</sup><a name="systembartintstate"></a>

当前系统栏回调信息集合。

C
chyyy0213 已提交
85 86 87 88 89 90 91 92
此接口为系统接口,三方应用不支持调用。

**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称       | 参数类型                                           | 可读 | 可写 | 说明                       |
| ---------- | -------------------------------------------------- | ---- | ---- | -------------------------- |
| displayId  | number                                             | 是   | 否   | 当前物理屏幕id。           |
| regionTint | Array<[SystemBarRegionTint](#systembartegiontint)> | 是   | 是   | 当前改变所有的系统栏信息。 |
Z
zengyawen 已提交
93 94 95 96 97

## Rect<sup>7+</sup><a name="rect"></a>

矩形。

C
chyyy0213 已提交
98 99 100 101 102 103 104 105
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称   | 参数类型 | 可读 | 可写 | 说明               |
| ------ | -------- | ---- | ---- | ------------------ |
| left   | number   | 是   | 是   | 矩形区域的左边界。 |
| top    | number   | 是   | 是   | 矩形区域的上边界。 |
| width  | number   | 是   | 是   | 矩形区域的宽度。   |
| height | number   | 是   | 是   | 矩形区域的高度。   |
Z
zengyawen 已提交
106

107
## AvoidArea<sup>7+</sup><a name="avoidarea"></a>
Z
zengyawen 已提交
108 109 110

表示窗口内容规避区域。

C
chyyy0213 已提交
111 112 113 114 115 116 117 118
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称       | 参数类型      | 可读 | 可写 | 说明               |
| ---------- | ------------- | ---- | ---- | ------------------ |
| leftRect   | [Rect](#rect) | 是   | 是   | 屏幕左侧的矩形区。 |
| topRect    | [Rect](#rect) | 是   | 是   | 屏幕顶部的矩形区。 |
| rightRect  | [Rect](#rect) | 是   | 是   | 屏幕右侧的矩形区。 |
| bottomRect | [Rect](#rect) | 是   | 是   | 屏幕底部的矩形区。 |
Z
zengyawen 已提交
119

120
## Size<sup>7+</sup><a name="size"></a>
Z
zengyawen 已提交
121 122 123

窗口大小。

C
chyyy0213 已提交
124 125 126 127 128 129
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称   | 参数类型 | 可读 | 可写 | 说明       |
| ------ | -------- | ---- | ---- | ---------- |
| width  | number   | 是   | 是   | 窗口宽度。 |
| height | number   | 是   | 是   | 窗口高度。 |
Z
zengyawen 已提交
130

C
chyyy0213 已提交
131
## WindowProperties<a name="windowproperties"></a>
Z
zengyawen 已提交
132 133 134

窗口属性。

C
chyyy0213 已提交
135 136
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

C
chyyy0213 已提交
137 138
| 名称                            | 参数类型                  | 可读 | 可写 | 说明                                                         |
| ------------------------------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
C
chyyy0213 已提交
139 140 141 142 143 144 145 146 147 148 149 150
| windowRect<sup>7+</sup>         | [Rect](#rect)             | 是   | 是   | 窗口尺寸。                                                   |
| type<sup>7+</sup>               | [WindowType](#windowtype) | 是   | 是   | 窗口类型。                                                   |
| isFullScreen                    | boolean                   | 是   | 是   | 是否全屏,默认为false。                                      |
| isLayoutFullScreen<sup>7+</sup> | boolean                   | 是   | 是   | 窗口是否为沉浸式,默认为false。                              |
| focusable<sup>7+</sup>          | boolean                   | 是   | 否   | 窗口是否可聚焦,默认为true。                                 |
| touchable<sup>7+</sup>          | boolean                   | 是   | 否   | 窗口是否可触摸,默认为true。                                 |
| brightness                      | number                    | 是   | 是   | 屏幕亮度, 取值范围为0~1,1表示最大亮度值。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| dimBehindValue<sup>7+</sup>     | number                    | 是   | 是   | 靠后窗口的暗度值,取值范围为0~1,1表示最暗。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isKeepScreenOn                  | boolean                   | 是   | 是   | 屏幕是否常亮,默认为false。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isPrivacyMode<sup>7+</sup>      | boolean                   | 是   | 是   | 隐私模式,默认为false。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isRoundCorner<sup>7+</sup>      | boolean                   | 是   | 是   | 窗口是否为圆角。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isTransparent<sup>7+</sup>      | boolean                   | 是   | 是   | 窗口是否透明。默认为false。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
Z
zengyawen 已提交
151

C
chyyy0213 已提交
152
## ColorSpace<sup>8+</sup><a name="colorspace"></a>
Z
zengyawen 已提交
153

C
chyyy0213 已提交
154
色域模式。
Z
zengyawen 已提交
155

C
chyyy0213 已提交
156 157 158 159 160 161
**系统能力**:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。

| 名称       | 默认值 | 说明           |
| ---------- | ------ | -------------- |
| DEFAULT    | 0      | 默认色域模式。 |
| WIDE_GAMUT | 1      | 广色域模式。   |
Z
zengyawen 已提交
162

Z
zengyawen 已提交
163
## window.create<sup>7+</sup>
Z
zengyawen 已提交
164

C
chyyy0213 已提交
165
create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
166

C
chyyy0213 已提交
167
创建子窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
168

Z
zengyawen 已提交
169 170
从API version 8开始,此接口废弃,推荐使用[window.create<sup>8+</sup>](#windowcreate8)接口。

C
chyyy0213 已提交
171
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
172 173

- 参数
C
chyyy0213 已提交
174 175 176 177 178 179

  | 参数名   | 类型                                   | 必填 | 说明                       |
  | -------- | -------------------------------------- | ---- | -------------------------- |
  | id       | string                                 | 是   | 窗口id。                   |
  | type     | [WindowType](#windowtype)              | 是   | 窗口类型。                 |
  | callback | AsyncCallback&lt;[Window](#window)&gt; | 是   | 回调返回创建的子窗口对象。 |
Z
zengyawen 已提交
180 181 182

- 示例

C
chyyy0213 已提交
183
  ```
C
chyyy0213 已提交
184
   var windowClass = null;
C
chyyy0213 已提交
185
   window.create("first", window.WindowType.TYPE_APP, (err, data) => {
C
chyyy0213 已提交
186
      if (err.code) {
C
chyyy0213 已提交
187 188 189
          console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
          return;
      }
C
chyyy0213 已提交
190
      windowClass = data;
C
chyyy0213 已提交
191 192 193 194 195
      console.info('SubWindow created. Data: ' + JSON.stringify(data))
      windowClass.resetSize(500, 1000);
  });
  ```

Z
zengyawen 已提交
196
## window.create<sup>7+</sup>
C
chyyy0213 已提交
197 198 199 200 201

create(id: string, type: WindowType): Promise&lt;Window&gt;

创建子窗口,使用Promise方式作为异步方法。

Z
zengyawen 已提交
202 203
从API version 8开始,此接口废弃,推荐使用[window.create<sup>8+</sup>](#windowcreate8)接口。

C
chyyy0213 已提交
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                      | 必填 | 说明       |
  | ------ | ------------------------- | ---- | ---------- |
  | id     | string                    | 是   | 窗口id。   |
  | type   | [WindowType](#windowtype) | 是   | 窗口类型。 |

- 返回值

  | 类型                             | 说明                                              |
  | -------------------------------- | ------------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前创建的子窗口对象。 |

- 示例

  ```
C
chyyy0213 已提交
222
   var windowClass = null;
C
chyyy0213 已提交
223 224
   let promise = window.create("first", window.WindowType.TYPE_APP);
   promise.then((data)=> {
C
chyyy0213 已提交
225
   	windowClass = data;
C
chyyy0213 已提交
226 227 228 229 230
      console.info('SubWindow created. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
   });
  ```
C
chyyy0213 已提交
231

C
chyyy0213 已提交
232
## window.create<sup>8+</sup>
Z
zengyawen 已提交
233

C
chyyy0213 已提交
234
create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
235

C
chyyy0213 已提交
236
当Context为[ServiceExtensionContext](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md)时,创建系统窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
237

C
chyyy0213 已提交
238
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
239 240 241

- 参数

C
chyyy0213 已提交
242 243 244 245 246 247
  | 参数名   | 类型                                                         | 必填 | 说明                                                  |
  | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
  | ctx      | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息, 为ServiceExtensionContext的基类。 |
  | id       | string                                                       | 是   | 窗口id。                                              |
  | type     | [WindowType](#windowtype)                                    | 是   | 窗口类型。                                            |
  | callback | AsyncCallback&lt;[Window](#window)&gt;                       | 是   | 回调返回当前窗口对象。                                |
Z
zengyawen 已提交
248

C
chyyy0213 已提交
249
- 示例
Z
zengyawen 已提交
250

C
chyyy0213 已提交
251
  ```
C
chyyy0213 已提交
252
   var windowClass = null;
C
chyyy0213 已提交
253
   window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT, (err, data) => {
C
chyyy0213 已提交
254
      if (err.code) {
C
chyyy0213 已提交
255 256 257
          console.error('Failed to create the Window. Cause: ' + JSON.stringify(err));
          return;
      }
C
chyyy0213 已提交
258
      windowClass = data;
C
chyyy0213 已提交
259 260 261 262 263 264 265
      console.info('Window created. Data: ' + JSON.stringify(data))
      windowClass.resetSize(500, 1000);
  });
  ```

## window.create<sup>8+</sup>

C
chyyy0213 已提交
266
create(ctx: Context, id: string, type: WindowType): Promise&lt;Window&gt;
C
chyyy0213 已提交
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288

当Context为[ServiceExtensionContext](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md)时,创建系统窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                                                         | 必填 | 说明                                                  |
  | ------ | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
  | ctx    | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息, 为ServiceExtensionContext的基类。 |
  | id     | string                                                       | 是   | 窗口id。                                              |
  | type   | [WindowType](#windowtype)                                    | 是   | 窗口类型。                                            |

- 返回值

  | 类型                             | 说明                                            |
  | -------------------------------- | ----------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前创建的窗口对象。 |

- 示例

  ```
C
chyyy0213 已提交
289
   var windowClass = null;
C
chyyy0213 已提交
290 291
   let promise = window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT);
   promise.then((data)=> {
C
chyyy0213 已提交
292
   	windowClass = data;
C
chyyy0213 已提交
293 294 295 296 297
      console.info('Window created. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to create the Window. Cause: ' + JSON.stringify(err));
   });
  ```
Z
zengyawen 已提交
298

C
chyyy0213 已提交
299
## window.find<sup>7+</sup><a name="window-find"></a>
Z
zengyawen 已提交
300 301 302

find(id: string, callback: AsyncCallback&lt;Window&gt;): void

C
chyyy0213 已提交
303
查找id所对应的窗口,使用callback方式作为异步方法。
C
chyyy0213 已提交
304 305

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
306 307

- 参数
C
chyyy0213 已提交
308 309 310 311 312

  | 参数名   | 类型                                   | 必填 | 说明                         |
  | -------- | -------------------------------------- | ---- | ---------------------------- |
  | id       | string                                 | 是   | 窗口id。                     |
  | callback | AsyncCallback&lt;[Window](#window)&gt; | 是   | 回调返回当前查找的窗口对象。 |
Z
zengyawen 已提交
313 314

- 示例
C
chyyy0213 已提交
315

Z
zengyawen 已提交
316
  ```
C
chyyy0213 已提交
317 318
   var windowClass = null;
   window.find("alertWindow", (err, data) => {
C
chyyy0213 已提交
319
     if (err.code) {
C
chyyy0213 已提交
320
         console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
321 322
         return;
     }
C
chyyy0213 已提交
323 324
     windowClass = data;
     console.info('window found. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
  });
  ```

## window.find<sup>7+</sup>

find(id: string): Promise&lt;Window&gt;

查找id所对应的窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型   | 必填 | 说明     |
  | ------ | ------ | ---- | -------- |
  | id     | string | 是   | 窗口id。 |

- 返回值

  | 类型                             | 说明                                            |
  | -------------------------------- | ----------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前查找的窗口对象。 |

- 示例

  ```
C
chyyy0213 已提交
351 352
   var windowClass = null;
   let promise = window.find("alertWindow");
C
chyyy0213 已提交
353
   promise.then((data)=> {
C
chyyy0213 已提交
354
   	windowClass = data;
C
chyyy0213 已提交
355 356 357 358
      console.info('window found. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
   });
Z
zengyawen 已提交
359 360
  ```

C
chyyy0213 已提交
361
## window.getTopWindow<a name="window-gettopwindow"></a>
Z
zengyawen 已提交
362

C
chyyy0213 已提交
363
getTopWindow(callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
364

C
chyyy0213 已提交
365
获取当前应用内最后显示的窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
366

C
chyyy0213 已提交
367
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
368 369

- 参数
C
chyyy0213 已提交
370 371 372 373

  | 参数名   | 类型                                   | 必填 | 说明                                   |
  | -------- | -------------------------------------- | ---- | -------------------------------------- |
  | callback | AsyncCallback&lt;[Window](#window)&gt; | 是   | 回调返回当前应用内最后显示的窗口对象。 |
Z
zengyawen 已提交
374 375

- 示例
C
chyyy0213 已提交
376

Z
zengyawen 已提交
377
  ```
C
chyyy0213 已提交
378
  var windowClass = null;
C
chyyy0213 已提交
379
  window.getTopWindow((err, data) => {
C
chyyy0213 已提交
380
      if (err.code) {
C
chyyy0213 已提交
381
          console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
382 383
          return;
      }
C
chyyy0213 已提交
384
      windowClass = data;
C
chyyy0213 已提交
385
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
Z
zengyawen 已提交
386 387 388
  });
  ```

C
chyyy0213 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
## window.getTopWindow

getTopWindow(): Promise&lt;Window&gt;

获取当前应用内最后显示的窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                             | 说明                                                      |
  | -------------------------------- | --------------------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |

- 示例

  ```
C
chyyy0213 已提交
406
   var windowClass = null;
C
chyyy0213 已提交
407 408
   let promise = window.getTopWindow();
   promise.then((data)=> {
C
chyyy0213 已提交
409
   	windowClass = data;
C
chyyy0213 已提交
410 411 412 413 414 415 416
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
   })
  ```

## window.getTopWindow<sup>8+</sup>
Z
zengyawen 已提交
417

C
chyyy0213 已提交
418
getTopWindow(ctx: Context, callback: AsyncCallback&lt;Window&gt;): void
Z
zengyawen 已提交
419

C
chyyy0213 已提交
420
获取当前应用内最后显示的窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
421

C
chyyy0213 已提交
422
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
423 424

- 参数
C
chyyy0213 已提交
425 426 427 428 429

  | 参数名   | 类型                                                         | 必填 | 说明                                   |
  | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
  | ctx      | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息。                   |
  | callback | AsyncCallback&lt;[Window](#window)&gt;                       | 是   | 回调返回当前应用内最后显示的窗口对象。 |
Z
zengyawen 已提交
430 431

- 示例
C
chyyy0213 已提交
432

Z
zengyawen 已提交
433
  ```
C
chyyy0213 已提交
434
  var windowClass = null;
C
chyyy0213 已提交
435
  window.getTopWindow(this.context, (err, data) => {
C
chyyy0213 已提交
436
      if (err.code) {
C
chyyy0213 已提交
437
          console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
438 439
          return;
      }
C
chyyy0213 已提交
440
      windowClass = data;
C
chyyy0213 已提交
441
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
Z
zengyawen 已提交
442 443 444
  });
  ```

C
chyyy0213 已提交
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
## window.getTopWindow<sup>8+</sup>

getTopWindow(ctx: Context): Promise&lt;Window&gt;

获取当前应用内最后显示的窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                                                         | 必填 | 说明                 |
  | ------ | ------------------------------------------------------------ | ---- | -------------------- |
  | ctx    | [Context](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md) | 是   | 当前应用上下文信息。 |

- 返回值

  | 类型                             | 说明                                                      |
  | -------------------------------- | --------------------------------------------------------- |
  | Promise&lt;[Window](#window)&gt; | 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |

- 示例

  ```
C
chyyy0213 已提交
468
   var windowClass = null;
C
chyyy0213 已提交
469 470
   let promise = window.getTopWindow(this.context);
   promise.then((data)=> {
C
chyyy0213 已提交
471
   	windowClass = data;
C
chyyy0213 已提交
472 473 474 475 476 477
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
478
## on('systemBarTintChange')<sup>8+</sup>
Z
zengyawen 已提交
479

C
chyyy0213 已提交
480
on(type: 'systemBarTintChange', callback: Callback&lt;SystemBarTintState&gt;): void
Z
zengyawen 已提交
481

C
chyyy0213 已提交
482
注册状态栏、导航栏的监听函数。
Z
zengyawen 已提交
483

C
chyyy0213 已提交
484 485
此接口为系统接口,三方应用不支持调用。

C
chyyy0213 已提交
486
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
487 488

- 参数
C
chyyy0213 已提交
489 490 491 492 493

  | 参数名   | 类型                                                      | 必填 | 说明                                                         |
  | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                                                    | 是   | 设置监听类型。<br/>-&nbsp;type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听; |
  | callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 是   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
494 495

- 示例
C
chyyy0213 已提交
496

Z
zengyawen 已提交
497
  ```
C
chyyy0213 已提交
498 499 500
  var type = 'systemBarTintChange';
  windowClass.on(type, (data) => {
      console.info('Succeeded in enabling the listener for systemBarTint changes. Data: ' + JSON.stringify(data));
Z
zengyawen 已提交
501 502 503
  });
  ```

C
chyyy0213 已提交
504
## off('systemBarTintChange')<sup>8+</sup>
Z
zengyawen 已提交
505

C
chyyy0213 已提交
506
off(type: 'systemBarTintChange', callback?: Callback&lt;SystemBarTintState &gt;): void
Z
zengyawen 已提交
507

C
chyyy0213 已提交
508
关闭监听。
Z
zengyawen 已提交
509

C
chyyy0213 已提交
510 511
此接口为系统接口,三方应用不支持调用。

C
chyyy0213 已提交
512
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
513 514

- 参数
C
chyyy0213 已提交
515 516 517 518 519

  | 参数名   | 类型                                                      | 必填 | 说明                                                         |
  | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                                                    | 是   | 设置监听类型。<br/>-&nbsp;type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听; |
  | callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 否   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
520 521

- 示例
C
chyyy0213 已提交
522

Z
zengyawen 已提交
523
  ```
C
chyyy0213 已提交
524 525
  var type = 'systemBarTintChange';
  windowClass.off(type);
Z
zengyawen 已提交
526 527 528 529
  ```

## Window

Z
zengyawen 已提交
530
下列API示例中都需使用[getTopWindow()](#window-gettopwindow)[create()](#windowcreate7)[find()](#window-find)等先获取到Window实例,再通过此实例调用对应方法。
Z
zengyawen 已提交
531

C
chyyy0213 已提交
532
### hide<sup>7+</sup>
Z
zengyawen 已提交
533

C
chyyy0213 已提交
534
hide (callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
535

C
chyyy0213 已提交
536
隐藏当前窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
537

C
chyyy0213 已提交
538 539
此接口为系统接口,三方应用不支持调用。

C
chyyy0213 已提交
540
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
541 542

- 参数
C
chyyy0213 已提交
543 544 545 546

  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
547 548

- 示例
C
chyyy0213 已提交
549

Z
zengyawen 已提交
550
  ```
C
chyyy0213 已提交
551
  windowClass.hide((err, data) => {
C
chyyy0213 已提交
552
      if (err.code) {
C
chyyy0213 已提交
553
          console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
554 555
          return;
      }
C
chyyy0213 已提交
556
      console.info('window hidden. data: ' + JSON.stringify(data))
C
chyyy0213 已提交
557
  })
Z
zengyawen 已提交
558 559
  ```

C
chyyy0213 已提交
560 561
### hide<sup>7+</sup>

C
chyyy0213 已提交
562
hide(): Promise&lt;void&gt;
C
chyyy0213 已提交
563 564 565

隐藏当前窗口,使用Promise方式作为异步方法。

C
chyyy0213 已提交
566 567
此接口为系统接口,三方应用不支持调用。

C
chyyy0213 已提交
568 569 570 571 572 573 574 575 576 577 578 579
**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.hide();
C
chyyy0213 已提交
580 581
   promise.then((data)=> {
      console.info('window hidden. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
582 583 584 585 586
   }).catch((err)=>{
      console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
587
### show<sup>7+</sup>
Z
zengyawen 已提交
588

C
chyyy0213 已提交
589
show(callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
590

C
chyyy0213 已提交
591
显示当前窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
592

C
chyyy0213 已提交
593
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
594 595

- 参数
C
chyyy0213 已提交
596 597 598 599

  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
600 601

- 示例
C
chyyy0213 已提交
602

Z
zengyawen 已提交
603
  ```
C
chyyy0213 已提交
604
  windowClass.show((err, data) => {
C
chyyy0213 已提交
605
      if (err.code) {
C
chyyy0213 已提交
606
          console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
607 608
          return;
      }
C
chyyy0213 已提交
609
      console.info('Succeeded in showing the window. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
610
  })
Z
zengyawen 已提交
611 612
  ```

C
chyyy0213 已提交
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
### show<sup>7+</sup>

show(): Promise&lt;void&gt;

显示当前窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.show();
C
chyyy0213 已提交
631 632
   promise.then((data)=> {
      console.info('Succeeded in showing the window. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
633 634 635 636 637
   }).catch((err)=>{
      console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
638 639 640
### destroy<sup>7+</sup>

destroy(callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
641

C
chyyy0213 已提交
642
销毁当前窗口,使用callback方式作为异步方法。
Z
zengyawen 已提交
643

C
chyyy0213 已提交
644
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
645 646

- 参数
C
chyyy0213 已提交
647 648 649 650

  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
651 652

- 示例
C
chyyy0213 已提交
653

Z
zengyawen 已提交
654
  ```
C
chyyy0213 已提交
655
  windowClass.destroy((err, data) => {
C
chyyy0213 已提交
656
      if (err.code) {
C
chyyy0213 已提交
657
          console.error('Failed to destroy the window. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
658 659
          return;
      }
C
chyyy0213 已提交
660
      console.info('Succeeded in destroying the window. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
661
  })
Z
zengyawen 已提交
662 663
  ```

C
chyyy0213 已提交
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
### destroy<sup>7+</sup>

destroy(): Promise&lt;void&gt;

销毁当前窗口,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.destroy();
C
chyyy0213 已提交
682 683
   promise.then((data)=> {
      console.info('Succeeded in destroying the window. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
684 685 686 687 688
   }).catch((err)=>{
      console.error('Failed to destroy the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
689
### moveTo<sup>7+</sup>
Z
zengyawen 已提交
690

C
chyyy0213 已提交
691
moveTo(x: number, y: number, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
692

C
chyyy0213 已提交
693
移动窗口位置,使用callback方式作为异步方法。
C
chyyy0213 已提交
694 695

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
696 697

- 参数
C
chyyy0213 已提交
698 699 700 701 702 703

  | 参数名   | 类型                      | 必填 | 说明                                    |
  | -------- | ------------------------- | ---- | --------------------------------------- |
  | x        | number                    | 是   | 窗口在x轴方向移动的值,值为正表示右移。 |
  | y        | number                    | 是   | 窗口在y轴方向移动的值,值为正表示下移。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。                              |
Z
zengyawen 已提交
704 705

- 示例
C
chyyy0213 已提交
706

Z
zengyawen 已提交
707
  ```
C
chyyy0213 已提交
708
  windowClass.moveTo(300, 300, (err, data)=>{
C
chyyy0213 已提交
709
      if (err.code) {
C
chyyy0213 已提交
710
          console.error('Failed to move the window. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
711 712
          return;
      }
C
chyyy0213 已提交
713
      console.info('Window moved. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
714
  
Z
zengyawen 已提交
715 716 717
  });
  ```

C
chyyy0213 已提交
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
### moveTo<sup>7+</sup>

moveTo(x: number, y: number): Promise&lt;void&gt;

移动窗口位置,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型   | 必填 | 说明                                    |
  | ------ | ------ | ---- | --------------------------------------- |
  | x      | number | 是   | 窗口在x轴方向移动的值,值为正表示右移。 |
  | y      | number | 是   | 窗口在y轴方向移动的值,值为正表示下移。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.moveTo(300, 300);
C
chyyy0213 已提交
743 744
   promise.then((data)=> {
      console.info('Window moved. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
745 746 747 748 749
   }).catch((err)=>{
      console.error('Failed to move the window. Cause: ' + JSON.stringify(err));
   })
  ```

C
chyyy0213 已提交
750 751 752
### resetSize<sup>7+</sup>

resetSize(width: number, height: number, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
753

C
chyyy0213 已提交
754
改变当前窗口大小,使用callback方式作为异步方法。
Z
zengyawen 已提交
755

C
chyyy0213 已提交
756
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
757 758

- 参数
C
chyyy0213 已提交
759 760 761 762 763 764

  | 参数名   | 类型                      | 必填 | 说明             |
  | -------- | ------------------------- | ---- | ---------------- |
  | width    | number                    | 是   | 目标窗口的宽度。 |
  | height   | number                    | 是   | 目标窗口的高度。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。       |
Z
zengyawen 已提交
765 766

- 示例
C
chyyy0213 已提交
767

Z
zengyawen 已提交
768
  ```
C
chyyy0213 已提交
769
  windowClass.resetSize(500, 1000, (err, data) => {
C
chyyy0213 已提交
770
      if (err.code) {
C
chyyy0213 已提交
771
          console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
772 773
          return;
      }
C
chyyy0213 已提交
774
      console.info('Window size changed. Data: ' + JSON.stringify(data))
Z
zengyawen 已提交
775 776 777
  });
  ```

C
chyyy0213 已提交
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
### resetSize<sup>7+</sup>

resetSize(width: number, height: number): Promise&lt;void&gt;

改变当前窗口大小,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型   | 必填 | 说明             |
  | ------ | ------ | ---- | ---------------- |
  | width  | number | 是   | 目标窗口的宽度。 |
  | height | number | 是   | 目标窗口的高度。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   let promise = windowClass.resetSize(500, 1000);
C
chyyy0213 已提交
803 804
   promise.then((data)=> {
      console.info('Window size changed. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
805 806 807 808 809
   }).catch((err)=>{
      console.error('Failed to change the window size. Cause: ' + JSON.stringify(err));
   });
  ```

810 811 812 813
### setWindowType<sup>7+</sup>

setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void

C
chyyy0213 已提交
814
设置窗口类型,使用callback方式作为异步方法。
815

C
chyyy0213 已提交
816 817
此接口为系统接口,三方应用不支持调用。

C
chyyy0213 已提交
818 819
**系统能力**:SystemCapability.WindowManager.WindowManager.Core

820
- 参数
C
chyyy0213 已提交
821

C
chyyy0213 已提交
822 823 824 825
  | 参数名   | 类型                      | 必填 | 说明       |
  | -------- | ------------------------- | ---- | ---------- |
  | type     | [WindowType](#windowtype) | 是   | 窗口类型。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
826 827

- 示例
C
chyyy0213 已提交
828

829 830
  ```
  var type = window.TYPE_APP;
C
chyyy0213 已提交
831
  windowClass.setWindowType(type, (err, data) => {
C
chyyy0213 已提交
832
    if (err.code) {
833 834 835
        console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
        return;
    }
C
chyyy0213 已提交
836
    console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data))
837 838 839
  });
  ```

C
chyyy0213 已提交
840 841 842 843 844 845
### setWindowType<sup>7+</sup>

setWindowType(type: WindowType): Promise&lt;void&gt;

设置窗口类型,使用Promise方式作为异步方法。

C
chyyy0213 已提交
846 847
此接口为系统接口,三方应用不支持调用。

C
chyyy0213 已提交
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                      | 必填 | 说明       |
  | ------ | ------------------------- | ---- | ---------- |
  | type   | [WindowType](#windowtype) | 是   | 窗口类型。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
   var type = window.TYPE_APP;
   let promise = windowClass.setWindowType(type);
C
chyyy0213 已提交
867 868
   promise.then((data)=> {
      console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
869 870 871 872 873
   }).catch((err)=>{
      console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
   });
  ```

C
chyyy0213 已提交
874
### getProperties
Z
zengyawen 已提交
875

C
chyyy0213 已提交
876
getProperties(callback: AsyncCallback&lt;WindowProperties&gt;): void
Z
zengyawen 已提交
877

C
chyyy0213 已提交
878
获取当前窗口的属性,使用callback方式作为异步方法返回WindowProperties。
Z
zengyawen 已提交
879

C
chyyy0213 已提交
880
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
881 882

- 参数
C
chyyy0213 已提交
883 884 885 886

  | 参数名   | 类型                                                       | 必填 | 说明               |
  | -------- | ---------------------------------------------------------- | ---- | ------------------ |
  | callback | AsyncCallback&lt;[WindowProperties](#windowproperties)&gt; | 是   | 回调返回窗口属性。 |
Z
zengyawen 已提交
887 888

- 示例
C
chyyy0213 已提交
889

Z
zengyawen 已提交
890
  ```
C
chyyy0213 已提交
891
  windowClass.getProperties((err, data) => {
C
chyyy0213 已提交
892
      if (err.code) {
C
chyyy0213 已提交
893
          console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
894 895
          return;
      }
C
chyyy0213 已提交
896
      console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
Z
zengyawen 已提交
897 898 899
  });
  ```

C
chyyy0213 已提交
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
### getProperties

getProperties(): Promise&lt;WindowProperties&gt;

获取当前窗口的属性,使用promise方式作为异步方法返回WindowProperties。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                                                 | 说明                                  |
  | ---------------------------------------------------- | ------------------------------------- |
  | Promise&lt;[WindowProperties](#windowproperties)&gt; | 以Promise形式返回结果,返回窗口属性。 |

- 示例

  ```
   let promise = windowClass.getProperties();
   promise.then((data)=> {
      console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
   });
  ```

C
chyyy0213 已提交
925
### getAvoidArea<sup>7+</sup>
Z
zengyawen 已提交
926

C
chyyy0213 已提交
927
getAvoidArea(type: AvoidAreaType, callback: AsyncCallback&lt;AvoidArea&gt;): void
Z
zengyawen 已提交
928

C
chyyy0213 已提交
929
获取窗口内容规避的区域,如系统的系统栏区域、凹凸区域。使用callback方式作为异步方法。
C
chyyy0213 已提交
930 931

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
932 933

- 参数
C
chyyy0213 已提交
934 935 936 937 938

  | 参数名   | 类型                                         | 必填 | 说明                                                         |
  | -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | [AvoidAreaType](#avoidareatype)              | 是   | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏区域。 |
  | callback | AsyncCallback&lt;[AvoidArea](#avoidarea)&gt; | 是   | 回调返回窗口内容规避区域。                                   |
Z
zengyawen 已提交
939 940

- 示例
C
chyyy0213 已提交
941

Z
zengyawen 已提交
942
  ```
C
chyyy0213 已提交
943 944
  var type = window.AvoidAreaType.TYPE_SYSTEM;
  windowClass.getAvoidArea(type, (err, data) => {
C
chyyy0213 已提交
945
      if (err.code) {
C
chyyy0213 已提交
946
          console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
947 948
          return;
      }
C
chyyy0213 已提交
949
      console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
Z
zengyawen 已提交
950 951 952
  });
  ```

C
chyyy0213 已提交
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
### getAvoidArea<sup>7+</sup>

getAvoidArea(type: AvoidAreaType): Promise&lt;AvoidArea&gt;

获取窗口内容规避的区域,如系统的系统栏区域、凹凸区域。使用promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型                            | 必填 | 说明                                                         |
  | ------ | ------------------------------- | ---- | ------------------------------------------------------------ |
  | type   | [AvoidAreaType](#avoidareatype) | 是   | 表示规避区类型。type为TYPE_SYSTEM,表示系统默认区域。type为TYPE_CUTOUT,表示刘海屏区域。 |

- 返回值

  | 类型                                   | 说明                                          |
  | -------------------------------------- | --------------------------------------------- |
  | Promise&lt;[AvoidArea](#avoidarea)&gt; | 以Promise形式返回结果,返回窗口内容规避区域。 |

- 示例

  ```
   let promise = windowClass.getAvoidArea();
   promise.then((data)=> {
      console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data))
   }).catch((err)=>{
      console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
   });
  ```

C
chyyy0213 已提交
984 985 986
### setFullScreen

setFullScreen(isFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
987

C
chyyy0213 已提交
988
设置是否为全屏状态,使用callback方式作为异步方法。
Z
zengyawen 已提交
989

C
chyyy0213 已提交
990
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
991 992

- 参数
C
chyyy0213 已提交
993 994 995 996 997

  | 参数名       | 类型                      | 必填 | 说明                                           |
  | ------------ | ------------------------- | ---- | ---------------------------------------------- |
  | isFullScreen | boolean                   | 是   | 是否设为全屏状态,且全屏状态隐藏状态栏导航栏。 |
  | callback     | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                     |
Z
zengyawen 已提交
998 999

- 示例
C
chyyy0213 已提交
1000

Z
zengyawen 已提交
1001
  ```
C
chyyy0213 已提交
1002
  var isFullScreen = true;
C
chyyy0213 已提交
1003
  windowClass.setFullScreen(isFullScreen, (err, data) => {
C
chyyy0213 已提交
1004
      if (err.code) {
C
chyyy0213 已提交
1005
          console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
1006 1007
          return;
      }
C
chyyy0213 已提交
1008
      console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
  });
  ```

### setFullScreen

setFullScreen(isFullScreen: boolean): Promise&lt;void&gt;

设置是否为全屏状态,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名       | 类型    | 必填 | 说明                                           |
  | ------------ | ------- | ---- | ---------------------------------------------- |
  | isFullScreen | boolean | 是   | 是否设为全屏状态,且全屏状态隐藏状态栏导航栏。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isFullScreen = true;
  let promise = windowClass.setFullScreen(isFullScreen);
C
chyyy0213 已提交
1037 1038
  promise.then((data)=> {
      console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1039 1040
  }).catch((err)=>{
      console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
1041 1042 1043
  });
  ```

C
chyyy0213 已提交
1044 1045 1046
### setLayoutFullScreen<sup>7+</sup>

setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
1047

C
chyyy0213 已提交
1048
设置窗口的布局是否为全屏显示状态,使用callback方式作为异步方法。
Z
zengyawen 已提交
1049

C
chyyy0213 已提交
1050
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1051 1052

- 参数
C
chyyy0213 已提交
1053

C
chyyy0213 已提交
1054 1055 1056 1057
  | 参数名             | 类型                      | 必填 | 说明                                                         |
  | ------------------ | ------------------------- | ---- | ------------------------------------------------------------ |
  | isLayoutFullScreen | boolean                   | 是   | 窗口的布局是否为全屏显示状态,且全屏状态下状态栏、导航栏仍然显示。 |
  | callback           | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                                   |
Z
zengyawen 已提交
1058 1059

- 示例
C
chyyy0213 已提交
1060

Z
zengyawen 已提交
1061
  ```
C
chyyy0213 已提交
1062
  var isLayoutFullScreen= true;
C
chyyy0213 已提交
1063
  windowClass.setLayoutFullScreen(isLayoutFullScreen, (err, data) => {
C
chyyy0213 已提交
1064
      if (err.code) {
C
chyyy0213 已提交
1065
          console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1066 1067
          return;
      }
C
chyyy0213 已提交
1068
      console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
  });
  ```

### setLayoutFullScreen<sup>7+</sup>

setLayoutFullScreen(isLayoutFullScreen: boolean): Promise&lt;void&gt;

设置窗口的布局是否为全屏显示状态,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名             | 类型    | 必填 | 说明                                                         |
  | ------------------ | ------- | ---- | ------------------------------------------------------------ |
  | isLayoutFullScreen | boolean | 是   | 窗口的布局是否为全屏显示状态,且全屏状态下状态栏、导航栏仍然显示。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isLayoutFullScreen = true;
  let promise = windowClass.setLayoutFullScreen(isLayoutFullScreen);
C
chyyy0213 已提交
1097 1098
  promise.then((data)=> {
      console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1099 1100
  }).catch((err)=>{
      console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1101 1102 1103 1104 1105
  });
  ```

### setSystemBarEnable<sup>7+</sup>

C
chyyy0213 已提交
1106
setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
1107

C
chyyy0213 已提交
1108
设置导航栏、状态栏的可见模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1109

C
chyyy0213 已提交
1110 1111
**系统能力**:SystemCapability.WindowManager.WindowManager.Core

Z
zengyawen 已提交
1112
- 参数
C
chyyy0213 已提交
1113 1114 1115 1116 1117

  | 参数名   | 类型                      | 必填 | 说明                                                         |
  | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
  | names    | Array                     | 是   | 设置状态栏和导航栏是否显示。例如,需全部显示,该参数设置为["status",&nbsp;"navigation"], 不设置,则默认不显示。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                                   |
Z
zengyawen 已提交
1118 1119

- 示例
C
chyyy0213 已提交
1120

Z
zengyawen 已提交
1121 1122
  ```
  var names = ["status", "navigation"];
C
chyyy0213 已提交
1123
  windowClass.setSystemBarEnable(names, (err, data) => {
C
chyyy0213 已提交
1124
      if (err.code) {
Z
zengyawen 已提交
1125 1126 1127
          console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
          return;
      }
C
chyyy0213 已提交
1128
      console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
  });
  ```

### setSystemBarEnable<sup>7+</sup>

setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise&lt;void&gt;

设置导航栏、状态栏的可见模式,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型  | 必填 | 说明                                                         |
  | ------ | ----- | ---- | ------------------------------------------------------------ |
  | names  | Array | 是   | 设置状态栏和导航栏是否显示。例如,需全部显示,该参数设置为["status",&nbsp;"navigation"], 不设置,则默认不显示。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var names = ["status", "navigation"];
  let promise = windowClass.setSystemBarEnable(names);
C
chyyy0213 已提交
1157 1158
  promise.then((data)=> {
      console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1159 1160
  }).catch((err)=>{
      console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1161 1162 1163 1164 1165 1166 1167
  });
  ```

### setSystemBarProperties

setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback&lt;void&gt;): void

C
chyyy0213 已提交
1168
设置窗口内导航栏、状态栏的属性,使用callback方式作为异步方法。
C
chyyy0213 已提交
1169 1170

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1171 1172

- 参数
C
chyyy0213 已提交
1173 1174 1175 1176 1177

  | 参数名              | 类型                                        | 必填 | 说明                 |
  | ------------------- | ------------------------------------------- | ---- | -------------------- |
  | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是   | 导航栏状态栏的属性。 |
  | callback            | AsyncCallback&lt;void&gt;                   | 是   | 回调函数。           |
Z
zengyawen 已提交
1178 1179

- 示例
C
chyyy0213 已提交
1180

Z
zengyawen 已提交
1181 1182 1183 1184 1185 1186
  ```
  var SystemBarProperties={
      statusBarColor: '#ff00ff',
      navigationBarColor: '#00ff00',
      //以下两个属性从API Version7开始支持
      isStatusBarLightIcon: true,
C
chyyy0213 已提交
1187 1188
      isNavigationBarLightIcon:false,
      //以下两个属性从API Version8开始支持
C
chyyy0213 已提交
1189
      statusBarContentColor:'#ffffff',
C
chyyy0213 已提交
1190
      navigationBarContentColor:'#00ffff'
Z
zengyawen 已提交
1191
  };
C
chyyy0213 已提交
1192
  windowClass.setSystemBarProperties(SystemBarProperties, (err, data) => {
C
chyyy0213 已提交
1193
      if (err.code) {
Z
zengyawen 已提交
1194 1195 1196
          console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
          return;
      }
C
chyyy0213 已提交
1197
      console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
  });
  ```

### setSystemBarProperties

setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise&lt;void&gt;

设置窗口内导航栏、状态栏的属性,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名              | 类型                                        | 必填 | 说明                 |
  | ------------------- | ------------------------------------------- | ---- | -------------------- |
  | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是   | 导航栏状态栏的属性。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var SystemBarProperties={
      statusBarColor: '#ff00ff',
      navigationBarColor: '#00ff00',
      //以下两个属性从API Version7开始支持
      isStatusBarLightIcon: true,
      isNavigationBarLightIcon:false,
      //以下两个属性从API Version8开始支持
C
chyyy0213 已提交
1231
      statusBarContentColor:'#ffffff',
C
chyyy0213 已提交
1232 1233 1234
      navigationBarContentColor:'#00ffff'
  };
  let promise = windowClass.setSystemBarProperties(SystemBarProperties);
C
chyyy0213 已提交
1235 1236
  promise.then((data)=> {
      console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1237 1238
  }).catch((err)=>{
      console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
1239 1240 1241
  });
  ```

C
chyyy0213 已提交
1242
### loadContent<sup>7+</sup>
Z
zengyawen 已提交
1243

C
chyyy0213 已提交
1244
loadContent(path: string, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
1245

C
chyyy0213 已提交
1246
当前窗口加载具体页面内容,使用callback方式作为异步方法。
Z
zengyawen 已提交
1247

C
chyyy0213 已提交
1248
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1249 1250 1251

- 参数

C
chyyy0213 已提交
1252 1253
  | 参数名   | 类型                      | 必填 | 说明                 |
  | -------- | ------------------------- | ---- | -------------------- |
C
chyyy0213 已提交
1254 1255
  | path     | string                    | 是   | 设置加载页面的路径。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。           |
C
chyyy0213 已提交
1256
  
Z
zengyawen 已提交
1257 1258 1259
- 示例

  ```
C
chyyy0213 已提交
1260
  windowClass.loadContent("pages/page2/page2", (err, data) => {
C
chyyy0213 已提交
1261
     if (err.code) {
Z
zengyawen 已提交
1262 1263 1264
           console.error('Failed to load the content. Cause:' + JSON.stringify(err));
           return;
     }
C
chyyy0213 已提交
1265
    console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1266 1267 1268
  });
  ```

C
chyyy0213 已提交
1269
### loadContent<sup>7+</sup>
C
chyyy0213 已提交
1270

C
chyyy0213 已提交
1271
loadContent(path: string): Promise&lt;void&gt;
C
chyyy0213 已提交
1272 1273 1274 1275 1276 1277 1278

当前窗口加载具体页面内容,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

C
chyyy0213 已提交
1279 1280 1281 1282
  | 参数名 | 类型   | 必填 | 说明                 |
  | ------ | ------ | ---- | -------------------- |
  | path   | string | 是   | 设置加载页面的路径。 |
  
C
chyyy0213 已提交
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  let promise = windowClass.loadContent("pages/page2/page2");
C
chyyy0213 已提交
1293 1294
  promise.then((data)=> {
      console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1295 1296
  }).catch((err)=>{
      console.error('Failed to load the content. Cause: ' + JSON.stringify(err));
Z
zengyawen 已提交
1297 1298 1299
  });
  ```

C
chyyy0213 已提交
1300
### isShowing<sup>7+</sup>
Z
zengyawen 已提交
1301

C
chyyy0213 已提交
1302 1303
isShowing(callback: AsyncCallback&lt;boolean&gt;): void

C
chyyy0213 已提交
1304
判断当前窗口是否已显示,使用callback方式作为异步方法。
Z
zengyawen 已提交
1305

C
chyyy0213 已提交
1306
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1307 1308

- 参数
C
chyyy0213 已提交
1309

C
chyyy0213 已提交
1310 1311
  | 参数名   | 类型                         | 必填 | 说明                             |
  | -------- | ---------------------------- | ---- | -------------------------------- |
C
chyyy0213 已提交
1312
  | callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数返回是否显示子窗口结果。 |
Z
zengyawen 已提交
1313 1314

- 示例
C
chyyy0213 已提交
1315

Z
zengyawen 已提交
1316
  ```
C
chyyy0213 已提交
1317
  windowClass.isShowing((err, data) => {
C
chyyy0213 已提交
1318
      if (err.code) {
C
chyyy0213 已提交
1319
          console.error('Failed to check whether the window is showing. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1320 1321
          return;
      }
C
chyyy0213 已提交
1322
      console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
  });
  ```

### isShowing<sup>7+</sup>

isShowing(): Promise&lt;boolean&gt;

判断当前窗口是否已显示,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                   | 说明                                                  |
  | ---------------------- | ----------------------------------------------------- |
  | Promise&lt;boolean&gt; | 以Promise形式返回结果,返回当前窗口是否已显示的结果。 |

- 示例

  ```
  let promise = windowClass.isShowing();
C
chyyy0213 已提交
1344 1345
  promise.then((data)=> {
      console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1346 1347 1348
  }).catch((err)=>{
      console.error('Failed to check whether the window is showing. Cause: ' + JSON.stringify(err));
  });
Z
zengyawen 已提交
1349 1350
  ```

C
chyyy0213 已提交
1351
### on('windowSizeChange')<sup>7+</sup>
Z
zengyawen 已提交
1352

C
chyyy0213 已提交
1353
on(type:  'windowSizeChange', callback: Callback&lt;Size&gt;): void
Z
zengyawen 已提交
1354

C
chyyy0213 已提交
1355 1356 1357
开启监听。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1358 1359

- 参数
C
chyyy0213 已提交
1360

C
chyyy0213 已提交
1361 1362 1363 1364
  | 参数名   | 类型                          | 必填 | 说明                                                         |
  | -------- | ----------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                        | 是   | 设置监听类型。<br/>-&nbsp;type为'windowSizeChange'时表示监听类型为窗口尺寸变化监听; |
  | callback | Callback&lt;[Size](#size)&gt; | 是   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
1365 1366

- 示例
C
chyyy0213 已提交
1367

Z
zengyawen 已提交
1368
  ```
C
chyyy0213 已提交
1369 1370 1371 1372
  var type = 'windowSizeChange';
  windowClass.on(type, (data) => {
      console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data));
  });
Z
zengyawen 已提交
1373 1374
  ```

C
chyyy0213 已提交
1375
### off('windowSizeChange')<sup>7+</sup>
Z
zengyawen 已提交
1376

C
chyyy0213 已提交
1377
off(type: 'windowSizeChange', callback?: Callback&lt;Size &gt;): void
Z
zengyawen 已提交
1378

C
chyyy0213 已提交
1379 1380 1381
关闭监听。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1382 1383

- 参数
C
chyyy0213 已提交
1384

C
chyyy0213 已提交
1385 1386 1387 1388
  | 参数名   | 类型                          | 必填 | 说明                                                         |
  | -------- | ----------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                        | 是   | 设置监听类型。<br/>-&nbsp;type为'windowSizeChange'<sup>7+</sup>时表示监听类型为窗口尺寸变化监听; |
  | callback | Callback&lt;[Size](#size)&gt; | 否   | 回调返回监听到的信息。                                       |
Z
zengyawen 已提交
1389 1390

- 示例
C
chyyy0213 已提交
1391

Z
zengyawen 已提交
1392
  ```
C
chyyy0213 已提交
1393 1394
  var type = 'windowSizeChange';
  windowClass.off(type);
Z
zengyawen 已提交
1395 1396
  ```

C
chyyy0213 已提交
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
### on('systemAvoidAreaChange')<sup>7+</sup>

on(type: 'systemAvoidAreaChange', callback: Callback&lt;AvoidArea&gt;): void

开启监听。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名   | 类型                                    | 必填 | 说明                                                         |
  | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                                  | 是   | 设置监听类型。<br/>-&nbsp;type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听。 |
  | callback | Callback&lt;[AvoidArea](#avoidarea)&gt; | 是   | 回调返回监听到的信息。                                       |

- 示例

  ```
  var type = 'systemAvoidAreaChange';
  windowClass.on(type, (data) => {
      console.info('Succeeded in enabling the listener for system avoid area changes. Data: ' + JSON.stringify(data));
  });
  ```

### off('systemAvoidAreaChange')<sup>7+</sup>

off(type: 'systemAvoidAreaChange', callback?: Callback&lt;AvoidArea&gt;): void

关闭监听。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名   | 类型                                    | 必填 | 说明                                                         |
  | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                                  | 是   | 设置监听类型。<br/>-&nbsp;type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听。 |
  | callback | Callback&lt;[AvoidArea](#avoidarea)&gt; | 否   | 回调返回监听到的信息。                                       |

- 示例

  ```
  var type = 'systemAvoidAreaChange';
  windowClass.off(type);
  ```

C
chyyy0213 已提交
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
### on('keyboardHeightChange')<sup>7+</sup>

on(type: 'keyboardHeightChange', callback: Callback&lt;number&gt;): void

开启键盘高度变化的监听。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名   | 类型                                    | 必填 | 说明                                                         |
  | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                                  | 是   | 设置监听类型。<br/>-&nbsp;type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听。 |
  | callback | Callback&lt;[AvoidArea](#avoidarea)&gt; | 是   | 回调返回监听到的信息。                                       |

- 示例

  ```
  var type = 'keyboardHeightChange';
  windowClass.on(type, (data) => {
      console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data));
  });
  ```

### off('keyboardHeightChange')<sup>7+</sup>

off(type: 'keyboardHeightChange', callback?: Callback&lt;number&gt;): void

关闭键盘高度变化的监听。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名   | 类型                   | 必填 | 说明                                                         |
  | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
  | type     | string                 | 是   | 设置监听类型。<br/>-&nbsp;type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听。 |
  | callback | Callback&lt;number&gt; | 否   | 回调返回监听到的信息。                                       |

- 示例

  ```
  var type = 'keyboardHeightChange';
  windowClass.off(type);
  ```

C
chyyy0213 已提交
1493
### isSupportWideGamut<sup>8+</sup>
Z
zengyawen 已提交
1494

C
chyyy0213 已提交
1495
isSupportWideGamut(callback: AsyncCallback&lt;boolean&gt;): void
C
chyyy0213 已提交
1496

C
chyyy0213 已提交
1497
判断当前窗口是否支持广色域模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1498

C
chyyy0213 已提交
1499
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1500 1501

- 参数
C
chyyy0213 已提交
1502 1503 1504 1505

  | 参数名   | 类型                         | 必填 | 说明                             |
  | -------- | ---------------------------- | ---- | -------------------------------- |
  | callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数返回是否支持广色域模式。 |
Z
zengyawen 已提交
1506 1507

- 示例
C
chyyy0213 已提交
1508

Z
zengyawen 已提交
1509
  ```
C
chyyy0213 已提交
1510
  windowClass.isSupportWideGamut((err, data) => {
C
chyyy0213 已提交
1511
      if (err.code) {
C
chyyy0213 已提交
1512
          console.error('Failed to check whether the window support WideGamut. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1513 1514
          return;
      }
C
chyyy0213 已提交
1515
      console.info('Succeeded in checking whether the window support WideGamut Data: ' + JSON.stringify(data))
Z
zengyawen 已提交
1516 1517 1518
  })
  ```

C
chyyy0213 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
### isSupportWideGamut<sup>8+</sup>

isSupportWideGamut(): Promise&lt;boolean&gt;

判断当前窗口是否支持广色域模式,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                   | 说明                                                         |
  | ---------------------- | ------------------------------------------------------------ |
  | Promise&lt;boolean&gt; | 以Promise形式返回结果,返回当前窗口是否支持广色域模式的结果。 |

- 示例

  ```
  let promise = windowClass.isSupportWideGamut();
C
chyyy0213 已提交
1537 1538
  promise.then((data)=> {
      console.info('Succeeded in checking whether the window support WideGamut. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1539 1540 1541 1542 1543
  }).catch((err)=>{
      console.error('Failed to check whether the window support WideGamut. Cause: ' + JSON.stringify(err));
  });
  ```

C
chyyy0213 已提交
1544 1545
### setColorSpace<sup>8+</sup>

C
chyyy0213 已提交
1546
setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
1547

C
chyyy0213 已提交
1548
设置当前窗口为广色域模式或默认色域模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1549

C
chyyy0213 已提交
1550
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1551 1552

- 参数
C
chyyy0213 已提交
1553 1554 1555 1556 1557

  | 参数名     | 类型                      | 必填 | 说明         |
  | ---------- | ------------------------- | ---- | ------------ |
  | colorSpace | [ColorSpace](#colorspace) | 是   | 设置色域模式 |
  | callback   | AsyncCallback&lt;void&gt; | 是   | 回调函数。   |
Z
zengyawen 已提交
1558 1559

- 示例
C
chyyy0213 已提交
1560

Z
zengyawen 已提交
1561
  ```
C
chyyy0213 已提交
1562
  windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err, data) => {
C
chyyy0213 已提交
1563
      if (err.code) {
C
chyyy0213 已提交
1564
          console.error('Failed to set window colorspace. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1565 1566
          return;
      }
C
chyyy0213 已提交
1567
      console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data))
Z
zengyawen 已提交
1568 1569 1570
  })
  ```

C
chyyy0213 已提交
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
### setColorSpace<sup>8+</sup>

setColorSpace(colorSpace:ColorSpace): Promise&lt;void&gt;

设置当前窗口为广色域模式或默认色域模式,使用promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名     | 类型                      | 必填 | 说明         |
  | ---------- | ------------------------- | ---- | ------------ |
  | colorSpace | [ColorSpace](#colorspace) | 是   | 设置色域模式 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  let promise = windowClass.isSupportWideGamut(window.ColorSpace.WIDE_GAMUT);
C
chyyy0213 已提交
1595 1596
  promise.then((data)=> {
      console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data))
C
chyyy0213 已提交
1597 1598 1599 1600 1601
  }).catch((err)=>{
      console.error('Failed to set window colorspacet. Cause: ' + JSON.stringify(err));
  });
  ```

C
chyyy0213 已提交
1602
### getColorSpace<sup>8+</sup>
Z
zengyawen 已提交
1603

C
chyyy0213 已提交
1604
getColorSpace(callback: AsyncCallback&lt;ColorSpace&gt;): void
Z
zengyawen 已提交
1605

C
chyyy0213 已提交
1606
获取当前窗口色域模式,使用callback方式作为异步方法。
Z
zengyawen 已提交
1607

C
chyyy0213 已提交
1608
**系统能力**:SystemCapability.WindowManager.WindowManager.Core
Z
zengyawen 已提交
1609 1610

- 参数
C
chyyy0213 已提交
1611 1612 1613 1614

  | 参数名   | 类型                                           | 必填 | 说明                       |
  | -------- | ---------------------------------------------- | ---- | -------------------------- |
  | callback | AsyncCallback&lt;[ColorSpace](#colorspace)&gt; | 是   | 回调函数返回当前色域模式。 |
Z
zengyawen 已提交
1615 1616

- 示例
C
chyyy0213 已提交
1617

Z
zengyawen 已提交
1618
  ```
C
chyyy0213 已提交
1619
  windowClass.getColorSpace((err, data) => {
C
chyyy0213 已提交
1620
      if (err.code) {
C
chyyy0213 已提交
1621
          console.error('Failed to get window color space. Cause:' + JSON.stringify(err));
Z
zengyawen 已提交
1622 1623
          return;
      }
C
chyyy0213 已提交
1624 1625
      console.info('Succeeded in getting window color space. Cause:' + JSON.stringify(data))
  })
Z
zengyawen 已提交
1626 1627
  ```

C
chyyy0213 已提交
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
### getColorSpace<sup>8+</sup>

getColorSpace(): Promise&lt;ColorSpace&gt;

获取当前窗口色域模式,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 返回值

  | 类型                                     | 说明                                      |
  | ---------------------------------------- | ----------------------------------------- |
  | Promise&lt;[ColorSpace](#colorspace)&gt; | 以Promise形式返回结果,返回当前色域模式。 |

- 示例

  ```
  let promise = windowClass.getColorSpace();
  promise.then((data)=> {
      console.info('Succeeded in getting window color space. Cause:' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set window colorspacet. Cause: ' + JSON.stringify(err));
  });
  ```

C
chyyy0213 已提交
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163
### setBackgroundColor

setBackgroundColor(color: string, callback: AsyncCallback&lt;void&gt;): void

设置窗口的背景色,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名   | 类型                      | 必填 | 说明                                                         |
  | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
  | color    | string                    | 是   | 需要设置的背景色,为16进制颜色,例如"#00FF00"或"#FF00FF00"。 |
  | callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                                   |

- 示例

  ```
  var color = '#00ff33';
  windowClass.setBackgroundColor(color, (err, data) => {
      if (err.code) {
          console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data));
  });
  ```

### setBackgroundColor

setBackgroundColor(color: string): Promise&lt;void&gt;

设置窗口的背景色,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名 | 类型   | 必填 | 说明                                                         |
  | ------ | ------ | ---- | ------------------------------------------------------------ |
  | color  | string | 是   | 需要设置的背景色,为16进制颜色,例如"#00FF00"或"#FF00FF00"。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var color = '#00ff33';
  let promise = windowClass.setBackgroundColor(color);
  promise.then((data)=> {
      console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
  });
  ```

### setBrightness

setBrightness(brightness: number, callback: AsyncCallback&lt;void&gt;): void

设置屏幕亮度值,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名     | 类型                      | 必填 | 说明                                 |
  | ---------- | ------------------------- | ---- | ------------------------------------ |
  | brightness | number                    | 是   | 屏幕亮度值,值为0-1之间。1表示最亮。 |
  | callback   | AsyncCallback&lt;void&gt; | 是   | 回调函数。                           |

- 示例

  ```
  var brightness = 1;
  windowClass.setBrightness(brightness, (err, data) => {
      if (err.code) {
          console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data));
  });
  ```

### setBrightness

setBrightness(brightness: number): Promise&lt;void&gt;

设置屏幕亮度值,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名     | 类型   | 必填 | 说明                                 |
  | ---------- | ------ | ---- | ------------------------------------ |
  | brightness | number | 是   | 屏幕亮度值,值为0-1之间。1表示最亮。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var brightness = 1;
  let promise = windowClass.setBrightness(brightness);
  promise.then((data)=> {
      console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
  });
  ```

### setDimBehind<sup>7+</sup>

setDimBehind(dimBehindValue: number, callback: AsyncCallback&lt;void&gt;): void

窗口叠加时,设备有子窗口的情况下设置靠后的窗口的暗度值,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名         | 类型                      | 必填 | 说明                                               |
  | -------------- | ------------------------- | ---- | -------------------------------------------------- |
  | dimBehindValue | number                    | 是   | 表示靠后的窗口的暗度值,取值范围为0-1,1表示最暗。 |
  | callback       | AsyncCallback&lt;void&gt; | 是   | 回调函数。                                         |

- 示例

  ```
  windowClass.setDimBehind(0.5, (err, data) => {
      if (err.code) {
          console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the dimness. Data:' + JSON.stringify(data));
  });
  ```

### setDimBehind<sup>7+</sup>

setDimBehind(dimBehindValue: number): Promise&lt;void&gt;

窗口叠加时,设备有子窗口的情况下设置靠后的窗口的暗度值,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名         | 类型   | 必填 | 说明                                               |
  | -------------- | ------ | ---- | -------------------------------------------------- |
  | dimBehindValue | number | 是   | 表示靠后的窗口的暗度值,取值范围为0-1,1表示最暗。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  let promise = windowClass.setDimBehind(0.5);
  promise.then((data)=> {
      console.info('Succeeded in setting the dimness. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
  });
  ```

### setFocusable<sup>7+</sup>

setFocusable(isFocusable: boolean, callback: AsyncCallback&lt;void&gt;): void

设置点击时是否支持切换焦点窗口,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名      | 类型                      | 必填 | 说明                         |
  | ----------- | ------------------------- | ---- | ---------------------------- |
  | isFocusable | boolean                   | 是   | 点击时是否支持切换焦点窗口。 |
  | callback    | AsyncCallback&lt;void&gt; | 是   | 回调函数。                   |

- 示例

  ```
  var isFocusable= true;
  windowClass.setFocusable(isFocusable, (err, data) => {
      if (err.code) {
          console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data));
  });
  ```

### setFocusable<sup>7+</sup>

setFocusable(isFocusable: boolean): Promise&lt;void&gt;

设置点击时是否支持切换焦点窗口,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名      | 类型    | 必填 | 说明                         |
  | ----------- | ------- | ---- | ---------------------------- |
  | isFocusable | boolean | 是   | 点击时是否支持切换焦点窗口。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isFocusable= true;
  let promise = windowClass.setFocusable(isFocusable);
  promise.then((data)=> {
      console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the window to be focusable. Cause: ' + JSON.stringify(err));
  });
  ```

### setKeepScreenOn

setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback&lt;void&gt;): void

设置屏幕是否为常亮状态,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名         | 类型                      | 必填 | 说明                     |
  | -------------- | ------------------------- | ---- | ------------------------ |
  | isKeepScreenOn | boolean                   | 是   | 是否设置为屏幕常亮状态。 |
  | callback       | AsyncCallback&lt;void&gt; | 是   | 回调函数。               |

- 示例

  ```
  var isKeepScreenOn = true;
  windowClass.setKeepScreenOn(isKeepScreenOn, (err, data) => {
      if (err.code) {
          console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data));
  });
  ```

### setKeepScreenOn

setKeepScreenOn(isKeepScreenOn: boolean): Promise&lt;void&gt;

设置屏幕是否为常亮状态,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名         | 类型    | 必填 | 说明                     |
  | -------------- | ------- | ---- | ------------------------ |
  | isKeepScreenOn | boolean | 是   | 是否设置为屏幕常亮状态。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isKeepScreenOn= true;
  let promise = windowClass.setKeepScreenOn(isKeepScreenOn);
  promise.then((data)=> {
      console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
  });
  ```

### setOutsideTouchable<sup>7+</sup>

setOutsideTouchable(touchable: boolean, callback: AsyncCallback&lt;void&gt;): void

设置是否允许可点击子窗口以外的区域,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名    | 类型                      | 必填 | 说明             |
  | --------- | ------------------------- | ---- | ---------------- |
  | touchable | boolean                   | 是   | 设置是否可点击。 |
  | callback  | AsyncCallback&lt;void&gt; | 是   | 回调函数。       |

- 示例

  ```
  windowClass.setOutsideTouchable(true, (err, data) => {
      if (err.code) {
          console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data))
  })
  ```

### setOutsideTouchable<sup>7+</sup>

setOutsideTouchable(touchable: boolean): Promise&lt;void&gt;

设置是否允许可点击子窗口以外的区域,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名    | 类型    | 必填 | 说明             |
  | --------- | ------- | ---- | ---------------- |
  | touchable | boolean | 是   | 设置是否可点击。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  let promise = windowClass.setOutsideTouchable(true);
  promise.then((data)=> {
      console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
  });
  ```

### setPrivacyMode<sup>7+</sup>

setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback&lt;void&gt;): void

设置窗口是否为隐私模式,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名        | 类型                      | 必填 | 说明                 |
  | ------------- | ------------------------- | ---- | -------------------- |
  | isPrivacyMode | boolean                   | 是   | 窗口是否为隐私模式。 |
  | callback      | AsyncCallback&lt;void&gt; | 是   | 回调函数。           |

- 示例

  ```
  var isPrivacyMode = true;
  windowClass.setPrivacyMode(isPrivacyMode, (err, data) => {
      if (err.code) {
          console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the window to privacy mode. Data:' + JSON.stringify(data));
  
  });
  ```

### setPrivacyMode<sup>7+</sup>

setPrivacyMode(isPrivacyMode: boolean): Promise&lt;void&gt;

设置窗口是否为隐私模式,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名        | 类型    | 必填 | 说明                 |
  | ------------- | ------- | ---- | -------------------- |
  | isPrivacyMode | boolean | 是   | 窗口是否为隐私模式。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isPrivacyMode = true;
  let promise = windowClass.setPrivacyMode(isPrivacyMode);
  promise.then((data)=> {
      console.info('Succeeded in setting the window to privacy mode. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the window to privacy mode. Cause: ' + JSON.stringify(err));
  });
  ```

### setTouchable<sup>7+</sup>

setTouchable(isTouchable: boolean, callback: AsyncCallback&lt;void&gt;): void

设置窗口是否为可触状态,使用callback方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名      | 类型                      | 必填 | 说明                 |
  | ----------- | ------------------------- | ---- | -------------------- |
  | isTouchable | boolean                   | 是   | 窗口是否为可触状态。 |
  | callback    | AsyncCallback&lt;void&gt; | 是   | 回调函数。           |

- 示例

  ```
  var isTouchable = true;
  windowClass.setTouchable(isTouchable, (err, data) => {
      if (err.code) {
          console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err));
          return;
      }
      console.info('Succeeded in setting the window to be touchable. Data:' + JSON.stringify(data));
  
  });
  ```

### setTouchable<sup>7+</sup>

setTouchable(isTouchable: boolean): Promise&lt;void&gt;

设置窗口是否为可触状态,使用Promise方式作为异步方法。

本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。

**系统能力**:SystemCapability.WindowManager.WindowManager.Core

- 参数

  | 参数名      | 类型    | 必填 | 说明                 |
  | ----------- | ------- | ---- | -------------------- |
  | isTouchable | boolean | 是   | 窗口是否为可触状态。 |

- 返回值

  | 类型                | 说明                                            |
  | ------------------- | ----------------------------------------------- |
  | Promise&lt;void&gt; | 以Promise形式返回结果,返回当前函数执行的结果。 |

- 示例

  ```
  var isTouchable = true;
  let promise = windowClass.setTouchable(isTouchable);
  promise.then((data)=> {
      console.info('Succeeded in setting the window to be touchable. Data: ' + JSON.stringify(data))
  }).catch((err)=>{
      console.error('Failed to set the window to be touchable. Cause: ' + JSON.stringify(err));
  });
  ```

###