From 9d22fe0768bae24e3f6e9aacb54b91c42ac87298 Mon Sep 17 00:00:00 2001
From: zhirong <215782872@qq.com>
Date: Fri, 27 May 2022 16:41:56 +0800
Subject: [PATCH] fixed fe8ed1d from
https://gitee.com/yang-zhirong6/docs/pulls/4524 xxx
Signed-off-by: zhirong <215782872@qq.com>
Change-Id: I9dbd4601e5b6fd4188313e7db02a7d8375094c5f
---
.../reference/apis/js-apis-window.md | 133 ++++++++++++++++++
1 file changed, 133 insertions(+)
diff --git a/zh-cn/application-dev/reference/apis/js-apis-window.md b/zh-cn/application-dev/reference/apis/js-apis-window.md
index 44daad198d..9a5501a92c 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-window.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-window.md
@@ -148,6 +148,7 @@ import window from '@ohos.window';
| focusable7+ | boolean | 是 | 否 | 窗口是否可聚焦,默认为true。 |
| touchable7+ | boolean | 是 | 否 | 窗口是否可触摸,默认为true。 |
| brightness | number | 是 | 是 | 屏幕亮度, 取值范围为0~1,1表示最大亮度值。 |
+| dimBehindValue(deprecated) | number | 是 | 是 | 靠后窗口的暗度值,取值范围为0~1,1表示最暗。
- **说明:** 从API version 9开始废弃。
- 从 API version 7开始支持|
| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮,默认为false。 |
| isPrivacyMode7+ | boolean | 是 | 是 | 隐私模式,默认为false。 |
| isRoundCorner7+ | boolean | 是 | 是 | 窗口是否为圆角。默认为false。 |
@@ -1778,6 +1779,72 @@ setBrightness(brightness: number): Promise<void>
});
```
+### setDimBehind(deprecated)
+
+setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void
+
+窗口叠加时,设备有子窗口的情况下设置靠后的窗口的暗度值,使用callback方式作为异步方法。
+
+> **说明:** 从API version 9开始废弃。
+>
+> 从 API version 7开始支持。
+
+**系统能力:** SystemCapability.WindowManager.WindowManager.Core
+
+**参数:**
+
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------------- | ------------------------- | ---- | -------------------------------------------------- |
+ | dimBehindValue | number | 是 | 表示靠后的窗口的暗度值,取值范围为0-1,1表示最暗。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+**示例:**
+
+ ```js
+ 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(deprecated)
+
+setDimBehind(dimBehindValue: number): Promise<void>
+
+窗口叠加时,设备有子窗口的情况下设置靠后的窗口的暗度值,使用Promise方式作为异步方法。
+
+> **说明:** 从API version 9开始废弃。
+>
+> 从 API version 7开始支持。
+
+**系统能力:** SystemCapability.WindowManager.WindowManager.Core
+
+**参数:**
+
+ | 参数名 | 类型 | 必填 | 说明 |
+ | -------------- | ------ | ---- | -------------------------------------------------- |
+ | dimBehindValue | number | 是 | 表示靠后的窗口的暗度值,取值范围为0-1,1表示最暗。 |
+
+**返回值:**
+
+ | 类型 | 说明 |
+ | ------------------- | ----------------------------------------------- |
+ | Promise<void> | 以Promise形式返回结果,返回当前函数执行的结果。 |
+
+**示例:**
+
+ ```js
+ 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));
+ });
+ ```
+
### setFocusable7+
setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void
@@ -1866,6 +1933,72 @@ setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): v
});
```
+### setOutsideTouchable(deprecated)
+
+setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): void
+
+设置是否允许可点击子窗口以外的区域,使用callback方式作为异步方法。
+
+> **说明:** 从API version 9开始废弃。
+>
+> 从 API version 7开始支持。
+
+**系统能力:** SystemCapability.WindowManager.WindowManager.Core
+
+**参数:**
+
+ | 参数名 | 类型 | 必填 | 说明 |
+ | --------- | ------------------------- | ---- | ---------------- |
+ | touchable | boolean | 是 | 设置是否可点击。 |
+ | callback | AsyncCallback<void> | 是 | 回调函数。 |
+
+**示例:**
+
+ ```js
+ 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(deprecated)
+
+setOutsideTouchable(touchable: boolean): Promise<void>
+
+设置是否允许可点击子窗口以外的区域,使用Promise方式作为异步方法。
+
+> **说明:** 从API version 9开始废弃。
+>
+> 从 API version 7开始支持。
+
+**系统能力:** SystemCapability.WindowManager.WindowManager.Core
+
+**参数:**
+
+ | 参数名 | 类型 | 必填 | 说明 |
+ | --------- | ------- | ---- | ---------------- |
+ | touchable | boolean | 是 | 设置是否可点击。 |
+
+**返回值:**
+
+ | 类型 | 说明 |
+ | ------------------- | ----------------------------------------------- |
+ | Promise<void> | 以Promise形式返回结果,返回当前函数执行的结果。 |
+
+**示例:**
+
+ ```js
+ 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));
+ });
+ ```
+
### setKeepScreenOn
setKeepScreenOn(isKeepScreenOn: boolean): Promise<void>
--
GitLab