Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
3845f9d3
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
3845f9d3
编写于
5月 20, 2022
作者:
G
ge-yafang
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
ge-yafang
<
geyafang@huawei.com
>
上级
d90e4f3c
变更
5
显示空白变更内容
内联
并排
Showing
5 changed file
with
588 addition
and
739 deletion
+588
-739
zh-cn/application-dev/quick-start/start-with-ets-low-code.md
zh-cn/application-dev/quick-start/start-with-ets-low-code.md
+4
-4
zh-cn/application-dev/quick-start/start-with-ets.md
zh-cn/application-dev/quick-start/start-with-ets.md
+3
-3
zh-cn/application-dev/quick-start/start-with-js-low-code.md
zh-cn/application-dev/quick-start/start-with-js-low-code.md
+3
-3
zh-cn/application-dev/quick-start/start-with-js.md
zh-cn/application-dev/quick-start/start-with-js.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-window.md
zh-cn/application-dev/reference/apis/js-apis-window.md
+575
-727
未找到文件。
zh-cn/application-dev/quick-start/start-with-ets-low-code.md
浏览文件 @
3845f9d3
...
...
@@ -17,7 +17,7 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能,通过可
-
直接创建一个支持低代码开发的新工程以进行开发。本文以此方式为例进行说明。
-
在已有工程中,创建
V
isual文件来进行开发。
-
在已有工程中,创建
v
isual文件来进行开发。
## 创建新工程支持低代码开发
...
...
@@ -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>
打开index.visual文件,选中画布中的组件,单击鼠标右键,选择Delete删除画布原有模板组件。操作如下所示:
...
...
zh-cn/application-dev/quick-start/start-with-ets.md
浏览文件 @
3845f9d3
...
...
@@ -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)
...
...
zh-cn/application-dev/quick-start/start-with-js-low-code.md
浏览文件 @
3845f9d3
...
...
@@ -15,7 +15,7 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能,通过可
-
直接创建一个支持低代码开发的新工程以进行开发。本文以此方式为例进行说明。
-
在已有工程中,创建
V
isual文件来进行开发。
-
在已有工程中,创建
v
isual文件来进行开发。
## 创建新工程支持低代码开发
...
...
@@ -50,9 +50,9 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能,通过可
## 构建第一个页面
工程同步完成后,第一个页面已有一个容器、文本(Hello World)显示。为了更详细地了解低代码开发,我们将删除画布原有模板组件,从零开始完成页面的添加、设置。
工程同步完成后,第一个页面已有一个容器、
一段
文本(Hello World)显示。为了更详细地了解低代码开发,我们将删除画布原有模板组件,从零开始完成页面的添加、设置。
第一个页面内有一个容器、文本和一个按钮,通过Div、Text和Button组件来实现。
第一个页面内有一个容器、
一段
文本和一个按钮,通过Div、Text和Button组件来实现。
1.
删除画布原有模板组件。
<a
name=
delete_origin_content
></a>
打开index.visual文件,选中画布中的组件,单击鼠标右键,选择Delete删除画布原有模板组件。操作如下所示:
...
...
zh-cn/application-dev/quick-start/start-with-js.md
浏览文件 @
3845f9d3
...
...
@@ -52,7 +52,7 @@
```
2.
添加按钮,并绑定onclick方法。
在默认页面基础上,我们添加一个button类型的input组件,作为按钮
接收用户点击的动作
,从而实现跳转到另一个页面。“
**index.hml**
”文件的示例代码如下:
在默认页面基础上,我们添加一个button类型的input组件,作为按钮
响应用户点击
,从而实现跳转到另一个页面。“
**index.hml**
”文件的示例代码如下:
```
...
...
@@ -102,6 +102,7 @@
4.
在编辑窗口右上角的侧边工具栏,点击Previewer,打开预览器。第一个页面效果如下图所示:
!
[
zh-cn_image_0000001216084724
](
figures/zh-cn_image_0000001216084724.png
)
...
...
zh-cn/application-dev/reference/apis/js-apis-window.md
浏览文件 @
3845f9d3
...
...
@@ -3,6 +3,7 @@
窗口提供管理窗口的一些基础能力,包括对窗口的创建、销毁,以及对窗口的属性设置等各项功能。
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> API 9当前为Canary版本,仅供试用,不保证接口可稳定调用。
...
...
@@ -110,7 +111,7 @@ import window from '@ohos.window';
## AvoidArea<sup>7+</sup>
表示
窗口内容规避区域。
窗口内容规避区域。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。
...
...
@@ -139,19 +140,18 @@ import window from '@ohos.window';
**系统能力:**
以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------------------- | ------------------------- | ---- | ---- | --------------------------------------------
----------------
|
| ------------------------------- | ------------------------- | ---- | ---- | -------------------------------------------- |
| windowRect
<sup>
7+
</sup>
|
[
Rect
](
#rect
)
| 是 | 是 | 窗口尺寸。 |
| type
<sup>
7+
</sup>
|
[
WindowType
](
#windowtype
)
| 是 | 是 | 窗口类型。 |
| isFullScreen | boolean | 是 | 是 | 是否全屏,默认为false。 |
| isLayoutFullScreen
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否为沉浸式,默认为false。 |
| focusable
<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版本中提供使用支持。 |
| dimBehindValue
<sup>
7+
</sup>
| number | 是 | 是 | 靠后窗口的暗度值,取值范围为0~1,1表示最暗。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮,默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isPrivacyMode
<sup>
7+
</sup>
| boolean | 是 | 是 | 隐私模式,默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isRoundCorner
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否为圆角。默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isTransparent
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否透明。默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| brightness | number | 是 | 是 | 屏幕亮度, 取值范围为0~1,1表示最大亮度值。 |
| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮,默认为false。 |
| isPrivacyMode
<sup>
7+
</sup>
| boolean | 是 | 是 | 隐私模式,默认为false。 |
| isRoundCorner
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否为圆角。默认为false。 |
| isTransparent
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否透明。默认为false。 |
## ColorSpace<sup>8+</sup>
...
...
@@ -168,7 +168,7 @@ import window from '@ohos.window';
create(id: string, type: WindowType, callback: AsyncCallback
<
Window
>
): void
创建子窗口,使用callback
方式作为异步方法
。
创建子窗口,使用callback
异步回调
。
从API version 8开始,此接口废弃,推荐使用
[
window.create<sup>8+</sup>
](
#windowcreate8
)
接口。
...
...
@@ -176,11 +176,11 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------- |
| id | string | 是 | 窗口id。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| callback | AsyncCallback
<
[Window](#window)
>
| 是 | 回调返回创建的子窗口对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------- |
| id | string | 是 | 窗口id。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| callback | AsyncCallback
<
[Window](#window)
>
| 是 | 回调返回创建的子窗口对象。 |
**示例:**
...
...
@@ -201,7 +201,7 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi
create(id: string, type: WindowType): Promise
<
Window
>
创建子窗口,使用Promise
方式作为异步方法
。
创建子窗口,使用Promise
异步回调
。
从API version 8开始,此接口废弃,推荐使用
[
window.create<sup>8+</sup>
](
#windowcreate8
)
接口。
...
...
@@ -209,16 +209,16 @@ create(id: string, type: WindowType): Promise<Window>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ---------- |
| id | string | 是 | 窗口id。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ---------- |
| id | string | 是 | 窗口id。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
**返回值:**
| 类型 | 说明 |
| -------------------------------- | ------------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前创建的子窗口对象。 |
| 类型 | 说明 |
| -------------------------------- | ------------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前创建的子窗口对象。 |
**示例:**
...
...
@@ -237,20 +237,20 @@ 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 | 是 | 当前应用上下文信息。
<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。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| callback | AsyncCallback
<
[Window](#window)
>
| 是 | 回调返回当前窗口对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ |
| 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。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| callback | AsyncCallback
<
[Window](#window)
>
| 是 | 回调返回当前窗口对象。 |
**示例:**
...
...
@@ -271,25 +271,25 @@ 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 | 是 | 当前应用上下文信息。
<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。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ------------------------------------------------------------ |
| 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。 |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
**返回值:**
| 类型 | 说明 |
| -------------------------------- | ----------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前创建的窗口对象。 |
| 类型 | 说明 |
| -------------------------------- | ----------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前创建的窗口对象。 |
**示例:**
...
...
@@ -308,16 +308,16 @@ 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)
>
| 是 | 回调返回当前查找的窗口对象。 |
**示例:**
...
...
@@ -337,21 +337,21 @@ 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形式返回结果,返回当前查找的窗口对象。 |
**示例:**
...
...
@@ -370,7 +370,7 @@ find(id: string): Promise<Window>
getTopWindow(callback: AsyncCallback
<
Window
>
): void
获取当前应用内最后显示的窗口,使用callback
方式作为异步方法
。
获取当前应用内最后显示的窗口,使用callback
异步回调
。
从API version 8开始,此接口废弃,推荐使用
[
window.getTopWindow<sup>8+</sup>
](
#windowgettopwindow8
)
接口。
...
...
@@ -378,9 +378,9 @@ getTopWindow(callback: AsyncCallback<Window>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback
<
[Window](#window)
>
| 是 | 回调返回当前应用内最后显示的窗口对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback
<
[Window](#window)
>
| 是 | 回调返回当前应用内最后显示的窗口对象。 |
**示例:**
...
...
@@ -400,7 +400,7 @@ getTopWindow(callback: AsyncCallback<Window>): void
getTopWindow(): Promise
<
Window
>
获取当前应用内最后显示的窗口,使用Promise
方式作为异步方法
。
获取当前应用内最后显示的窗口,使用Promise
异步回调
。
从API version 8开始,此接口废弃,推荐使用
[
window.getTopWindow<sup>8+</sup>
](
#windowgettopwindow8
)
接口。
...
...
@@ -408,9 +408,9 @@ getTopWindow(): Promise<Window>
**返回值:**
| 类型 | 说明 |
| -------------------------------- | --------------------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |
| 类型 | 说明 |
| -------------------------------- | --------------------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |
**示例:**
...
...
@@ -429,16 +429,16 @@ getTopWindow(): Promise<Window>
getTopWindow(ctx: Context, callback: AsyncCallback
<
Window
>
): void
获取当前应用内最后显示的窗口,使用callback
方式作为异步方法
。
获取当前应用内最后显示的窗口,使用callback
异步回调
。
**系统能力:**
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
)
。 |
| callback | AsyncCallback
<
[Window](#window)
>
| 是 | 回调返回当前应用内最后显示的窗口对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ |
| 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
<
[Window](#window)
>
| 是 | 回调返回当前应用内最后显示的窗口对象。 |
**示例:**
...
...
@@ -458,21 +458,21 @@ getTopWindow(ctx: Context, callback: AsyncCallback<Window>): void
getTopWindow(ctx: Context): Promise
<
Window
>
获取当前应用内最后显示的窗口,使用Promise
方式作为异步方法
。
获取当前应用内最后显示的窗口,使用Promise
异步回调
。
**系统能力:**
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
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |
| 类型 | 说明 |
| -------------------------------- | --------------------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前应用内最后显示的窗口对象。 |
**示例:**
...
...
@@ -499,10 +499,10 @@ on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): v
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemBarTintChange',即导航栏、状态栏属性变化事件。 |
| callback | Callback
<
[SystemBarTintState](#systembartintstate)
>
| 是 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemBarTintChange',即导航栏、状态栏属性变化事件。 |
| callback | Callback
<
[SystemBarTintState](#systembartintstate)
>
| 是 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -525,10 +525,10 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemBarTintChange',即导航栏、状态栏属性变化事件。 |
| callback | Callback
<
[SystemBarTintState](#systembartintstate)
>
| 否 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemBarTintChange',即导航栏、状态栏属性变化事件。 |
| callback | Callback
<
[SystemBarTintState](#systembartintstate)
>
| 否 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -539,13 +539,13 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >)
## Window
下列API示例中都需
使用
[
getTopWindow()
](
#windowgettopwindow
)
、
[
create()
](
#windowcreate7
)
、
[
find()
](
#windowfind7
)
等先
获取到Window实例,再通过此实例调用对应方法。
下列API示例中都需
先使用
[
getTopWindow()
](
#windowgettopwindow
)
、
[
create()
](
#windowcreate7
)
、
[
find()
](
#windowfind7
)
中的任一方法
获取到Window实例,再通过此实例调用对应方法。
### hide<sup>7+</sup>
hide (callback: AsyncCallback
<
void
>
): void
隐藏当前窗口,使用callback
方式作为异步方法
。
隐藏当前窗口,使用callback
异步回调
。
此接口为系统接口,三方应用不支持调用。
...
...
@@ -553,9 +553,9 @@ hide (callback: AsyncCallback<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -573,7 +573,7 @@ hide (callback: AsyncCallback<void>): void
hide(): Promise
<
void
>
隐藏当前窗口,使用Promise
方式作为异步方法
。
隐藏当前窗口,使用Promise
异步回调
。
此接口为系统接口,三方应用不支持调用。
...
...
@@ -581,9 +581,9 @@ hide(): Promise<void>
**返回值:**
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -600,15 +600,15 @@ hide(): Promise<void>
show(callback: AsyncCallback
<
void
>
): void
显示当前窗口,使用callback
方式作为异步方法
。
显示当前窗口,使用callback
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -626,15 +626,15 @@ show(callback: AsyncCallback<void>): void
show(): Promise
<
void
>
显示当前窗口,使用Promise
方式作为异步方法
。
显示当前窗口,使用Promise
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -651,15 +651,15 @@ show(): Promise<void>
destroy(callback: AsyncCallback
<
void
>
): void
销毁当前窗口,使用callback
方式作为异步方法
。
销毁当前窗口,使用callback
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -677,15 +677,15 @@ destroy(callback: AsyncCallback<void>): void
destroy(): Promise
<
void
>
销毁当前窗口,使用Promise
方式作为异步方法
。
销毁当前窗口,使用Promise
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -702,17 +702,17 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -731,22 +731,22 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -763,17 +763,17 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -791,22 +791,22 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -823,7 +823,7 @@ resetSize(width: number, height: number): Promise<void>
setWindowType(type: WindowType, callback: AsyncCallback
<
void
>
): void
设置窗口类型,使用callback
方式作为异步方法
。
设置窗口类型,使用callback
异步回调
。
此接口为系统接口,三方应用不支持调用。
...
...
@@ -831,10 +831,10 @@ setWindowType(type: WindowType, callback: AsyncCallback<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -853,7 +853,7 @@ setWindowType(type: WindowType, callback: AsyncCallback<void>): void
setWindowType(type: WindowType): Promise
<
void
>
设置窗口类型,使用Promise
方式作为异步方法
。
设置窗口类型,使用Promise
异步回调
。
此接口为系统接口,三方应用不支持调用。
...
...
@@ -861,15 +861,15 @@ setWindowType(type: WindowType): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ---------- |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ---------- |
| type |
[
WindowType
](
#windowtype
)
| 是 | 窗口类型。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
| 类型 | 说明 |
| ------------------- | ----------------------------------------------- |
| Promise
<
void
>
| 以Promise形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -887,15 +887,15 @@ 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)
>
| 是 | 回调返回窗口属性。 |
**示例:**
...
...
@@ -913,15 +913,15 @@ getProperties(callback: AsyncCallback<WindowProperties>): void
getProperties(): Promise
<
WindowProperties
>
获取当前窗口的属性,使用
promise方式作为异步方法
返回WindowProperties。
获取当前窗口的属性,使用
Promise异步回调,
返回WindowProperties。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------------------------------------- | ------------------------------------- |
| Promise
<
[WindowProperties](#windowproperties)
>
| 以Promise形式返回结果,返回窗口属性。 |
| 类型 | 说明 |
| ---------------------------------------------------- | ------------------------------------- |
| Promise
<
[WindowProperties](#windowproperties)
>
| 以Promise形式返回结果,返回窗口属性。 |
**示例:**
...
...
@@ -938,16 +938,16 @@ 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)
>
| 是 | 回调返回窗口内容规避区域。 |
**示例:**
...
...
@@ -966,21 +966,21 @@ 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形式返回结果,返回窗口内容规避区域。 |
**示例:**
...
...
@@ -997,16 +997,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1025,21 +1025,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1057,16 +1057,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1085,21 +1085,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1117,16 +1117,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1145,21 +1145,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1177,16 +1177,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1214,21 +1214,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1255,16 +1255,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1282,21 +1282,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1313,15 +1313,15 @@ loadContent(path: string): Promise<void>
isShowing(callback: AsyncCallback
<
boolean
>
): void
判断当前窗口是否已显示,使用callback
方式作为异步方法
。
判断当前窗口是否已显示,使用callback
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数返回是否显示子窗口结果。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数返回是否显示子窗口结果。 |
**示例:**
...
...
@@ -1339,15 +1339,15 @@ isShowing(callback: AsyncCallback<boolean>): void
isShowing(): Promise
<
boolean
>
判断当前窗口是否已显示,使用Promise
方式作为异步方法
。
判断当前窗口是否已显示,使用Promise
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------- | ----------------------------------------------------- |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回当前窗口是否已显示的结果。 |
| 类型 | 说明 |
| ---------------------- | ----------------------------------------------------- |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回当前窗口是否已显示的结果。 |
**示例:**
...
...
@@ -1370,10 +1370,10 @@ on(type: 'windowSizeChange', callback: Callback<Size>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
| type | string | 是 | 监听事件,固定为'windowSizeChange',即窗口尺寸变化事件。 |
| callback | Callback
<
[Size](#size)
>
| 是 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
| type | string | 是 | 监听事件,固定为'windowSizeChange',即窗口尺寸变化事件。 |
| callback | Callback
<
[Size](#size)
>
| 是 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -1394,10 +1394,10 @@ off(type: 'windowSizeChange', callback?: Callback<Size >): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
| type | string | 是 | 监听事件,固定为'windowSizeChange',即窗口尺寸变化事件。 |
| callback | Callback
<
[Size](#size)
>
| 否 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
| type | string | 是 | 监听事件,固定为'windowSizeChange',即窗口尺寸变化事件。 |
| callback | Callback
<
[Size](#size)
>
| 否 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -1416,10 +1416,10 @@ on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemAvoidAreaChange',即系统窗口规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea)
>
| 是 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemAvoidAreaChange',即系统窗口规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea)
>
| 是 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -1440,10 +1440,10 @@ off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemAvoidAreaChange',即系统窗口规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea)
>
| 否 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'systemAvoidAreaChange',即系统窗口规避区变化事件。 |
| callback | Callback
<
[AvoidArea](#avoidarea)
>
| 否 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -1458,16 +1458,14 @@ 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
>
| 是 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -1484,16 +1482,14 @@ 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
>
| 否 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -1506,15 +1502,15 @@ off(type: 'keyboardHeightChange', callback?: Callback<number>): void
isSupportWideGamut(callback: AsyncCallback
<
boolean
>
): void
判断当前窗口是否支持广色域模式,使用callback
方式作为异步方法
。
判断当前窗口是否支持广色域模式,使用callback
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数返回是否支持广色域模式。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数返回是否支持广色域模式。 |
**示例:**
...
...
@@ -1532,15 +1528,15 @@ isSupportWideGamut(callback: AsyncCallback<boolean>): void
isSupportWideGamut(): Promise
<
boolean
>
判断当前窗口是否支持广色域模式,使用Promise
方式作为异步方法
。
判断当前窗口是否支持广色域模式,使用Promise
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回当前窗口是否支持广色域模式的结果。 |
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise
<
boolean
>
| 以Promise形式返回结果,返回当前窗口是否支持广色域模式的结果。 |
**示例:**
...
...
@@ -1557,16 +1553,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1584,21 +1580,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1615,15 +1611,15 @@ setColorSpace(colorSpace:ColorSpace): Promise<void>
getColorSpace(callback: AsyncCallback
<
ColorSpace
>
): void
获取当前窗口色域模式,使用callback
方式作为异步方法
。
获取当前窗口色域模式,使用callback
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | -------------------------- |
| callback | AsyncCallback
<
[ColorSpace](#colorspace)
>
| 是 | 回调函数返回当前色域模式。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | -------------------------- |
| callback | AsyncCallback
<
[ColorSpace](#colorspace)
>
| 是 | 回调函数返回当前色域模式。 |
**示例:**
...
...
@@ -1641,15 +1637,15 @@ getColorSpace(callback: AsyncCallback<ColorSpace>): void
getColorSpace(): Promise
<
ColorSpace
>
获取当前窗口色域模式,使用Promise
方式作为异步方法
。
获取当前窗口色域模式,使用Promise
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ----------------------------------------- |
| Promise
<
[ColorSpace](#colorspace)
>
| 以Promise形式返回结果,返回当前色域模式。 |
| 类型 | 说明 |
| ---------------------------------------- | ----------------------------------------- |
| Promise
<
[ColorSpace](#colorspace)
>
| 以Promise形式返回结果,返回当前色域模式。 |
**示例:**
...
...
@@ -1666,18 +1662,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1696,23 +1690,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1730,18 +1722,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1760,23 +1750,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1790,84 +1778,20 @@ setBrightness(brightness: number): Promise<void>
});
```
### setDimBehind<sup>7+</sup>
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
));
});
```
### setDimBehind<sup>7+</sup>
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
));
});
```
### setFocusable<sup>7+</sup>
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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1886,23 +1810,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1920,18 +1842,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -1950,23 +1870,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -1980,84 +1898,20 @@ setKeepScreenOn(isKeepScreenOn: boolean): Promise<void>
});
```
### setOutsideTouchable<sup>7+</sup>
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
))
})
```
### setOutsideTouchable<sup>7+</sup>
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
));
});
```
### setPrivacyMode<sup>7+</sup>
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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -2077,23 +1931,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -2111,18 +1963,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -2142,23 +1992,21 @@ 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形式返回结果,返回当前函数执行的结果。 |
**示例:**
...
...
@@ -2193,15 +2041,15 @@ WindowStage生命周期。
getMainWindow(): Promise
<
Window
>
获取该WindowStage实例下的主窗口,使用Promise
方式作为异步方法
。
获取该WindowStage实例下的主窗口,使用Promise
异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| -------------------------------- | ---------------------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前WindowStage下的主窗口对象。 |
| 类型 | 说明 |
| -------------------------------- | ---------------------------------------------------------- |
| Promise
<
[Window](#window)
>
| 以Promise形式返回结果,返回当前WindowStage下的主窗口对象。 |
**示例:**
...
...
@@ -2225,15 +2073,15 @@ 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下的主窗口对象。 |
**示例:**
...
...
@@ -2258,21 +2106,21 @@ 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形式返回结果,返回当前创建的子窗口对象。 |
**示例:**
...
...
@@ -2296,16 +2144,16 @@ 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)
>
| 是 | 回调返回当前创建的子窗口对象。 |
**示例:**
...
...
@@ -2331,15 +2179,15 @@ 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下的所有子窗口对象。 |
**示例:**
...
...
@@ -2363,15 +2211,15 @@ 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下的所有子窗口对象。 |
**示例:**
...
...
@@ -2396,16 +2244,16 @@ 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
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -2434,10 +2282,10 @@ on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'windowStageEvent',即WindowStage生命周期变化事件。 |
| callback | Callback
<
[WindowStageEventType](#windowstageeventtype9)
>
| 是 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'windowStageEvent',即WindowStage生命周期变化事件。 |
| callback | Callback
<
[WindowStageEventType](#windowstageeventtype9)
>
| 是 | 回调返回监听到的信息。 |
**示例:**
...
...
@@ -2463,10 +2311,10 @@ off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType&g
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'windowStageEvent',即WindowStage生命周期变化事件。 |
| callback | Callback
<
[WindowStageEventType](#windowstageeventtype9)
>
| 否 | 回调返回监听到的信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'windowStageEvent',即WindowStage生命周期变化事件。 |
| callback | Callback
<
[WindowStageEventType](#windowstageeventtype9)
>
| 否 | 回调返回监听到的信息。 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录