Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
187781fd
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
187781fd
编写于
3月 26, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 26, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2584 修复卡片资料描述问题
Merge pull request !2584 from yangzk/rk_dev
上级
acc94d75
92adadae
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
21 addition
and
19 deletion
+21
-19
zh-cn/application-dev/ability/fa-formability.md
zh-cn/application-dev/ability/fa-formability.md
+15
-15
zh-cn/application-dev/ability/stage-formextension.md
zh-cn/application-dev/ability/stage-formextension.md
+6
-4
未找到文件。
zh-cn/application-dev/ability/fa-formability.md
浏览文件 @
187781fd
...
...
@@ -24,16 +24,16 @@
FA卡片开发,即基于
[
FA模型
](
fa-brief.md
)
的卡片提供方开发,主要涉及如下功能逻辑:
-
开发卡片生命周期回调函数
FormAbility
。
-
开发卡片生命周期回调函数
LifecycleForm
。
-
创建卡片数据FormBindingData对象。
-
通过FormProvider更新卡片。
-
开发卡片页面。
## 接口说明
卡片生命周期回调函数
FormAbility
的接口如下:
卡片生命周期回调函数
LifecycleForm
的接口如下:
**表1**
FormAbility
API接口功能介绍
**表1**
LifecycleForm
API接口功能介绍
| 接口名 | 描述 |
| :----------------------------------------------------------- | :------------------------------------------- |
...
...
@@ -43,7 +43,7 @@ FA卡片开发,即基于[FA模型](fa-brief.md)的卡片提供方开发,主
| onVisibilityChange(newStatus: { [key: string]: number }): void | 卡片提供方接收修改可见性的通知接口。 |
| onEvent(formId: string, message: string): void | 卡片提供方接收处理卡片事件的通知接口。 |
| onDestroy(formId: string): void | 卡片提供方接收销毁卡片的通知接口。 |
| on
ConfigurationUpdated(config: Configuration): void; | 当系统配置更新时调用。
|
| on
AcquireFormState?(want: Want): formInfo.FormState | 卡片提供方接收查询卡片状态的通知接口。
|
FormProvider类具体的API详见
[
接口文档
](
../reference/apis/js-apis-formprovider.md
)
。
...
...
@@ -58,9 +58,9 @@ FormProvider类具体的API详见[接口文档](../reference/apis/js-apis-formpr
## 开发步骤
### 创建
FormAbility
### 创建
LifecycleForm
创建FA模型的卡片,需实现
FormAbility
生命周期接口。具体示例代码如下:
创建FA模型的卡片,需实现
LifecycleForm的
生命周期接口。具体示例代码如下:
1.
导入相关模块
...
...
@@ -70,7 +70,7 @@ FormProvider类具体的API详见[接口文档](../reference/apis/js-apis-formpr
import
formProvider
from
'
@ohos.application.formProvider
'
```
2.
实现
FormAbility
生命周期接口
2.
实现
LifecycleForm
生命周期接口
```
javascript
export
default
{
...
...
@@ -129,7 +129,7 @@ Form需要在应用配置文件config.json中进行配置。
| -------- | ------------------------------------------------------------ | -------- | ------------------------ |
| name | 表示JS Component的名字。该标签不可缺省,默认值为default。 | 字符串 | 否 |
| pages | 表示JS Component的页面用于列举JS Component中每个页面的路由信息[页面路径+页面名称]。该标签不可缺省,取值为数组,数组第一个元素代表JS FA首页。 | 数组 | 否 |
| window | 用于定义与显示窗口相关的配置。
该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。
| 对象 | 可缺省 |
| window | 用于定义与显示窗口相关的配置。
| 对象 | 可缺省 |
| type | 表示JS应用的类型。取值范围如下:
<br
/>
normal:标识该JS Component为应用实例。
<br
/>
form:标识该JS Component为卡片实例。 | 字符串 | 可缺省,缺省值为“normal” |
| mode | 定义JS组件的开发模式。 | 对象 | 可缺省,缺省值为空 |
...
...
@@ -147,28 +147,26 @@ Form需要在应用配置文件config.json中进行配置。
}]
```
-
abilities模块,用于对应卡片的
FormAbility
,内部字段结构说明:
-
abilities模块,用于对应卡片的
LifecycleForm
,内部字段结构说明:
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ------------------- | ------------------------------------------------------------ | ---------- | ------------------------ |
| name | 表示卡片的类名。字符串最大长度为127字节。 | 字符串 | 否 |
| description | 表示卡片的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省为空。 |
| isDefault | 表示该卡片是否为默认卡片,每个Ability有且只有一个默认卡片。
<br
/>
true:默认卡片。
<br
/>
false:非默认卡片。 | 布尔值 | 否 |
| type | 表示卡片的类型。取值范围如下:
<br
/>
J
ava:Java卡片。
<br
/>
JS:JS卡片。
| 字符串 | 否 |
| type | 表示卡片的类型。取值范围如下:
<br
/>
J
S:JS卡片。
| 字符串 | 否 |
| colorMode | 表示卡片的主题样式,取值范围如下:
<br
/>
auto:自适应。
<br
/>
dark:深色主题。
<br
/>
light:浅色主题。 | 字符串 | 可缺省,缺省值为“auto”。 |
| supportDimensions | 表示卡片支持的外观规格,取值范围:
<br
/>
1
* 2:表示1行2列的二宫格。<br />2 *
2:表示2行2列的四宫格。
<br
/>
2
* 4:表示2行4列的八宫格。<br />4 *
4:表示4行4列的十六宫格。 | 字符串数组 | 否 |
| defaultDimension | 表示卡片的默认外观规格,取值必须在该卡片supportDimensions配置的列表中。 | 字符串 | 否 |
| landscapeLayouts | 表示卡片外观规格对应的横向布局文件,与supportDimensions中的规格一一对应。仅当卡片类型为Java卡片时,需要配置该标签。 | 字符串数组 | 否 |
| portraitLayouts | 表示卡片外观规格对应的竖向布局文件,与supportDimensions中的规格一一对应。仅当卡片类型为Java卡片时,需要配置该标签。 | 字符串数组 | 否 |
| updateEnabled | 表示卡片是否支持周期性刷新,取值范围:
<br
/>
true:表示支持周期性刷新,可以在定时刷新(updateDuration)和定点刷新(scheduledUpdateTime)两种方式任选其一,优先选择定时刷新。
<br
/>
false:表示不支持周期性刷新。 | 布尔类型 | 否 |
| scheduledUpdateTime | 表示卡片的定点刷新的时刻,采用24小时制,精确到分钟。 | 字符串 | 可缺省,缺省值为“0:0”。 |
| updateDuration | 表示卡片定时刷新的更新周期,单位为30分钟,取值为自然数。
<br
/>
当取值为0时,表示该参数不生效。
<br
/>
当取值为正整数N时,表示刷新周期为30
*
N分钟。 | 数值 | 可缺省,缺省值为“0”。 |
| formConfigAbility | 表示
用于调整卡片的设施或活动的名称。
| 字符串 | 可缺省,缺省值为空。 |
| formConfigAbility | 表示
卡片的配置跳转链接,采用URI格式。
| 字符串 | 可缺省,缺省值为空。 |
| formVisibleNotify | 标识是否允许卡片使用卡片可见性通知。 | 字符串 | 可缺省,缺省值为空。 |
| jsComponentName | 表示JS卡片的Component名称。字符串最大长度为127字节。
仅当卡片类型为JS卡片时,需要配置该标签。
| 字符串 | 否 |
| jsComponentName | 表示JS卡片的Component名称。字符串最大长度为127字节。
| 字符串 | 否 |
| metaData | 表示卡片的自定义信息,包含customizeData数组标签。 | 对象 | 可缺省,缺省值为空。 |
| customizeData | 表示自定义的卡片信息。 | 对象数组 | 可缺省,缺省值为空。 |
配置示例如下:
```
json
...
...
@@ -180,6 +178,8 @@ Form需要在应用配置文件config.json中进行配置。
"label"
:
"$string:form_FormAbility_label"
,
"srcPath"
:
"FormAbility"
,
"type"
:
"service"
,
"srcLanguage"
:
"ets"
,
"formsEnabled"
:
true
,
"forms"
:
[{
"colorMode"
:
"auto"
,
"defaultDimension"
:
"2*2"
,
...
...
zh-cn/application-dev/ability/stage-formextension.md
浏览文件 @
187781fd
...
...
@@ -145,7 +145,7 @@ Form需要在应用配置文件module.json中进行配置。
| icon | 表示extensionAbility的图标资源文件的索引。 | 字符串 | 可缺省,缺省值为空。 |
| label | 表示extensionAbility的标签信息,即extensionAbility对外显示的文字描述信息。取值可以是描述性内容,也可以是标识label的资源索引。 | 字符串 | 可缺省,缺省值为空。 |
| type | 表示extensionAbility的类型。取值form、service等 | 字符串 | 否 |
| permissions | 表示其他应用的Ability调用此Ability时需要申请的权限。
通常采用反向域名格式,取值可以是系统预定义的权限,也可以是开发者自定义的权限。
| 字符串数组 | 可缺省,缺省值为空。 |
| permissions | 表示其他应用的Ability调用此Ability时需要申请的权限。
| 字符串数组 | 可缺省,缺省值为空。 |
| metadata | 表示extensionAbility的元信息。用于描述extensionAbility的配置信息。 | 对象 | 可缺省,缺省值为空 |
对于FormExtensionAbility来说,type需要配置为form,并且需要填写metadata元信息,用于配置卡片的具体信息。
...
...
@@ -166,14 +166,16 @@ Form需要在应用配置文件module.json中进行配置。
}]
```
- 卡片profile模块
,卡片metadata元信息,内部字段结构说明:
- 卡片profile模块
。在 FormExtensionAbility 的元信息中,需要使用 ohos.extension.form 指定的资源文件的路径,如使用 $profile:form_config 指定开发视图的 resources/base/profile/ 目录下的 form_config.json 作为卡片profile配置文件。
内部字段结构说明:
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
| ------------------- | ------------------------------------------------------------ | ---------- | ------------------------ |
| name | 表示卡片的类名。字符串最大长度为127字节。 | 字符串 | 否 |
| description | 表示卡片的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。字符串最大长度为255字节。 | 字符串 | 可缺省,缺省为空。 |
| src | 表示卡片对应的UI代码的完整路径。 | 字符串 | 否 |
| window |
| |
|
| window |
用于定义与显示窗口相关的配置。 | 对象 | 可缺省
|
| isDefault | 表示该卡片是否为默认卡片,每个Ability有且只有一个默认卡片。<br />true:默认卡片。<br />false:非默认卡片。 | 布尔值 | 否 |
| colorMode | 表示卡片的主题样式,取值范围如下:<br />auto:自适应。<br />dark:深色主题。<br />light:浅色主题。 | 字符串 | 可缺省,缺省值为“auto”。 |
| supportDimensions | 表示卡片支持的外观规格,取值范围:<br />1 * 2:表示1行2列的二宫格。<br />2 * 2:表示2行2列的四宫格。<br />2 * 4:表示2行4列的八宫格。<br />4 * 4:表示4行4列的十六宫格。 | 字符串数组 | 否 |
...
...
@@ -186,7 +188,7 @@ Form需要在应用配置文件module.json中进行配置。
| metaData | 表示卡片的自定义信息,包含customizeData数组标签。 | 对象 | 可缺省,缺省值为空。 |
配置示例如下:
```
json
{
"forms": [{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录