diff --git a/en/application-dev/reference/apis/js-apis-window.md b/en/application-dev/reference/apis/js-apis-window.md
index 6c4890a972ef5426b2a4e6a57f41d426412b3736..b3db77cfbac7a3c195a6f2d88cf88977332457ca 100644
--- a/en/application-dev/reference/apis/js-apis-window.md
+++ b/en/application-dev/reference/apis/js-apis-window.md
@@ -1,8 +1,13 @@
# Window
-The **Window** module provides basic capabilities for managing windows, including creating and destroying windows and setting serial port attributes.
+The `Window` module provides basic window management capabilities, such as creating and destroying the current window, setting properties for the current window, and managing and scheduling windows.
-> **NOTE**
+This module provides the following common window-related functions:
+
+- [Window](#window): the current window instance, which is the basic unit managed by the window manager.
+- [WindowStage](#windowstage9): window manager that manages windows.
+
+> **NOTE**
>
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
@@ -20,37 +25,38 @@ Enumerates the window types.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
-| Name | Default Value | Description |
+| Name | Value| Description |
| ----------------- | ------ | ------------------ |
-| TYPE_APP | 0 | Application subwindow. |
+| TYPE_APP | 0 | Application subwindow.|
| TYPE_SYSTEM_ALERT | 1 | System alert window.|
+
## AvoidAreaType7+
Enumerates the types of the area where the window cannot be displayed.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
-| Name | Default Value | Description |
-| ----------- | ------ | ------------------ |
-| TYPE_SYSTEM | 0 | Default area of the system.|
-| TYPE_CUTOUT | 1 | Notch. |
+| Name | Value | Description |
+| ----------- | ---- | ------------------ |
+| TYPE_SYSTEM | 0 | Default area of the system.|
+| TYPE_CUTOUT | 1 | Notch. |
## WindowMode7+
-Enumerates the window modes of an application.
+Enumerates the window modes.
This is a system API and cannot be called by third-party applications.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
-| Name | Default Value | Description |
-| ---------- | ------ | ----------------------------- |
-| UNDEFINED | 1 | The window mode is not defined by the application. |
-| FULLSCREEN | 2 | The application is displayed in full screen. |
-| PRIMARY | 3 | The application is displayed in the primary window in split-screen mode. |
-| SECONDARY | 4 | The application is displayed in the secondary window in split-screen mode. |
-| FLOATING | 5 | The application is displayed in a floating window.|
+| Name | Value | Description |
+| ---------- | ---- | ----------------------------- |
+| UNDEFINED | 1 | The window mode is not defined by the application. |
+| FULLSCREEN | 2 | The application is displayed in full screen. |
+| PRIMARY | 3 | The application is displayed in the primary window in split-screen mode. |
+| SECONDARY | 4 | The application is displayed in the secondary window in split-screen mode. |
+| FLOATING | 5 | The application is displayed in a floating window.|
## SystemBarProperties
@@ -60,10 +66,10 @@ Describes the properties of the status bar and navigation bar.
| Name | Type| Readable| Writable| Description |
| -------------------------------------- | -------- | ---- | ---- | ------------------------------------------------------------ |
-| statusBarColor | string | Yes | Yes | Background color of the status bar. The value is a hexadecimal RGB or aRGB color value and is case insensitive, for example, **\#00FF00** or **\#FF00FF00**.|
+| statusBarColor | string | Yes | Yes | Background color of the status bar. The value is a hexadecimal RGB or aRGB color value and is case insensitive, for example, `#00FF00` or `#FF00FF00`.|
| isStatusBarLightIcon7+ | boolean | No | Yes | Whether any icon on the status bar is highlighted. |
| statusBarContentColor8+ | string | No | Yes | Color of the text on the status bar. |
-| navigationBarColor | string | Yes | Yes | Background color of the navigation bar. The value is a hexadecimal RGB or aRGB color value and is case insensitive, for example, **\#00FF00** or **\#FF00FF00**.|
+| navigationBarColor | string | Yes | Yes | Background color of the navigation bar. The value is a hexadecimal RGB or aRGB color value and is case insensitive, for example, `#00FF00` or `#FF00FF00`.|
| isNavigationBarLightIcon7+ | boolean | No | No | Whether any icon on the navigation bar is highlighted. |
| navigationBarContentColor8+ | string | No | Yes | Color of the text on the navigation bar. |
@@ -80,7 +86,7 @@ This is a system API and cannot be called by third-party applications.
| type | [WindowType](#windowtype) | Yes | Yes | Type of the system bar whose properties are changed. Only the status bar and navigation bar are supported.|
| isEnable | boolean | Yes | Yes | Whether the system bar is displayed. |
| region | [Rect](#rect) | Yes | Yes | Current position and size of the system bar. |
-| backgroundColor | string | Yes | Yes | Background color of the system bar. The value is a hexadecimal RGB or aRGB color value and is case insensitive, for example, **\#00FF00** or **\#FF00FF00**.|
+| backgroundColor | string | Yes | Yes | Background color of the system bar. The value is a hexadecimal RGB or aRGB color value and is case insensitive, for example, `#00FF00` or `#FF00FF00`.|
| contentColor | string | Yes | Yes | Color of the text on the system bar. |
## SystemBarTintState8+
@@ -91,14 +97,14 @@ This is a system API and cannot be called by third-party applications.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
-| Name | Type | Readable| Writable| Description |
-| ---------- | --------------------------------------------------- | ---- | ---- | -------------------------- |
-| displayId | number | Yes | No | ID of the current physical screen. |
-| regionTint | Array<[SystemBarRegionTint](#systembarregiontint8)> | Yes | Yes | All system bar information changed.|
+| Name | Type | Readable| Writable| Description |
+| ---------- | --------------------------------------------------- | ---- | ---- | ---------------------------- |
+| displayId | number | Yes | No | ID of the current physical screen. |
+| regionTint | Array<[SystemBarRegionTint](#systembarregiontint8)> | Yes | Yes | All system bar information that has been changed.|
## Rect7+
- Describes the rectangular area of the window.
+Describes the rectangular area of the window.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
@@ -143,16 +149,16 @@ Describes the window properties.
| ------------------------------- | ------------------------- | ---- | ---- | -------------------------------------------- |
| windowRect7+ | [Rect](#rect) | Yes | Yes | Window size. |
| type7+ | [WindowType](#windowtype) | Yes | Yes | Window type. |
-| isFullScreen | boolean | Yes | Yes | Whether the window is displayed in full screen mode. The default value is **false**. |
-| isLayoutFullScreen7+ | boolean | Yes | Yes | Whether the window layout is in full-screen mode (whether the window is immersive). The default value is **false**. |
-| focusable7+ | boolean | Yes | No | Whether the window can gain focus. The default value is **true**. |
-| touchable7+ | boolean | Yes | No | Whether the window is touchable. The default value is **true**. |
-| brightness | number | Yes | Yes | Screen brightness. The value ranges from 0 to 1. The value **1** indicates the maximum brightness. |
-| dimBehindValue(deprecated) | number | Yes | Yes | Dimness of the window that is not on top. The value ranges from 0 to 1. The value **1** indicates the maximum dimness.
This attribute is supported since API version 7 and deprecated since API version 9.
|
-| isKeepScreenOn | boolean | Yes | Yes | Whether the screen is always on. The default value is **false**. |
-| isPrivacyMode7+ | boolean | Yes | Yes | Whether the window is in privacy mode. The default value is **false**. |
-| isRoundCorner7+ | boolean | Yes | Yes | Whether the window has rounded corners. The default value is **false**. |
-| isTransparent7+ | boolean | Yes | Yes | Whether the window is transparent. The default value is **false**. |
+| isFullScreen | boolean | Yes | Yes | Whether the window is displayed in full screen mode. The default value is `false`. |
+| isLayoutFullScreen7+ | boolean | Yes | Yes | Whether the window layout is in full-screen mode (whether the window is immersive). The default value is `false`. |
+| focusable7+ | boolean | Yes | No | Whether the window can gain focus. The default value is `true`. |
+| touchable7+ | boolean | Yes | No | Whether the window is touchable. The default value is `true`. |
+| brightness | number | Yes | Yes | Screen brightness. The value ranges from 0 to 1. The value `1` indicates the maximum brightness. |
+| dimBehindValue(deprecated) | number | Yes | Yes | Dimness of the window that is not on top. The value ranges from 0 to 1. The value `1` indicates the maximum dimness.
This attribute is supported since API version 7 and deprecated since API version 9.
|
+| isKeepScreenOn | boolean | Yes | Yes | Whether the screen is always on. The default value is `false`. |
+| isPrivacyMode7+ | boolean | Yes | Yes | Whether the window is in privacy mode. The default value is `false`. |
+| isRoundCorner7+ | boolean | Yes | Yes | Whether the window has rounded corners. The default value is `false`. |
+| isTransparent7+ | boolean | Yes | Yes | Whether the window is transparent. The default value is `false`. |
## ColorSpace8+
@@ -171,32 +177,28 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi
Creates a subwindow. This API uses an asynchronous callback to return the result.
-This API is deprecated since API version 8. You are advised to use [window.create8+](#windowcreate8) instead.
-
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------------------------- | ---- | -------------------------- |
-| id | string | Yes | Window ID. |
-| type | [WindowType](#windowtype) | Yes | Window type. |
+| Name | Type | Mandatory| Description |
+| -------- | -------------------------------------- | ---- | ------------------------------------ |
+| id | string | Yes | Window ID. |
+| type | [WindowType](#windowtype) | Yes | Window type. |
| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the subwindow created.|
**Example**
- ```js
- var windowClass = null;
- window.create("first", window.WindowType.TYPE_APP, (err, data) => {
- if (err.code) {
- console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('SubWindow created. Data: ' + JSON.stringify(data))
- windowClass.resetSize(500, 1000);
- });
- ```
+```js
+var windowClass = null;
+ let promise = window.create("first", window.WindowType.TYPE_APP);
+ promise.then((data)=> {
+ windowClass = data;
+ console.info('SubWindow created. Data: ' + JSON.stringify(data));
+ }).catch((err)=>{
+ console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
+ });
+```
## window.create7+
@@ -204,8 +206,6 @@ create(id: string, type: WindowType): Promise<Window>
Creates a subwindow. This API uses a promise to return the result.
-This API is deprecated since API version 8. You are advised to use [window.create8+](#windowcreate8) instead.
-
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
@@ -217,22 +217,22 @@ This API is deprecated since API version 8. You are advised to use [window.creat
**Return value**
-| Type | Description |
-| -------------------------------- | ------------------------------------------------- |
+| Type | Description |
+| -------------------------------- | --------------------------------------- |
| Promise<[Window](#window)> | Promise used to return the subwindow created.|
**Example**
- ```js
- var windowClass = null;
- let promise = window.create("first", window.WindowType.TYPE_APP);
- promise.then((data)=> {
- windowClass = data;
- console.info('SubWindow created. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var windowClass = null;
+let promise = window.create("first", window.WindowType.TYPE_APP);
+promise.then((data)=> {
+ windowClass = data;
+ console.info('SubWindow created. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
+});
+```
## window.create8+
@@ -246,25 +246,25 @@ Creates a subwindow (in API version 8) or a system window (from API version 9).
| Name | Type | Mandatory| Description |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ |
-| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [ServiceExtensionContext](js-apis-service-extension-context.md). |
+| ctx | Context | Yes | Current application context.
For the definition of `Context` of API version 8, see [Context](js-apis-Context.md).
For the definition of `Context` of API version 9, see [ServiceExtensionContext](js-apis-service-extension-context.md).|
| id | string | Yes | Window ID. |
| type | [WindowType](#windowtype) | Yes | Window type. |
-| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the window created. |
+| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the window created. |
**Example**
- ```js
- var windowClass = null;
- window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT, (err, data) => {
- if (err.code) {
- console.error('Failed to create the Window. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('Window created. Data: ' + JSON.stringify(data))
- windowClass.resetSize(500, 1000);
- });
- ```
+```js
+var windowClass = null;
+ window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT, (err, data) => {
+ if (err.code) {
+ console.error('Failed to create the Window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ windowClass = data;
+ console.info('Window created. Data: ' + JSON.stringify(data));
+ windowClass.resetSize(500, 1000);
+});
+```
## window.create8+
@@ -278,28 +278,28 @@ Creates a subwindow (in API version 8) or a system window (from API version 9).
| Name| Type | Mandatory| Description |
| ------ | ------------------------- | ---- | ------------------------------------------------------------ |
-| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [ServiceExtensionContext](js-apis-service-extension-context.md). |
+| ctx | Context | Yes | Current application context.
For the definition of `Context` of API version 8, see [Context](js-apis-Context.md).
For the definition of `Context` of API version 9, see [ServiceExtensionContext](js-apis-service-extension-context.md).|
| id | string | Yes | Window ID. |
| type | [WindowType](#windowtype) | Yes | Window type. |
**Return value**
-| Type | Description |
-| -------------------------------- | ----------------------------------------------- |
+| Type | Description |
+| -------------------------------- | --------------------------------------- |
| Promise<[Window](#window)> | Promise used to return the window created.|
**Example**
- ```js
- var windowClass = null;
- let promise = window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT);
- promise.then((data)=> {
- windowClass = data;
- console.info('Window created. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to create the Window. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var windowClass = null;
+let promise = window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT);
+promise.then((data)=> {
+ windowClass = data;
+ console.info('Window created. Data:' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to create the Window. Cause:' + JSON.stringify(err));
+});
+```
## window.find7+
@@ -311,24 +311,24 @@ Finds a window based on the ID. This API uses an asynchronous callback to return
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------------------------- | ---- | ---------------------------- |
-| id | string | Yes | Window ID. |
+| Name | Type | Mandatory| Description |
+| -------- | -------------------------------------- | ---- | ------------------------------------ |
+| id | string | Yes | Window ID. |
| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the window found.|
**Example**
- ```js
- var windowClass = null;
- window.find("alertWindow", (err, data) => {
- if (err.code) {
- console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('window found. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+var windowClass = null;
+ window.find("alertWindow", (err, data) => {
+ if (err.code) {
+ console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ windowClass = data;
+ console.info('window found. Data: ' + JSON.stringify(data));
+});
+```
## window.find7+
@@ -346,22 +346,22 @@ Finds a window based on the ID. This API uses a promise to return the result.
**Return value**
-| Type | Description |
-| -------------------------------- | ----------------------------------------------- |
+| Type | Description |
+| -------------------------------- | ------------------------------------- |
| Promise<[Window](#window)> | Promise used to return the window found.|
**Example**
- ```js
- var windowClass = null;
- let promise = window.find("alertWindow");
- promise.then((data)=> {
- windowClass = data;
- console.info('window found. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var windowClass = null;
+let promise = window.find("alertWindow");
+promise.then((data)=> {
+ windowClass = data;
+ console.info('window found. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
+});
+```
## window.getTopWindow
@@ -369,29 +369,27 @@ getTopWindow(callback: AsyncCallback<Window>): void
Obtains the top window of the current application. This API uses an asynchronous callback to return the result.
-This API is deprecated since API version 8. You are advised to use [window.getTopWindow8+](#windowgettopwindow8) instead.
-
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------------------------- | ---- | -------------------------------------- |
+| Name | Type | Mandatory| Description |
+| -------- | -------------------------------------- | ---- | -------------------------------------------- |
| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the top window obtained.|
**Example**
- ```js
- var windowClass = null;
- window.getTopWindow((err, data) => {
- if (err.code) {
- console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+var windowClass = null;
+window.getTopWindow((err, data) => {
+ if (err.code) {
+ console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ windowClass = data;
+ console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
+});
+```
## window.getTopWindow
@@ -399,28 +397,26 @@ getTopWindow(): Promise<Window>
Obtains the top window of the current application. This API uses a promise to return the result.
-This API is deprecated since API version 8. You are advised to use [window.getTopWindow8+](#windowgettopwindow8) instead.
-
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Return value**
-| Type | Description |
-| -------------------------------- | --------------------------------------------------------- |
+| Type | Description |
+| -------------------------------- | ----------------------------------------------- |
| Promise<[Window](#window)> | Promise used to return the top window obtained.|
**Example**
- ```js
- var windowClass = null;
- let promise = window.getTopWindow();
- promise.then((data)=> {
- windowClass = data;
- console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
- })
- ```
+```js
+var windowClass = null;
+let promise = window.getTopWindow();
+promise.then((data)=> {
+ windowClass = data;
+ console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
+})
+```
## window.getTopWindow8+
@@ -434,22 +430,22 @@ Obtains the top window of the current application. This API uses an asynchronous
| Name | Type | Mandatory| Description |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ |
-| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [AbilityContext](js-apis-ability-context.md). |
-| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the top window obtained. |
+| ctx | Context | Yes | Current application context.
For the definition of `Context` of API version 8, see [Context](js-apis-Context.md).
For the definition of `Context` of API version 9, see [AbilityContext](js-apis-ability-context.md).|
+| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the top window obtained. |
**Example**
- ```js
- var windowClass = null;
- window.getTopWindow(this.context, (err, data) => {
- if (err.code) {
- console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+var windowClass = null;
+window.getTopWindow(this.context, (err, data) => {
+ if (err.code) {
+ console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ windowClass = data;
+ console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
+});
+```
## window.getTopWindow8+
@@ -463,26 +459,26 @@ Obtains the top window of the current application. This API uses a promise to re
| Name| Type | Mandatory| Description |
| ------ | ------- | ---- | ------------------------------------------------------------ |
-| ctx | Context | Yes | Current application context.
For the definition of **Context** of API version 8, see [Context](js-apis-Context.md).
For the definition of **Context** of API version 9, see [AbilityContext](js-apis-ability-context.md). |
+| ctx | Context | Yes | Current application context.
For the definition of `Context` of API version 8, see [Context](js-apis-Context.md).
For the definition of `Context` of API version 9, see [AbilityContext](js-apis-ability-context.md).|
**Return value**
-| Type | Description |
-| -------------------------------- | --------------------------------------------------------- |
+| Type | Description |
+| -------------------------------- | ----------------------------------------------- |
| Promise<[Window](#window)> | Promise used to return the top window obtained.|
**Example**
- ```js
- var windowClass = null;
- let promise = window.getTopWindow(this.context);
- promise.then((data)=> {
- windowClass = data;
- console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
- })
- ```
+```js
+var windowClass = null;
+let promise = window.getTopWindow(this.context);
+promise.then((data)=> {
+ windowClass = data;
+ console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
+})
+```
## on('systemBarTintChange')8+
@@ -498,17 +494,16 @@ This is a system API and cannot be called by third-party applications.
| Name | Type | Mandatory| Description |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **systemBarTintChange**, indicating the property change event of the status bar and navigation bar.|
-| callback | Callback<[SystemBarTintState](#systembartintstate)> | Yes | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `systemBarTintChange`, indicating the property change event of the status bar and navigation bar.|
+| callback | Callback<[SystemBarTintState](#systembartintstate)> | Yes | Callback used to return the properties of the status bar and navigation bar. |
**Example**
- ```js
- var type = 'systemBarTintChange';
- windowClass.on(type, (data) => {
- console.info('Succeeded in enabling the listener for systemBarTint changes. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+window.on('systemBarTintChange', (data) => {
+ console.info('Succeeded in enabling the listener for systemBarTint changes. Data: ' + JSON.stringify(data));
+});
+```
## off('systemBarTintChange')8+
@@ -524,19 +519,20 @@ This is a system API and cannot be called by third-party applications.
| Name | Type | Mandatory| Description |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **systemBarTintChange**, indicating the property change event of the status bar and navigation bar.|
-| callback | Callback<[SystemBarTintState](#systembartintstate)> | No | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `systemBarTintChange`, indicating the property change event of the status bar and navigation bar.|
+| callback | Callback<[SystemBarTintState](#systembartintstate)> | No | Callback used to return the properties of the status bar and navigation bar. |
**Example**
- ```js
- var type = 'systemBarTintChange';
- windowClass.off(type);
- ```
+```js
+window.off('systemBarTintChange');
+```
## Window
-In the following API examples, you must use [getTopWindow()](#windowgettopwindow), [create()](#windowcreate7), or [find()](#windowfind7) to obtain a **Window** instance and then call a method in this instance.
+Represents the current window instance, which is the basic unit managed by the window manager.
+
+In the following API examples, you must use [getTopWindow()](#windowgettopwindow), [create()](#windowcreate7), or [find()](#windowfind7) to obtain a `Window` instance and then call a method in this instance.
### hide7+
@@ -552,19 +548,19 @@ This is a system API and cannot be called by third-party applications.
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ---------- |
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
**Example**
- ```js
- windowClass.hide((err, data) => {
- if (err.code) {
- console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('window hidden. data: ' + JSON.stringify(data))
- })
- ```
+```js
+windowClass.hide((err, data) => {
+ if (err.code) {
+ console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('window hidden. data: ' + JSON.stringify(data));
+})
+```
### hide7+
@@ -578,20 +574,20 @@ This is a system API and cannot be called by third-party applications.
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.hide();
- promise.then((data)=> {
- console.info('window hidden. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
- })
- ```
+```js
+let promise = windowClass.hide();
+promise.then((data)=> {
+ console.info('window hidden. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to hide the window. Cause: ' + JSON.stringify(err));
+})
+```
### show7+
@@ -605,19 +601,19 @@ Shows this window. This API uses an asynchronous callback to return the result.
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ---------- |
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
**Example**
- ```js
- windowClass.show((err, data) => {
- if (err.code) {
- console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in showing the window. Data: ' + JSON.stringify(data))
- })
- ```
+```js
+windowClass.show((err, data) => {
+ if (err.code) {
+ console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in showing the window. Data: ' + JSON.stringify(data));
+})
+```
### show7+
@@ -629,20 +625,20 @@ Shows this window. This API uses a promise to return the result.
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.show();
- promise.then((data)=> {
- console.info('Succeeded in showing the window. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
- })
- ```
+```js
+let promise = windowClass.show();
+promise.then((data)=> {
+ console.info('Succeeded in showing the window. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
+})
+```
### destroy7+
@@ -656,19 +652,19 @@ Destroys this window. This API uses an asynchronous callback to return the resul
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ---------- |
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
**Example**
- ```js
- windowClass.destroy((err, data) => {
- if (err.code) {
- console.error('Failed to destroy the window. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in destroying the window. Data: ' + JSON.stringify(data))
- })
- ```
+```js
+windowClass.destroy((err, data) => {
+ if (err.code) {
+ console.error('Failed to destroy the window. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in destroying the window. Data: ' + JSON.stringify(data));
+})
+```
### destroy7+
@@ -680,20 +676,20 @@ Destroys this window. This API uses a promise to return the result.
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.destroy();
- promise.then((data)=> {
- console.info('Succeeded in destroying the window. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to destroy the window. Cause: ' + JSON.stringify(err));
- })
- ```
+```js
+let promise = windowClass.destroy();
+promise.then((data)=> {
+ console.info('Succeeded in destroying the window. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to destroy the window. Cause: ' + JSON.stringify(err));
+})
+```
### moveTo7+
@@ -709,20 +705,20 @@ Moves this window. This API uses an asynchronous callback to return the result.
| -------- | ------------------------- | ---- | ------------------------------------------------- |
| x | number | Yes | Distance that the window moves along the x-axis, in px. A positive value indicates that the window moves to the right.|
| y | number | Yes | Distance that the window moves along the y-axis, in px. A positive value indicates that the window moves downwards.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- windowClass.moveTo(300, 300, (err, data)=>{
- if (err.code) {
- console.error('Failed to move the window. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Window moved. Data: ' + JSON.stringify(data))
-
- });
- ```
+```js
+windowClass.moveTo(300, 300, (err, data)=>{
+ if (err.code) {
+ console.error('Failed to move the window. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Window moved. Data: ' + JSON.stringify(data));
+
+});
+```
### moveTo7+
@@ -741,20 +737,20 @@ Moves this window. This API uses a promise to return the result.
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.moveTo(300, 300);
- promise.then((data)=> {
- console.info('Window moved. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to move the window. Cause: ' + JSON.stringify(err));
- })
- ```
+```js
+let promise = windowClass.moveTo(300, 300);
+promise.then((data)=> {
+ console.info('Window moved. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to move the window. Cause: ' + JSON.stringify(err));
+})
+```
### resetSize7+
@@ -770,19 +766,19 @@ Changes the size of this window. This API uses an asynchronous callback to retur
| -------- | ------------------------- | ---- | -------------------------- |
| width | number | Yes | New width of the window, in px.|
| height | number | Yes | New height of the window, in px.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- windowClass.resetSize(500, 1000, (err, data) => {
- if (err.code) {
- console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Window size changed. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+windowClass.resetSize(500, 1000, (err, data) => {
+ if (err.code) {
+ console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Window size changed. Data: ' + JSON.stringify(data));
+});
+```
### resetSize7+
@@ -801,20 +797,20 @@ Changes the size of this window. This API uses a promise to return the result.
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.resetSize(500, 1000);
- promise.then((data)=> {
- console.info('Window size changed. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to change the window size. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.resetSize(500, 1000);
+promise.then((data)=> {
+ console.info('Window size changed. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to change the window size. Cause: ' + JSON.stringify(err));
+});
+```
### setWindowType7+
@@ -831,20 +827,20 @@ This is a system API and cannot be called by third-party applications.
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ---------- |
| type | [WindowType](#windowtype) | Yes | Window type.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
**Example**
- ```js
- var type = window.TYPE_APP;
- windowClass.setWindowType(type, (err, data) => {
- if (err.code) {
- console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+var type = window.WindowType.TYPE_APP;
+windowClass.setWindowType(type, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data));
+});
+```
### setWindowType7+
@@ -864,21 +860,21 @@ This is a system API and cannot be called by third-party applications.
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var type = window.TYPE_APP;
- let promise = windowClass.setWindowType(type);
- promise.then((data)=> {
- console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var type = window.WindowType.TYPE_APP;
+let promise = windowClass.setWindowType(type);
+promise.then((data)=> {
+ console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the window type. Cause: ' + JSON.stringify(err));
+});
+```
### getProperties
@@ -890,21 +886,21 @@ Obtains the properties of this window. This API uses an asynchronous callback to
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ---------------------------------------------------------- | ---- | ------------------ |
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------------------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback<[WindowProperties](#windowproperties)> | Yes | Callback used to return the window properties.|
**Example**
- ```js
- windowClass.getProperties((err, data) => {
- if (err.code) {
- console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+windowClass.getProperties((err, data) => {
+ if (err.code) {
+ console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
+});
+```
### getProperties
@@ -916,20 +912,20 @@ Obtains the properties of this window. This API uses a promise to return the res
**Return value**
-| Type | Description |
-| ---------------------------------------------------- | ------------------------------------- |
+| Type | Description |
+| ---------------------------------------------------- | ------------------------------- |
| Promise<[WindowProperties](#windowproperties)> | Promise used to return the window properties.|
**Example**
- ```js
- let promise = windowClass.getProperties();
- promise.then((data)=> {
- console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.getProperties();
+promise.then((data)=> {
+ console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
+});
+```
### getAvoidArea7+
@@ -943,21 +939,21 @@ Obtains the area where this window cannot be displayed, for example, the system
| Name | Type | Mandatory| Description |
| -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
-| type | [AvoidAreaType](#avoidareatype) | Yes | Type of the area. **TYPE_SYSTEM** indicates the default area of the system. **TYPE_CUTOUT** indicates the notch.|
-| callback | AsyncCallback<[AvoidArea](#avoidarea)> | Yes | Callback used to return the area. |
+| type | [AvoidAreaType](#avoidareatype) | Yes | Type of the area. `TYPE_SYSTEM` indicates the default area of the system. `TYPE_CUTOUT` indicates the notch.|
+| callback | AsyncCallback<[AvoidArea](#avoidarea)> | Yes | Callback used to return the area. |
**Example**
- ```js
- var type = window.AvoidAreaType.TYPE_SYSTEM;
- windowClass.getAvoidArea(type, (err, data) => {
- if (err.code) {
- console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
- });
- ```
+```js
+var type = window.AvoidAreaType.TYPE_SYSTEM;
+windowClass.getAvoidArea(type, (err, data) => {
+ if (err.code) {
+ console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
+});
+```
### getAvoidArea7+
@@ -971,24 +967,24 @@ Obtains the area where this window cannot be displayed, for example, the system
| Name| Type | Mandatory| Description |
| ------ | ------------------------------- | ---- | ------------------------------------------------------------ |
-| type | [AvoidAreaType](#avoidareatype) | Yes | Type of the area. **TYPE_SYSTEM** indicates the default area of the system. **TYPE_CUTOUT** indicates the notch.|
+| type | [AvoidAreaType](#avoidareatype) | Yes | Type of the area. `TYPE_SYSTEM` indicates the default area of the system. `TYPE_CUTOUT` indicates the notch.|
**Return value**
-| Type | Description |
-| -------------------------------------- | --------------------------------------------- |
+| Type | Description |
+| -------------------------------------- | ----------------------------------- |
| Promise<[AvoidArea](#avoidarea)> | Promise used to return the area.|
**Example**
- ```js
- let promise = windowClass.getAvoidArea();
- promise.then((data)=> {
- console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.getAvoidArea();
+promise.then((data)=> {
+ console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to obtain the area. Cause:' + JSON.stringify(err));
+});
+```
### setFullScreen
@@ -1003,20 +999,20 @@ Sets whether to enable the full-screen mode for this window. This API uses an as
| Name | Type | Mandatory| Description |
| ------------ | ------------------------- | ---- | ---------------------------------------------- |
| isFullScreen | boolean | Yes | Whether to enable the full-screen mode, in which the status bar and navigation bar are hidden.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var isFullScreen = true;
- windowClass.setFullScreen(isFullScreen, (err, data) => {
- if (err.code) {
- console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+var isFullScreen = true;
+windowClass.setFullScreen(isFullScreen, (err, data) => {
+ if (err.code) {
+ console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data));
+});
+```
### setFullScreen
@@ -1034,21 +1030,21 @@ Sets whether to enable the full-screen mode for this window. This API uses a pro
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var isFullScreen = true;
- let promise = windowClass.setFullScreen(isFullScreen);
- promise.then((data)=> {
- console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var isFullScreen = true;
+let promise = windowClass.setFullScreen(isFullScreen);
+promise.then((data)=> {
+ console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err));
+});
+```
### setLayoutFullScreen7+
@@ -1063,20 +1059,20 @@ Sets whether to enable the full-screen mode for the window layout. This API uses
| Name | Type | Mandatory| Description |
| ------------------ | ------------------------- | ---- | ------------------------------------------------------------ |
| isLayoutFullScreen | boolean | Yes | Whether to enable the full-screen mode for the window layout, in which the status bar and navigation bar are displayed.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var isLayoutFullScreen= true;
- windowClass.setLayoutFullScreen(isLayoutFullScreen, (err, data) => {
- if (err.code) {
- console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+var isLayoutFullScreen= true;
+windowClass.setLayoutFullScreen(isLayoutFullScreen, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data));
+});
+```
### setLayoutFullScreen7+
@@ -1094,21 +1090,21 @@ Sets whether to enable the full-screen mode for the window layout. This API uses
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var isLayoutFullScreen = true;
- let promise = windowClass.setLayoutFullScreen(isLayoutFullScreen);
- promise.then((data)=> {
- console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
- });
- ```
+```js
+var isLayoutFullScreen = true;
+let promise = windowClass.setLayoutFullScreen(isLayoutFullScreen);
+promise.then((data)=> {
+ console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
+});
+```
### setSystemBarEnable7+
@@ -1122,21 +1118,21 @@ Sets whether to display the status bar and navigation bar in this window. This A
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
-| names | Array | Yes | Whether to display the status bar and navigation bar. For example, to display the status bar and navigation bar, set this parameter to **["status", "navigation"]**. By default, they are not displayed.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| names | Array | Yes | Whether to display the status bar and navigation bar.
For example, to display the status bar and navigation bar, set this parameter to `["status", "navigation"]`. By default, they are not displayed.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var names = ["status", "navigation"];
- windowClass.setSystemBarEnable(names, (err, data) => {
- if (err.code) {
- console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+var names = ["status", "navigation"];
+windowClass.setSystemBarEnable(names, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data));
+});
+```
### setSystemBarEnable7+
@@ -1150,25 +1146,25 @@ Sets whether to display the status bar and navigation bar in this window. This A
| Name| Type | Mandatory| Description |
| ------ | ----- | ---- | ------------------------------------------------------------ |
-| names | Array | Yes | Whether to display the status bar and navigation bar. For example, to display the status bar and navigation bar, set this parameter to **["status", "navigation"]**. By default, they are not displayed.|
+| names | Array | Yes | Whether to display the status bar and navigation bar.
For example, to display the status bar and navigation bar, set this parameter to `["status", "navigation"]`. By default, they are not displayed.|
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var names = ["status", "navigation"];
- let promise = windowClass.setSystemBarEnable(names);
- promise.then((data)=> {
- console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
- });
- ```
+```js
+var names = ["status", "navigation"];
+let promise = windowClass.setSystemBarEnable(names);
+promise.then((data)=> {
+ console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the system bar to be visible. Cause:' + JSON.stringify(err));
+});
+```
### setSystemBarProperties
@@ -1180,32 +1176,32 @@ Sets the properties of the status bar and navigation bar in this window. This AP
**Parameters**
-| Name | Type | Mandatory| Description |
-| ------------------- | ------------------------------------------- | ---- | -------------------- |
+| Name | Type | Mandatory| Description |
+| ------------------- | ------------------------------------------- | ---- | ---------------------- |
| SystemBarProperties | [SystemBarProperties](#systembarproperties) | Yes | Properties of the status bar and navigation bar.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
-
-**Example**
-
- ```js
- var SystemBarProperties={
- statusBarColor: '#ff00ff',
- navigationBarColor: '#00ff00',
- // The following properties are supported since API version 7.
- isStatusBarLightIcon: true,
- isNavigationBarLightIcon:false,
- // The following properties are supported since API version 8.
- statusBarContentColor:'#ffffff',
- navigationBarContentColor:'#00ffff'
- };
- windowClass.setSystemBarProperties(SystemBarProperties, (err, data) => {
- if (err.code) {
- console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data))
- });
- ```
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
+
+**Example**
+
+```js
+var SystemBarProperties={
+ statusBarColor: '#ff00ff',
+ navigationBarColor: '#00ff00',
+ // The following properties are supported since API version 7.
+ isStatusBarLightIcon: true,
+ isNavigationBarLightIcon:false,
+ // The following properties are supported since API version 8.
+ statusBarContentColor:'#ffffff',
+ navigationBarContentColor:'#00ffff'
+};
+windowClass.setSystemBarProperties(SystemBarProperties, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data));
+});
+```
### setSystemBarProperties
@@ -1217,42 +1213,42 @@ Sets the properties of the status bar and navigation bar in this window. This AP
**Parameters**
-| Name | Type | Mandatory| Description |
-| ------------------- | ------------------------------------------- | ---- | -------------------- |
+| Name | Type | Mandatory| Description |
+| ------------------- | ------------------------------------------- | ---- | ---------------------- |
| SystemBarProperties | [SystemBarProperties](#systembarproperties) | Yes | Properties of the status bar and navigation bar.|
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
-
-**Example**
-
- ```js
- var SystemBarProperties={
- statusBarColor: '#ff00ff',
- navigationBarColor: '#00ff00',
- // The following properties are supported since API version 7.
- isStatusBarLightIcon: true,
- isNavigationBarLightIcon:false,
- // The following properties are supported since API version 8.
- statusBarContentColor:'#ffffff',
- navigationBarContentColor:'#00ffff'
- };
- let promise = windowClass.setSystemBarProperties(SystemBarProperties);
- promise.then((data)=> {
- console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
- });
- ```
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
+
+**Example**
+
+```js
+var SystemBarProperties={
+ statusBarColor: '#ff00ff',
+ navigationBarColor: '#00ff00',
+ // The following properties are supported since API version 7.
+ isStatusBarLightIcon: true,
+ isNavigationBarLightIcon:false,
+ // The following properties are supported since API version 8.
+ statusBarContentColor:'#ffffff',
+ navigationBarContentColor:'#00ffff'
+};
+let promise = windowClass.setSystemBarProperties(SystemBarProperties);
+promise.then((data)=> {
+ console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
+});
+```
### loadContent7+
loadContent(path: string, callback: AsyncCallback<void>): void
-Loads content to this window. This API uses an asynchronous callback to return the result.
+Loads content from a page to this window. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
@@ -1261,25 +1257,25 @@ Loads content to this window. This API uses an asynchronous callback to return t
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | -------------------- |
| path | string | Yes | Path of the page from which the content will be loaded.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- windowClass.loadContent("pages/page2/page2", (err, data) => {
- if (err.code) {
- console.error('Failed to load the content. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+windowClass.loadContent("pages/page2/page2", (err, data) => {
+ if (err.code) {
+ console.error('Failed to load the content. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data));
+});
+```
### loadContent7+
loadContent(path: string): Promise<void>
-Loads content to this window. This API uses a promise to return the result.
+Loads content from a page to this window. This API uses a promise to return the result.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
@@ -1291,21 +1287,20 @@ Loads content to this window. This API uses a promise to return the result.
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.loadContent("pages/page2/page2");
- promise.then((data)=> {
- console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to load the content. Cause: ' + JSON.stringify(err));
- });
- ```
-
+```js
+let promise = windowClass.loadContent("pages/page2/page2");
+promise.then((data)=> {
+ console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to load the content. Cause: ' + JSON.stringify(err));
+});
+```
### isShowing7+
isShowing(callback: AsyncCallback<boolean>): void
@@ -1316,21 +1311,21 @@ Checks whether this window is displayed. This API uses an asynchronous callback
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ---------------------------- | ---- | -------------------------------- |
-| callback | AsyncCallback<boolean> | Yes | Callback used to return whether the window is displayed.|
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
+| callback | AsyncCallback<boolean> | Yes | Callback used to return the result. The value `true` means that this window is displayed, and `false` means the opposite.|
**Example**
- ```js
- windowClass.isShowing((err, data) => {
- if (err.code) {
- console.error('Failed to check whether the window is showing. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data))
- });
- ```
+```js
+windowClass.isShowing((err, data) => {
+ if (err.code) {
+ console.error('Failed to check whether the window is showing. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data));
+});
+```
### isShowing7+
@@ -1342,20 +1337,20 @@ Checks whether this window is displayed. This API uses a promise to return the r
**Return value**
-| Type | Description |
-| ---------------------- | ----------------------------------------------------- |
-| Promise<boolean> | Promise used to return whether the window is displayed.|
+| Type | Description |
+| ---------------------- | ------------------------------------------------------------ |
+| Promise<boolean> | Promise used to return the result. The value `true` means that this window is displayed, and `false` means the opposite.|
**Example**
- ```js
- let promise = windowClass.isShowing();
- promise.then((data)=> {
- console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to check whether the window is showing. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.isShowing();
+promise.then((data)=> {
+ console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to check whether the window is showing. Cause: ' + JSON.stringify(err));
+});
+```
### on('windowSizeChange')7+
@@ -1367,19 +1362,18 @@ Enables listening for window size changes.
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
-| type | string | Yes | Type of event to listen for. The value is fixed at **windowSizeChange**, indicating the window size change event.|
-| callback | Callback<[Size](#size)> | Yes | Callback used to return the information. |
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------------ | ---- | -------------------------------------------------------- |
+| type | string | Yes | Type of event to listen for. The value is fixed at `windowSizeChange`, indicating the window size change event.|
+| callback | Callback<[Size](#size7)> | Yes | Callback used to return the window size. |
**Example**
- ```js
- var type = 'windowSizeChange';
- windowClass.on(type, (data) => {
- console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+windowClass.on('windowSizeChange', (data) => {
+ console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data));
+});
+```
### off('windowSizeChange')7+
@@ -1393,15 +1387,14 @@ Disables listening for window size changes.
| Name | Type | Mandatory| Description |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
-| type | string | Yes | Type of event to listen for. The value is fixed at **windowSizeChange**, indicating the window size change event.|
-| callback | Callback<[Size](#size)> | No | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `windowSizeChange`, indicating the window size change event.|
+| callback | Callback<[Size](#size)> | No | Callback used to return the window size. |
**Example**
- ```js
- var type = 'windowSizeChange';
- windowClass.off(type);
- ```
+```js
+windowClass.off('windowSizeChange');
+```
### on('systemAvoidAreaChange')7+
@@ -1415,17 +1408,16 @@ Enables listening for changes to the area where the window cannot be displayed.
| Name | Type | Mandatory| Description |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **systemAvoidAreaChange**, indicating the event of changes to the area where the window cannot be displayed.|
-| callback | Callback<[AvoidArea](#avoidarea)> | Yes | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `systemAvoidAreaChange`, indicating the event of changes to the area where the window cannot be displayed.|
+| callback | Callback<[AvoidArea](#avoidarea)> | Yes | Callback used to return the area. |
**Example**
- ```js
- var type = 'systemAvoidAreaChange';
- windowClass.on(type, (data) => {
- console.info('Succeeded in enabling the listener for system avoid area changes. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+windowClass.on('systemAvoidAreaChange', (data) => {
+ console.info('Succeeded in enabling the listener for system avoid area changes. Data: ' + JSON.stringify(data));
+});
+```
### off('systemAvoidAreaChange')7+
@@ -1439,15 +1431,14 @@ Disables listening for changes to the area where the window cannot be displayed.
| Name | Type | Mandatory| Description |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **systemAvoidAreaChange**, indicating the event of changes to the area where the window cannot be displayed.|
-| callback | Callback<[AvoidArea](#avoidarea)> | No | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `systemAvoidAreaChange`, indicating the event of changes to the area where the window cannot be displayed.|
+| callback | Callback<[AvoidArea](#avoidarea)> | No | Callback used to return the area. |
**Example**
- ```js
- var type = 'systemAvoidAreaChange';
- windowClass.off(type);
- ```
+```js
+windowClass.off('systemAvoidAreaChange');
+```
### on('keyboardHeightChange')7+
@@ -1459,19 +1450,18 @@ Enables listening for keyboard height changes.
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ------------------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **keyboardHeightChange**, indicating the keyboard height change event.|
-| callback | Callbacknumber> | Yes | Callback used to return the information. |
+| Name | Type | Mandatory| Description |
+| -------- | ------------------- | ---- | ------------------------------------------------------------ |
+| type | string | Yes | Type of event to listen for. The value is fixed at `keyboardHeightChange`, indicating the keyboard height change event.|
+| callback | Callback {
- console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+windowClass.on('keyboardHeightChange', (data) => {
+ console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data));
+});
+```
### off('keyboardHeightChange')7+
@@ -1485,15 +1475,14 @@ Disables listening for keyboard height changes.
| Name | Type | Mandatory| Description |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **keyboardHeightChange**, indicating the keyboard height change event.|
-| callback | Callback<number> | No | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `keyboardHeightChange`, indicating the keyboard height change event.|
+| callback | Callback<number> | No | Callback used to return the current keyboard height. |
**Example**
- ```js
- var type = 'keyboardHeightChange';
- windowClass.off(type);
- ```
+```js
+windowClass.off('keyboardHeightChange');
+```
### isSupportWideGamut8+
@@ -1505,21 +1494,21 @@ Checks whether this window supports the wide color gamut mode. This API uses an
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ---------------------------- | ---- | -------------------------------- |
-| callback | AsyncCallback<boolean> | Yes | Callback used to return whether the wide color gamut mode is supported.|
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
+| callback | AsyncCallback<boolean> | Yes | Callback used to return the result. The value `true` means that the wide color gamut mode is supported, and `false` means the opposite.|
**Example**
- ```js
- windowClass.isSupportWideGamut((err, data) => {
- if (err.code) {
- console.error('Failed to check whether the window support WideGamut. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in checking whether the window support WideGamut Data: ' + JSON.stringify(data))
- })
- ```
+```js
+windowClass.isSupportWideGamut((err, data) => {
+ if (err.code) {
+ console.error('Failed to check whether the window support WideGamut. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in checking whether the window support WideGamut Data: ' + JSON.stringify(data));
+})
+```
### isSupportWideGamut8+
@@ -1533,18 +1522,18 @@ Checks whether this window supports the wide color gamut mode. This API uses a p
| Type | Description |
| ---------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Promise used to return whether the wide color gamut mode is supported.|
+| Promise<boolean> | Promise used to return the result. The value `true` means that the wide color gamut mode is supported, and `false` means the opposite.|
**Example**
- ```js
- let promise = windowClass.isSupportWideGamut();
- promise.then((data)=> {
- console.info('Succeeded in checking whether the window support WideGamut. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to check whether the window support WideGamut. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.isSupportWideGamut();
+promise.then((data)=> {
+ console.info('Succeeded in checking whether the window support WideGamut. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to check whether the window support WideGamut. Cause: ' + JSON.stringify(err));
+});
+```
### setColorSpace8+
@@ -1559,19 +1548,19 @@ Sets this window to the wide or default color gamut mode. This API uses an async
| Name | Type | Mandatory| Description |
| ---------- | ------------------------- | ---- | ------------ |
| colorSpace | [ColorSpace](#colorspace) | Yes | Color gamut mode.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err, data) => {
- if (err.code) {
- console.error('Failed to set window colorspace. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data))
- })
- ```
+```js
+windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set window colorspace. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data));
+})
+```
### setColorSpace8+
@@ -1583,26 +1572,26 @@ Sets this window to the wide or default color gamut mode. This API uses a promis
**Parameters**
-| Name | Type | Mandatory| Description |
-| ---------- | ------------------------- | ---- | ------------ |
+| Name | Type | Mandatory| Description |
+| ---------- | ------------------------- | ---- | -------------- |
| colorSpace | [ColorSpace](#colorspace) | Yes | Color gamut mode.|
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.isSupportWideGamut(window.ColorSpace.WIDE_GAMUT);
- promise.then((data)=> {
- console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set window colorspace. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.isSupportWideGamut(window.ColorSpace.WIDE_GAMUT);
+promise.then((data)=> {
+ console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set window colorspace. Cause: ' + JSON.stringify(err));
+});
+```
### getColorSpace8+
@@ -1614,21 +1603,21 @@ Obtains the color gamut mode of this window. This API uses an asynchronous callb
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ---------------------------------------------- | ---- | -------------------------- |
-| callback | AsyncCallback<[ColorSpace](#colorspace)> | Yes | Callback used to return the color gamut mode obtained.|
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------------------------- | ---- | ---------------------------------------------------------- |
+| callback | AsyncCallback<[ColorSpace](#colorspace)> | Yes | Callback used to return the result. When the color gamut mode is obtained successfully, `err` is `undefined`, and `data` is the current color gamut mode.|
**Example**
- ```js
- windowClass.getColorSpace((err, data) => {
- if (err.code) {
- console.error('Failed to get window colorspace. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in getting window colorspace. Cause:' + JSON.stringify(data))
- })
- ```
+```js
+windowClass.getColorSpace((err, data) => {
+ if (err.code) {
+ console.error('Failed to get window colorspace. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in getting window colorspace. Cause:' + JSON.stringify(data));
+})
+```
### getColorSpace8+
@@ -1640,20 +1629,20 @@ Obtains the color gamut mode of this window. This API uses a promise to return t
**Return value**
-| Type | Description |
-| ---------------------------------------- | ----------------------------------------- |
-| Promise<[ColorSpace](#colorspace)> | Promise used to return the color gamut mode obtained.|
+| Type | Description |
+| ---------------------------------------- | ------------------------------- |
+| Promise<[ColorSpace](#colorspace)> | Promise used to return the current color gamut mode.|
**Example**
- ```js
- let promise = windowClass.getColorSpace();
- promise.then((data)=> {
- console.info('Succeeded in getting window color space. Cause:' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to get window colorspace. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.getColorSpace();
+promise.then((data)=> {
+ console.info('Succeeded in getting window color space. Cause:' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to get window colorspace. Cause: ' + JSON.stringify(err));
+});
+```
### setBackgroundColor
@@ -1667,21 +1656,21 @@ Sets the background color for this window. This API uses an asynchronous callbac
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
-| color | string | Yes | Background color to set. The value is a hexadecimal color value and is case insensitive, for example, **#00FF00** or **#FF00FF00**.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| color | string | Yes | Background color to set. The value is a hexadecimal color value and is case insensitive, for example, `#00FF00` or `#FF00FF00`.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var color = '#00ff33';
- windowClass.setBackgroundColor(color, (err, data) => {
- if (err.code) {
- console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+var color = '#00ff33';
+windowClass.setBackgroundColor(color, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data));
+});
+```
### setBackgroundColor
@@ -1695,25 +1684,25 @@ Sets the background color for this window. This API uses a promise to return the
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------------------------------------------------------------ |
-| color | string | Yes | Background color to set. The value is a hexadecimal color value and is case insensitive, for example, **#00FF00** or **#FF00FF00**.|
+| color | string | Yes | Background color to set. The value is a hexadecimal color value and is case insensitive, for example, `#00FF00` or `#FF00FF00`.|
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var color = '#00ff33';
- let promise = windowClass.setBackgroundColor(color);
- promise.then((data)=> {
- console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var color = '#00ff33';
+let promise = windowClass.setBackgroundColor(color);
+promise.then((data)=> {
+ console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the background color. Cause: ' + JSON.stringify(err));
+});
+```
### setBrightness
@@ -1727,21 +1716,21 @@ Sets the screen brightness for this window. This API uses an asynchronous callba
| Name | Type | Mandatory| Description |
| ---------- | ------------------------- | ---- | ------------------------------------ |
-| brightness | number | Yes | Brightness to set, which ranges from 0 to 1. The value **1** indicates the brightest.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| brightness | number | Yes | Brightness to set, which ranges from 0 to 1. The value `1` indicates the brightest.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var brightness = 1;
- windowClass.setBrightness(brightness, (err, data) => {
- if (err.code) {
- console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+var brightness = 1;
+windowClass.setBrightness(brightness, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data));
+});
+```
### setBrightness
@@ -1755,25 +1744,25 @@ Sets the screen brightness for this window. This API uses a promise to return th
| Name | Type | Mandatory| Description |
| ---------- | ------ | ---- | ------------------------------------ |
-| brightness | number | Yes | Brightness to set, which ranges from 0 to 1. The value **1** indicates the brightest.|
+| brightness | number | Yes | Brightness to set, which ranges from 0 to 1. The value `1` indicates the brightest.|
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var brightness = 1;
- let promise = windowClass.setBrightness(brightness);
- promise.then((data)=> {
- console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var brightness = 1;
+let promise = windowClass.setBrightness(brightness);
+promise.then((data)=> {
+ console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
+});
+```
### setDimBehind(deprecated)
@@ -1783,7 +1772,7 @@ Sets the dimness of the window that is not on top. This API uses an asynchronous
> **NOTE**
>
-> This API is supported since API version 7 and deprecated since API version 9.
+> This API is supported since API version 7 and deprecated since API version 9.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
@@ -1791,20 +1780,20 @@ Sets the dimness of the window that is not on top. This API uses an asynchronous
| Name | Type | Mandatory| Description |
| -------------- | ------------------------- | ---- | -------------------------------------------------- |
-| dimBehindValue | number | Yes | Dimness of the window to set. The value ranges from 0 to 1. The value **1** indicates the dimmest.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| dimBehindValue | number | Yes | Dimness of the window to set. The value ranges from 0 to 1. The value `1` indicates the dimmest.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- windowClass.setDimBehind(0.5, (err, data) => {
- if (err.code) {
- console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the dimness. Data:' + JSON.stringify(data));
- });
- ```
+```js
+windowClass.setDimBehind(0.5, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the dimness. Data:' + JSON.stringify(data));
+});
+```
### setDimBehind(deprecated)
@@ -1814,7 +1803,7 @@ Sets the dimness of the window that is not on top. This API uses a promise to re
> **NOTE**
>
-> This API is supported since API version 7 and deprecated since API version 9.
+> This API is supported since API version 7 and deprecated since API version 9.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
@@ -1822,24 +1811,24 @@ Sets the dimness of the window that is not on top. This API uses a promise to re
| Name | Type | Mandatory| Description |
| -------------- | ------ | ---- | -------------------------------------------------- |
-| dimBehindValue | number | Yes | Dimness of the window to set. The value ranges from 0 to 1. The value **1** indicates the dimmest.|
+| dimBehindValue | number | Yes | Dimness of the window to set. The value ranges from 0 to 1. The value `1` indicates the dimmest.|
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.setDimBehind(0.5);
- promise.then((data)=> {
- console.info('Succeeded in setting the dimness. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.setDimBehind(0.5);
+promise.then((data)=> {
+ console.info('Succeeded in setting the dimness. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err));
+});
+```
### setFocusable7+
@@ -1854,20 +1843,20 @@ Sets whether this window can gain focus. This API uses an asynchronous callback
| Name | Type | Mandatory| Description |
| ----------- | ------------------------- | ---- | ---------------------------- |
| isFocusable | boolean | Yes | Whether the window can gain focus.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var isFocusable= true;
- windowClass.setFocusable(isFocusable, (err, data) => {
- if (err.code) {
- console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+var isFocusable= true;
+windowClass.setFocusable(isFocusable, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data));
+});
+```
### setFocusable7+
@@ -1885,21 +1874,21 @@ Sets whether this window can gain focus. This API uses a promise to return the r
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var isFocusable= true;
- let promise = windowClass.setFocusable(isFocusable);
- promise.then((data)=> {
- console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the window to be focusable. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var isFocusable= true;
+let promise = windowClass.setFocusable(isFocusable);
+promise.then((data)=> {
+ console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the window to be focusable. Cause: ' + JSON.stringify(err));
+});
+```
### setKeepScreenOn
@@ -1914,20 +1903,52 @@ Sets whether to keep the screen always on. This API uses an asynchronous callbac
| Name | Type | Mandatory| Description |
| -------------- | ------------------------- | ---- | ------------------------ |
| isKeepScreenOn | boolean | Yes | Whether to keep the screen always on.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
+
+**Example**
+
+```js
+var isKeepScreenOn = true;
+windowClass.setKeepScreenOn(isKeepScreenOn, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data));
+});
+```
+
+### setKeepScreenOn
+
+setKeepScreenOn(isKeepScreenOn: boolean): Promise<void>
+
+Sets whether to keep the screen always on. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.WindowManager.WindowManager.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------------- | ------- | ---- | ------------------------ |
+| isKeepScreenOn | boolean | Yes | Whether to keep the screen always on.|
+
+**Return value**
+
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var isKeepScreenOn = true;
- windowClass.setKeepScreenOn(isKeepScreenOn, (err, data) => {
- if (err.code) {
- console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data));
- });
- ```
+```js
+var isKeepScreenOn = true;
+let promise = windowClass.setKeepScreenOn(isKeepScreenOn);
+promise.then((data) => {
+ console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.info('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
+});
+```
### setOutsideTouchable(deprecated)
@@ -1937,7 +1958,7 @@ Sets whether the area outside the subwindow is touchable. This API uses an async
> **NOTE**
>
-> This API is supported since API version 7 and deprecated since API version 9.
+> This API is supported since API version 7 and deprecated since API version 9.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
@@ -1945,20 +1966,20 @@ Sets whether the area outside the subwindow is touchable. This API uses an async
| Name | Type | Mandatory| Description |
| --------- | ------------------------- | ---- | ---------------- |
-| touchable | boolean | Yes | Whether the area outside the subwindow is touchable. The value **true** means that such an area is touchable, and **false** means the opposite.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| touchable | boolean | Yes | Whether the area outside the subwindow is touchable. The value `true` means that such an area is touchable, and `false` means the opposite.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- windowClass.setOutsideTouchable(true, (err, data) => {
- if (err.code) {
- console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data))
- })
- ```
+```js
+windowClass.setOutsideTouchable(true, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data));
+})
+```
### setOutsideTouchable(deprecated)
@@ -1967,8 +1988,10 @@ setOutsideTouchable(touchable: boolean): Promise<void>
Sets whether the area outside the subwindow is touchable. This API uses a promise to return the result.
> **NOTE**
->
+>
> This API is supported since API version 7 and deprecated since API version 9.
+>
+>
**System capability**: SystemCapability.WindowManager.WindowManager.Core
@@ -1976,56 +1999,24 @@ Sets whether the area outside the subwindow is touchable. This API uses a promis
| Name | Type | Mandatory| Description |
| --------- | ------- | ---- | ---------------- |
-| touchable | boolean | Yes | Whether the area outside the subwindow is touchable. The value **true** means that such an area is touchable, and **false** means the opposite.|
+| touchable | boolean | Yes | Whether the area outside the subwindow is touchable. The value `true` means that such an area is touchable, and `false` means the opposite.|
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- let promise = windowClass.setOutsideTouchable(true);
- promise.then((data)=> {
- console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
- });
- ```
-
-### setKeepScreenOn
-
-setKeepScreenOn(isKeepScreenOn: boolean): Promise<void>
-
-Sets whether to keep the screen always on. This API uses a promise to return the result.
-
-**System capability**: SystemCapability.WindowManager.WindowManager.Core
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| -------------- | ------- | ---- | ------------------------ |
-| isKeepScreenOn | boolean | Yes | Whether to keep the screen always on.|
-
-**Return value**
-
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
-
-**Example**
-
- ```js
- var isKeepScreenOn= true;
- let promise = windowClass.setKeepScreenOn(isKeepScreenOn);
- promise.then((data)=> {
- console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+let promise = windowClass.setOutsideTouchable(true);
+promise.then((data)=> {
+ console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err));
+});
+```
### setPrivacyMode7+
@@ -2040,21 +2031,21 @@ Sets whether this window is in privacy mode. This API uses an asynchronous callb
| Name | Type | Mandatory| Description |
| ------------- | ------------------------- | ---- | -------------------- |
| isPrivacyMode | boolean | Yes | Whether the window is in privacy mode.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var isPrivacyMode = true;
- windowClass.setPrivacyMode(isPrivacyMode, (err, data) => {
- if (err.code) {
- console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the window to privacy mode. Data:' + JSON.stringify(data));
-
- });
- ```
+```js
+var isPrivacyMode = true;
+windowClass.setPrivacyMode(isPrivacyMode, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window to privacy mode. Data:' + JSON.stringify(data));
+
+});
+```
### setPrivacyMode7+
@@ -2072,21 +2063,21 @@ Sets whether this window is in privacy mode. This API uses a promise to return t
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var isPrivacyMode = true;
- let promise = windowClass.setPrivacyMode(isPrivacyMode);
- promise.then((data)=> {
- console.info('Succeeded in setting the window to privacy mode. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the window to privacy mode. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var isPrivacyMode = true;
+let promise = windowClass.setPrivacyMode(isPrivacyMode);
+promise.then((data)=> {
+ console.info('Succeeded in setting the window to privacy mode. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the window to privacy mode. Cause: ' + JSON.stringify(err));
+});
+```
### setTouchable7+
@@ -2101,21 +2092,21 @@ Sets whether this window is touchable. This API uses an asynchronous callback to
| Name | Type | Mandatory| Description |
| ----------- | ------------------------- | ---- | -------------------- |
| isTouchable | boolean | Yes | Whether the window is touchable.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
**Example**
- ```js
- var isTouchable = true;
- windowClass.setTouchable(isTouchable, (err, data) => {
- if (err.code) {
- console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in setting the window to be touchable. Data:' + JSON.stringify(data));
-
- });
- ```
+```js
+var isTouchable = true;
+windowClass.setTouchable(isTouchable, (err, data) => {
+ if (err.code) {
+ console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in setting the window to be touchable. Data:' + JSON.stringify(data));
+
+});
+```
### setTouchable7+
@@ -2133,21 +2124,21 @@ Sets whether this window is touchable. This API uses a promise to return the res
**Return value**
-| Type | Description |
-| ------------------- | ----------------------------------------------- |
-| Promise<void> | Promise used to return the execution result.|
+| Type | Description |
+| ------------------- | ------------------------- |
+| Promise<void> | Promise that returns no value.|
**Example**
- ```js
- var isTouchable = true;
- let promise = windowClass.setTouchable(isTouchable);
- promise.then((data)=> {
- console.info('Succeeded in setting the window to be touchable. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to set the window to be touchable. Cause: ' + JSON.stringify(err));
- });
- ```
+```js
+var isTouchable = true;
+let promise = windowClass.setTouchable(isTouchable);
+promise.then((data)=> {
+ console.info('Succeeded in setting the window to be touchable. Data: ' + JSON.stringify(data));
+}).catch((err)=>{
+ console.error('Failed to set the window to be touchable. Cause: ' + JSON.stringify(err));
+});
+```
## WindowStageEventType9+
@@ -2155,8 +2146,8 @@ Describes the lifecycle of a window stage.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
-| Name | Default Value | Description |
-| ---------- | ------ | -------- |
+| Name | Default Value | Description |
+| ---------- | ------ | ---------- |
| FOREGROUND | 1 | The window stage is running in the foreground.|
| ACTIVE | 2 | The window stage gains focus.|
| INACTIVE | 3 | The window stage loses focus.|
@@ -2164,8 +2155,43 @@ Describes the lifecycle of a window stage.
## WindowStage9+
-Before calling any of the following APIs, you must use `[onWindowStageCreate()](js-apis-application-ability.md#abilityonwindowstagecreate)` to create a **WindowStage** instance.
+Implements a window manager, which manages each basic window unit, that is, [Window](#window) instance.
+
+Before calling any of the following APIs, you must use `[onWindowStageCreate()](js-apis-application-ability.md#abilityonwindowstagecreate)` to create a `WindowStage` instance.
+
+### getMainWindow9+
+
+getMainWindow(callback: AsyncCallback<Window>): void
+
+Obtains the main window of this window stage. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.WindowManager.WindowManager.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | -------------------------------------- | ---- | --------------------------------------------- |
+| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the main window.|
+**Example**
+
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ var windowClass = null;
+ windowStage.getMainWindow((err, data) => {
+ if (err.code) {
+ console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ windowClass = data;
+ console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
+ });
+ }
+}
+```
### getMainWindow9+
getMainWindow(): Promise<Window>
@@ -2176,61 +2202,63 @@ Obtains the main window of this window stage. This API uses a promise to return
**Return value**
-| Type | Description |
-| -------------------------------- | ---------------------------------------------------------- |
+| Type | Description |
+| -------------------------------- | ------------------------------------------------ |
| Promise<[Window](#window)> | Promise used to return the main window.|
**Example**
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var windowClass = null;
- let promise = windowStage.getMainWindow();
- promise.then((data)=> {
- windowClass = data;
- console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
- });
- }
- }
- ```
-
-### getMainWindow9+
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ var windowClass = null;
+ let promise = windowStage.getMainWindow();
+ promise.then((data)=> {
+ windowClass = data;
+ console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
+ }).catch((err)=>{
+ console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
+ });
+ }
+}
+```
+### createSubWindow9+
-getMainWindow(callback: AsyncCallback<Window>): void
+createSubWindow(name: string, callback: AsyncCallback<Window>): void
-Obtains the main window of this window stage. This API uses an asynchronous callback to return the result.
+Creates a subwindow for this window stage. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------------------------- | ---- | --------------------------------------- |
-| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the main window.|
+| Name | Type | Mandatory| Description |
+| -------- | -------------------------------------- | ---- | --------------------------------------------- |
+| name | String | Yes | Name of the subwindow. |
+| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the subwindow.|
**Example**
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var windowClass = null;
- windowStage.getMainWindow((err, data) => {
- if (err.code) {
- console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
- });
- }
- }
- ```
-
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ var windowClass = null;
+ windowStage.createSubWindow("mySubWindow", (err, data) => {
+ if (err.code) {
+ console.error('Failed to create the subwindow. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ windowClass = data;
+ console.info('Succeeded in creating the subwindow. Data: ' + JSON.stringify(data));
+ windowClass.resetSize(500, 1000);
+ });
+ }
+}
+```
### createSubWindow9+
createSubWindow(name: string): Promise<Window>
@@ -2247,63 +2275,61 @@ Creates a subwindow for this window stage. This API uses a promise to return the
**Return value**
-| Type | Description |
-| -------------------------------- | ------------------------------------------------- |
-| Promise<[Window](#window)> | Promise used to return the subwindow created.|
-
-**Example**
-
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var windowClass = null;
- let promise = windowStage.createSubWindow("mySubWindow");
- promise.then((data)=> {
- windowClass = data;
- console.info('Succeeded in create sub window. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to create sub window. Cause: ' + JSON.stringify(err));
- })
- }
- }
- ```
-
-### createSubWindow9+
+| Type | Description |
+| -------------------------------- | ------------------------------------------------ |
+| Promise<[Window](#window)> | Promise used to return the subwindow.|
+
+**Example**
+
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ var windowClass = null;
+ let promise = windowStage.createSubWindow("mySubWindow");
+ promise.then((data)=> {
+ windowClass = data;
+ console.info('Succeeded in creating the subwindow. Data: ' + JSON.stringify(data));
+ }).catch((err)=>{
+ console.error('Failed to create the subwindow. Cause: ' + JSON.stringify(err));
+ })
+ }
+}
+```
+### getSubWindow9+
-createSubWindow(name: string, callback: AsyncCallback<Window>): void
+getSubWindow(callback: AsyncCallback<Array<Window>>): void
-Creates a subwindow for this window stage. This API uses an asynchronous callback to return the result.
+Obtains all the subwindows of this window stage. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------------------------- | ---- | ------------------------------ |
-| name | String | Yes | Name of the subwindow. |
-| callback | AsyncCallback<[Window](#window)> | Yes | Callback used to return the subwindow created.|
+| Name | Type | Mandatory| Description |
+| -------- | --------------------------------------------------- | ---- | ------------------------------------------------- |
+| callback | AsyncCallback<Array<[Window](#window)>> | Yes | Callback used to return all the subwindows.|
**Example**
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var windowClass = null;
- windowStage.createSubWindow("mySubWindow", (err, data) => {
- if (err.code) {
- console.error('Failed to create sub window. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('Succeeded in create sub window. Data: ' + JSON.stringify(data));
- windowClass.resetSize(500, 1000);
- });
- }
- }
- ```
-
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ var windowClass = null;
+ windowStage.getSubWindow((err, data) => {
+ if (err.code) {
+ console.error('Failed to obtain the subwindow. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ windowClass = data;
+ console.info('Succeeded in obtaining the subwindow. Data: ' + JSON.stringify(data));
+ });
+ }
+}
+```
### getSubWindow9+
getSubWindow(): Promise<Array<Window>>
@@ -2314,92 +2340,60 @@ Obtains all the subwindows of this window stage. This API uses a promise to retu
**Return value**
-| Type | Description |
-| --------------------------------------------- | ------------------------------------------------------------ |
+| Type | Description |
+| --------------------------------------------- | ---------------------------------------------------- |
| Promise<Array<[Window](#window)>> | Promise used to return all the subwindows.|
**Example**
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var windowClass = null;
- let promise = windowStage.getSubWindow();
- promise.then((data)=> {
- windowClass = data;
- console.info('Succeeded in obtaining the sub window. Data: ' + JSON.stringify(data))
- }).catch((err)=>{
- console.error('Failed to obtain the sub window. Cause: ' + JSON.stringify(err));
- })
- }
- }
- ```
-
-### getSubWindow9+
-
-getSubWindow(callback: AsyncCallback<Array<Window>>): void
-
-Obtains all the subwindows of this window stage. This API uses an asynchronous callback to return the result.
-
-**System capability**: SystemCapability.WindowManager.WindowManager.Core
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| -------- | --------------------------------------------------- | ---- | ------------------------------------------- |
-| callback | AsyncCallback<Array<[Window](#window)>> | Yes | Callback used to return all the subwindows.|
-
-**Example**
-
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var windowClass = null;
- windowStage.getSubWindow((err, data) => {
- if (err.code) {
- console.error('Failed to obtain the sub window. Cause: ' + JSON.stringify(err));
- return;
- }
- windowClass = data;
- console.info('Succeeded in obtaining the sub window. Data: ' + JSON.stringify(data));
- });
- }
- }
- ```
-
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ var windowClass = null;
+ let promise = windowStage.getSubWindow();
+ promise.then((data)=> {
+ windowClass = data;
+ console.info('Succeeded in obtaining the subwindow. Data: ' + JSON.stringify(data));
+ }).catch((err)=>{
+ console.error('Failed to obtain the subwindow. Cause: ' + JSON.stringify(err));
+ })
+ }
+}
+```
### loadContent9+
loadContent(path: string, callback: AsyncCallback<void>): void
-Loads content to this window stage. This API uses an asynchronous callback to return the result.
+Loads content from a page to this window stage. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.WindowManager.WindowManager.Coretype with the value **windowSizeChange**
+**System capability**: SystemCapability.WindowManager.WindowManager.Core
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | -------------------- |
| path | string | Yes | Path of the page from which the content will be loaded.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the execution result. |
-
-**Example**
-
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- windowStage.loadContent("pages/page2", (err, data) => {
- if (err.code) {
- console.error('Failed to load the content. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
- });
- }
- }
- ```
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
+
+**Example**
+
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ windowStage.loadContent("pages/page2", (err, data) => {
+ if (err.code) {
+ console.error('Failed to load the content. Cause:' + JSON.stringify(err));
+ return;
+ }
+ console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data));
+ });
+ }
+}
+```
### on('windowStageEvent')9+
@@ -2413,22 +2407,22 @@ Enables listening for window stage lifecycle changes.
| Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **windowStageEvent**, indicating the window stage lifecycle change event.|
-| callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | Yes | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `windowStageEvent`, indicating the window stage lifecycle change event.|
+| callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | Yes | Callback used to return the window stage lifecycle state. |
**Example**
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var type = 'windowStageEvent';
- windowStage.on(type, (data) => {
- console.info('Succeeded in enabling the listener for window stage event changes. Data: ' + JSON.stringify(data));
- });
- }
- }
- ```
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ windowStage.on('windowStageEvent', (data) => {
+ console.info('Succeeded in enabling the listener for window stage event changes. Data: ' + JSON.stringify(data));
+ });
+ }
+}
+```
### off('windowStageEvent')9+
@@ -2442,17 +2436,17 @@ Disables listening for window stage lifecycle changes.
| Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Type of event to listen for. The value is fixed at **windowStageEvent**, indicating the window stage lifecycle change event.|
-| callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | No | Callback used to return the information. |
+| type | string | Yes | Type of event to listen for. The value is fixed at `windowStageEvent`, indicating the window stage lifecycle change event.|
+| callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | No | Callback used to return the window stage lifecycle state. |
**Example**
- ```ts
- class myAbility extends Ability {
- onWindowStageCreate(windowStage) {
- console.log('onWindowStageCreate');
- var type = 'windowStageEvent';
- windowStage.off(type);
- }
- }
- ```
+```ts
+import Ability from '@ohos.application.Ability';
+class myAbility extends Ability {
+ onWindowStageCreate(windowStage) {
+ console.log('onWindowStageCreate');
+ windowStage.off('windowStageEvent');
+ }
+}
+```