提交 ae686d70 编写于 作者: G ge-yafang

update docs

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