Skip to content

D
Docs

OpenHarmony / Docs
接近 2 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 a41a5d01 编写于 作者: L leafly2021
浏览文件
操作

add animation api docs 

Signed-off-by: Nleafly2021 <figo.yefei@huawei.com>
Change-Id: Ic4159e49db7fab898681b438923a3dfccaace086
上级 bf9dc5aa
隐藏空白更改
内联 并排
Showing with 689 addition and 224 deletion
zh-cn/application-dev/reference/apis/js-apis-window.md
浏览文件 @ a41a5d01
...@@ -209,20 +209,20 @@ import window from '@ohos.window'; ...@@ -209,20 +209,20 @@ 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表示最大亮度值。 | | brightness | number | 是 | 是 | 屏幕亮度， 取值范围为0~1，1表示最大亮度值。 |
| dimBehindValue<sup>(deprecated)</sup> | number | 是 | 是 | 靠后窗口的暗度值，取值范围为0~1，1表示最暗。<br>- **说明：** 从API version 9开始废弃。<br>- 从 API version 7开始支持| | dimBehindValue<sup>(deprecated)</sup> | number | 是 | 是 | 靠后窗口的暗度值，取值范围为0~1，1表示最暗。<br>- **说明：** 从API version 9开始废弃。<br>- 从 API version 7开始支持 |
| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮，默认为false。 | | isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮，默认为false。 |
| isPrivacyMode<sup>7+</sup> | boolean | 是 | 是 | 隐私模式，默认为false。 | | isPrivacyMode<sup>7+</sup> | boolean | 是 | 是 | 隐私模式，默认为false。 |
| isRoundCorner<sup>7+</sup> | boolean | 是 | 是 | 窗口是否为圆角。默认为false。 | | isRoundCorner<sup>(deprecated)</sup> | boolean | 是 | 是 | 窗口是否为圆角。默认为false。<br>- **说明：** 从API version 9开始废弃。<br/>- 从 API version 7开始支持 |
| isTransparent<sup>7+</sup> | boolean | 是 | 是 | 窗口是否透明。默认为false。 | | isTransparent<sup>7+</sup> | boolean | 是 | 是 | 窗口是否透明。默认为false。 |
## ColorSpace<sup>8+</sup> ## ColorSpace<sup>8+</sup>
...@@ -235,6 +235,51 @@ import window from '@ohos.window'; ...@@ -235,6 +235,51 @@ import window from '@ohos.window';
| DEFAULT | 0 | 默认色域模式。 | | DEFAULT | 0 | 默认色域模式。 |
| WIDE_GAMUT | 1 | 广色域模式。 | | WIDE_GAMUT | 1 | 广色域模式。 |
## ScaleOptions<sup>9+</sup>
缩放参数。
此接口为系统接口。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | -------------------------------------------------- |
| x | number | 否 | 是 | X轴的缩放参数，默认值为1.0。 |
| y | number | 否 | 是 | Y轴的缩放参数，默认值为1.0。 |
| pivotX | number | 否 | 是 | 缩放中心点X轴坐标，默认值为0.5， 取值范围0.0~1.0。 |
| pivotY | number | 否 | 是 | 缩放中心点Y轴坐标，默认值为0.5， 取值范围0.0~1.0。 |
## RotateOptions<sup>9+</sup>
旋转参数。
此接口为系统接口。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | -------------------------------------------------- |
| x | number | 否 | 是 | 绕X轴的旋转角度，默认值为0.0。 |
| y | number | 否 | 是 | 绕Y轴的旋转角度，默认值为0.0。 |
| z | number | 否 | 是 | 绕Z轴的旋转角度，默认值为0.0。 |
| pivotX | number | 否 | 是 | 旋转中心点X轴坐标，默认值为0.5， 取值范围0.0~1.0。 |
| pivotY | number | 否 | 是 | 旋转中心点Y轴坐标，默认值为0.5， 取值范围0.0~1.0。 |
## TranslateOptions<sup>9+</sup>
平移参数。
此接口为系统接口。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---- | -------- | ---- | ---- | ---------------------------- |
| x | number | 否 | 是 | X轴的平移参数，默认值为0.0。 |
| y | number | 否 | 是 | Y轴的平移参数，默认值为0.0。 |
| z | number | 否 | 是 | Z轴的平移参数，默认值为0.0。 |
## window.create<sup>7+</sup> ## window.create<sup>7+</sup>
create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): void create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): void
...@@ -245,7 +290,7 @@ create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): voi ...@@ -245,7 +290,7 @@ create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): voi
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------------------------ | | -------- | -------------------------------------- | ---- | ------------------------------------ |
...@@ -253,7 +298,7 @@ create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): voi ...@@ -253,7 +298,7 @@ create(id: string, type: WindowType, callback: AsyncCallback&lt;Window&gt;): voi
| type | [WindowType](#windowtype) | 是 | 窗口类型。 | | type | [WindowType](#windowtype) | 是 | 窗口类型。 |
| callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前创建的子窗口对象。 | | callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前创建的子窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -276,20 +321,20 @@ create(id: string, type: WindowType): Promise&lt;Window&gt; ...@@ -276,20 +321,20 @@ create(id: string, type: WindowType): Promise&lt;Window&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ---------- | | ------ | ------------------------- | ---- | ---------- |
| id | string | 是 | 窗口id。 | | id | string | 是 | 窗口id。 |
| type | [WindowType](#windowtype) | 是 | 窗口类型。 | | type | [WindowType](#windowtype) | 是 | 窗口类型。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------------------------- | | -------------------------------- | --------------------------------------- |
| Promise&lt;[Window](#window)&gt; | Promise对象。返回当前创建的子窗口对象。 | | Promise&lt;[Window](#window)&gt; | Promise对象。返回当前创建的子窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -312,7 +357,7 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback&lt;Wi ...@@ -312,7 +357,7 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback&lt;Wi
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | -------------------------------------- | ---- | ------------------------------------------------------------ |
...@@ -321,7 +366,7 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback&lt;Wi ...@@ -321,7 +366,7 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback&lt;Wi
| type | [WindowType](#windowtype) | 是 | 窗口类型。 | | type | [WindowType](#windowtype) | 是 | 窗口类型。 |
| callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前创建的子窗口对象。 | | callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前创建的子窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -346,7 +391,7 @@ create(ctx: Context, id: string, type: WindowType): Promise&lt;Window&gt; ...@@ -346,7 +391,7 @@ create(ctx: Context, id: string, type: WindowType): Promise&lt;Window&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ------------------------------------------------------------ | | ------ | ------------------------- | ---- | ------------------------------------------------------------ |
...@@ -354,13 +399,13 @@ create(ctx: Context, id: string, type: WindowType): Promise&lt;Window&gt; ...@@ -354,13 +399,13 @@ create(ctx: Context, 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对象。返回当前创建的子窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -381,14 +426,14 @@ find(id: string, callback: AsyncCallback&lt;Window&gt;): void ...@@ -381,14 +426,14 @@ find(id: string, callback: AsyncCallback&lt;Window&gt;): void
**系统能力：** 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; | 是 | 回调函数。返回当前查找到的窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -410,19 +455,19 @@ find(id: string): Promise&lt;Window&gt; ...@@ -410,19 +455,19 @@ find(id: string): Promise&lt;Window&gt;
**系统能力：** 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对象。返回当前查找的窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -445,13 +490,13 @@ getTopWindow(callback: AsyncCallback&lt;Window&gt;): void ...@@ -445,13 +490,13 @@ getTopWindow(callback: AsyncCallback&lt;Window&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------------- | | -------- | -------------------------------------- | ---- | -------------------------------------------- |
| callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前应用内最后显示的窗口对象。 | | callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前应用内最后显示的窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -475,13 +520,13 @@ getTopWindow(): Promise&lt;Window&gt; ...@@ -475,13 +520,13 @@ getTopWindow(): Promise&lt;Window&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | ----------------------------------------------- | | -------------------------------- | ----------------------------------------------- |
| Promise&lt;[Window](#window)&gt; | Promise对象。返回当前应用内最后显示的窗口对象。 | | Promise&lt;[Window](#window)&gt; | Promise对象。返回当前应用内最后显示的窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -502,14 +547,14 @@ getTopWindow(ctx: Context, callback: AsyncCallback&lt;Window&gt;): void ...@@ -502,14 +547,14 @@ getTopWindow(ctx: Context, callback: AsyncCallback&lt;Window&gt;): void
**系统能力：** 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; | 是 | 回调函数。返回当前应用内最后显示的窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -531,19 +576,19 @@ getTopWindow(ctx: Context): Promise&lt;Window&gt; ...@@ -531,19 +576,19 @@ getTopWindow(ctx: Context): Promise&lt;Window&gt;
**系统能力：** 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对象。返回当前应用内最后显示的窗口对象。 |
**示例：** **示例：**
```js ```js
var windowClass = null; var windowClass = null;
...@@ -609,7 +654,7 @@ minimizeAll(id: number): Promise&lt;void&gt; ...@@ -609,7 +654,7 @@ minimizeAll(id: number): Promise&lt;void&gt;
| -------- | ------------------------- | ---- | -------------- | | -------- | ------------------------- | ---- | -------------- |
| id | number | 是 | 显示设备[Display](js-apis-display.md#display)的ID号 | | id | number | 是 | 显示设备[Display](js-apis-display.md#display)的ID号 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
...@@ -672,7 +717,7 @@ toggleShownStateForAllAppWindows(): Promise&lt;void&gt; ...@@ -672,7 +717,7 @@ toggleShownStateForAllAppWindows(): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
...@@ -728,7 +773,7 @@ setWindowLayoutMode(mode: WindowLayoutMode): Promise&lt;void&gt; ...@@ -728,7 +773,7 @@ setWindowLayoutMode(mode: WindowLayoutMode): Promise&lt;void&gt;
| -------- | ------------------------- | ---- | -------------- | | -------- | ------------------------- | ---- | -------------- |
| mode | [WindowLayoutMode](#windowlayoutmode9) | 是 | 设置的窗口布局模式 | | mode | [WindowLayoutMode](#windowlayoutmode9) | 是 | 设置的窗口布局模式 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
...@@ -755,14 +800,14 @@ on(type: 'systemBarTintChange', callback: Callback&lt;SystemBarTintState&gt;): v ...@@ -755,14 +800,14 @@ on(type: 'systemBarTintChange', callback: Callback&lt;SystemBarTintState&gt;): v
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 |
| callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 是 | 回调函数。返回当前的状态栏、导航栏信息集合。 | | callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 是 | 回调函数。返回当前的状态栏、导航栏信息集合。 |
**示例：** **示例：**
```js ```js
window.on('systemBarTintChange', (data) => { window.on('systemBarTintChange', (data) => {
...@@ -780,14 +825,14 @@ off(type: 'systemBarTintChange', callback?: Callback&lt;SystemBarTintState &gt;) ...@@ -780,14 +825,14 @@ off(type: 'systemBarTintChange', callback?: Callback&lt;SystemBarTintState &gt;)
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 |
| callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 否 | 回调函数。返回当前的状态栏、导航栏信息集合。 | | callback | Callback&lt;[SystemBarTintState](#systembartintstate)&gt; | 否 | 回调函数。返回当前的状态栏、导航栏信息集合。 |
**示例：** **示例：**
```js ```js
window.off('systemBarTintChange'); window.off('systemBarTintChange');
...@@ -809,13 +854,13 @@ hide (callback: AsyncCallback&lt;void&gt;): void ...@@ -809,13 +854,13 @@ hide (callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
windowClass.hide((err, data) => { windowClass.hide((err, data) => {
...@@ -837,13 +882,13 @@ hide(): Promise&lt;void&gt; ...@@ -837,13 +882,13 @@ hide(): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.hide(); let promise = windowClass.hide();
...@@ -854,6 +899,61 @@ promise.then((data)=> { ...@@ -854,6 +899,61 @@ promise.then((data)=> {
}) })
``` ```
### hideWithAnimation<sup>9+</sup>
hideWithAnimation(callback: AsyncCallback&lt;void&gt;): void
隐藏当前窗口，过程中播放动画，使用callback异步回调。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：**
```js
windowClass.hideWithAnimation((err, data) => {
if (err.code) {
console.error('Failed to hide the window with animation. Cause: ' + JSON.stringify(err));
return;
}
console.info('window hidden with animation. data: ' + JSON.stringify(data));
})
```
### hideWithAnimation<sup>9+</sup>
hideWithAnimation(): Promise&lt;void&gt;
隐藏当前窗口，过程中播放动画，使用Promise异步回调。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promise = windowClass.hideWithAnimation();
promise.then((data)=> {
console.info('window hidden with animation. Data: ' + JSON.stringify(data));
}).catch((err)=>{
console.error('Failed to hide the window with animation. Cause: ' + JSON.stringify(err));
})
```
### show<sup>7+</sup> ### show<sup>7+</sup>
show(callback: AsyncCallback&lt;void&gt;): void show(callback: AsyncCallback&lt;void&gt;): void
...@@ -862,13 +962,13 @@ show(callback: AsyncCallback&lt;void&gt;): void ...@@ -862,13 +962,13 @@ show(callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
windowClass.show((err, data) => { windowClass.show((err, data) => {
...@@ -888,13 +988,13 @@ show(): Promise&lt;void&gt; ...@@ -888,13 +988,13 @@ show(): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.show(); let promise = windowClass.show();
...@@ -905,6 +1005,61 @@ promise.then((data)=> { ...@@ -905,6 +1005,61 @@ promise.then((data)=> {
}) })
``` ```
### showWithAnimation<sup>9+</sup>
showWithAnimation(callback: AsyncCallback&lt;void&gt;): void
显示当前窗口，过程中播放动画，使用callback异步回调。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：**
```js
windowClass.showWithAnimation((err, data) => {
if (err.code) {
console.error('Failed to show the window with animation. Cause: ' + JSON.stringify(err));
return;
}
console.info('Succeeded in showing the window with animation. Data: ' + JSON.stringify(data));
})
```
### showWithAnimation<sup>9+</sup>
showWithAnimation(): Promise&lt;void&gt;
显示当前窗口，过程中播放动画，使用Promise异步回调。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
let promise = windowClass.showWithAnimation();
promise.then((data)=> {
console.info('Succeeded in showing the window with animation. Data: ' + JSON.stringify(data));
}).catch((err)=>{
console.error('Failed to show the window with animation. Cause: ' + JSON.stringify(err));
})
```
### destroy<sup>7+</sup> ### destroy<sup>7+</sup>
destroy(callback: AsyncCallback&lt;void&gt;): void destroy(callback: AsyncCallback&lt;void&gt;): void
...@@ -913,13 +1068,13 @@ destroy(callback: AsyncCallback&lt;void&gt;): void ...@@ -913,13 +1068,13 @@ destroy(callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
windowClass.destroy((err, data) => { windowClass.destroy((err, data) => {
...@@ -939,13 +1094,13 @@ destroy(): Promise&lt;void&gt; ...@@ -939,13 +1094,13 @@ destroy(): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.destroy(); let promise = windowClass.destroy();
...@@ -964,7 +1119,7 @@ moveTo(x: number, y: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -964,7 +1119,7 @@ moveTo(x: number, y: number, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------- | | -------- | ------------------------- | ---- | ------------------------------------------------- |
...@@ -972,7 +1127,7 @@ moveTo(x: number, y: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -972,7 +1127,7 @@ moveTo(x: number, y: number, callback: AsyncCallback&lt;void&gt;): void
| y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移，单位为px。 | | y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移，单位为px。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
windowClass.moveTo(300, 300, (err, data)=>{ windowClass.moveTo(300, 300, (err, data)=>{
...@@ -993,20 +1148,20 @@ moveTo(x: number, y: number): Promise&lt;void&gt; ...@@ -993,20 +1148,20 @@ moveTo(x: number, y: number): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------- | | ------ | ------ | ---- | ------------------------------------------------- |
| x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移，单位为px。 | | x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移，单位为px。 |
| y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移，单位为px。 | | y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移，单位为px。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.moveTo(300, 300); let promise = windowClass.moveTo(300, 300);
...@@ -1025,7 +1180,7 @@ resetSize(width: number, height: number, callback: AsyncCallback&lt;void&gt;): v ...@@ -1025,7 +1180,7 @@ resetSize(width: number, height: number, callback: AsyncCallback&lt;void&gt;): v
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------- | | -------- | ------------------------- | ---- | -------------------------- |
...@@ -1033,7 +1188,7 @@ resetSize(width: number, height: number, callback: AsyncCallback&lt;void&gt;): v ...@@ -1033,7 +1188,7 @@ resetSize(width: number, height: number, callback: AsyncCallback&lt;void&gt;): v
| height | number | 是 | 目标窗口的高度，单位为px。 | | height | number | 是 | 目标窗口的高度，单位为px。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
windowClass.resetSize(500, 1000, (err, data) => { windowClass.resetSize(500, 1000, (err, data) => {
...@@ -1053,20 +1208,20 @@ resetSize(width: number, height: number): Promise&lt;void&gt; ...@@ -1053,20 +1208,20 @@ resetSize(width: number, height: number): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- | | ------ | ------ | ---- | -------------------------- |
| width | number | 是 | 目标窗口的宽度，单位为px。 | | width | number | 是 | 目标窗口的宽度，单位为px。 |
| height | number | 是 | 目标窗口的高度，单位为px。 | | height | number | 是 | 目标窗口的高度，单位为px。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.resetSize(500, 1000); let promise = windowClass.resetSize(500, 1000);
...@@ -1077,7 +1232,7 @@ promise.then((data)=> { ...@@ -1077,7 +1232,7 @@ promise.then((data)=> {
}); });
``` ```
### setWindowType<sup>7+</sup> ### setWindowType<sup>(deprecated)</sup>
setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void
...@@ -1085,16 +1240,20 @@ setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void ...@@ -1085,16 +1240,20 @@ setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void
此接口为系统接口。 此接口为系统接口。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| type | [WindowType](#windowtype) | 是 | 窗口类型。 | | type | [WindowType](#windowtype) | 是 | 窗口类型。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var type = window.WindowType.TYPE_APP; var type = window.WindowType.TYPE_APP;
...@@ -1107,7 +1266,7 @@ windowClass.setWindowType(type, (err, data) => { ...@@ -1107,7 +1266,7 @@ windowClass.setWindowType(type, (err, data) => {
}); });
``` ```
### setWindowType<sup>7+</sup> ### setWindowType<sup>(deprecated)</sup>
setWindowType(type: WindowType): Promise&lt;void&gt; setWindowType(type: WindowType): Promise&lt;void&gt;
...@@ -1115,21 +1274,25 @@ setWindowType(type: WindowType): Promise&lt;void&gt; ...@@ -1115,21 +1274,25 @@ setWindowType(type: WindowType): Promise&lt;void&gt;
此接口为系统接口。 此接口为系统接口。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ---------- | | ------ | ------------------------- | ---- | ---------- |
| type | [WindowType](#windowtype) | 是 | 窗口类型。 | | type | [WindowType](#windowtype) | 是 | 窗口类型。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var type = window.WindowType.TYPE_APP; var type = window.WindowType.TYPE_APP;
...@@ -1149,13 +1312,13 @@ getProperties(callback: AsyncCallback&lt;WindowProperties&gt;): void ...@@ -1149,13 +1312,13 @@ getProperties(callback: AsyncCallback&lt;WindowProperties&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------------- | ---- | ---------------------------- | | -------- | ---------------------------------------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;[WindowProperties](#windowproperties)&gt; | 是 | 回调函数。返回当前窗口属性。 | | callback | AsyncCallback&lt;[WindowProperties](#windowproperties)&gt; | 是 | 回调函数。返回当前窗口属性。 |
**示例：** **示例：**
```js ```js
windowClass.getProperties((err, data) => { windowClass.getProperties((err, data) => {
...@@ -1175,13 +1338,13 @@ getProperties(): Promise&lt;WindowProperties&gt; ...@@ -1175,13 +1338,13 @@ getProperties(): Promise&lt;WindowProperties&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------------------- | ------------------------------- | | ---------------------------------------------------- | ------------------------------- |
| Promise&lt;[WindowProperties](#windowproperties)&gt; | Promise对象。返回当前窗口属性。 | | Promise&lt;[WindowProperties](#windowproperties)&gt; | Promise对象。返回当前窗口属性。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.getProperties(); let promise = windowClass.getProperties();
...@@ -1200,14 +1363,14 @@ getAvoidArea(type: [AvoidAreaType](#avoidareatype7), callback: AsyncCallback&lt; ...@@ -1200,14 +1363,14 @@ getAvoidArea(type: [AvoidAreaType](#avoidareatype7), callback: AsyncCallback&lt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- |-----------------------------------------------| ---- | ------------------------------------------------------------ | | -------- |-----------------------------------------------| ---- | ------------------------------------------------------------ |
| type | [AvoidAreaType](#avoidareatype7) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。type为TYPE_SYSTEM_GESTURE，表示手势区域。type为TYPE_KEYBOARD，表示软键盘区域。 | | type | [AvoidAreaType](#avoidareatype7) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。type为TYPE_SYSTEM_GESTURE，表示手势区域。type为TYPE_KEYBOARD，表示软键盘区域。 |
| callback | AsyncCallback&lt;[AvoidArea](#avoidarea7)&gt; | 是 | 回调函数。返回窗口内容规避区域。 | | callback | AsyncCallback&lt;[AvoidArea](#avoidarea7)&gt; | 是 | 回调函数。返回窗口内容规避区域。 |
**示例：** **示例：**
```js ```js
var type = window.AvoidAreaType.TYPE_SYSTEM; var type = window.AvoidAreaType.TYPE_SYSTEM;
...@@ -1228,19 +1391,19 @@ getAvoidArea(type: [AvoidAreaType](#avoidareatype7)): Promise&lt;[AvoidArea](#av ...@@ -1228,19 +1391,19 @@ getAvoidArea(type: [AvoidAreaType](#avoidareatype7)): Promise&lt;[AvoidArea](#av
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ |----------------------------------| ---- | ------------------------------------------------------------ | | ------ |----------------------------------| ---- | ------------------------------------------------------------ |
| type | [AvoidAreaType](#avoidareatype7) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。type为TYPE_SYSTEM_GESTURE，表示手势区域。type为TYPE_KEYBOARD，表示软键盘区域。 | | type | [AvoidAreaType](#avoidareatype7) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。type为TYPE_SYSTEM_GESTURE，表示手势区域。type为TYPE_KEYBOARD，表示软键盘区域。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
|-----------------------------------------| ----------------------------------- | |-----------------------------------------| ----------------------------------- |
| Promise&lt;[AvoidArea](#avoidarea7)&gt; | Promise对象。返回窗口内容规避区域。 | | Promise&lt;[AvoidArea](#avoidarea7)&gt; | Promise对象。返回窗口内容规避区域。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.getAvoidArea(); let promise = windowClass.getAvoidArea();
...@@ -1259,14 +1422,14 @@ setFullScreen(isFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -1259,14 +1422,14 @@ setFullScreen(isFullScreen: boolean, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------- | ---- | ---------------------------------------------- | | ------------ | ------------------------- | ---- | ---------------------------------------------- |
| isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | | isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var isFullScreen = true; var isFullScreen = true;
...@@ -1287,19 +1450,19 @@ setFullScreen(isFullScreen: boolean): Promise&lt;void&gt; ...@@ -1287,19 +1450,19 @@ setFullScreen(isFullScreen: boolean): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------- | ---- | ---------------------------------------------- | | ------------ | ------- | ---- | ---------------------------------------------- |
| isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | | isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var isFullScreen = true; var isFullScreen = true;
...@@ -1319,14 +1482,14 @@ setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback&lt;void ...@@ -1319,14 +1482,14 @@ setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback&lt;void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------ | ------------------------- | ---- | ------------------------------------------------------------ | | ------------------ | ------------------------- | ---- | ------------------------------------------------------------ |
| isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | | isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var isLayoutFullScreen= true; var isLayoutFullScreen= true;
...@@ -1347,19 +1510,19 @@ setLayoutFullScreen(isLayoutFullScreen: boolean): Promise&lt;void&gt; ...@@ -1347,19 +1510,19 @@ setLayoutFullScreen(isLayoutFullScreen: boolean): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------ | ------- | ---- | ------------------------------------------------------------ | | ------------------ | ------- | ---- | ------------------------------------------------------------ |
| isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | | isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var isLayoutFullScreen = true; var isLayoutFullScreen = true;
...@@ -1379,14 +1542,14 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallbac ...@@ -1379,14 +1542,14 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallbac
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| names | Array | 是 | 设置状态栏和导航栏是否显示。<br>例如，需全部显示，该参数设置为["status",&nbsp;"navigation"]；不设置，则默认不显示。 | | names | Array | 是 | 设置状态栏和导航栏是否显示。<br>例如，需全部显示，该参数设置为["status",&nbsp;"navigation"]；不设置，则默认不显示。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var names = ["status", "navigation"]; var names = ["status", "navigation"];
...@@ -1407,19 +1570,19 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise&lt;void&gt; ...@@ -1407,19 +1570,19 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----- | ---- | ------------------------------------------------------------ | | ------ | ----- | ---- | ------------------------------------------------------------ |
| names | Array | 是 | 设置状态栏和导航栏是否显示。<br>例如，需全部显示，该参数设置为["status",&nbsp;"navigation"]；不设置，则默认不显示。 | | names | Array | 是 | 设置状态栏和导航栏是否显示。<br>例如，需全部显示，该参数设置为["status",&nbsp;"navigation"]；不设置，则默认不显示。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var names = ["status", "navigation"]; var names = ["status", "navigation"];
...@@ -1439,14 +1602,14 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: Async ...@@ -1439,14 +1602,14 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: Async
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------- | ------------------------------------------- | ---- | ---------------------- | | ------------------- | ------------------------------------------- | ---- | ---------------------- |
| SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏、状态栏的属性。 | | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏、状态栏的属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var SystemBarProperties={ var SystemBarProperties={
...@@ -1476,19 +1639,19 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise&lt;voi ...@@ -1476,19 +1639,19 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise&lt;voi
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------- | ------------------------------------------- | ---- | ---------------------- | | ------------------- | ------------------------------------------- | ---- | ---------------------- |
| SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏、状态栏的属性。 | | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏、状态栏的属性。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var SystemBarProperties={ var SystemBarProperties={
...@@ -1517,14 +1680,14 @@ setPreferredOrientation(orientation: Orientation, callback: AsyncCallback&lt;voi ...@@ -1517,14 +1680,14 @@ setPreferredOrientation(orientation: Orientation, callback: AsyncCallback&lt;voi
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------- | ------------------------------------------- | ---- | ---------------------- | | ------------------- | ------------------------------------------- | ---- | ---------------------- |
| Orientation | [Orientation](#orientation9) | 是 | 窗口显示方向的属性。 | | Orientation | [Orientation](#orientation9) | 是 | 窗口显示方向的属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var orientation = window.Orientation.AUTO_ROTATION; var orientation = window.Orientation.AUTO_ROTATION;
...@@ -1545,19 +1708,19 @@ setPreferredOrientation(orientation: Orientation): Promise&lt;void&gt; ...@@ -1545,19 +1708,19 @@ setPreferredOrientation(orientation: Orientation): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------------- | ------------------------------------------- | ---- | ---------------------- | | ------------------- | ------------------------------------------- | ---- | ---------------------- |
| Orientation | [Orientation](#orientation9) | 是 | 窗口显示方向的属性。 | | Orientation | [Orientation](#orientation9) | 是 | 窗口显示方向的属性。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var orientation = window.Orientation.AUTO_ROTATION; var orientation = window.Orientation.AUTO_ROTATION;
...@@ -1577,14 +1740,14 @@ loadContent(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -1577,14 +1740,14 @@ loadContent(path: string, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------- | | -------- | ------------------------- | ---- | -------------------- |
| path | string | 是 | 设置加载页面的路径。 | | path | string | 是 | 设置加载页面的路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
windowClass.loadContent("pages/page2/page2", (err, data) => { windowClass.loadContent("pages/page2/page2", (err, data) => {
...@@ -1604,19 +1767,19 @@ loadContent(path: string): Promise&lt;void&gt; ...@@ -1604,19 +1767,19 @@ loadContent(path: string): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------- | | ------ | ------ | ---- | -------------------- |
| path | string | 是 | 设置加载页面的路径。 | | path | string | 是 | 设置加载页面的路径。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.loadContent("pages/page2/page2"); let promise = windowClass.loadContent("pages/page2/page2");
...@@ -1636,7 +1799,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void ...@@ -1636,7 +1799,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
...@@ -1648,7 +1811,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void ...@@ -1648,7 +1811,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void
```ts ```ts
class myAbility extends Ability { class myAbility extends Ability {
storage : LocalStorage storage : LocalStorage
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.storage = new LocalStorage(); this.storage = new LocalStorage();
this.storage.setOrCreate("storageSimpleProp",121); this.storage.setOrCreate("storageSimpleProp",121);
...@@ -1674,7 +1837,7 @@ loadContent(path: string, storage: LocalStorage): Promise&lt;void&gt; ...@@ -1674,7 +1837,7 @@ loadContent(path: string, storage: LocalStorage): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
...@@ -1691,7 +1854,7 @@ loadContent(path: string, storage: LocalStorage): Promise&lt;void&gt; ...@@ -1691,7 +1854,7 @@ loadContent(path: string, storage: LocalStorage): Promise&lt;void&gt;
```ts ```ts
class myAbility extends Ability { class myAbility extends Ability {
storage : LocalStorage storage : LocalStorage
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.storage = new LocalStorage(); this.storage = new LocalStorage();
this.storage.setOrCreate("storageSimpleProp",121); this.storage.setOrCreate("storageSimpleProp",121);
...@@ -1715,13 +1878,13 @@ isShowing(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1715,13 +1878,13 @@ isShowing(callback: AsyncCallback&lt;boolean&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。返回true表示当前窗口已显示，返回false则表示当前窗口未显示。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。返回true表示当前窗口已显示，返回false则表示当前窗口未显示。 |
**示例：** **示例：**
```js ```js
windowClass.isShowing((err, data) => { windowClass.isShowing((err, data) => {
...@@ -1741,13 +1904,13 @@ isShowing(): Promise&lt;boolean&gt; ...@@ -1741,13 +1904,13 @@ isShowing(): Promise&lt;boolean&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise对象。返回true表示当前窗口已显示，返回false则表示当前窗口未显示。 | | Promise&lt;boolean&gt; | Promise对象。返回true表示当前窗口已显示，返回false则表示当前窗口未显示。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.isShowing(); let promise = windowClass.isShowing();
...@@ -1766,14 +1929,14 @@ on(type: 'windowSizeChange', callback: Callback&lt;Size&gt;): void ...@@ -1766,14 +1929,14 @@ on(type: 'windowSizeChange', callback: Callback&lt;Size&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------ | ---- | -------------------------------------------------------- | | -------- | ------------------------------ | ---- | -------------------------------------------------------- |
| type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 |
| callback | Callback&lt;[Size](#size7)&gt; | 是 | 回调函数。返回当前的窗口尺寸。 | | callback | Callback&lt;[Size](#size7)&gt; | 是 | 回调函数。返回当前的窗口尺寸。 |
**示例：** **示例：**
```js ```js
windowClass.on('windowSizeChange', (data) => { windowClass.on('windowSizeChange', (data) => {
...@@ -1789,14 +1952,14 @@ off(type: 'windowSizeChange', callback?: Callback&lt;Size &gt;): void ...@@ -1789,14 +1952,14 @@ off(type: 'windowSizeChange', callback?: Callback&lt;Size &gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- | | -------- | ----------------------------- | ---- | -------------------------------------------------------- |
| type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 |
| callback | Callback&lt;[Size](#size)&gt; | 否 | 回调函数。返回当前的窗口尺寸。 | | callback | Callback&lt;[Size](#size)&gt; | 否 | 回调函数。返回当前的窗口尺寸。 |
**示例：** **示例：**
```js ```js
windowClass.off('windowSizeChange'); windowClass.off('windowSizeChange');
...@@ -1813,14 +1976,14 @@ on(type: 'systemAvoidAreaChange', callback: Callback&lt;[AvoidArea](#avoidarea7) ...@@ -1813,14 +1976,14 @@ on(type: 'systemAvoidAreaChange', callback: Callback&lt;[AvoidArea](#avoidarea7)
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- |------------------------------------------| ---- | ------------------------------------------------------- | | -------- |------------------------------------------| ---- | ------------------------------------------------------- |
| type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统规避区变化事件。 | | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统规避区变化事件。 |
| callback | Callback&lt;[AvoidArea](#avoidarea7)&gt; | 是 | 回调函数。返回当前规避区。 | | callback | Callback&lt;[AvoidArea](#avoidarea7)&gt; | 是 | 回调函数。返回当前规避区。 |
**示例：** **示例：**
```js ```js
windowClass.on('systemAvoidAreaChange', (data) => { windowClass.on('systemAvoidAreaChange', (data) => {
...@@ -1839,14 +2002,14 @@ off(type: 'systemAvoidAreaChange', callback?: Callback&lt;[AvoidArea](#avoidarea ...@@ -1839,14 +2002,14 @@ off(type: 'systemAvoidAreaChange', callback?: Callback&lt;[AvoidArea](#avoidarea
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- |------------------------------------------| ---- | ------------------------------------------------------- | | -------- |------------------------------------------| ---- | ------------------------------------------------------- |
| type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统规避区变化事件。 | | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统规避区变化事件。 |
| callback | Callback&lt;[AvoidArea](#avoidarea7)&gt; | 否 | 回调函数。返回当前规避区。 | | callback | Callback&lt;[AvoidArea](#avoidarea7)&gt; | 否 | 回调函数。返回当前规避区。 |
**示例：** **示例：**
```js ```js
windowClass.off('systemAvoidAreaChange'); windowClass.off('systemAvoidAreaChange');
...@@ -1905,14 +2068,14 @@ on(type: 'keyboardHeightChange', callback: Callback&lt;number&gt;): void ...@@ -1905,14 +2068,14 @@ on(type: 'keyboardHeightChange', callback: Callback&lt;number&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 |
| callback | Callback<number&gt; | 是 | 回调函数。返回当前的键盘高度。 | | callback | Callback<number&gt; | 是 | 回调函数。返回当前的键盘高度。 |
**示例：** **示例：**
```js ```js
windowClass.on('keyboardHeightChange', (data) => { windowClass.on('keyboardHeightChange', (data) => {
...@@ -1928,14 +2091,14 @@ off(type: 'keyboardHeightChange', callback?: Callback&lt;number&gt;): void ...@@ -1928,14 +2091,14 @@ off(type: 'keyboardHeightChange', callback?: Callback&lt;number&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 |
| callback | Callback&lt;number&gt; | 否 | 回调函数。返回当前的键盘高度。 | | callback | Callback&lt;number&gt; | 否 | 回调函数。返回当前的键盘高度。 |
**示例：** **示例：**
```js ```js
windowClass.off('keyboardHeightChange'); windowClass.off('keyboardHeightChange');
...@@ -1946,6 +2109,7 @@ windowClass.off('keyboardHeightChange'); ...@@ -1946,6 +2109,7 @@ windowClass.off('keyboardHeightChange');
on(type: 'touchOutside', callback: Callback&lt;void&gt;): void on(type: 'touchOutside', callback: Callback&lt;void&gt;): void
开启本窗口区域范围外的点击事件的监听。 开启本窗口区域范围外的点击事件的监听。
此接口为系统接口。 此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
...@@ -1970,6 +2134,7 @@ windowClass.on('touchOutside', () => { ...@@ -1970,6 +2134,7 @@ windowClass.on('touchOutside', () => {
off(type: 'touchOutside', callback?: Callback&lt;void&gt;): void off(type: 'touchOutside', callback?: Callback&lt;void&gt;): void
关闭本窗口区域范围外的点击事件的监听。 关闭本窗口区域范围外的点击事件的监听。
此接口为系统接口。 此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
...@@ -2092,7 +2257,7 @@ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;, c ...@@ -2092,7 +2257,7 @@ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;, c
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------- | ---- | -------------------- | | ----------- | ------------------------- | ---- | -------------------- |
...@@ -2100,7 +2265,7 @@ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;, c ...@@ -2100,7 +2265,7 @@ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;, c
| deathCallback | Callback&lt;void&gt; | 是 | 模态窗口销毁监听。 | | deathCallback | Callback&lt;void&gt; | 是 | 模态窗口销毁监听。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
class TestRemoteObject extends rpc.RemoteObject { class TestRemoteObject extends rpc.RemoteObject {
...@@ -2139,20 +2304,20 @@ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;): ...@@ -2139,20 +2304,20 @@ bindDialogTarget(token: rpc.RemoteObject, deathCallback: Callback&lt;void&gt;):
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------- | ---- | -------------------- | | ----------- | ------------------------- | ---- | -------------------- |
| token | [rpc.RemoteObject](js-apis-rpc.md#remoteobject) | 是 | 目标窗口token值。 | | token | [rpc.RemoteObject](js-apis-rpc.md#remoteobject) | 是 | 目标窗口token值。 |
| deathCallback | Callback&lt;void&gt; | 是 | 模态窗口销毁监听。 | | deathCallback | Callback&lt;void&gt; | 是 | 模态窗口销毁监听。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
class TestRemoteObject extends rpc.RemoteObject { class TestRemoteObject extends rpc.RemoteObject {
...@@ -2188,13 +2353,13 @@ isSupportWideGamut(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -2188,13 +2353,13 @@ isSupportWideGamut(callback: AsyncCallback&lt;boolean&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。返回true表示当前窗口支持广色域模式，返回false则表示当前窗口不支持广色域模式。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。返回true表示当前窗口支持广色域模式，返回false则表示当前窗口不支持广色域模式。 |
**示例：** **示例：**
```js ```js
windowClass.isSupportWideGamut((err, data) => { windowClass.isSupportWideGamut((err, data) => {
...@@ -2214,13 +2379,13 @@ isSupportWideGamut(): Promise&lt;boolean&gt; ...@@ -2214,13 +2379,13 @@ isSupportWideGamut(): Promise&lt;boolean&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise对象。返回true表示当前窗口支持广色域模式，返回false则表示当前窗口不支持广色域模式。 | | Promise&lt;boolean&gt; | Promise对象。返回true表示当前窗口支持广色域模式，返回false则表示当前窗口不支持广色域模式。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.isSupportWideGamut(); let promise = windowClass.isSupportWideGamut();
...@@ -2239,14 +2404,14 @@ setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback&lt;void&gt;): void ...@@ -2239,14 +2404,14 @@ setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------ | | ---------- | ------------------------- | ---- | ------------ |
| colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 | | colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err, data) => { windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err, data) => {
...@@ -2266,19 +2431,19 @@ setColorSpace(colorSpace:ColorSpace): Promise&lt;void&gt; ...@@ -2266,19 +2431,19 @@ setColorSpace(colorSpace:ColorSpace): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | -------------- | | ---------- | ------------------------- | ---- | -------------- |
| colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式。 | | colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT); let promise = windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT);
...@@ -2297,13 +2462,13 @@ getColorSpace(callback: AsyncCallback&lt;ColorSpace&gt;): void ...@@ -2297,13 +2462,13 @@ getColorSpace(callback: AsyncCallback&lt;ColorSpace&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ---------------------------------------------------------- | | -------- | ---------------------------------------------- | ---- | ---------------------------------------------------------- |
| callback | AsyncCallback&lt;[ColorSpace](#colorspace)&gt; | 是 | 回调函数。当获取成功，err为undefined，data为当前色域模式。 | | callback | AsyncCallback&lt;[ColorSpace](#colorspace)&gt; | 是 | 回调函数。当获取成功，err为undefined，data为当前色域模式。 |
**示例：** **示例：**
```js ```js
windowClass.getColorSpace((err, data) => { windowClass.getColorSpace((err, data) => {
...@@ -2323,13 +2488,13 @@ getColorSpace(): Promise&lt;ColorSpace&gt; ...@@ -2323,13 +2488,13 @@ getColorSpace(): Promise&lt;ColorSpace&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------------------------------- | | ---------------------------------------- | ------------------------------- |
| Promise&lt;[ColorSpace](#colorspace)&gt; | Promise对象。返回当前色域模式。 | | Promise&lt;[ColorSpace](#colorspace)&gt; | Promise对象。返回当前色域模式。 |
**示例：** **示例：**
```js ```js
let promise = windowClass.getColorSpace(); let promise = windowClass.getColorSpace();
...@@ -2348,14 +2513,14 @@ setBackgroundColor(color: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -2348,14 +2513,14 @@ setBackgroundColor(color: string, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| color | string | 是 | 需要设置的背景色，为十六进制颜色，不区分大小写，例如`#00FF00`或`#FF00FF00`。 | | color | string | 是 | 需要设置的背景色，为十六进制颜色，不区分大小写，例如`#00FF00`或`#FF00FF00`。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var color = '#00ff33'; var color = '#00ff33';
...@@ -2376,19 +2541,19 @@ setBackgroundColor(color: string): Promise&lt;void&gt; ...@@ -2376,19 +2541,19 @@ setBackgroundColor(color: string): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| color | string | 是 | 需要设置的背景色，为十六进制颜色，不区分大小写，例如"#00FF00"或"#FF00FF00"。 | | color | string | 是 | 需要设置的背景色，为十六进制颜色，不区分大小写，例如"#00FF00"或"#FF00FF00"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var color = '#00ff33'; var color = '#00ff33';
...@@ -2406,17 +2571,17 @@ setWakeUpScreen(wakeUp: boolean): void; ...@@ -2406,17 +2571,17 @@ setWakeUpScreen(wakeUp: boolean): void;
窗口唤醒屏幕。 窗口唤醒屏幕。
此接口为系统接口，三方应用不支持调用。 此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ------- | ---- | ---------------------------- | | ---------------- | ------- | ---- | ---------------------------- |
| wakeUp | boolean | 是 | 是否设置唤醒屏幕。 | | wakeUp | boolean | 是 | 是否设置唤醒屏幕。 |
**示例：** **示例：**
```ts ```ts
var wakeUp = true; var wakeUp = true;
...@@ -2431,14 +2596,14 @@ setBrightness(brightness: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -2431,14 +2596,14 @@ setBrightness(brightness: number, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** 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; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var brightness = 1; var brightness = 1;
...@@ -2459,19 +2624,19 @@ setBrightness(brightness: number): Promise&lt;void&gt; ...@@ -2459,19 +2624,19 @@ setBrightness(brightness: number): Promise&lt;void&gt;
**系统能力：** 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对象。 |
**示例：** **示例：**
```js ```js
var brightness = 1; var brightness = 1;
...@@ -2521,7 +2686,7 @@ setDimBehind(dimBehindValue: number): Promise&lt;void&gt; ...@@ -2521,7 +2686,7 @@ setDimBehind(dimBehindValue: number): Promise&lt;void&gt;
窗口叠加时，设备有子窗口的情况下设置靠后的窗口的暗度值，使用Promise异步回调。 窗口叠加时，设备有子窗口的情况下设置靠后的窗口的暗度值，使用Promise异步回调。
> **说明：** 该接口不支持使用。 > **说明：** 该接口不支持使用。
> >
> 从API version 9开始废弃。从API Version 7开始支持。 > 从API version 9开始废弃。从API Version 7开始支持。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
...@@ -2557,14 +2722,14 @@ setFocusable(isFocusable: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -2557,14 +2722,14 @@ setFocusable(isFocusable: boolean, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------- | ---- | ---------------------------- | | ----------- | ------------------------- | ---- | ---------------------------- |
| isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | | isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var isFocusable= true; var isFocusable= true;
...@@ -2585,19 +2750,19 @@ setFocusable(isFocusable: boolean): Promise&lt;void&gt; ...@@ -2585,19 +2750,19 @@ setFocusable(isFocusable: boolean): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | ---------------------------- | | ----------- | ------- | ---- | ---------------------------- |
| isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | | isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var isFocusable= true; var isFocusable= true;
...@@ -2617,14 +2782,14 @@ setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback&lt;void&gt;): v ...@@ -2617,14 +2782,14 @@ setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback&lt;void&gt;): v
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------- | ---- | ------------------------ | | -------------- | ------------------------- | ---- | ------------------------ |
| isKeepScreenOn | boolean | 是 | 设置屏幕是否为常亮状态。 | | isKeepScreenOn | boolean | 是 | 设置屏幕是否为常亮状态。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var isKeepScreenOn = true; var isKeepScreenOn = true;
...@@ -2645,13 +2810,13 @@ setKeepScreenOn(isKeepScreenOn: boolean): Promise&lt;void&gt; ...@@ -2645,13 +2810,13 @@ setKeepScreenOn(isKeepScreenOn: boolean): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------- | ---- | ------------------------ | | -------------- | ------- | ---- | ------------------------ |
| isKeepScreenOn | boolean | 是 | 设置屏幕是否为常亮状态。 | | isKeepScreenOn | boolean | 是 | 设置屏幕是否为常亮状态。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
...@@ -2665,7 +2830,7 @@ let promise = windowClass.setKeepScreenOn(isKeepScreenOn); ...@@ -2665,7 +2830,7 @@ let promise = windowClass.setKeepScreenOn(isKeepScreenOn);
promise.then((data) => { promise.then((data) => {
console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data)); console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data));
}).catch((err)=>{ }).catch((err)=>{
console.info('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err)); console.info('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
}); });
``` ```
...@@ -2676,7 +2841,7 @@ setOutsideTouchable(touchable: boolean, callback: AsyncCallback&lt;void&gt;): vo ...@@ -2676,7 +2841,7 @@ setOutsideTouchable(touchable: boolean, callback: AsyncCallback&lt;void&gt;): vo
设置是否允许可点击子窗口之外的区域，使用callback异步回调。 设置是否允许可点击子窗口之外的区域，使用callback异步回调。
> **说明：** 该接口不支持使用。 > **说明：** 该接口不支持使用。
> >
> 从API version 9开始废弃。从API Version 7开始支持。 > 从API version 9开始废弃。从API Version 7开始支持。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
...@@ -2707,7 +2872,7 @@ setOutsideTouchable(touchable: boolean): Promise&lt;void&gt; ...@@ -2707,7 +2872,7 @@ setOutsideTouchable(touchable: boolean): Promise&lt;void&gt;
设置是否允许可点击子窗口之外的区域，使用Promise异步回调。。 设置是否允许可点击子窗口之外的区域，使用Promise异步回调。。
> **说明：** 该接口不支持使用。 > **说明：** 该接口不支持使用。
> >
> 从API version 9开始废弃。从 API version 7开始支持。 > 从API version 9开始废弃。从 API version 7开始支持。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
...@@ -2743,14 +2908,14 @@ setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback&lt;void&gt;): voi ...@@ -2743,14 +2908,14 @@ setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback&lt;void&gt;): voi
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------- | ---- | -------------------- | | ------------- | ------------------------- | ---- | -------------------- |
| isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | | isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var isPrivacyMode = true; var isPrivacyMode = true;
...@@ -2772,19 +2937,19 @@ setPrivacyMode(isPrivacyMode: boolean): Promise&lt;void&gt; ...@@ -2772,19 +2937,19 @@ setPrivacyMode(isPrivacyMode: boolean): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------- | ---- | -------------------- | | ------------- | ------- | ---- | -------------------- |
| isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | | isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var isPrivacyMode = true; var isPrivacyMode = true;
...@@ -2823,14 +2988,14 @@ setTouchable(isTouchable: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -2823,14 +2988,14 @@ setTouchable(isTouchable: boolean, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------- | ---- | -------------------- | | ----------- | ------------------------- | ---- | -------------------- |
| isTouchable | boolean | 是 | 窗口是否为可触状态。 | | isTouchable | boolean | 是 | 窗口是否为可触状态。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var isTouchable = true; var isTouchable = true;
...@@ -2852,19 +3017,19 @@ setTouchable(isTouchable: boolean): Promise&lt;void&gt; ...@@ -2852,19 +3017,19 @@ setTouchable(isTouchable: boolean): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | -------------------- | | ----------- | ------- | ---- | -------------------- |
| isTouchable | boolean | 是 | 窗口是否为可触状态。 | | isTouchable | boolean | 是 | 窗口是否为可触状态。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var isTouchable = true; var isTouchable = true;
...@@ -2886,14 +3051,14 @@ setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback&lt;void&g ...@@ -2886,14 +3051,14 @@ setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback&lt;void&g
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------- | ---- | -------------------- | | ----------- | ------------------------- | ---- | -------------------- |
| isForbidSplitMove | boolean | 是 | 窗口在分屏模式下是否被禁止移动。 | | isForbidSplitMove | boolean | 是 | 窗口在分屏模式下是否被禁止移动。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```js ```js
var isForbidSplitMove = true; var isForbidSplitMove = true;
...@@ -2917,19 +3082,19 @@ setForbidSplitMove(isForbidSplitMove: boolean): Promise&lt;void&gt; ...@@ -2917,19 +3082,19 @@ setForbidSplitMove(isForbidSplitMove: boolean): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | -------------------- | | ----------- | ------- | ---- | -------------------- |
| isForbidSplitMove | boolean | 是 | 窗口在分屏模式下是否被禁止移动。 | | isForbidSplitMove | boolean | 是 | 窗口在分屏模式下是否被禁止移动。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：** **示例：**
```js ```js
var isForbidSplitMove = true; var isForbidSplitMove = true;
...@@ -3004,7 +3169,7 @@ setBlur(radius: number): void ...@@ -3004,7 +3169,7 @@ setBlur(radius: number): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
...@@ -3026,7 +3191,7 @@ setBackdropBlur(radius: number): void ...@@ -3026,7 +3191,7 @@ setBackdropBlur(radius: number): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
...@@ -3048,7 +3213,7 @@ setBackdropBlurStyle(blurStyle: BlurStyle): void ...@@ -3048,7 +3213,7 @@ setBackdropBlurStyle(blurStyle: BlurStyle): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------- | ---- | ---------------------- | | --------- | --------- | ---- | ---------------------- |
...@@ -3070,7 +3235,7 @@ setShadow(radius: number, color?: string, offsetX?: number, offsetY?: number): v ...@@ -3070,7 +3235,7 @@ setShadow(radius: number, color?: string, offsetX?: number, offsetY?: number): v
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ | | ------- | ------ | ---- | ------------------------------------------------------------ |
...@@ -3095,7 +3260,7 @@ setCornerRadius(cornerRadius: number): void ...@@ -3095,7 +3260,7 @@ setCornerRadius(cornerRadius: number): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | -------------------- | | ----------- | ------- | ---- | -------------------- |
...@@ -3107,6 +3272,163 @@ setCornerRadius(cornerRadius: number): void ...@@ -3107,6 +3272,163 @@ setCornerRadius(cornerRadius: number): void
windowClass.setCornerRadius(4.0); windowClass.setCornerRadius(4.0);
``` ```
### opacity<sup>9+</sup>
opacity(opacity: number): void
设置窗口透明度。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | --------------------- |
| opacity | number | 是 | 透明度，范围0.0~1.0。 |
**示例：**
```ts
windowClass.opacity(0.5);
console.log('set window opacity end');
```
### scale<sup>9+</sup>
scale(scaleOptions: ScaleOptions): void
设置窗口缩放参数。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------------ | ---- | ---------- |
| scaleOptions | [ScaleOptions](#scaleoptions9) | 是 | 缩放参数。 |
**示例：**
```ts
var obj : window.ScaleOptions;
obj.x = 2.0;
obj.y = 1.0;
obj.pivotX = 0.5;
obj.pivotY = 0.5;
windowClass.scale(obj);
console.log('set window scale end');
```
### rotate<sup>9+</sup>
rotate(rotateOptions: RotateOptions): void
设置窗口旋转参数。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | -------------------------------- | ---- | ---------- |
| rotateOptions | [RotateOptions](#rotateoptions9) | 是 | 旋转参数。 |
**示例：**
```ts
var obj : window.RotateOptions;
obj.x = 1.0;
obj.y = 1.0;
obj.z = 45.0;
obj.pivotX = 0.5;
obj.pivotY = 0.5;
windowClass.rotate(obj);
console.log('set window rotate end');
```
### translate<sup>9+</sup>
translate(translateOptions: TranslateOptions): void
设置窗口平移参数。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------------- | -------------------------------------- | ---- | ---------- |
| translateOptions | [TranslateOptions](#translateoptions9) | 是 | 平移参数。 |
**示例：**
```ts
var obj : window.TranslateOptions;
obj.x = 100.0;
obj.y = 0.0;
obj.z = 0.0;
windowClass.translate(obj);
console.log('set window translate end');
```
### getTransitionController<sup>9+</sup>
getTransitionController(): TransitionController
获取窗口属性转换控制器。
此接口为系统接口。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：**
| 类型 | 说明 |
| ---------------------------------------------- | ---------------- |
| [TransitionController](#transitioncontroller9) | 属性转换控制器。 |
**示例：**
```ts
let controller = windowClass.getTransitionController(); // 获取属性转换控制器
controller.animationForHidden = (context : window.TransitionContext) => {
let toWindow = context.toWindow
animateTo({
duration: 1000, // 动画时长
tempo: 0.5, // 播放速率
curve: Curve.EaseInOut, // 动画曲线
delay: 0, // 动画延迟
iterations: 1, // 播放次数
playMode: PlayMode.Normal, // 动画模式
}, () => {
var obj : window.TranslateOptions;
obj.x = 100.0;
obj.y = 0.0;
obj.z = 0.0;
toWindow.translate(obj); // 设置动画过程中的属性转换
console.info('toWindow translate end');
}
)
context.completeTransition(true)
console.info('complete transition end');
}
windowClass.showWithAnimation((err, data) => {
if (err.code) {
console.error('Failed to show the window with animation. Cause: ' + JSON.stringify(err));
return;
}
console.info('Succeeded in showing the window with animation. Data: ' + JSON.stringify(data));
})
```
## WindowStageEventType<sup>9+</sup> ## WindowStageEventType<sup>9+</sup>
WindowStage生命周期。 WindowStage生命周期。
...@@ -3138,13 +3460,13 @@ getMainWindow(callback: AsyncCallback&lt;Window&gt;): void ...@@ -3138,13 +3460,13 @@ getMainWindow(callback: AsyncCallback&lt;Window&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | --------------------------------------------- | | -------- | -------------------------------------- | ---- | --------------------------------------------- |
| callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前WindowStage下的主窗口对象。 | | callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前WindowStage下的主窗口对象。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3173,13 +3495,13 @@ getMainWindow(): Promise&lt;Window&gt; ...@@ -3173,13 +3495,13 @@ getMainWindow(): Promise&lt;Window&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | ------------------------------------------------ | | -------------------------------- | ------------------------------------------------ |
| Promise&lt;[Window](#window)&gt; | Promise对象。返回当前WindowStage下的主窗口对象。 | | Promise&lt;[Window](#window)&gt; | Promise对象。返回当前WindowStage下的主窗口对象。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3207,14 +3529,14 @@ createSubWindow(name: string, callback: AsyncCallback&lt;Window&gt;): void ...@@ -3207,14 +3529,14 @@ createSubWindow(name: string, callback: AsyncCallback&lt;Window&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | --------------------------------------------- | | -------- | -------------------------------------- | ---- | --------------------------------------------- |
| name | String | 是 | 子窗口的名字。 | | name | String | 是 | 子窗口的名字。 |
| callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前WindowStage下的子窗口对象。 | | callback | AsyncCallback&lt;[Window](#window)&gt; | 是 | 回调函数。返回当前WindowStage下的子窗口对象。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3244,19 +3566,19 @@ createSubWindow(name: string): Promise&lt;Window&gt; ...@@ -3244,19 +3566,19 @@ createSubWindow(name: string): Promise&lt;Window&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | -------------- |
| name | String | 是 | 子窗口的名字。 | | name | String | 是 | 子窗口的名字。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | ------------------------------------------------ | | -------------------------------- | ------------------------------------------------ |
| Promise&lt;[Window](#window)&gt; | Promise对象。返回当前WindowStage下的子窗口对象。 | | Promise&lt;[Window](#window)&gt; | Promise对象。返回当前WindowStage下的子窗口对象。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3284,13 +3606,13 @@ getSubWindow(callback: AsyncCallback&lt;Array&lt;Window&gt;&gt;): void ...@@ -3284,13 +3606,13 @@ getSubWindow(callback: AsyncCallback&lt;Array&lt;Window&gt;&gt;): void
**系统能力：** 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下的所有子窗口对象。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3319,13 +3641,13 @@ getSubWindow(): Promise&lt;Array&lt;Window&gt;&gt; ...@@ -3319,13 +3641,13 @@ getSubWindow(): Promise&lt;Array&lt;Window&gt;&gt;
**系统能力：** 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下的所有子窗口对象。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3353,7 +3675,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void ...@@ -3353,7 +3675,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
...@@ -3366,7 +3688,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void ...@@ -3366,7 +3688,7 @@ loadContent(path: string, storage: LocalStorage, callback: AsyncCallback&lt;void
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
class myAbility extends Ability { class myAbility extends Ability {
storage : LocalStorage storage : LocalStorage
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.storage = new LocalStorage(); this.storage = new LocalStorage();
this.storage.setOrCreate("storageSimpleProp",121); this.storage.setOrCreate("storageSimpleProp",121);
...@@ -3392,7 +3714,7 @@ loadContent(path: string, storage?: LocalStorage): Promise&lt;void&gt; ...@@ -3392,7 +3714,7 @@ loadContent(path: string, storage?: LocalStorage): Promise&lt;void&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
...@@ -3410,7 +3732,7 @@ loadContent(path: string, storage?: LocalStorage): Promise&lt;void&gt; ...@@ -3410,7 +3732,7 @@ loadContent(path: string, storage?: LocalStorage): Promise&lt;void&gt;
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
class myAbility extends Ability { class myAbility extends Ability {
storage : LocalStorage storage : LocalStorage
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
this.storage = new LocalStorage(); this.storage = new LocalStorage();
this.storage.setOrCreate("storageSimpleProp",121); this.storage.setOrCreate("storageSimpleProp",121);
...@@ -3437,14 +3759,14 @@ loadContent(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -3437,14 +3759,14 @@ loadContent(path: string, callback: AsyncCallback&lt;void&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------- | | -------- | ------------------------- | ---- | -------------------- |
| path | string | 是 | 设置加载页面的路径。 | | path | string | 是 | 设置加载页面的路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3472,14 +3794,14 @@ on(eventType: 'windowStageEvent', callback: Callback&lt;WindowStageEventType&gt; ...@@ -3472,14 +3794,14 @@ on(eventType: 'windowStageEvent', callback: Callback&lt;WindowStageEventType&gt;
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 |
| callback | Callback&lt;[WindowStageEventType](#windowstageeventtype9)&gt; | 是 | 回调函数。返回当前的WindowStage生命周期状态。 | | callback | Callback&lt;[WindowStageEventType](#windowstageeventtype9)&gt; | 是 | 回调函数。返回当前的WindowStage生命周期状态。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3503,14 +3825,14 @@ off(eventType: 'windowStageEvent', callback?: Callback&lt;WindowStageEventType&g ...@@ -3503,14 +3825,14 @@ off(eventType: 'windowStageEvent', callback?: Callback&lt;WindowStageEventType&g
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 |
| callback | Callback&lt;[WindowStageEventType](#windowstageeventtype9)&gt; | 否 | 回调函数。返回当前的WindowStage生命周期状态。 | | callback | Callback&lt;[WindowStageEventType](#windowstageeventtype9)&gt; | 否 | 回调函数。返回当前的WindowStage生命周期状态。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3534,7 +3856,7 @@ disableWindowDecor(): void ...@@ -3534,7 +3856,7 @@ disableWindowDecor(): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3551,19 +3873,20 @@ class myAbility extends Ability { ...@@ -3551,19 +3873,20 @@ class myAbility extends Ability {
setShowOnLockScreen(showOnLockScreen: boolean): void setShowOnLockScreen(showOnLockScreen: boolean): void
设置应用显示在锁屏之上。 设置应用显示在锁屏之上。
此接口为系统接口，三方应用不支持调用。
此接口为系统接口。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ------- | ---- | ---------------------------- | | ---------------- | ------- | ---- | ---------------------------- |
| showOnLockScreen | boolean | 是 | 是否设置应用显示在锁屏之上。 | | showOnLockScreen | boolean | 是 | 是否设置应用显示在锁屏之上。 |
**示例：** **示例：**
```ts ```ts
import Ability from '@ohos.application.Ability'; import Ability from '@ohos.application.Ability';
...@@ -3574,4 +3897,146 @@ class myAbility extends Ability { ...@@ -3574,4 +3897,146 @@ class myAbility extends Ability {
} }
} }
``` ```
## TransitionContext<sup>9+</sup>
属性转换的上下文信息。
此接口为系统接口。
### toWindow<sup>9+</sup>
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ----------------- | ---- | ---- | ---------------- |
| toWindow | [Window](#window) | 是 | 是 | 动画的目标窗口。 |
### completeTransition<sup>9+</sup>
completeTransition(isCompleted: boolean): void
设置属性转换的最终完成状态。该函数需要在动画函数[animateTo()](../arkui-ts/ts-explicit-animation.md)执行后设置。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | ------------------------------------------------------------ |
| isCompleted | boolean | 是 | 窗口属性转换是否完成。true：完成本次转换；false：撤销本次转换。 |
**示例：**
```ts
let controller = windowClass.getTransitionController();
controller.animationForShown = (context : window.TransitionContext) => {
let toWindow = context.toWindow
animateTo({
duration: 1000, // 动画时长
tempo: 0.5, // 播放速率
curve: Curve.EaseInOut, // 动画曲线
delay: 0, // 动画延迟
iterations: 1, // 播放次数
playMode: PlayMode.Normal, // 动画模式
}, () => {
var obj : window.TranslateOptions;
obj.x = 100.0;
obj.y = 0.0;
obj.z = 0.0;
toWindow.translate(obj);
console.info('toWindow translate end');
}
)
context.completeTransition(true)
console.info('complete transition end');
}
```
## TransitionController<sup>9+</sup>
属性转换控制器。
此接口为系统接口。
### animationForShown<sup>9+</sup>
animationForShown(context: TransitionContext): void
窗口显示时的自定义动画配置。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | -------------------- |
| context | [TransitionContext](#transitioncontext9) | 是 | 属性转换时的上下文。 |
**示例：**
```ts
let controller = windowClass.getTransitionController();
controller.animationForShown = (context : window.TransitionContext) => {
let toWindow = context.toWindow
animateTo({
duration: 1000, // 动画时长
tempo: 0.5, // 播放速率
curve: Curve.EaseInOut, // 动画曲线
delay: 0, // 动画延迟
iterations: 1, // 播放次数
playMode: PlayMode.Normal, // 动画模式
}, () => {
var obj : window.TranslateOptions;
obj.x = 100.0;
obj.y = 0.0;
obj.z = 0.0;
toWindow.translate(obj);
console.info('toWindow translate end');
}
)
context.completeTransition(true)
console.info('complete transition end');
}
```
### animationForHidden<sup>9+</sup>
animationForHidden(context: TransitionContext): void
窗口隐藏时的自定义动画配置。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | -------------------- |
| context | [TransitionContext](#transitioncontext9) | 是 | 属性转换时的上下文。 |
**示例：**
```ts
let controller = windowClass.getTransitionController();
controller.animationForHidden = (context : window.TransitionContext) => {
let toWindow = context.toWindow
animateTo({
duration: 1000, // 动画时长
tempo: 0.5, // 播放速率
curve: Curve.EaseInOut, // 动画曲线
delay: 0, // 动画延迟
iterations: 1, // 播放次数
playMode: PlayMode.Normal, // 动画模式
}, () => {
var obj : window.TranslateOptions;
obj.x = 100.0;
obj.y = 0.0;
obj.z = 0.0;
toWindow.translate(obj);
console.info('toWindow translate end');
}
)
context.completeTransition(true)
console.info('complete transition end');
}
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或