From 567c3b7cd5b1346db87eba0c96d490f53182f63f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=91=9B=E4=BA=9A=E8=8A=B3?= Date: Tue, 28 Dec 2021 03:17:45 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-window.md. Signed-off-by: ge-yafang --- .../reference/apis/js-apis-window.md | 44 ++++++++++++++----- 1 file changed, 34 insertions(+), 10 deletions(-) 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 ecbeffbc3ff..2d98b341351 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -1,7 +1,7 @@ # 窗口 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 @@ -40,7 +40,7 @@ ohos.permission.SYSTEM_FLOAT_WINDOW | height | number | 是 | 是 | 矩形区域的高度。 | -## AvoidArea7+ +## AvoidArea7+ 表示窗口内容规避区域。 @@ -52,7 +52,7 @@ ohos.permission.SYSTEM_FLOAT_WINDOW | bottomRect | [Rect](#rect) | 是 | 是 | 屏幕底部的矩形区。 | -## Size7+ +## Size7+ 窗口大小。 @@ -93,7 +93,7 @@ ohos.permission.SYSTEM_FLOAT_WINDOW | secondaryBounds | [Rect](#rect) | 表示次要边界信息，返回Rect类实例。 | -## window.getTopWindow +## window.getTopWindow getTopWindow(callback: AsyncCallback<Window>): void @@ -127,7 +127,7 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | id | string | 是 | 窗口id。 | - | type | [WindowType](#windowtype7-) | 是 | 窗口类型。 | + | type | [WindowType](#windowtype) | 是 | 窗口类型。 | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前窗口对象。 | - 示例 @@ -283,7 +283,7 @@ setSplitBarVisibility(isVisibility: boolean, callback: AsyncCallback<void> | TYPE_SYSTEM_ALERT | 1 | 表示系统弹窗。 | -## AvoidAreaType7+ +## AvoidAreaType7+ 窗口内容需要规避区域的类型。 @@ -442,6 +442,30 @@ setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): v }); ``` +### setWindowType7+ + +setWindowType(type: WindowType, callback: AsyncCallback<void>): void + +设置窗口类型。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | [WindowType](#windowType7) | 是 |窗口类型。 | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + ``` + var type = window.TYPE_APP; + windowClass.setWindowType(type, (err, data) => { + if (err) { + console.error('Failed to set the window type. Cause: ' + JSON.stringify(err)); + return; + } + console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data)) + }); + ``` + ### setDimBehind7+ setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void @@ -648,8 +672,8 @@ getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): voi - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [AvoidAreaType](#avoidareatype7-) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | - | callback | AsyncCallback<[AvoidArea](#avoidarea7-)> | 是 | 回调返回窗口内容规避区域。 | + | type | [AvoidAreaType](#avoidareatype) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | + | callback | AsyncCallback<[AvoidArea](#avoidarea)> | 是 | 回调返回窗口内容规避区域。 | - 示例 ``` @@ -904,7 +928,7 @@ on(type: string, callback: Callback<AvoidArea | Size | number>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置监听类型。
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听；
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听；
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 | - | callback | Callback<[AvoidArea](#avoidarea7-) \| Size \| number> | 是 | 回调返回监听到的信息。 | + | callback | Callback<[AvoidArea](#avoidarea) \| [Size](#size) \| number> | 是 | 回调返回监听到的信息。 | - 示例 ``` @@ -924,7 +948,7 @@ off(type: string, callback?: Callback<AvoidArea | Size | number>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置监听类型。
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听；
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听；
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 | - | callback | Callback<[AvoidArea](#avoidarea7-) \| Size \| number> | 否 | 回调返回监听到的信息。 | + | callback | Callback<[AvoidArea](#avoidarea) \| [Size](#size) \| number> | 否 | 回调返回监听到的信息。 | - 示例 ``` -- Gitee