From 1812dad0ac968b3238fd050f790b4ec193cf9f49 Mon Sep 17 00:00:00 2001 From: ge-yafang Date: Sat, 7 May 2022 19:51:08 +0800 Subject: [PATCH] update docs Signed-off-by: ge-yafang --- .../reference/apis/js-apis-window.md | 89 ++++++++++--------- 1 file changed, 49 insertions(+), 40 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 047d75eb83..1fa3f88c0d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -11,7 +11,7 @@ import window from '@ohos.window'; ``` -## WindowType7+ +## WindowType7+ 窗口类型。 @@ -22,7 +22,7 @@ import window from '@ohos.window'; | TYPE_APP | 0 | 表示应用子窗口。 | | TYPE_SYSTEM_ALERT | 1 | 表示系统告警窗口。 | -## AvoidAreaType7+ +## AvoidAreaType7+ 窗口内容需要规避区域的类型。 @@ -33,7 +33,7 @@ import window from '@ohos.window'; | TYPE_SYSTEM | 0 | 表示系统默认区域。 | | TYPE_CUTOUT | 1 | 表示刘海屏区域。 | -## WindowMode7+ +## WindowMode7+ 窗口模式。 @@ -49,7 +49,7 @@ import window from '@ohos.window'; | SECONDARY | 4 | 表示APP分屏多窗口次要模式。 | | FLOATING | 5 | 表示APP自由悬浮形式窗口模式。 | -## SystemBarProperties +## SystemBarProperties 状态栏导航栏的属性。 @@ -64,7 +64,7 @@ import window from '@ohos.window'; | isNavigationBarLightIcon7+ | boolean | 否 | 否 | 导航栏图标是否为高亮状态。 | | navigationBarContentColor8+ | string | 否 | 是 | 导航栏文字颜色。 | -## SystemBarRegionTint 8+ +## SystemBarRegionTint 8+ 单个导航栏或状态栏回调信息。 @@ -80,7 +80,7 @@ import window from '@ohos.window'; | backgroundColor | string | 是 | 是 | 系统栏背景颜色，为16进制RGB或ARGB颜色，例如"\#00FF00"或"\#FF00FF00"。 | | contentColor | string | 是 | 是 | 系统栏文字颜色。 | -## SystemBarTintState 8+ +## SystemBarTintState 8+ 当前系统栏回调信息集合。 @@ -93,7 +93,7 @@ import window from '@ohos.window'; | displayId | number | 是 | 否 | 当前物理屏幕id。 | | regionTint | Array<[SystemBarRegionTint](#systembartegiontint)> | 是 | 是 | 当前改变所有的系统栏信息。 | -## Rect7+ +## Rect7+ 矩形。 @@ -106,7 +106,7 @@ import window from '@ohos.window'; | width | number | 是 | 是 | 矩形区域的宽度。 | | height | number | 是 | 是 | 矩形区域的高度。 | -## AvoidArea7+ +## AvoidArea7+ 表示窗口内容规避区域。 @@ -119,7 +119,7 @@ import window from '@ohos.window'; | rightRect | [Rect](#rect) | 是 | 是 | 屏幕右侧的矩形区。 | | bottomRect | [Rect](#rect) | 是 | 是 | 屏幕底部的矩形区。 | -## Size7+ +## Size7+ 窗口大小。 @@ -130,7 +130,7 @@ import window from '@ohos.window'; | width | number | 是 | 是 | 窗口宽度。 | | height | number | 是 | 是 | 窗口高度。 | -## WindowProperties +## WindowProperties 窗口属性。 @@ -148,10 +148,10 @@ import window from '@ohos.window'; | dimBehindValue7+ | number | 是 | 是 | 靠后窗口的暗度值，取值范围为0~1，1表示最暗。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | | isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮，默认为false。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | | isPrivacyMode7+ | boolean | 是 | 是 | 隐私模式，默认为false。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | -| isRoundCorner7+ | boolean | 是 | 是 | 窗口是否为圆角。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| isRoundCorner7+ | boolean | 是 | 是 | 窗口是否为圆角。默认为false。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | | isTransparent7+ | boolean | 是 | 是 | 窗口是否透明。默认为false。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | -## ColorSpace8+ +## ColorSpace8+ 色域模式。 @@ -271,7 +271,7 @@ create(ctx: Context, id: string, type: WindowType): Promise<Window> 创建子窗口，使用Promise方式作为异步方法，其中Context详见[Context](js-apis-Context.md)。 -从API version 9开始，当Context为[ServiceExtAbilityContext](js-apis-serviceExtAbilityContext.md)时，创建系统窗口，使用Promise方式作为异步方法。 +从API version 9开始，当Context为[ServiceExtAbilityContext](js-apis-serviceExtbilityContext.md)时，创建系统窗口，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.WindowManager.WindowManager.Core @@ -302,7 +302,7 @@ create(ctx: Context, id: string, type: WindowType): Promise<Window> }); ``` -## window.find7+ +## window.find7+ find(id: string, callback: AsyncCallback<Window>): void @@ -364,7 +364,7 @@ find(id: string): Promise<Window> }); ``` -## window.getTopWindow +## window.getTopWindow getTopWindow(callback: AsyncCallback<Window>): void @@ -495,7 +495,7 @@ on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): v | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听； | + | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | | callback | Callback<[SystemBarTintState](#systembartintstate)> | 是 | 回调返回监听到的信息。 | - 示例 @@ -521,7 +521,7 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >) | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听； | + | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | | callback | Callback<[SystemBarTintState](#systembartintstate)> | 否 | 回调返回监听到的信息。 | - 示例 @@ -1259,7 +1259,7 @@ loadContent(path: string, callback: AsyncCallback<void>): void | -------- | ------------------------- | ---- | -------------------- | | path | string | 是 | 设置加载页面的路径。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | - + - 示例 ```js @@ -1285,7 +1285,7 @@ loadContent(path: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | | path | string | 是 | 设置加载页面的路径。 | - + - 返回值 | 类型 | 说明 | @@ -1364,10 +1364,10 @@ on(type: 'windowSizeChange', callback: Callback<Size>): void - 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'windowSizeChange'时表示监听类型为窗口尺寸变化监听； | - | callback | Callback<[Size](#size)> | 是 | 回调返回监听到的信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------------- | ---- | -------------------------------------------------------- | + | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | + | callback | Callback<[Size](#size)> | 是 | 回调返回监听到的信息。 | - 示例 @@ -1388,14 +1388,14 @@ off(type: 'windowSizeChange', callback?: Callback<Size >): void - 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听； | - | callback | Callback<[Size](#size)> | 否 | 回调返回监听到的信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------------- | ---- | -------------------------------------------------------- | + | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | + | callback | Callback<[Size](#size)> | 否 | 回调返回监听到的信息。 | - 示例 - ``` + ```js var type = 'windowSizeChange'; windowClass.off(type); ``` @@ -1412,7 +1412,7 @@ on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听。 | + | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | | callback | Callback<[AvoidArea](#avoidarea)> | 是 | 回调返回监听到的信息。 | - 示例 @@ -1436,12 +1436,12 @@ off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听。 | + | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | | callback | Callback<[AvoidArea](#avoidarea)> | 否 | 回调返回监听到的信息。 | - 示例 - ``` + ```js var type = 'systemAvoidAreaChange'; windowClass.off(type); ``` @@ -1460,7 +1460,7 @@ on(type: 'keyboardHeightChange', callback: Callback<number>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听。 | + | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | | callback | Callbacknumber> | 是 | 回调返回监听到的信息。 | - 示例 @@ -1486,12 +1486,12 @@ off(type: 'keyboardHeightChange', callback?: Callback<number>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听。 | + | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | | callback | Callback<number> | 否 | 回调返回监听到的信息。 | - 示例 - ``` + ```js var type = 'keyboardHeightChange'; windowClass.off(type); ``` @@ -1538,7 +1538,7 @@ isSupportWideGamut(): Promise<boolean> - 示例 - ``` + ```js let promise = windowClass.isSupportWideGamut(); promise.then((data)=> { console.info('Succeeded in checking whether the window support WideGamut. Data: ' + JSON.stringify(data)) @@ -1578,7 +1578,7 @@ setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void setColorSpace(colorSpace:ColorSpace): Promise<void> -设置当前窗口为广色域模式或默认色域模式，使用promise方式作为异步方法。 +设置当前窗口为广色域模式或默认色域模式，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.WindowManager.WindowManager.Core @@ -2166,7 +2166,7 @@ setTouchable(isTouchable: boolean): Promise<void> }); ``` -## WindowStageEventType9+ +## WindowStageEventType9+ WindowStage生命周期。 @@ -2255,16 +2255,19 @@ createSubWindow(name: string): Promise<Window> 创建该WindowStage实例下的子窗口，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.WindowManager.WindowManager.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------- | | name | String | 是 | 子窗口的名字。 | + - 返回值 | 类型 | 说明 | | -------------------------------- | ------------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的子窗口对象。 | + - 示例 ```ts @@ -2325,6 +2328,7 @@ getSubWindow(): Promise<Array<Window>> 获取该WindowStage实例下的所有子窗口，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.WindowManager.WindowManager.Core + - 返回值 | 类型 | 说明 | @@ -2356,6 +2360,7 @@ getSubWindow(callback: AsyncCallback<Array<Window>>): void 获取该WindowStage实例下的所有子窗口，使用callback方式作为异步方法。 **系统能力**：SystemCapability.WindowManager.WindowManager.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | @@ -2395,7 +2400,7 @@ loadContent(path: string, callback: AsyncCallback<void>): void | -------- | ------------------------- | ---- | -------------------- | | path | string | 是 | 设置加载页面的路径。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | - + - 示例 ```ts @@ -2412,6 +2417,7 @@ loadContent(path: string, callback: AsyncCallback<void>): void } } ``` + ### on('windowStageEvent')9+ on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType>): void @@ -2419,11 +2425,12 @@ on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType> 开启WindowStage生命周期变化的监听。 **系统能力**：SystemCapability.WindowManager.WindowManager.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'windowStageEvent'时表示监听类型为WindowStage生命周期变化监听。 | + | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | | callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 是 | 回调返回监听到的信息。 | - 示例 @@ -2447,12 +2454,14 @@ off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType&g 关闭WindowStage生命周期变化的监听。 **系统能力**：SystemCapability.WindowManager.WindowManager.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 设置监听类型。
- type为'windowStageEvent'时表示监听类型为WindowStage生命周期变化监听。 | + | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | | callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 否 | 回调返回监听到的信息。 | + - 示例 ```ts -- GitLab