diff --git a/zh-cn/application-dev/quick-start/start-with-ets-low-code.md b/zh-cn/application-dev/quick-start/start-with-ets-low-code.md index 2be296de7cb22dbf1ee5012befde40b1f4a5b103..81e1cf99a9143329d3bba0217511091f9ab0e751 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets-low-code.md +++ b/zh-cn/application-dev/quick-start/start-with-ets-low-code.md @@ -17,7 +17,7 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可 - 直接创建一个支持低代码开发的新工程以进行开发。本文以此方式为例进行说明。 -- 在已有工程中，创建Visual文件来进行开发。 +- 在已有工程中，创建visual文件来进行开发。 ## 创建新工程支持低代码开发 @@ -46,9 +46,9 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可 ## 构建第一个页面 -工程同步完成后，第一个页面已有一个容器、文本（Hello World）显示。为了更详细地了解低代码开发，我们将删除画布原有模板组件，从零开始完成页面的添加、设置。 +工程同步完成后，第一个页面已有一个容器、一段文本（Hello World）显示。为了更详细地了解低代码开发，我们将删除画布原有模板组件，从零开始完成页面的添加、设置。 -第一个页面内有一个容器、文本和一个按钮，通过Column、Text和Button组件来实现。其中，Column为沿垂直方向布局的容器组件，具体使用请见[Column](../reference/arkui-ts/ts-container-column.md)。 +第一个页面内有一个容器、一段文本和一个按钮，通过Column、Text和Button组件来实现。其中，Column为沿垂直方向布局的容器组件，具体使用请见[Column](../reference/arkui-ts/ts-container-column.md)。 1. 删除画布原有模板组件。 打开index.visual文件，选中画布中的组件，单击鼠标右键，选择Delete删除画布原有模板组件。操作如下所示： diff --git a/zh-cn/application-dev/quick-start/start-with-ets.md b/zh-cn/application-dev/quick-start/start-with-ets.md index 0b84c9b3f64168de0f9e6ae209a7f74f046a9174..8f85148746c4d952ede64bc4cb80ba47393244a1 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets.md +++ b/zh-cn/application-dev/quick-start/start-with-ets.md @@ -64,7 +64,7 @@ ``` 2. 添加按钮。 - 在默认页面基础上，我们添加一个Button组件，作为按钮接收用户点击的动作，从而实现跳转到另一个页面。“**index.ets**”文件的示例如下： + 在默认页面基础上，我们添加一个Button组件，作为按钮响应用户点击，从而实现跳转到另一个页面。“**index.ets**”文件的示例如下： ``` @@ -79,7 +79,7 @@ Text(this.message) .fontSize(50) .fontWeight(FontWeight.Bold) - // 添加按钮，以接收用户点击 + // 添加按钮，以响应用户点击 Button() { Text('Next') .fontSize(30) @@ -171,7 +171,7 @@ Text(this.message) .fontSize(50) .fontWeight(FontWeight.Bold) - // 添加按钮，以接收用户点击 + // 添加按钮，以响应用户点击 Button() { Text('Next') .fontSize(30) diff --git a/zh-cn/application-dev/quick-start/start-with-js-low-code.md b/zh-cn/application-dev/quick-start/start-with-js-low-code.md index f8b9a22bdaf20339eb11572356d3a4b40cf6987d..4b7db2ab59aaf7583b530dee648942f0466873ae 100644 --- a/zh-cn/application-dev/quick-start/start-with-js-low-code.md +++ b/zh-cn/application-dev/quick-start/start-with-js-low-code.md @@ -15,7 +15,7 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可 - 直接创建一个支持低代码开发的新工程以进行开发。本文以此方式为例进行说明。 -- 在已有工程中，创建Visual文件来进行开发。 +- 在已有工程中，创建visual文件来进行开发。 ## 创建新工程支持低代码开发 @@ -50,9 +50,9 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可 ## 构建第一个页面 -工程同步完成后，第一个页面已有一个容器、文本（Hello World）显示。为了更详细地了解低代码开发，我们将删除画布原有模板组件，从零开始完成页面的添加、设置。 +工程同步完成后，第一个页面已有一个容器、一段文本（Hello World）显示。为了更详细地了解低代码开发，我们将删除画布原有模板组件，从零开始完成页面的添加、设置。 -第一个页面内有一个容器、文本和一个按钮，通过Div、Text和Button组件来实现。 +第一个页面内有一个容器、一段文本和一个按钮，通过Div、Text和Button组件来实现。 1. 删除画布原有模板组件。 打开index.visual文件，选中画布中的组件，单击鼠标右键，选择Delete删除画布原有模板组件。操作如下所示： diff --git a/zh-cn/application-dev/quick-start/start-with-js.md b/zh-cn/application-dev/quick-start/start-with-js.md index e3861a65ad10d2d9dfd713ee604a388b187c0ba1..0d41f5245e116ca5c21ef3fa90925566e2bac4af 100644 --- a/zh-cn/application-dev/quick-start/start-with-js.md +++ b/zh-cn/application-dev/quick-start/start-with-js.md @@ -52,7 +52,7 @@ ``` 2. 添加按钮，并绑定onclick方法。 - 在默认页面基础上，我们添加一个button类型的input组件，作为按钮接收用户点击的动作，从而实现跳转到另一个页面。“**index.hml**”文件的示例代码如下： + 在默认页面基础上，我们添加一个button类型的input组件，作为按钮响应用户点击，从而实现跳转到另一个页面。“**index.hml**”文件的示例代码如下： ``` 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 507f67d85cf93cf3b8c0abfc7546213e10b0236b..64130a267005cd2cabd62bc83de18d848f849d88 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -2,7 +2,8 @@ 窗口提供管理窗口的一些基础能力，包括对窗口的创建、销毁，以及对窗口的属性设置等各项功能。 -> **说明：** +> **说明：** +> > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 @@ -108,7 +109,7 @@ import window from '@ohos.window'; ## AvoidArea7+ -表示窗口内容规避区域。 +窗口内容规避区域。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。 @@ -136,20 +137,19 @@ import window from '@ohos.window'; **系统能力：** 以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| ------------------------------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ | -| windowRect7+ | [Rect](#rect) | 是 | 是 | 窗口尺寸。 | -| type7+ | [WindowType](#windowtype) | 是 | 是 | 窗口类型。 | -| isFullScreen | boolean | 是 | 是 | 是否全屏，默认为false。 | -| isLayoutFullScreen7+ | boolean | 是 | 是 | 窗口是否为沉浸式，默认为false。 | -| focusable7+ | boolean | 是 | 否 | 窗口是否可聚焦，默认为true。 | -| touchable7+ | boolean | 是 | 否 | 窗口是否可触摸，默认为true。 | -| brightness | number | 是 | 是 | 屏幕亮度， 取值范围为0~1，1表示最大亮度值。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | -| 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 | 是 | 是 | 窗口是否为圆角。默认为false。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | -| isTransparent7+ | boolean | 是 | 是 | 窗口是否透明。默认为false。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------------------------------- | ------------------------- | ---- | ---- | -------------------------------------------- | +| windowRect7+ | [Rect](#rect) | 是 | 是 | 窗口尺寸。 | +| type7+ | [WindowType](#windowtype) | 是 | 是 | 窗口类型。 | +| isFullScreen | boolean | 是 | 是 | 是否全屏，默认为false。 | +| isLayoutFullScreen7+ | boolean | 是 | 是 | 窗口是否为沉浸式，默认为false。 | +| focusable7+ | boolean | 是 | 否 | 窗口是否可聚焦，默认为true。 | +| touchable7+ | boolean | 是 | 否 | 窗口是否可触摸，默认为true。 | +| brightness | number | 是 | 是 | 屏幕亮度， 取值范围为0~1，1表示最大亮度值。 | +| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮，默认为false。 | +| isPrivacyMode7+ | boolean | 是 | 是 | 隐私模式，默认为false。 | +| isRoundCorner7+ | boolean | 是 | 是 | 窗口是否为圆角。默认为false。 | +| isTransparent7+ | boolean | 是 | 是 | 窗口是否透明。默认为false。 | ## ColorSpace8+ @@ -166,21 +166,21 @@ import window from '@ohos.window'; create(id: string, type: WindowType, callback: AsyncCallback<Window>): void -创建子窗口，使用callback方式作为异步方法。 +创建子窗口，使用callback异步回调。 从API version 8开始，此接口废弃，推荐使用[window.create8+](#windowcreate8)接口。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | -------------------------- | - | id | string | 是 | 窗口id。 | - | type | [WindowType](#windowtype) | 是 | 窗口类型。 | - | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回创建的子窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | -------------------------- | +| id | string | 是 | 窗口id。 | +| type | [WindowType](#windowtype) | 是 | 窗口类型。 | +| callback | AsyncCallback<[Window](#window)> | 是 | 回调返回创建的子窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -199,26 +199,26 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi create(id: string, type: WindowType): Promise<Window> -创建子窗口，使用Promise方式作为异步方法。 +创建子窗口，使用Promise异步回调。 从API version 8开始，此接口废弃，推荐使用[window.create8+](#windowcreate8)接口。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------------------------- | ---- | ---------- | - | id | string | 是 | 窗口id。 | - | type | [WindowType](#windowtype) | 是 | 窗口类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------- | ---- | ---------- | +| id | string | 是 | 窗口id。 | +| type | [WindowType](#windowtype) | 是 | 窗口类型。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------- | ------------------------------------------------- | - | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的子窗口对象。 | +| 类型 | 说明 | +| -------------------------------- | ------------------------------------------------- | +| Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的子窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -235,22 +235,22 @@ create(id: string, type: WindowType): Promise<Window> create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback<Window>): void -创建子窗口，使用callback方式作为异步方法，其中Context详见[Context](js-apis-Context.md)。 +创建子窗口，使用callback异步回调，其中Context详见[Context](js-apis-Context.md)。 -从API version 9开始，当Context为[ServiceExtensionContext](js-apis-service-extension-context.md)时，创建系统窗口，使用callback方式作为异步方法。 +从API version 9开始，当Context为[ServiceExtensionContext](js-apis-service-extension-context.md)时，创建系统窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | - | ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。 | - | id | string | 是 | 窗口id。 | - | type | [WindowType](#windowtype) | 是 | 窗口类型。 | - | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | +| ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。 | +| id | string | 是 | 窗口id。 | +| type | [WindowType](#windowtype) | 是 | 窗口类型。 | +| callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -269,27 +269,27 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback<Wi create(ctx: Context, id: string, type: WindowType): Promise<Window> -创建子窗口，使用Promise方式作为异步方法，其中Context详见[Context](js-apis-Context.md)。 +创建子窗口，使用Promise异步回调，其中Context详见[Context](js-apis-Context.md)。 -从API version 9开始，当Context为[ServiceExtensionContext](js-apis-service-extension-context.md)时，创建系统窗口，使用Promise方式作为异步方法。 +从API version 9开始，当Context为[ServiceExtensionContext](js-apis-service-extension-context.md)时，创建系统窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------------------------- | ---- | ------------------------------------------------------------ | - | ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。 | - | id | string | 是 | 窗口id。 | - | type | [WindowType](#windowtype) | 是 | 窗口类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------- | ---- | ------------------------------------------------------------ | +| ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-service-extension-context.md)。 | +| id | string | 是 | 窗口id。 | +| type | [WindowType](#windowtype) | 是 | 窗口类型。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------- | ----------------------------------------------- | - | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的窗口对象。 | +| 类型 | 说明 | +| -------------------------------- | ----------------------------------------------- | +| Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -306,18 +306,18 @@ create(ctx: Context, id: string, type: WindowType): Promise<Window> find(id: string, callback: AsyncCallback<Window>): void -查找id所对应的窗口，使用callback方式作为异步方法。 +查找id所对应的窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | ---------------------------- | - | id | string | 是 | 窗口id。 | - | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前查找的窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ---------------------------- | +| id | string | 是 | 窗口id。 | +| callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前查找的窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -335,23 +335,23 @@ find(id: string, callback: AsyncCallback<Window>): void find(id: string): Promise<Window> -查找id所对应的窗口，使用Promise方式作为异步方法。 +查找id所对应的窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | -------- | - | id | string | 是 | 窗口id。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------- | +| id | string | 是 | 窗口id。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------- | ----------------------------------------------- | - | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前查找的窗口对象。 | +| 类型 | 说明 | +| -------------------------------- | ----------------------------------------------- | +| Promise<[Window](#window)> | 以Promise形式返回结果，返回当前查找的窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -368,19 +368,19 @@ find(id: string): Promise<Window> getTopWindow(callback: AsyncCallback<Window>): void -获取当前应用内最后显示的窗口，使用callback方式作为异步方法。 +获取当前应用内最后显示的窗口，使用callback异步回调。 从API version 8开始，此接口废弃，推荐使用[window.getTopWindow8+](#windowgettopwindow8)接口。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | -------------------------------------- | - | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前应用内最后显示的窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | -------------------------------------- | +| callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前应用内最后显示的窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -398,19 +398,19 @@ getTopWindow(callback: AsyncCallback<Window>): void getTopWindow(): Promise<Window> -获取当前应用内最后显示的窗口，使用Promise方式作为异步方法。 +获取当前应用内最后显示的窗口，使用Promise异步回调。 从API version 8开始，此接口废弃，推荐使用[window.getTopWindow8+](#windowgettopwindow8)接口。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------- | --------------------------------------------------------- | - | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前应用内最后显示的窗口对象。 | +| 类型 | 说明 | +| -------------------------------- | --------------------------------------------------------- | +| Promise<[Window](#window)> | 以Promise形式返回结果，返回当前应用内最后显示的窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -427,18 +427,18 @@ getTopWindow(): Promise<Window> getTopWindow(ctx: Context, callback: AsyncCallback<Window>): void -获取当前应用内最后显示的窗口，使用callback方式作为异步方法。 +获取当前应用内最后显示的窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | - | ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。 | - | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前应用内最后显示的窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | +| ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。 | +| callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前应用内最后显示的窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -456,23 +456,23 @@ getTopWindow(ctx: Context, callback: AsyncCallback<Window>): void getTopWindow(ctx: Context): Promise<Window> -获取当前应用内最后显示的窗口，使用Promise方式作为异步方法。 +获取当前应用内最后显示的窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------- | ---- | ------------------------------------------------------------ | - | ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------------------------------------ | +| ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------- | --------------------------------------------------------- | - | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前应用内最后显示的窗口对象。 | +| 类型 | 说明 | +| -------------------------------- | --------------------------------------------------------- | +| Promise<[Window](#window)> | 以Promise形式返回结果，返回当前应用内最后显示的窗口对象。 | -**示例：** +**示例：** ```js var windowClass = null; @@ -495,14 +495,14 @@ on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): v **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | - | callback | Callback<[SystemBarTintState](#systembartintstate)> | 是 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | +| callback | Callback<[SystemBarTintState](#systembartintstate)> | 是 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'systemBarTintChange'; @@ -521,14 +521,14 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >) **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | - | callback | Callback<[SystemBarTintState](#systembartintstate)> | 否 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | +| callback | Callback<[SystemBarTintState](#systembartintstate)> | 否 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'systemBarTintChange'; @@ -537,25 +537,25 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >) ## Window -下列API示例中都需使用[getTopWindow()](#windowgettopwindow)、[create()](#windowcreate7)、[find()](#windowfind7)等先获取到Window实例，再通过此实例调用对应方法。 +下列API示例中都需先使用[getTopWindow()](#windowgettopwindow)、[create()](#windowcreate7)、[find()](#windowfind7)中的任一方法获取到Window实例，再通过此实例调用对应方法。 ### hide7+ hide (callback: AsyncCallback<void>): void -隐藏当前窗口，使用callback方式作为异步方法。 +隐藏当前窗口，使用callback异步回调。 此接口为系统接口，三方应用不支持调用。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------- | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js windowClass.hide((err, data) => { @@ -571,19 +571,19 @@ hide (callback: AsyncCallback<void>): void hide(): Promise<void> -隐藏当前窗口，使用Promise方式作为异步方法。 +隐藏当前窗口，使用Promise异步回调。 此接口为系统接口，三方应用不支持调用。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.hide(); @@ -598,17 +598,17 @@ hide(): Promise<void> show(callback: AsyncCallback<void>): void -显示当前窗口，使用callback方式作为异步方法。 +显示当前窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------- | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js windowClass.show((err, data) => { @@ -624,17 +624,17 @@ show(callback: AsyncCallback<void>): void show(): Promise<void> -显示当前窗口，使用Promise方式作为异步方法。 +显示当前窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.show(); @@ -649,17 +649,17 @@ show(): Promise<void> destroy(callback: AsyncCallback<void>): void -销毁当前窗口，使用callback方式作为异步方法。 +销毁当前窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------- | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js windowClass.destroy((err, data) => { @@ -675,17 +675,17 @@ destroy(callback: AsyncCallback<void>): void destroy(): Promise<void> -销毁当前窗口，使用Promise方式作为异步方法。 +销毁当前窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.destroy(); @@ -700,19 +700,19 @@ destroy(): Promise<void> moveTo(x: number, y: number, callback: AsyncCallback<void>): void -移动窗口位置，使用callback方式作为异步方法。 +移动窗口位置，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | --------------------------------------- | - | x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移。 | - | y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | --------------------------------------- | +| x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移。 | +| y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js windowClass.moveTo(300, 300, (err, data)=>{ @@ -729,24 +729,24 @@ moveTo(x: number, y: number, callback: AsyncCallback<void>): void moveTo(x: number, y: number): Promise<void> -移动窗口位置，使用Promise方式作为异步方法。 +移动窗口位置，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | --------------------------------------- | - | x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移。 | - | y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | --------------------------------------- | +| x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移。 | +| y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.moveTo(300, 300); @@ -761,19 +761,19 @@ moveTo(x: number, y: number): Promise<void> resetSize(width: number, height: number, callback: AsyncCallback<void>): void -改变当前窗口大小，使用callback方式作为异步方法。 +改变当前窗口大小，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------- | - | width | number | 是 | 目标窗口的宽度。 | - | height | number | 是 | 目标窗口的高度。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------- | +| width | number | 是 | 目标窗口的宽度。 | +| height | number | 是 | 目标窗口的高度。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js windowClass.resetSize(500, 1000, (err, data) => { @@ -789,24 +789,24 @@ resetSize(width: number, height: number, callback: AsyncCallback<void>): v resetSize(width: number, height: number): Promise<void> -改变当前窗口大小，使用Promise方式作为异步方法。 +改变当前窗口大小，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ---------------- | - | width | number | 是 | 目标窗口的宽度。 | - | height | number | 是 | 目标窗口的高度。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------------- | +| width | number | 是 | 目标窗口的宽度。 | +| height | number | 是 | 目标窗口的高度。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.resetSize(500, 1000); @@ -821,20 +821,20 @@ resetSize(width: number, height: number): Promise<void> setWindowType(type: WindowType, callback: AsyncCallback<void>): void -设置窗口类型，使用callback方式作为异步方法。 +设置窗口类型，使用callback异步回调。 此接口为系统接口，三方应用不支持调用。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------- | - | type | [WindowType](#windowtype) | 是 | 窗口类型。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| type | [WindowType](#windowtype) | 是 | 窗口类型。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var type = window.TYPE_APP; @@ -851,25 +851,25 @@ setWindowType(type: WindowType, callback: AsyncCallback<void>): void setWindowType(type: WindowType): Promise<void> -设置窗口类型，使用Promise方式作为异步方法。 +设置窗口类型，使用Promise异步回调。 此接口为系统接口，三方应用不支持调用。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------------------------- | ---- | ---------- | - | type | [WindowType](#windowtype) | 是 | 窗口类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------- | ---- | ---------- | +| type | [WindowType](#windowtype) | 是 | 窗口类型。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var type = window.TYPE_APP; @@ -885,17 +885,17 @@ setWindowType(type: WindowType): Promise<void> getProperties(callback: AsyncCallback<WindowProperties>): void -获取当前窗口的属性，使用callback方式作为异步方法返回WindowProperties。 +获取当前窗口的属性，使用callback异步回调，返回WindowProperties。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------------------------- | ---- | ------------------ | - | callback | AsyncCallback<[WindowProperties](#windowproperties)> | 是 | 回调返回窗口属性。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------------------------- | ---- | ------------------ | +| callback | AsyncCallback<[WindowProperties](#windowproperties)> | 是 | 回调返回窗口属性。 | -**示例：** +**示例：** ```js windowClass.getProperties((err, data) => { @@ -911,17 +911,17 @@ getProperties(callback: AsyncCallback<WindowProperties>): void getProperties(): Promise<WindowProperties> -获取当前窗口的属性，使用promise方式作为异步方法返回WindowProperties。 +获取当前窗口的属性，使用Promise异步回调，返回WindowProperties。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | ---------------------------------------------------- | ------------------------------------- | - | Promise<[WindowProperties](#windowproperties)> | 以Promise形式返回结果，返回窗口属性。 | +| 类型 | 说明 | +| ---------------------------------------------------- | ------------------------------------- | +| Promise<[WindowProperties](#windowproperties)> | 以Promise形式返回结果，返回窗口属性。 | -**示例：** +**示例：** ```js let promise = windowClass.getProperties(); @@ -936,18 +936,18 @@ getProperties(): Promise<WindowProperties> getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): void -获取窗口内容规避的区域，如系统的系统栏区域、凹凸区域。使用callback方式作为异步方法。 +获取窗口内容规避的区域，如系统的系统栏区域、凹凸区域。使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | - | type | [AvoidAreaType](#avoidareatype) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | - | callback | AsyncCallback<[AvoidArea](#avoidarea)> | 是 | 回调返回窗口内容规避区域。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | [AvoidAreaType](#avoidareatype) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | +| callback | AsyncCallback<[AvoidArea](#avoidarea)> | 是 | 回调返回窗口内容规避区域。 | -**示例：** +**示例：** ```js var type = window.AvoidAreaType.TYPE_SYSTEM; @@ -964,23 +964,23 @@ getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): voi getAvoidArea(type: AvoidAreaType): Promise<AvoidArea> -获取窗口内容规避的区域，如系统的系统栏区域、凹凸区域。使用promise方式作为异步方法。 +获取窗口内容规避的区域，如系统的系统栏区域、凹凸区域。使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------------------------------- | ---- | ------------------------------------------------------------ | - | type | [AvoidAreaType](#avoidareatype) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------- | ---- | ------------------------------------------------------------ | +| type | [AvoidAreaType](#avoidareatype) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------------- | --------------------------------------------- | - | Promise<[AvoidArea](#avoidarea)> | 以Promise形式返回结果，返回窗口内容规避区域。 | +| 类型 | 说明 | +| -------------------------------------- | --------------------------------------------- | +| Promise<[AvoidArea](#avoidarea)> | 以Promise形式返回结果，返回窗口内容规避区域。 | -**示例：** +**示例：** ```js let promise = windowClass.getAvoidArea(); @@ -995,18 +995,18 @@ getAvoidArea(type: AvoidAreaType): Promise<AvoidArea> setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void -设置是否为全屏状态，使用callback方式作为异步方法。 +设置是否为全屏状态，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------ | ------------------------- | ---- | ---------------------------------------------- | - | isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ------------------------- | ---- | ---------------------------------------------- | +| isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var isFullScreen = true; @@ -1023,23 +1023,23 @@ setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void setFullScreen(isFullScreen: boolean): Promise<void> -设置是否为全屏状态，使用Promise方式作为异步方法。 +设置是否为全屏状态，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------ | ------- | ---- | ---------------------------------------------- | - | isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ------- | ---- | ---------------------------------------------- | +| isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var isFullScreen = true; @@ -1055,18 +1055,18 @@ setFullScreen(isFullScreen: boolean): Promise<void> setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void -设置窗口的布局是否为全屏显示状态，使用callback方式作为异步方法。 +设置窗口的布局是否为全屏显示状态，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------------ | ------------------------- | ---- | ------------------------------------------------------------ | - | isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------------ | ------------------------- | ---- | ------------------------------------------------------------ | +| isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var isLayoutFullScreen= true; @@ -1083,23 +1083,23 @@ setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void setLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void> -设置窗口的布局是否为全屏显示状态，使用Promise方式作为异步方法。 +设置窗口的布局是否为全屏显示状态，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------------ | ------- | ---- | ------------------------------------------------------------ | - | isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------------ | ------- | ---- | ------------------------------------------------------------ | +| isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var isLayoutFullScreen = true; @@ -1115,18 +1115,18 @@ setLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void> setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback<void>): void -设置导航栏、状态栏的可见模式，使用callback方式作为异步方法。 +设置导航栏、状态栏的可见模式，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------------------------------------------------------ | - | names | Array | 是 | 设置状态栏和导航栏是否显示。例如，需全部显示，该参数设置为["status", "navigation"], 不设置，则默认不显示。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| names | Array | 是 | 设置状态栏和导航栏是否显示。例如，需全部显示，该参数设置为["status", "navigation"], 不设置，则默认不显示。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var names = ["status", "navigation"]; @@ -1143,23 +1143,23 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallbac setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void> -设置导航栏、状态栏的可见模式，使用Promise方式作为异步方法。 +设置导航栏、状态栏的可见模式，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ----- | ---- | ------------------------------------------------------------ | - | names | Array | 是 | 设置状态栏和导航栏是否显示。例如，需全部显示，该参数设置为["status", "navigation"], 不设置，则默认不显示。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----- | ---- | ------------------------------------------------------------ | +| names | Array | 是 | 设置状态栏和导航栏是否显示。例如，需全部显示，该参数设置为["status", "navigation"], 不设置，则默认不显示。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var names = ["status", "navigation"]; @@ -1175,18 +1175,18 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void> setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void -设置窗口内导航栏、状态栏的属性，使用callback方式作为异步方法。 +设置窗口内导航栏、状态栏的属性，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------------- | ------------------------------------------- | ---- | -------------------- | - | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏状态栏的属性。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------------- | ------------------------------------------- | ---- | -------------------- | +| SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏状态栏的属性。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var SystemBarProperties={ @@ -1212,23 +1212,23 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: Async setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<void> -设置窗口内导航栏、状态栏的属性，使用Promise方式作为异步方法。 +设置窗口内导航栏、状态栏的属性，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------------- | ------------------------------------------- | ---- | -------------------- | - | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏状态栏的属性。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------------- | ------------------------------------------- | ---- | -------------------- | +| SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏状态栏的属性。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var SystemBarProperties={ @@ -1253,18 +1253,18 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<voi loadContent(path: string, callback: AsyncCallback<void>): void -当前窗口加载具体页面内容，使用callback方式作为异步方法。 +当前窗口加载具体页面内容，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | -------------------- | - | path | string | 是 | 设置加载页面的路径。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------- | +| path | string | 是 | 设置加载页面的路径。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js windowClass.loadContent("pages/page2/page2", (err, data) => { @@ -1280,23 +1280,23 @@ loadContent(path: string, callback: AsyncCallback<void>): void loadContent(path: string): Promise<void> -当前窗口加载具体页面内容，使用Promise方式作为异步方法。 +当前窗口加载具体页面内容，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | -------------------- | - | path | string | 是 | 设置加载页面的路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------- | +| path | string | 是 | 设置加载页面的路径。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.loadContent("pages/page2/page2"); @@ -1311,17 +1311,17 @@ loadContent(path: string): Promise<void> isShowing(callback: AsyncCallback<boolean>): void -判断当前窗口是否已显示，使用callback方式作为异步方法。 +判断当前窗口是否已显示，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------- | ---- | -------------------------------- | - | callback | AsyncCallback<boolean> | 是 | 回调函数返回是否显示子窗口结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | -------------------------------- | +| callback | AsyncCallback<boolean> | 是 | 回调函数返回是否显示子窗口结果。 | -**示例：** +**示例：** ```js windowClass.isShowing((err, data) => { @@ -1337,17 +1337,17 @@ isShowing(callback: AsyncCallback<boolean>): void isShowing(): Promise<boolean> -判断当前窗口是否已显示，使用Promise方式作为异步方法。 +判断当前窗口是否已显示，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | ---------------------- | ----------------------------------------------------- | - | Promise<boolean> | 以Promise形式返回结果，返回当前窗口是否已显示的结果。 | +| 类型 | 说明 | +| ---------------------- | ----------------------------------------------------- | +| Promise<boolean> | 以Promise形式返回结果，返回当前窗口是否已显示的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.isShowing(); @@ -1366,14 +1366,14 @@ on(type: 'windowSizeChange', callback: Callback<Size>): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------- | ---- | -------------------------------------------------------- | - | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | - | callback | Callback<[Size](#size)> | 是 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------- | ---- | -------------------------------------------------------- | +| type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | +| callback | Callback<[Size](#size)> | 是 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'windowSizeChange'; @@ -1390,14 +1390,14 @@ off(type: 'windowSizeChange', callback?: Callback<Size >): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------- | ---- | -------------------------------------------------------- | - | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | - | callback | Callback<[Size](#size)> | 否 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------- | ---- | -------------------------------------------------------- | +| type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | +| callback | Callback<[Size](#size)> | 否 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'windowSizeChange'; @@ -1412,14 +1412,14 @@ on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | - | callback | Callback<[AvoidArea](#avoidarea)> | 是 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | +| callback | Callback<[AvoidArea](#avoidarea)> | 是 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'systemAvoidAreaChange'; @@ -1436,14 +1436,14 @@ off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | - | callback | Callback<[AvoidArea](#avoidarea)> | 否 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | +| callback | Callback<[AvoidArea](#avoidarea)> | 否 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'systemAvoidAreaChange'; @@ -1456,18 +1456,16 @@ on(type: 'keyboardHeightChange', callback: Callback<number>): void 开启键盘高度变化的监听。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | - | callback | Callbacknumber> | 是 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | +| callback | Callbacknumber> | 是 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'keyboardHeightChange'; @@ -1482,18 +1480,16 @@ off(type: 'keyboardHeightChange', callback?: Callback<number>): void 关闭键盘高度变化的监听。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | - | callback | Callback<number> | 否 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | +| callback | Callback<number> | 否 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```js var type = 'keyboardHeightChange'; @@ -1504,17 +1500,17 @@ off(type: 'keyboardHeightChange', callback?: Callback<number>): void isSupportWideGamut(callback: AsyncCallback<boolean>): void -判断当前窗口是否支持广色域模式，使用callback方式作为异步方法。 +判断当前窗口是否支持广色域模式，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------- | ---- | -------------------------------- | - | callback | AsyncCallback<boolean> | 是 | 回调函数返回是否支持广色域模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | -------------------------------- | +| callback | AsyncCallback<boolean> | 是 | 回调函数返回是否支持广色域模式。 | -**示例：** +**示例：** ```js windowClass.isSupportWideGamut((err, data) => { @@ -1530,17 +1526,17 @@ isSupportWideGamut(callback: AsyncCallback<boolean>): void isSupportWideGamut(): Promise<boolean> -判断当前窗口是否支持广色域模式，使用Promise方式作为异步方法。 +判断当前窗口是否支持广色域模式，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | ---------------------- | ------------------------------------------------------------ | - | Promise<boolean> | 以Promise形式返回结果，返回当前窗口是否支持广色域模式的结果。 | +| 类型 | 说明 | +| ---------------------- | ------------------------------------------------------------ | +| Promise<boolean> | 以Promise形式返回结果，返回当前窗口是否支持广色域模式的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.isSupportWideGamut(); @@ -1555,18 +1551,18 @@ isSupportWideGamut(): Promise<boolean> setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void -设置当前窗口为广色域模式或默认色域模式，使用callback方式作为异步方法。 +设置当前窗口为广色域模式或默认色域模式，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---------- | ------------------------- | ---- | ------------ | - | colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | ------------ | +| colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err, data) => { @@ -1582,23 +1578,23 @@ setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void setColorSpace(colorSpace:ColorSpace): Promise<void> -设置当前窗口为广色域模式或默认色域模式，使用Promise方式作为异步方法。 +设置当前窗口为广色域模式或默认色域模式，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---------- | ------------------------- | ---- | ------------ | - | colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | ------------ | +| colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js let promise = windowClass.isSupportWideGamut(window.ColorSpace.WIDE_GAMUT); @@ -1613,17 +1609,17 @@ setColorSpace(colorSpace:ColorSpace): Promise<void> getColorSpace(callback: AsyncCallback<ColorSpace>): void -获取当前窗口色域模式，使用callback方式作为异步方法。 +获取当前窗口色域模式，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------------- | ---- | -------------------------- | - | callback | AsyncCallback<[ColorSpace](#colorspace)> | 是 | 回调函数返回当前色域模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------------- | ---- | -------------------------- | +| callback | AsyncCallback<[ColorSpace](#colorspace)> | 是 | 回调函数返回当前色域模式。 | -**示例：** +**示例：** ```js windowClass.getColorSpace((err, data) => { @@ -1639,17 +1635,17 @@ getColorSpace(callback: AsyncCallback<ColorSpace>): void getColorSpace(): Promise<ColorSpace> -获取当前窗口色域模式，使用Promise方式作为异步方法。 +获取当前窗口色域模式，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | ---------------------------------------- | ----------------------------------------- | - | Promise<[ColorSpace](#colorspace)> | 以Promise形式返回结果，返回当前色域模式。 | +| 类型 | 说明 | +| ---------------------------------------- | ----------------------------------------- | +| Promise<[ColorSpace](#colorspace)> | 以Promise形式返回结果，返回当前色域模式。 | -**示例：** +**示例：** ```js let promise = windowClass.getColorSpace(); @@ -1664,20 +1660,18 @@ getColorSpace(): Promise<ColorSpace> setBackgroundColor(color: string, callback: AsyncCallback<void>): void -设置窗口的背景色，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置窗口的背景色，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------------------------------------------------------ | - | color | string | 是 | 需要设置的背景色，为16进制颜色，例如"#00FF00"或"#FF00FF00"。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| color | string | 是 | 需要设置的背景色，为16进制颜色，例如"#00FF00"或"#FF00FF00"。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var color = '#00ff33'; @@ -1694,25 +1688,23 @@ setBackgroundColor(color: string, callback: AsyncCallback<void>): void setBackgroundColor(color: string): Promise<void> -设置窗口的背景色，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置窗口的背景色，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------------------------------------------------------------ | - | color | string | 是 | 需要设置的背景色，为16进制颜色，例如"#00FF00"或"#FF00FF00"。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| color | string | 是 | 需要设置的背景色，为16进制颜色，例如"#00FF00"或"#FF00FF00"。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var color = '#00ff33'; @@ -1728,20 +1720,18 @@ setBackgroundColor(color: string): Promise<void> setBrightness(brightness: number, callback: AsyncCallback<void>): void -设置屏幕亮度值，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置屏幕亮度值，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---------- | ------------------------- | ---- | ------------------------------------ | - | brightness | number | 是 | 屏幕亮度值，值为0-1之间。1表示最亮。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | ------------------------------------ | +| brightness | number | 是 | 屏幕亮度值，值为0-1之间。1表示最亮。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var brightness = 1; @@ -1758,25 +1748,23 @@ setBrightness(brightness: number, callback: AsyncCallback<void>): void setBrightness(brightness: number): Promise<void> -设置屏幕亮度值，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置屏幕亮度值，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---------- | ------ | ---- | ------------------------------------ | - | brightness | number | 是 | 屏幕亮度值，值为0-1之间。1表示最亮。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ------------------------------------ | +| brightness | number | 是 | 屏幕亮度值，值为0-1之间。1表示最亮。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var brightness = 1; @@ -1788,86 +1776,22 @@ setBrightness(brightness: number): Promise<void> }); ``` -### setDimBehind7+ - -setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void - -窗口叠加时，设备有子窗口的情况下设置靠后的窗口的暗度值，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - -**系统能力：** 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)); - }); - ``` - -### setDimBehind7+ - -setDimBehind(dimBehindValue: number): Promise<void> - -窗口叠加时，设备有子窗口的情况下设置靠后的窗口的暗度值，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - -**系统能力：** 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 -设置点击时是否支持切换焦点窗口，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置点击时是否支持切换焦点窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----------- | ------------------------- | ---- | ---------------------------- | - | isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------------------------- | ---- | ---------------------------- | +| isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var isFocusable= true; @@ -1884,25 +1808,23 @@ setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void setFocusable(isFocusable: boolean): Promise<void> -设置点击时是否支持切换焦点窗口，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置点击时是否支持切换焦点窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----------- | ------- | ---- | ---------------------------- | - | isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------- | ---- | ---------------------------- | +| isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var isFocusable= true; @@ -1918,20 +1840,18 @@ setFocusable(isFocusable: boolean): Promise<void> setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void -设置屏幕是否为常亮状态，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置屏幕是否为常亮状态，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------------- | ------------------------- | ---- | ------------------------ | - | isKeepScreenOn | boolean | 是 | 是否设置为屏幕常亮状态。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------- | ---- | ------------------------ | +| isKeepScreenOn | boolean | 是 | 是否设置为屏幕常亮状态。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var isKeepScreenOn = true; @@ -1948,25 +1868,23 @@ setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): v setKeepScreenOn(isKeepScreenOn: boolean): Promise<void> -设置屏幕是否为常亮状态，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置屏幕是否为常亮状态，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------------- | ------- | ---- | ------------------------ | - | isKeepScreenOn | boolean | 是 | 是否设置为屏幕常亮状态。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------- | ---- | ------------------------ | +| isKeepScreenOn | boolean | 是 | 是否设置为屏幕常亮状态。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var isKeepScreenOn= true; @@ -1978,86 +1896,22 @@ setKeepScreenOn(isKeepScreenOn: boolean): Promise<void> }); ``` -### setOutsideTouchable7+ - -setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): void - -设置是否允许可点击子窗口以外的区域，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - -**系统能力：** 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)) - }) - ``` - -### setOutsideTouchable7+ - -setOutsideTouchable(touchable: boolean): Promise<void> - -设置是否允许可点击子窗口以外的区域，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - -**系统能力：** 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)); - }); - ``` - ### setPrivacyMode7+ setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void -设置窗口是否为隐私模式，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置窗口是否为隐私模式，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------- | ------------------------- | ---- | -------------------- | - | isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | ------------------------- | ---- | -------------------- | +| isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var isPrivacyMode = true; @@ -2075,25 +1929,23 @@ setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): voi setPrivacyMode(isPrivacyMode: boolean): Promise<void> -设置窗口是否为隐私模式，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置窗口是否为隐私模式，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------------- | ------- | ---- | -------------------- | - | isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | ------- | ---- | -------------------- | +| isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var isPrivacyMode = true; @@ -2109,20 +1961,18 @@ setPrivacyMode(isPrivacyMode: boolean): Promise<void> setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void -设置窗口是否为可触状态，使用callback方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置窗口是否为可触状态，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----------- | ------------------------- | ---- | -------------------- | - | isTouchable | boolean | 是 | 窗口是否为可触状态。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------------------------- | ---- | -------------------- | +| isTouchable | boolean | 是 | 窗口是否为可触状态。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```js var isTouchable = true; @@ -2140,25 +1990,23 @@ setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void setTouchable(isTouchable: boolean): Promise<void> -设置窗口是否为可触状态，使用Promise方式作为异步方法。 - -本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +设置窗口是否为可触状态，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----------- | ------- | ---- | -------------------- | - | isTouchable | boolean | 是 | 窗口是否为可触状态。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------- | ---- | -------------------- | +| isTouchable | boolean | 是 | 窗口是否为可触状态。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | ------------------- | ----------------------------------------------- | - | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------------- | +| Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -**示例：** +**示例：** ```js var isTouchable = true; @@ -2191,17 +2039,17 @@ WindowStage生命周期。 getMainWindow(): Promise<Window> -获取该WindowStage实例下的主窗口，使用Promise方式作为异步方法。 +获取该WindowStage实例下的主窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------- | ---------------------------------------------------------- | - | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前WindowStage下的主窗口对象。 | +| 类型 | 说明 | +| -------------------------------- | ---------------------------------------------------------- | +| Promise<[Window](#window)> | 以Promise形式返回结果，返回当前WindowStage下的主窗口对象。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2223,17 +2071,17 @@ getMainWindow(): Promise<Window> getMainWindow(callback: AsyncCallback<Window>): void -获取该WindowStage实例下的主窗口，使用callback方式作为异步方法。 +获取该WindowStage实例下的主窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | --------------------------------------- | - | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前WindowStage下的主窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | --------------------------------------- | +| callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前WindowStage下的主窗口对象。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2256,23 +2104,23 @@ getMainWindow(callback: AsyncCallback<Window>): void createSubWindow(name: string): Promise<Window> -创建该WindowStage实例下的子窗口，使用Promise方式作为异步方法。 +创建该WindowStage实例下的子窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | -------------- | - | name | String | 是 | 子窗口的名字。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------- | +| name | String | 是 | 子窗口的名字。 | -**返回值：** +**返回值：** - | 类型 | 说明 | - | -------------------------------- | ------------------------------------------------- | - | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的子窗口对象。 | +| 类型 | 说明 | +| -------------------------------- | ------------------------------------------------- | +| Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的子窗口对象。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2294,18 +2142,18 @@ createSubWindow(name: string): Promise<Window> createSubWindow(name: string, callback: AsyncCallback<Window>): void -创建该WindowStage实例下的子窗口，使用callback方式作为异步方法。 +创建该WindowStage实例下的子窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | ------------------------------ | - | name | String | 是 | 子窗口的名字。 | - | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前创建的子窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ------------------------------ | +| name | String | 是 | 子窗口的名字。 | +| callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前创建的子窗口对象。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2329,17 +2177,17 @@ createSubWindow(name: string, callback: AsyncCallback<Window>): void getSubWindow(): Promise<Array<Window>> -获取该WindowStage实例下的所有子窗口，使用Promise方式作为异步方法。 +获取该WindowStage实例下的所有子窗口，使用Promise异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**返回值：** +**返回值：** - | 类型 | 说明 | - | --------------------------------------------- | ------------------------------------------------------------ | - | Promise<Array<[Window](#window)>> | 以Promise形式返回结果，返回当前WindowStage下的所有子窗口对象。 | +| 类型 | 说明 | +| --------------------------------------------- | ------------------------------------------------------------ | +| Promise<Array<[Window](#window)>> | 以Promise形式返回结果，返回当前WindowStage下的所有子窗口对象。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2361,17 +2209,17 @@ getSubWindow(): Promise<Array<Window>> getSubWindow(callback: AsyncCallback<Array<Window>>): void -获取该WindowStage实例下的所有子窗口，使用callback方式作为异步方法。 +获取该WindowStage实例下的所有子窗口，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------------------- | ---- | ------------------------------------------- | - | callback | AsyncCallback<Array<[Window](#window)>> | 是 | 回调返回当前WindowStage下的所有子窗口对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------- | ---- | ------------------------------------------- | +| callback | AsyncCallback<Array<[Window](#window)>> | 是 | 回调返回当前WindowStage下的所有子窗口对象。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2394,18 +2242,18 @@ getSubWindow(callback: AsyncCallback<Array<Window>>): void loadContent(path: string, callback: AsyncCallback<void>): void -为当前WindowStage的主窗口加载具体页面内容，使用callback方式作为异步方法。 +为当前WindowStage的主窗口加载具体页面内容，使用callback异步回调。 **系统能力：** SystemCapability.WindowManager.WindowManager.Coretype为'windowSizeChange' -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | -------------------- | - | path | string | 是 | 设置加载页面的路径。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------- | +| path | string | 是 | 设置加载页面的路径。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2430,14 +2278,14 @@ on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType> **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | - | callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 是 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | +| callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 是 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```ts class myAbility extends Ability { @@ -2459,14 +2307,14 @@ off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType&g **系统能力：** SystemCapability.WindowManager.WindowManager.Core -**参数：** +**参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | - | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | - | callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 否 | 回调返回监听到的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | +| callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 否 | 回调返回监听到的信息。 | -**示例：** +**示例：** ```ts class myAbility extends Ability {