• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# WindowExtensionAbility
2
3
4[WindowExtensionAbility](../reference/apis/js-apis-application-windowExtensionAbility.md)是一种ExtensionAbility组件，用于提供界面组合扩展能力，允许系统应用进行跨应用的界面拉起和嵌入。
5
6
7WindowExtensionAbility必须和[AbilityComponent](../reference/arkui-ts/ts-container-ability-component.md)一起配合使用，并根据需求处理被拉起应用的业务。WindowExtensionAbility支持以连接形式运行，系统应用必须添加AbilityComponent组件启动WindowExtensionAbility服务。
8
9每个ExtensionAbility都有自己的Context，WindowExtensionAbility通过
10[WindowExtensionContext](../reference/apis/js-apis-inner-application-windowExtensionContext.md)提供相关能力。本文描述中称被启动的WindowExtensionAbility为提供方，称启动WindowExtensionAbility的AbilityComponent组件为使用方。
11
12> **说明：**
13>
14> 本接口为系统接口，如果三方开发者想要实现应用进行跨应用的界面拉起和嵌入，请参考[full-SDK替换指南](../../application-dev/quick-start/full-sdk-switch-guide.md)将SDK替换为full-SDK。
15>
16
17
18## 设置一个嵌入式UIAbility（仅对系统应用开放）
19
20WindowExtensionAbility提供了onConnect()、onDisconnect()和onWindowReady()生命周期回调，根据需要重写对应的回调方法。
21
22- **onWindowReady**：当该Ability的应用窗口创建成功时触发该回调。
23
24- **onConnect**：当窗口扩展组件AbilityComponent连接该Ability时回调。
25
26- **onDisconnect**：当窗口扩展组件AbilityComponent断开与该Ability的连接时回调。
27
28
29**开发步骤**
30
31开发者在实现一个嵌入式应用时，需要在DevEco Studio工程中手动新建一个WindowExtensionAbility，具体步骤如下。
32
331. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为WindowExtAbility。
34
352. 在WindowExtAbility目录，右键选择“New > ts File”，新建一个.ts文件并命名为WindowExtAbility.ts。
36
373. 打开WindowExtAbility.ts文件，导入WindowExtensionAbility的依赖包，自定义类继承WindowExtensionAbility并实现onWindowReady()、onConnect()和onDisconnect()生命周期回调。
38
39   ```ts
40   import Extension from '@ohos.application.WindowExtensionAbility'
41
42    export default class WindowExtAbility extends Extension {
43        onWindowReady(window) {
44            window.loadContent('WindowExtAbility/pages/index1').then(() => {
45                window.getProperties().then((pro) => {
46                    console.info("WindowExtension " + JSON.stringify(pro));
47                })
48                window.show();
49            })
50        }
51
52        onConnect(want) {
53            console.info('JSWindowExtension onConnect ' + want.abilityName);
54        }
55
56        onDisconnect(want) {
57            console.info('JSWindowExtension onDisconnect ' + want.abilityName);
58        }
59    }
60   ```
61
624. 在工程Module对应的[module.json5配置文件](../quick-start/module-configuration-file.md)中注册WindowExtensionAbility，type标签需要设置为“window”，srcEntry标签表示当前ExtensionAbility组件所对应的代码路径。
63
64   ```json
65   {
66     "module": {
67       "extensionAbilities": [
68            {
69                "name": "WindowExtAbility",
70                "srcEntry": "./ets/WindowExtAbility/WindowExtAbility.ts",
71                "icon": "$media:icon",
72                "description": "WindowExtension",
73                "type": "window",
74                "exported": true,
75            }
76        ],
77     }
78   }
79   ```
80
81
82## 拉起一个嵌入式UIAbility（仅对系统应用开放）
83
84系统应用可以通过AbilityComponent容器加载创建好的WindowExtensionAbility。
85
86**开发步骤**
87
881. 开发者在连接一个嵌入式应用时，需要在DevEco Studio工程中相应的pages界面中加入AbilityComponent控件。
89
902. 在AbilityComponent控件中写入正确的bundleName和abilityName。
91
923. 设置好宽高。示例代码如下：
93
94```ts
95@Entry
96@Component
97struct Index {
98  @State message: string = 'Hello World'
99
100  build() {
101    Row() {
102      Column() {
103        AbilityComponent({ abilityName: "WindowExtAbility", bundleName: "com.example.WindowExtAbility"})
104          .width(500)
105          .height(500)
106      }
107      .width('100%')
108    }
109    .height('100%')
110    .backgroundColor(0x64BB5c)
111  }
112}
113```
114
115## 相关示例
116
117针对WindowExtensionAbility开发，有以下相关示例可供参考：
118
119- [`WindowExtAbility`：WindowExtAbility的创建与使用（ArkTS）（API9）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/SystemFeature/WindowManagement/WindowExtAbility)
120