窗体规范
窗体规范文档。
构件需要根据业务菜单、窗体功能、业务和维护来建立窗体文件夹来管理窗体：
- 业务：普通业务功能窗体
- 弹出选择：用来做弹出选择的功能窗体
- 废弃：因需求变更旧窗体暂时不适用时，存放窗体的目录。
- 其他：存放些备份或暂时没用上的窗体。
命名规范：
- 命名原则：
- 必须包含明确含义；
- 必须以form开头；
- 编码使用全小写英文单词，禁止使用汉语拼音及简拼，间隔用下划线连接。
一般命名方式：
- 窗体编码：
form_模块/功能名称_业务动作。- 窗体名称：
模块/产品名称+业务动作。弹出子窗体与父窗体命名方式一致。
2.1 一般命名方式
示例:
| 窗体 | 命名方式 | 例子1 | 例子2 | 例子3 |
|---|---|---|---|---|
| 窗体编码 | form_模块/功能名称_业务动作 | form_reimburse_list | form_reimburse_edit | form_reimburse_report |
| 窗体名称 | 模块/产品名称+业务动作 | 报销申请编辑 | 报销申请报表 |
2.2 业务动作与窗体编码
后缀参照表:
| 业务动作 | 窗体编码后缀 |
|---|---|
| 列表、清单 | list |
| 查询 | query |
| 弹窗选择 | select |
| 申请、登记、编辑 | edit |
| 报表 | report |
| 设置 | setting |
| 打印模板 | print |
如果开发中定义窗体输入作为变量记录数据状态，必须勾选为“私有”。
目前窗体模板固有的窗体输入如下：
3.1【主页面】窗体
| 私有 | 窗体输入编码 | 窗体输入名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|---|---|
| √ | isEditData | 编辑数据标识 | 布尔 | false | 用于判断编辑窗体是否编辑了数据，主页面根据返回值为true刷新数据 |
| √ | currentWindowInstanceCode | 当前窗体实例编码 | 文本 | 当其他窗体需要执行当前窗体方法时，传递给目标窗体 | |
parentWindowInstanceCode | 来源窗体实例编码 | 文本 | 用于执行来源窗体方法 |
3.2【明细编辑查看页面】窗体
| 私有 | 窗体输入编码 | 窗体输入名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|---|---|
| √ | currentWindowInstanceCode | 当前窗体实例编码 | 文本 | 当其他窗体需要执行当前窗体方法时，传递给目标窗体 | |
parentWindowInstanceCode | 来源窗体实例编码 | 文本 | 用于执行来源窗体方法 | ||
| √ | bizId | 流程业务Id | 文本 | 主要用于待办、已办任务打开表单进行传参（与传BizId参数一样） | |
mainId | 业务主表Id | 文本 | 主要用于主页面编辑、查看数据时打开编辑窗体进行传参 |
info命名规范：
- 命名原则：
- 必须包含明确含义；
- 必须以menu开头；
- 编码使用全小写英文单词，禁止使用汉语拼音及简拼，间隔用下划线连接。
- 菜单编码：
menu_模块/功能名称_业务动作。- 菜单名称：
根据业务要求定义即可。示例:
| 构件菜单 | 命名方式 | 例子 |
|---|---|---|
| 菜单编码 | menu_模块/功能名称_业务动作 | menu_reimburse_list |
info命名规范：
- 命名原则：
- 必须包含明确含义；
- 与报表窗体编码一致，必须以form开头；
- 编码使用全小写英文单词，禁止使用汉语拼音及简拼，间隔用下划线连接。
- 报表编码：
form_模块/功能名称_report。- 报表名称：
根据业务要求定义即可。- 一般与报表窗体编码一致命名即可。
示例:
| 报表 | 命名方式 | 例子 |
|---|---|---|
| 报表编码 | form_模块/功能名称_业务动作 | form_reimburse_report |