diff --git a/zh-cn/application-dev/reference/apis/js-apis-window.md b/zh-cn/application-dev/reference/apis/js-apis-window.md index 4656798f1fc15fba1321337b2772d0a127f41012..975ce49cb9e17efb19f024ea0afaeed95936ce51 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -13,118 +13,152 @@ import window from '@ohos.window'; 窗å£ç±»åž‹ã€‚ -| å称 | 默认值 | 说明 | -| ----------------- | ------ | ------------------------------------------------------------ | -| TYPE_APP | 0 | 表示应用å窗å£ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| TYPE_SYSTEM_ALERT | 1 | 表示系统告è¦çª—å£ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | 默认值 | 说明 | +| ----------------- | ------ | ------------------ | +| TYPE_APP | 0 | 表示应用å窗å£ã€‚ | +| TYPE_SYSTEM_ALERT | 1 | 表示系统告è¦çª—å£ã€‚ | ## AvoidAreaType<sup>7+</sup><a name="avoidareatype"></a> 窗å£å†…容需è¦è§„é¿åŒºåŸŸçš„类型。 -| å称 | 默认值 | 说明 | -| ----------- | ------ | ------------------------------------------------------------ | -| TYPE_SYSTEM | 0 | 表示系统默认区域。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| TYPE_CUTOUT | 1 | 表示刘海å±åŒºåŸŸã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | 默认值 | 说明 | +| ----------- | ------ | ------------------ | +| TYPE_SYSTEM | 0 | 表示系统默认区域。 | +| TYPE_CUTOUT | 1 | 表示刘海å±åŒºåŸŸã€‚ | ## WindowMode<sup>7+</sup><a name="windowmode"></a> 窗å£æ¨¡å¼ã€‚ -| å称 | 默认值 | 说明 | -| ---------- | ------ | ------------------------------------------------------------ | -| UNDEFINED | 1 | 表示APP未定义窗å£æ¨¡å¼ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| FULLSCREEN | 2 | 表示APPå…¨å±æ¨¡å¼ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| PRIMARY | 3 | 表示APP分å±å¤šçª—å£ä¸»è¦æ¨¡å¼ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| SECONDARY | 4 | 表示APP分å±å¤šçª—å£æ¬¡è¦æ¨¡å¼ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| FLOATING | 5 | 表示APP自由悬浮形å¼çª—å£æ¨¡å¼ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | 默认值 | 说明 | +| ---------- | ------ | ----------------------------- | +| UNDEFINED | 1 | 表示APP未定义窗å£æ¨¡å¼ã€‚ | +| FULLSCREEN | 2 | 表示APPå…¨å±æ¨¡å¼ã€‚ | +| PRIMARY | 3 | 表示APP分å±å¤šçª—å£ä¸»è¦æ¨¡å¼ã€‚ | +| SECONDARY | 4 | 表示APP分å±å¤šçª—å£æ¬¡è¦æ¨¡å¼ã€‚ | +| FLOATING | 5 | 表示APP自由悬浮形å¼çª—å£æ¨¡å¼ã€‚ | ## SystemBarProperties<a name="systembarproperties"></a> 状æ€æ 导航æ 的属性。 +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + | å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | | -------------------------------------- | -------- | ---- | ---- | ------------------------------------------------------------ | -| statusBarColor | string | 是 | 是 | 状æ€æ 背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| isStatusBarLightIcon<sup>7+</sup> | boolean | å¦ | 是 | 状æ€æ å›¾æ ‡æ˜¯å¦ä¸ºé«˜äº®çŠ¶æ€ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| statusBarContentColor<sup>8+</sup> | string | å¦ | 是 | 状æ€æ æ–‡å—颜色。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| navigationBarColor | string | 是 | 是 | 导航æ 背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| isNavigationBarLightIcon<sup>7+</sup> | boolean | å¦ | å¦ | 导航æ å›¾æ ‡æ˜¯å¦ä¸ºé«˜äº®çŠ¶æ€ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| navigationBarContentColor<sup>8+</sup> | string | å¦ | 是 | 导航æ æ–‡å—颜色。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| statusBarColor | string | 是 | 是 | 状æ€æ 背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。 | +| isStatusBarLightIcon<sup>7+</sup> | boolean | å¦ | 是 | 状æ€æ å›¾æ ‡æ˜¯å¦ä¸ºé«˜äº®çŠ¶æ€ã€‚ | +| statusBarContentColor<sup>8+</sup> | string | å¦ | 是 | 状æ€æ æ–‡å—颜色。 | +| navigationBarColor | string | 是 | 是 | 导航æ 背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。 | +| isNavigationBarLightIcon<sup>7+</sup> | boolean | å¦ | å¦ | 导航æ å›¾æ ‡æ˜¯å¦ä¸ºé«˜äº®çŠ¶æ€ã€‚ | +| navigationBarContentColor<sup>8+</sup> | string | å¦ | 是 | 导航æ æ–‡å—颜色。 | ## SystemBarRegionTint <sup>8+</sup><a name="systembartegiontint"></a> å•ä¸ªå¯¼èˆªæ 或状æ€æ 回调信æ¯ã€‚ +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + | å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | | --------------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ | -| type | [WindowType](#windowtype) | 是 | 是 | 当å‰å±žæ€§æ”¹å˜çš„系统æ 类型,仅支æŒç±»åž‹ä¸ºå¯¼èˆªæ ã€çŠ¶æ€æ 的系统æ 。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| isEnable | boolean | 是 | 是 | 当å‰ç³»ç»Ÿæ 是å¦æ˜¾ç¤ºã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| region | [Rect](#rect) | 是 | 是 | 当å‰ç³»ç»Ÿæ çš„ä½ç½®åŠå¤§å°ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| backgroundColor | string | 是 | 是 | 系统æ 背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| contentColor | string | 是 | 是 | 系统æ æ–‡å—颜色。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| type | [WindowType](#windowtype) | 是 | 是 | 当å‰å±žæ€§æ”¹å˜çš„系统æ 类型,仅支æŒç±»åž‹ä¸ºå¯¼èˆªæ ã€çŠ¶æ€æ 的系统æ 。 | +| isEnable | boolean | 是 | 是 | 当å‰ç³»ç»Ÿæ 是å¦æ˜¾ç¤ºã€‚ | +| region | [Rect](#rect) | 是 | 是 | 当å‰ç³»ç»Ÿæ çš„ä½ç½®åŠå¤§å°ã€‚ | +| backgroundColor | string | 是 | 是 | 系统æ 背景颜色,为16进制RGB或ARGB颜色,例如"\#00FF00"或"\#FF00FF00"。 | +| contentColor | string | 是 | 是 | 系统æ æ–‡å—颜色。 | ## SystemBarTintState <sup>8+</sup><a name="systembartintstate"></a> 当å‰ç³»ç»Ÿæ 回调信æ¯é›†åˆã€‚ -| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | -| ---------- | -------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | -| displayId | number | 是 | å¦ | 当å‰ç‰©ç†å±å¹•id。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| regionTint | Array<[SystemBarRegionTint](#systembartegiontint)> | 是 | 是 | 当å‰æ”¹å˜æ‰€æœ‰çš„系统æ ä¿¡æ¯ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | +| ---------- | -------------------------------------------------- | ---- | ---- | -------------------------- | +| displayId | number | 是 | å¦ | 当å‰ç‰©ç†å±å¹•id。 | +| regionTint | Array<[SystemBarRegionTint](#systembartegiontint)> | 是 | 是 | 当å‰æ”¹å˜æ‰€æœ‰çš„系统æ ä¿¡æ¯ã€‚ | ## Rect<sup>7+</sup><a name="rect"></a> 矩形。 -| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | -| ------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| left | number | 是 | 是 | 矩形区域的左边界。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| top | number | 是 | 是 | 矩形区域的上边界。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| width | number | 是 | 是 | 矩形区域的宽度。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| height | number | 是 | 是 | 矩形区域的高度。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | +| ------ | -------- | ---- | ---- | ------------------ | +| left | number | 是 | 是 | 矩形区域的左边界。 | +| top | number | 是 | 是 | 矩形区域的上边界。 | +| width | number | 是 | 是 | 矩形区域的宽度。 | +| height | number | 是 | 是 | 矩形区域的高度。 | ## AvoidArea<sup>7+</sup><a name="avoidarea"></a> 表示窗å£å†…容规é¿åŒºåŸŸã€‚ -| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | -| ---------- | ------------- | ---- | ---- | ------------------------------------------------------------ | -| leftRect | [Rect](#rect) | 是 | 是 | å±å¹•å·¦ä¾§çš„矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| topRect | [Rect](#rect) | 是 | 是 | å±å¹•é¡¶éƒ¨çš„矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| rightRect | [Rect](#rect) | 是 | 是 | å±å¹•å³ä¾§çš„矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| bottomRect | [Rect](#rect) | 是 | 是 | å±å¹•åº•éƒ¨çš„矩形区。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | +| ---------- | ------------- | ---- | ---- | ------------------ | +| leftRect | [Rect](#rect) | 是 | 是 | å±å¹•å·¦ä¾§çš„矩形区。 | +| topRect | [Rect](#rect) | 是 | 是 | å±å¹•é¡¶éƒ¨çš„矩形区。 | +| rightRect | [Rect](#rect) | 是 | 是 | å±å¹•å³ä¾§çš„矩形区。 | +| bottomRect | [Rect](#rect) | 是 | 是 | å±å¹•åº•éƒ¨çš„矩形区。 | ## Size<sup>7+</sup><a name="size"></a> 窗å£å¤§å°ã€‚ -| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | -| ------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| width | number | 是 | 是 | 窗å£å®½åº¦ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| height | number | 是 | 是 | 窗å£é«˜åº¦ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | +| ------ | -------- | ---- | ---- | ---------- | +| width | number | 是 | 是 | 窗å£å®½åº¦ã€‚ | +| height | number | 是 | 是 | 窗å£é«˜åº¦ã€‚ | ## WindowProperties<a name="windowproperties"></a> 窗å£å±žæ€§ã€‚ +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + | å称 | å‚数类型 | å¯è¯» | å¯å†™ | 说明 | | ------------------------------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ | -| windowRect<sup>7+</sup> | [Rect](#rect) | 是 | 是 | 窗å£å°ºå¯¸ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| type<sup>7+</sup> | [WindowType](#windowtype) | 是 | 是 | 窗å£ç±»åž‹ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| isFullScreen | boolean | 是 | 是 | 是å¦å…¨å±ï¼Œé»˜è®¤ä¸ºfalse。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| isLayoutFullScreen<sup>7+</sup> | boolean | 是 | 是 | 窗å£æ˜¯å¦ä¸ºæ²‰æµ¸å¼ï¼Œé»˜è®¤ä¸ºfalse。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| focusable<sup>7+</sup> | boolean | 是 | å¦ | 窗å£æ˜¯å¦å¯èšç„¦ï¼Œé»˜è®¤ä¸ºtrue。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| touchable<sup>7+</sup> | boolean | 是 | å¦ | 窗å£æ˜¯å¦å¯è§¦æ‘¸ï¼Œé»˜è®¤ä¸ºtrue。<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| windowRect<sup>7+</sup> | [Rect](#rect) | 是 | 是 | 窗å£å°ºå¯¸ã€‚ | +| type<sup>7+</sup> | [WindowType](#windowtype) | 是 | 是 | 窗å£ç±»åž‹ã€‚ | +| isFullScreen | boolean | 是 | 是 | 是å¦å…¨å±ï¼Œé»˜è®¤ä¸ºfalse。 | +| isLayoutFullScreen<sup>7+</sup> | boolean | 是 | 是 | 窗å£æ˜¯å¦ä¸ºæ²‰æµ¸å¼ï¼Œé»˜è®¤ä¸ºfalse。 | +| focusable<sup>7+</sup> | boolean | 是 | å¦ | 窗å£æ˜¯å¦å¯èšç„¦ï¼Œé»˜è®¤ä¸ºtrue。 | +| touchable<sup>7+</sup> | boolean | 是 | å¦ | 窗å£æ˜¯å¦å¯è§¦æ‘¸ï¼Œé»˜è®¤ä¸ºtrue。 | +| brightness | number | 是 | 是 | å±å¹•äº®åº¦ï¼Œ å–值范围为0~1,1表示最大亮度值。<br/>本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ | +| dimBehindValue<sup>7+</sup> | number | 是 | 是 | é åŽçª—å£çš„暗度值,å–值范围为0~1,1表示最暗。<br/>本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ | +| isKeepScreenOn | boolean | 是 | 是 | å±å¹•æ˜¯å¦å¸¸äº®ï¼Œé»˜è®¤ä¸ºfalse。<br/>本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ | +| isPrivacyMode<sup>7+</sup> | boolean | 是 | 是 | éšç§æ¨¡å¼ï¼Œé»˜è®¤ä¸ºfalse。<br/>本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ | +| isRoundCorner<sup>7+</sup> | boolean | 是 | 是 | 窗å£æ˜¯å¦ä¸ºåœ†è§’。<br/>本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ | +| isTransparent<sup>7+</sup> | boolean | 是 | 是 | 窗å£æ˜¯å¦é€æ˜Žã€‚默认为false。<br/>本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ | ## ColorSpace<sup>8+</sup><a name="colorspace"></a> 色域模å¼ã€‚ -| å称 | 默认值 | 说明 | -| ---------- | ------ | ------------------------------------------------------------ | -| DEFAULT | 0 | 默认色域模å¼ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| WIDE_GAMUT | 1 | 广色域模å¼ã€‚<br/>**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +**系统能力**:以下å„项对应的系统能力å‡ä¸ºSystemCapability.WindowManager.WindowManager.Core。 + +| å称 | 默认值 | 说明 | +| ---------- | ------ | -------------- | +| DEFAULT | 0 | 默认色域模å¼ã€‚ | +| WIDE_GAMUT | 1 | 广色域模å¼ã€‚ | ## window.create<sup>7</sup><a name="window-create"></a> @@ -145,12 +179,13 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi - 示例 ``` + var windowClass = null; window.create("first", window.WindowType.TYPE_APP, (err, data) => { - windowClass = data; - if (err) { + 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); }); @@ -180,8 +215,10 @@ create(id: string, type: WindowType): Promise<Window> - 示例 ``` + 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)); @@ -208,12 +245,13 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback<Wi - 示例 ``` + var windowClass = null; window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT, (err, data) => { - windowClass = data; - if (err) { + 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); }); @@ -244,8 +282,10 @@ create(ctx: Context, id: string, type: WindowType): Promise<Window> - 示例 ``` + 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)); @@ -270,13 +310,14 @@ find(id: string, callback: AsyncCallback<Window>): void - 示例 ``` - window.find("first", (err, data) => { - if (err) { + var windowClass = null; + window.find("alertWindow", (err, data) => { + if (err.code) { console.error('Failed to find the Window. Cause: ' + JSON.stringify(err)); return; } - console.info('window found. Data: ' + JSON.stringify(data)) - windowClass = data; + windowClass = data; + console.info('window found. Data: ' + JSON.stringify(data)) }); ``` @@ -303,8 +344,10 @@ find(id: string): Promise<Window> - 示例 ``` - let promise = window.find("first"); + 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)); @@ -328,13 +371,14 @@ getTopWindow(callback: AsyncCallback<Window>): void - 示例 ``` + var windowClass = null; window.getTopWindow((err, data) => { - if (err) { + if (err.code) { console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err)); return; } - console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data)); windowClass = data; + console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data)); }); ``` @@ -355,8 +399,10 @@ getTopWindow(): Promise<Window> - 示例 ``` + 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)); @@ -381,13 +427,14 @@ getTopWindow(ctx: Context, callback: AsyncCallback<Window>): void - 示例 ``` + var windowClass = null; window.getTopWindow(this.context, (err, data) => { - if (err) { + if (err.code) { console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err)); return; } - console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data)); windowClass = data; + console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data)); }); ``` @@ -414,8 +461,10 @@ getTopWindow(ctx: Context): Promise<Window> - 示例 ``` + 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)); @@ -428,6 +477,8 @@ on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): v 注册状æ€æ ã€å¯¼èˆªæ 的监å¬å‡½æ•°ã€‚ +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + **系统能力**:SystemCapability.WindowManager.WindowManager.Core - å‚æ•° @@ -452,6 +503,8 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >) å…³é—监å¬ã€‚ +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + **系统能力**:SystemCapability.WindowManager.WindowManager.Core - å‚æ•° @@ -478,6 +531,8 @@ hide (callback: AsyncCallback<void>): void éšè—当å‰çª—å£ï¼Œä½¿ç”¨callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + **系统能力**:SystemCapability.WindowManager.WindowManager.Core - å‚æ•° @@ -489,12 +544,12 @@ hide (callback: AsyncCallback<void>): void - 示例 ``` - windowClass.hide((err) => { - if (err) { + windowClass.hide((err, data) => { + if (err.code) { console.error('Failed to hide the window. Cause: ' + JSON.stringify(err)); return; } - console.info('window hidden.') + console.info('window hidden. data: ' + JSON.stringify(data)) }) ``` @@ -504,6 +559,8 @@ hide(): Promise<void> éšè—当å‰çª—å£ï¼Œä½¿ç”¨Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + **系统能力**:SystemCapability.WindowManager.WindowManager.Core - 返回值 @@ -516,8 +573,8 @@ hide(): Promise<void> ``` let promise = windowClass.hide(); - promise.then(()=> { - console.info('window hidden.') + promise.then((data)=> { + console.info('window hidden. Data: ' + JSON.stringify(data)) }).catch((err)=>{ console.error('Failed to hide the window. Cause: ' + JSON.stringify(err)); }) @@ -540,12 +597,12 @@ show(callback: AsyncCallback<void>): void - 示例 ``` - windowClass.show((err) => { - if (err) { + 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.') + console.info('Succeeded in showing the window. Data: ' + JSON.stringify(data)) }) ``` @@ -567,8 +624,8 @@ show(): Promise<void> ``` let promise = windowClass.show(); - promise.then(()=> { - console.info('Succeeded in showing the window.') + 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)); }) @@ -591,12 +648,12 @@ destroy(callback: AsyncCallback<void>): void - 示例 ``` - windowClass.destroy((err) => { - if (err) { + 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.') + console.info('Succeeded in destroying the window. Data: ' + JSON.stringify(data)) }) ``` @@ -618,8 +675,8 @@ destroy(): Promise<void> ``` let promise = windowClass.destroy(); - promise.then(()=> { - console.info('Succeeded in destroying the window.') + 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)); }) @@ -644,12 +701,12 @@ moveTo(x: number, y: number, callback: AsyncCallback<void>): void - 示例 ``` - windowClass.moveTo(300, 300, (err)=>{ - if (err) { + 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.'); + console.info('Window moved. Data: ' + JSON.stringify(data)) }); ``` @@ -679,8 +736,8 @@ moveTo(x: number, y: number): Promise<void> ``` let promise = windowClass.moveTo(300, 300); - promise.then(()=> { - console.info('Window moved.') + promise.then((data)=> { + console.info('Window moved. Data: ' + JSON.stringify(data)) }).catch((err)=>{ console.error('Failed to move the window. Cause: ' + JSON.stringify(err)); }) @@ -705,12 +762,12 @@ resetSize(width: number, height: number, callback: AsyncCallback<void>): v - 示例 ``` - windowClass.resetSize(500, 1000, (err) => { - if (err) { + 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.'); + console.info('Window size changed. Data: ' + JSON.stringify(data)) }); ``` @@ -739,8 +796,8 @@ resetSize(width: number, height: number): Promise<void> ``` let promise = windowClass.resetSize(500, 1000); - promise.then(()=> { - console.info('Window size changed.') + 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)); }); @@ -752,6 +809,8 @@ setWindowType(type: WindowType, callback: AsyncCallback<void>): void 设置窗å£ç±»åž‹ï¼Œä½¿ç”¨callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + **系统能力**:SystemCapability.WindowManager.WindowManager.Core - å‚æ•° @@ -765,12 +824,12 @@ setWindowType(type: WindowType, callback: AsyncCallback<void>): void ``` var type = window.TYPE_APP; - windowClass.setWindowType(type, (err) => { - if (err) { + 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.') + console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data)) }); ``` @@ -780,6 +839,8 @@ setWindowType(type: WindowType): Promise<void> 设置窗å£ç±»åž‹ï¼Œä½¿ç”¨Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ +æ¤æŽ¥å£ä¸ºç³»ç»ŸæŽ¥å£ï¼Œä¸‰æ–¹åº”用ä¸æ”¯æŒè°ƒç”¨ã€‚ + **系统能力**:SystemCapability.WindowManager.WindowManager.Core - å‚æ•° @@ -799,8 +860,8 @@ setWindowType(type: WindowType): Promise<void> ``` var type = window.TYPE_APP; let promise = windowClass.setWindowType(type); - promise.then(()=> { - console.info('Succeeded in setting the window 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)); }); @@ -824,7 +885,7 @@ getProperties(callback: AsyncCallback<WindowProperties>): void ``` windowClass.getProperties((err, data) => { - if (err) { + if (err.code) { console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err)); return; } @@ -877,7 +938,7 @@ getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): voi ``` var type = window.AvoidAreaType.TYPE_SYSTEM; windowClass.getAvoidArea(type, (err, data) => { - if (err) { + if (err.code) { console.error('Failed to obtain the area. Cause:' + JSON.stringify(err)); return; } @@ -935,12 +996,12 @@ setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void ``` var isFullScreen = true; - windowClass.setFullScreen(isFullScreen, (err) => { - if (err) { + 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.'); + console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data)) }); ``` @@ -969,8 +1030,8 @@ setFullScreen(isFullScreen: boolean): Promise<void> ``` var isFullScreen = true; let promise = windowClass.setFullScreen(isFullScreen); - promise.then(()=> { - console.info('Succeeded in enabling the full-screen mode.')) + 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)); }); @@ -995,12 +1056,12 @@ setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void ``` var isLayoutFullScreen= true; - windowClass.setLayoutFullScreen(isLayoutFullScreen, (err) => { - if (err) { + 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.'); + console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data)) }); ``` @@ -1029,8 +1090,8 @@ setLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void> ``` var isLayoutFullScreen = true; let promise = windowClass.setLayoutFullScreen(isLayoutFullScreen); - promise.then(()=> { - console.info('Succeeded in setting the window layout to full-screen mode.')) + 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)); }); @@ -1055,12 +1116,12 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallbac ``` var names = ["status", "navigation"]; - windowClass.setSystemBarEnable(names, (err) => { - if (err) { + 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.'); + console.info('Succeeded in setting the system bar to be visible. Data: ' + JSON.stringify(data)) }); ``` @@ -1089,8 +1150,8 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void> ``` var names = ["status", "navigation"]; let promise = windowClass.setSystemBarEnable(names); - promise.then(()=> { - console.info('Succeeded in setting the system bar to be visible.')) + 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)); }); @@ -1121,15 +1182,15 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: Async isStatusBarLightIcon: true, isNavigationBarLightIcon:false, //以下两个属性从API Version8å¼€å§‹æ”¯æŒ - statusBarContentColor:'#ffffff' + statusBarContentColor:'#ffffff', navigationBarContentColor:'#00ffff' }; - windowClass.setSystemBarProperties(SystemBarProperties, (err) => { - if (err) { + 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.'); + console.info('Succeeded in setting the system bar properties. Data: ' + JSON.stringify(data)) }); ``` @@ -1163,20 +1224,20 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<voi isStatusBarLightIcon: true, isNavigationBarLightIcon:false, //以下两个属性从API Version8å¼€å§‹æ”¯æŒ - statusBarContentColor:'#ffffff' + statusBarContentColor:'#ffffff', navigationBarContentColor:'#00ffff' }; let promise = windowClass.setSystemBarProperties(SystemBarProperties); - promise.then(()=> { - console.info('Succeeded in setting the system bar properties.')) + 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)); }); ``` -### loadContent<sup>8+</sup> +### loadContent<sup>7+</sup> -loadContent(path: string, storage: ContentStorage, callback: AsyncCallback<void>): void +loadContent(path: string, callback: AsyncCallback<void>): void 当å‰çª—å£åŠ 载具体页é¢å†…容,使用callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ @@ -1187,24 +1248,23 @@ loadContent(path: string, storage: ContentStorage, callback: AsyncCallback<vo | å‚æ•°å | 类型 | å¿…å¡« | 说明 | | -------- | ------------------------- | ---- | -------------------- | | path | string | 是 | è®¾ç½®åŠ è½½é¡µé¢çš„路径。 | - | storage | ContentStorage | å¦ | 当å‰åº”用内的数æ®ã€‚ | | callback | AsyncCallback<void> | 是 | 回调函数。 | - + - 示例 ``` - windowClass.loadContent("pages/page2/page2", (err) => { - if (err) { + 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.'); + console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data)) }); ``` -### loadContent<sup>8+</sup> +### loadContent<sup>7+</sup> -loadContent(path: string, storage?: ContentStorage): Promise<void> +loadContent(path: string): Promise<void> 当å‰çª—å£åŠ 载具体页é¢å†…容,使用Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ @@ -1212,11 +1272,10 @@ loadContent(path: string, storage?: ContentStorage): Promise<void> - å‚æ•° - | å‚æ•°å | 类型 | å¿…å¡« | 说明 | - | ------- | -------------- | ---- | -------------------- | - | path | string | 是 | è®¾ç½®åŠ è½½é¡µé¢çš„路径。 | - | storage | ContentStorage | å¦ | 当å‰åº”用内的数æ®ã€‚ | - + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ------ | ------ | ---- | -------------------- | + | path | string | 是 | è®¾ç½®åŠ è½½é¡µé¢çš„路径。 | + - 返回值 | 类型 | 说明 | @@ -1227,8 +1286,8 @@ loadContent(path: string, storage?: ContentStorage): Promise<void> ``` let promise = windowClass.loadContent("pages/page2/page2"); - promise.then(()=> { - console.info('Succeeded in loading the content.')) + 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)); }); @@ -1251,12 +1310,12 @@ isShowing(callback: AsyncCallback<boolean>): void - 示例 ``` - windowClass.isShowing((err) => { - if (err) { + 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. Cause:') + console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data)) }); ``` @@ -1278,8 +1337,8 @@ isShowing(): Promise<boolean> ``` let promise = windowClass.isShowing(); - promise.then(()=> { - console.info('Succeeded in checking whether the window is showing.') + 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)); }); @@ -1377,6 +1436,56 @@ off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void windowClass.off(type); ``` +### on('keyboardHeightChange')<sup>7+</sup> + +on(type: 'keyboardHeightChange', callback: Callback<number>): void + +å¼€å¯é”®ç›˜é«˜åº¦å˜åŒ–的监å¬ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | + | type | string | 是 | 设置监å¬ç±»åž‹ã€‚<br/>- type为'keyboardHeightChange'时表示监å¬ç±»åž‹ä¸ºé”®ç›˜é«˜åº¦å˜åŒ–监å¬ã€‚ | + | callback | Callback<[AvoidArea](#avoidarea)> | 是 | 回调返回监å¬åˆ°çš„ä¿¡æ¯ã€‚ | + +- 示例 + + ``` + var type = 'keyboardHeightChange'; + windowClass.on(type, (data) => { + console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data)); + }); + ``` + +### off('keyboardHeightChange')<sup>7+</sup> + +off(type: 'keyboardHeightChange', callback?: Callback<number>): void + +å…³é—键盘高度å˜åŒ–的监å¬ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | -------- | ---------------------- | ---- | ------------------------------------------------------------ | + | type | string | 是 | 设置监å¬ç±»åž‹ã€‚<br/>- type为'keyboardHeightChange'时表示监å¬ç±»åž‹ä¸ºé”®ç›˜é«˜åº¦å˜åŒ–监å¬ã€‚ | + | callback | Callback<number> | å¦ | 回调返回监å¬åˆ°çš„ä¿¡æ¯ã€‚ | + +- 示例 + + ``` + var type = 'keyboardHeightChange'; + windowClass.off(type); + ``` + ### isSupportWideGamut<sup>8+</sup> isSupportWideGamut(callback: AsyncCallback<boolean>): void @@ -1394,12 +1503,12 @@ isSupportWideGamut(callback: AsyncCallback<boolean>): void - 示例 ``` - windowClass.isSupportWideGamut((err) => { - if (err) { + 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.') + console.info('Succeeded in checking whether the window support WideGamut Data: ' + JSON.stringify(data)) }) ``` @@ -1421,8 +1530,8 @@ isSupportWideGamut(): Promise<boolean> ``` let promise = windowClass.isSupportWideGamut(); - promise.then(()=> { - console.info('Succeeded in checking whether the window support WideGamut.') + 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)); }); @@ -1446,12 +1555,12 @@ setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void - 示例 ``` - windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err) => { - if (err) { + 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.') + console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data)) }) ``` @@ -1479,8 +1588,8 @@ setColorSpace(colorSpace:ColorSpace): Promise<void> ``` let promise = windowClass.isSupportWideGamut(window.ColorSpace.WIDE_GAMUT); - promise.then(()=> { - console.info('Succeeded in setting window colorspace.') + promise.then((data)=> { + console.info('Succeeded in setting window colorspace. Data: ' + JSON.stringify(data)) }).catch((err)=>{ console.error('Failed to set window colorspacet. Cause: ' + JSON.stringify(err)); }); @@ -1504,7 +1613,7 @@ getColorSpace(callback: AsyncCallback<ColorSpace>): void ``` windowClass.getColorSpace((err, data) => { - if (err) { + if (err.code) { console.error('Failed to get window color space. Cause:' + JSON.stringify(err)); return; } @@ -1537,3 +1646,514 @@ getColorSpace(): Promise<ColorSpace> }); ``` +### setBackgroundColor + +setBackgroundColor(color: string, callback: AsyncCallback<void>): void + +设置窗å£çš„背景色,使用callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | -------- | ------------------------- | ---- | ------------------------------------------------------------ | + | color | string | 是 | 需è¦è®¾ç½®çš„背景色,为16进制颜色,例如"#00FF00"或"#FF00FF00"。 | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + 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 + +setBackgroundColor(color: string): Promise<void> + +设置窗å£çš„背景色,使用Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ------ | ------ | ---- | ------------------------------------------------------------ | + | color | string | 是 | 需è¦è®¾ç½®çš„背景色,为16进制颜色,例如"#00FF00"或"#FF00FF00"。 | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + 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 + +setBrightness(brightness: number, callback: AsyncCallback<void>): void + +设置å±å¹•äº®åº¦å€¼ï¼Œä½¿ç”¨callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ---------- | ------------------------- | ---- | ------------------------------------ | + | brightness | number | 是 | å±å¹•äº®åº¦å€¼ï¼Œå€¼ä¸º0-1之间。1表示最亮。 | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + 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 + +setBrightness(brightness: number): Promise<void> + +设置å±å¹•äº®åº¦å€¼ï¼Œä½¿ç”¨Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ---------- | ------ | ---- | ------------------------------------ | + | brightness | number | 是 | å±å¹•äº®åº¦å€¼ï¼Œå€¼ä¸º0-1之间。1表示最亮。 | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + 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<sup>7+</sup> + +setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void + +窗å£å åŠ æ—¶ï¼Œè®¾å¤‡æœ‰å窗å£çš„情况下设置é åŽçš„窗å£çš„暗度值,使用callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | -------------- | ------------------------- | ---- | -------------------------------------------------- | + | dimBehindValue | number | 是 | 表示é åŽçš„窗å£çš„暗度值,å–值范围为0-1,1表示最暗。 | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + windowClass.setDimBehind(0.5, (err, data) => { + if (err.code) { + console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err)); + return; + } + console.info('Succeeded in setting the dimness. Data:' + JSON.stringify(data)); + }); + ``` + +### setDimBehind<sup>7+</sup> + +setDimBehind(dimBehindValue: number): Promise<void> + +窗å£å åŠ æ—¶ï¼Œè®¾å¤‡æœ‰å窗å£çš„情况下设置é åŽçš„窗å£çš„暗度值,使用Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | -------------- | ------ | ---- | -------------------------------------------------- | + | dimBehindValue | number | 是 | 表示é åŽçš„窗å£çš„暗度值,å–值范围为0-1,1表示最暗。 | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + let promise = windowClass.setDimBehind(0.5); + promise.then((data)=> { + console.info('Succeeded in setting the dimness. Data: ' + JSON.stringify(data)) + }).catch((err)=>{ + console.error('Failed to set the dimness. Cause: ' + JSON.stringify(err)); + }); + ``` + +### setFocusable<sup>7+</sup> + +setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void + +设置点击时是å¦æ”¯æŒåˆ‡æ¢ç„¦ç‚¹çª—å£ï¼Œä½¿ç”¨callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ----------- | ------------------------- | ---- | ---------------------------- | + | isFocusable | boolean | 是 | 点击时是å¦æ”¯æŒåˆ‡æ¢ç„¦ç‚¹çª—å£ã€‚ | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + 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)); + }); + ``` + +### setFocusable<sup>7+</sup> + +setFocusable(isFocusable: boolean): Promise<void> + +设置点击时是å¦æ”¯æŒåˆ‡æ¢ç„¦ç‚¹çª—å£ï¼Œä½¿ç”¨Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ----------- | ------- | ---- | ---------------------------- | + | isFocusable | boolean | 是 | 点击时是å¦æ”¯æŒåˆ‡æ¢ç„¦ç‚¹çª—å£ã€‚ | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + 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 + +setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void + +设置å±å¹•æ˜¯å¦ä¸ºå¸¸äº®çŠ¶æ€ï¼Œä½¿ç”¨callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | -------------- | ------------------------- | ---- | ------------------------ | + | isKeepScreenOn | boolean | 是 | 是å¦è®¾ç½®ä¸ºå±å¹•å¸¸äº®çŠ¶æ€ã€‚ | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + 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> + +设置å±å¹•æ˜¯å¦ä¸ºå¸¸äº®çŠ¶æ€ï¼Œä½¿ç”¨Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | -------------- | ------- | ---- | ------------------------ | + | isKeepScreenOn | boolean | 是 | 是å¦è®¾ç½®ä¸ºå±å¹•å¸¸äº®çŠ¶æ€ã€‚ | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + 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)); + }); + ``` + +### setOutsideTouchable<sup>7+</sup> + +setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): void + +设置是å¦å…许å¯ç‚¹å‡»å窗å£ä»¥å¤–的区域,使用callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | --------- | ------------------------- | ---- | ---------------- | + | touchable | boolean | 是 | 设置是å¦å¯ç‚¹å‡»ã€‚ | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + windowClass.setOutsideTouchable(true, (err, data) => { + if (err.code) { + console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err)); + return; + } + console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data)) + }) + ``` + +### setOutsideTouchable<sup>7+</sup> + +setOutsideTouchable(touchable: boolean): Promise<void> + +设置是å¦å…许å¯ç‚¹å‡»å窗å£ä»¥å¤–的区域,使用Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | --------- | ------- | ---- | ---------------- | + | touchable | boolean | 是 | 设置是å¦å¯ç‚¹å‡»ã€‚ | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + let promise = windowClass.setOutsideTouchable(true); + promise.then((data)=> { + console.info('Succeeded in setting the area to be touchable. Data: ' + JSON.stringify(data)) + }).catch((err)=>{ + console.error('Failed to set the area to be touchable. Cause: ' + JSON.stringify(err)); + }); + ``` + +### setPrivacyMode<sup>7+</sup> + +setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void + +设置窗å£æ˜¯å¦ä¸ºéšç§æ¨¡å¼ï¼Œä½¿ç”¨callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ------------- | ------------------------- | ---- | -------------------- | + | isPrivacyMode | boolean | 是 | 窗å£æ˜¯å¦ä¸ºéšç§æ¨¡å¼ã€‚ | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + 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)); + + }); + ``` + +### setPrivacyMode<sup>7+</sup> + +setPrivacyMode(isPrivacyMode: boolean): Promise<void> + +设置窗å£æ˜¯å¦ä¸ºéšç§æ¨¡å¼ï¼Œä½¿ç”¨Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ------------- | ------- | ---- | -------------------- | + | isPrivacyMode | boolean | 是 | 窗å£æ˜¯å¦ä¸ºéšç§æ¨¡å¼ã€‚ | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + 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)); + }); + ``` + +### setTouchable<sup>7+</sup> + +setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void + +设置窗å£æ˜¯å¦ä¸ºå¯è§¦çŠ¶æ€ï¼Œä½¿ç”¨callbackæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ----------- | ------------------------- | ---- | -------------------- | + | isTouchable | boolean | 是 | 窗å£æ˜¯å¦ä¸ºå¯è§¦çŠ¶æ€ã€‚ | + | callback | AsyncCallback<void> | 是 | 回调函数。 | + +- 示例 + + ``` + 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)); + + }); + ``` + +### setTouchable<sup>7+</sup> + +setTouchable(isTouchable: boolean): Promise<void> + +设置窗å£æ˜¯å¦ä¸ºå¯è§¦çŠ¶æ€ï¼Œä½¿ç”¨Promiseæ–¹å¼ä½œä¸ºå¼‚æ¥æ–¹æ³•ã€‚ + +本接å£åœ¨OpenHarmony 3.1 Release版本仅为接å£å®šä¹‰ï¼Œæš‚ä¸æ”¯æŒä½¿ç”¨ã€‚接å£å°†åœ¨OpenHarmony 3.1 MR版本ä¸æ供使用支æŒã€‚ + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- å‚æ•° + + | å‚æ•°å | 类型 | å¿…å¡« | 说明 | + | ----------- | ------- | ---- | -------------------- | + | isTouchable | boolean | 是 | 窗å£æ˜¯å¦ä¸ºå¯è§¦çŠ¶æ€ã€‚ | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ----------------------------------------------- | + | Promise<void> | 以Promiseå½¢å¼è¿”回结果,返回当å‰å‡½æ•°æ‰§è¡Œçš„结果。 | + +- 示例 + + ``` + 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)); + }); + ``` + +### \ No newline at end of file