方法

activate(infoConfig) : void

表单激活方法

  • 参数说明:object
参数名 类型 必填 默认值 说明
values Object 表单加载时候回显的值
readOnly Boolean 表单是否只读
readOnlyFields Object{字段编码:boolean} 对表单字段进行更细粒度的只读控制
  • 返回数据说明:voids

  • 示例:

createField(vm, options) : FieldCtrl

创建一个字段控制器

  • 参数说明:
参数名 类型 必填 默认值 说明
vm VueComponent 表单的vm实例
options Object 字段配置信息(详细参数请参照字段类FieldCtrl)
  • 返回数据说明:FieldCtrl

  • 示例:

// fieldCtrlInstance为FieldCtrl的子类
var fieldCtrlInstance =  FormCtrl.createField(FormCtrl.vm, options)
// 向页面上插入一个自定义的字段
FormCtrl.vm.$set(FormCtrl.fields, 'testCode' , fieldCtrlInstance);

editChild(fieldCode) : void

打开一个子功能或者子功能集合

  • 参数说明:
参数名 类型 必填 默认值 说明
fieldCode String 保存子功能信息的字段编码
  • 返回数据说明:void

  • 示例:

getActivateConfig() : infoConfig

获取表单加载配置信息

  • 参数说明:

  • 返回数据说明:infoConfig
    请参考上文的infoConfig信息

  • 示例:

getChanges() : Array[changeInfo]

获得表单加载完毕后改动的值

  • 返回数据说明:Array[changeInfo]
参数名 类型 说明
changeType userChange systemChange
name String 字段编码
newValue String 变更后的值
oldValue String 变更前的值
  • 示例:
// 以下代码为伪代码(即只能在特定情况下运行的代码),只做参考使用
var changes = FormCtrl.getChanges();
console.log(changes);
/*
[
    {changeType: "systemChange"
    name: "YZSQ_YZ"
    newVal: "2"
    oldVal: "1"
    }
]
*/

getDataById(id) : Promise(data)

获取当前功能下的某一个主键id的数据

  • 参数说明:
参数名 类型 必填 默认值 说明
id String 主键Id
  • 返回数据说明:Promise(data)

  • 示例:

getFields(fieldCode) : FieldCtrl| Array(FieldCtrl)

根据字段编码获取字段控制器

  • 参数说明:FieldCtrl| Array(FieldCtrl)
参数名 类型 必填 默认值 说明
fieldCode String 主键Id
  • 示例:
var field = FormCtrl.getFields(fieldCode); // fieldCtrl
var fields = FormCtrl.getFields(); // fieldCtrl[]

getHistory(fieldCode) : Array(FieldCtrl)

获取变更过的字段

  • 参数说明:FieldCtrl| Array(FieldCtrl)
参数名 类型 必填 默认值 说明
fieldCode String 主键Id
  • 示例:
var field = FormCtrl.getFields(fieldCode); // fieldCtrl
var fields = FormCtrl.getFields(); // fieldCtrl[]

getMountStatus() : Boolean

获取表单的加载状态

  • 返回数据说明:Boolean

  • 示例:

getPkValue() : String

获取当前主键的Id

  • 返回数据说明:String

  • 示例:

getValues(fieldCode) : Object|String

获得表单值,默认全部

  • 参数说明:
参数名 类型 必填 默认值 说明
fieldCode String 字段code
  • 返回数据说明:Object|String
  • 示例:
var val = Form.getValues('fieldCode'); // String
var values = Form.getValues(); // Object

init() : void

表单初始化事件,调用该方法后表单将重新初始化

  • 参数说明:

  • 示例:

isValid() : Boolean

验证表单所有的必填项是否完成填写

  • 参数说明:
参数名 类型 必填 默认值 说明
showMsg String true 是否显示提示信息
  • 示例:

refreshChild(funcCode) : void

刷新子功能中的列表数据

  • 参数说明:
参数名 类型 必填 默认值 说明
funcCode String 子功能编码
  • 示例:
  • 补充: 如果不传递子功能编码,则会刷新当前功能下的所有功能列表数据

refreshChildFunc() : void

刷新当前功能中的子功能数据

  • 参数说明:

  • 示例:

refreshChildGroup() : void

刷新当前功能中的子功能集合数据

  • 参数说明:

  • 示例:

reset(fieldCode) : void

重置当前表单值

  • 参数说明:
参数名 类型 必填 默认值 说明
fieldCode String 字段编码
  • 示例:
    FormCtrl.reset(); // 重置表单所有值
    FormCtrl.reset('fieldCode'); // 重置某一个字段的值

resetFields(fieldCode) : void

将当前表单中字段的所有信息(显隐状态,值,名称等)重置为默认值

  • 参数说明:
参数名 类型 必填 默认值 说明
fieldCode String 字段编码
  • 示例:
    FormCtrl.resetFields(); // 重置表单所有信息
    FormCtrl.resetFields('fieldCode'); // 重置某一个字段的信息

resetForm(values) : void

将当前表单的所有信息(显隐状态,值等)重置为默认值

  • 参数说明:
参数名 类型 必填 默认值 说明
values Object 表单回显值
  • 示例:
    FormCtrl.resetForm(); // 重置表单所有信息
    FormCtrl.resetForm({
      test:'设置test字段的值'
    }); // 重置表单所有信息

save() : void

提交当前表单数据

  • 参数说明:

  • 示例:

    FormCtrl.save();

setPkValue(id) : void

设置当前表单的主键id

  • 参数说明:
参数名 类型 必填 默认值 说明
id String 表单的主键Id
  • 返回数据说明:void

  • 示例:

FormCtrl.setPkValue('zhuJianId')
  • 注意:错误的主键id可能会导致表单类异常!

setReadOnly(readOnly, fieldCode) : void

设置当前表单的只读情况,也可以只根据字段编码设置某一个字段的只读情况

  • 参数说明:
参数名 类型 必填 默认值 说明
readOnly Boolean 只读情况
fieldCode String|Array 字段编码
  • 返回数据说明:void

  • 示例:

// 设置表单,所有字段,子功能,子功能集合的只读情况
FormCtrl.setReadOnly(true);

// 针对某一个字段设置只读,不会影响到表单,子功能,子功能集合的只读
FormCtrl.setReadOnly(false, 'fieldCode');
// 针对多个字段设置只读,不会影响到表单,子功能,子功能集合的只读
FormCtrl.setReadOnly(false, 'fieldCode,fieldCode1');
FormCtrl.setReadOnly(true, ['fieldCode','fieldCode1']);
  • 注意:如果不传fieldCode参数,只针对表单的只读进行设置的话,表单的只读情况会同时设置当前功能的子功能、子功能集合

setSaveBtnVisible(isVisiable) : void

设置保存按钮的显隐状态

  • 参数说明:
参数名 类型 必填 默认值 说明
isVisiable Boolean 是否显示
  • 返回数据说明:void

  • 示例:

// 显示保存按钮
FormCtrl.setSaveBtnVisible(true);
// 隐藏保存按钮
FormCtrl.setSaveBtnVisible(false);
  • 注意:

setValues(values) : void

设置表单值

  • 参数说明:
参数名 类型 必填 默认值 说明
values Object 字段值{字段编码:显示的值}
  • 返回数据说明:void

  • 示例:

// 设置表单值
FormCtrl.setValues({
    fieldCode: '设置字段编码为fieldCode的value'
});
  • 注意:

showChildFuncPopup() : void

显示子功能弹出层

  • 参数说明:

  • 返回数据说明:void

  • 示例:

  • 注意:

最后编辑: admin  文档更新时间: 2023-04-26 08:43   作者:admin