金蝶云苍穹动态表单插件loadCustomControlMeta

作者: 涎涎 | 来源:发表于2020-09-12 15:43 被阅读0次

金蝶云苍穹动态表单插件loadCustomControlMeta
金蝶云苍穹动态表单插件beforeDoOperation事件案例
金蝶云苍穹动态表单插件itemClick事件案例
金蝶云苍穹动态表单插件afterCreateNewData事件案
金蝶云苍穹动态表单插件registerListener事件案例
金蝶云苍穹如何创建动态表单？
金蝶云苍穹插件开发
金蝶云苍穹基础资料的简单介绍
金蝶云苍穹弹窗自定义动态表单案例
金蝶云苍穹插件开发之动态表单界面初始化事件测试

新建对话模态框动态表单
向其内容区添加Flex面板(更改标识为myfieldcontainer)和单据体后保存

新建插件类进行编码

package kd.bos.dynamicform.plugin;

import java.util.EventObject;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import kd.bos.dataentity.entity.DynamicObject;
import kd.bos.dataentity.entity.DynamicObjectCollection;
import kd.bos.dataentity.entity.LocaleString;
import kd.bos.dataentity.utils.StringUtils;
import kd.bos.entity.EntryType;
import kd.bos.entity.MainEntityType;
import kd.bos.entity.datamodel.events.BizDataEventArgs;
import kd.bos.entity.datamodel.events.GetEntityTypeEventArgs;
import kd.bos.entity.property.TextProp;
import kd.bos.exception.ErrorCode;
import kd.bos.exception.KDException;
import kd.bos.form.ClientProperties;
import kd.bos.form.container.Container;
import kd.bos.form.control.Button;
import kd.bos.form.control.Control;
import kd.bos.form.control.EntryGrid;
import kd.bos.form.control.events.ClickListener;
import kd.bos.form.events.LoadCustomControlMetasArgs;
import kd.bos.form.events.OnGetControlArgs;
import kd.bos.form.field.TextEdit;
import kd.bos.form.plugin.AbstractFormPlugin;
import kd.bos.metadata.entity.commonfield.TextField;
import kd.bos.metadata.form.container.FlexPanelAp;
import kd.bos.metadata.form.control.ButtonAp;
import kd.bos.metadata.form.control.EntryAp;
import kd.bos.metadata.form.control.EntryFieldAp;
import kd.bos.metadata.form.control.FieldAp;

/**
 * <p>Title: </p>
 * <p>
 *    Description:
 *    loadCustomControlMetas 事件试验
 *    ClickListener接口是为了让 
 *    getEntityType createNewData 这两个方法实现
 *    
 *    暂未试验成功，有bug
 * </p>
 * <p>Copyright: Copyright (c) 2020</p>
 * @author xx
 * @date 2020年3月6日
 * @version 1.0
 */
public class LoadCustomControlMetasSample extends AbstractFormPlugin implements ClickListener {

    private final static String KEY_ENTRYENTITY = "entryentity";//单据体(需要在页面新建)
    private final static String KEY_MYFIELDCONTAINER = "myfieldcontainer";//Flex面板(需要在页面新建)
    private final static String KEY_AUTOTEXT1 = "autotext1";
    private final static String KEY_AUTOTEXT2 = "autotext2";
    private final static String KEY_AUTOBUTTON1 = "autobutton1";
    
    /**
     * <p>Title: loadCustomControlMetas</p>
     * <p>
     *    Description:
     *    显示界面前，构建界面显示参数时，触发此事件；
     *    插件可以在此事件修改显示参数，向前端动态增加控件。
     *    特别说明：
     *    动态添加控件时，还需要同步处理onGetControl事件，向表单添加控件编程模型实例，并侦听控件的插件事件；
     *    动态增加字段，则还需要同步处理getEntityType, createNewData, beforeBindData事件，调整后台数据模型及数据包。
     *    需要同步处理的事件:
     *    public void loadCustomControlMetas(LoadCustomControlMetasArgs e) ：向前端浏览器界面输出动态控件的元数据；
     *    public void onGetControl(OnGetControlArgs e)：向后台视图模型，输出动态控件的编程模型实例，并侦听控件的事件
     *    public void getEntityType(GetEntityTypeEventArgs e)：向界面主实体模型，动态注册新的属性对象，存储动态添加的字段值；
     *    public void createNewData(BizDataEventArgs e)：基于修改后的实体模型，创建界面数据包，包含动态添加的字段值；
     *    public void beforeBindData(EventObject e)：向后台视图模型，添加动态字段的控件编辑模型；
     *    随后，系统将基于这些新添加的字段编辑模型(FieldEdit)，进行数据绑定。
     *    如果不处理这个事件，动态添加的字段值，显示不出来。
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.form.plugin.AbstractFormPlugin#loadCustomControlMetas(kd.bos.form.events.LoadCustomControlMetasArgs)
     * @version 1.0
     */
    @Override
    public void loadCustomControlMetas(LoadCustomControlMetasArgs e) {
        super.loadCustomControlMetas(e);
        // TODO 在此修改显示参数，向前端动态添加控件配置
        // 动态添加单据头字段、按钮
        FlexPanelAp headAp = this.createDynamicPanel();
        Map<String, Object> mapHead = new HashMap<>();
        mapHead.put(ClientProperties.Id, KEY_MYFIELDCONTAINER);
        mapHead.put(ClientProperties.Items, headAp.createControl().get(ClientProperties.Items));
        e.getItems().add(mapHead);
        
        // 动态添加单据体字段
        EntryAp entryAp = this.createDynamicEntryAp();
        Map<String, Object> mapEntry = new HashMap<>();
        mapEntry.put(ClientProperties.Id, KEY_ENTRYENTITY);
        mapEntry.put(ClientProperties.Columns, entryAp.createControl().get(ClientProperties.Columns));
        e.getItems().add(mapEntry);
    }
    
    /**
     * <p>Title: getEntityType</p>
     * <p>
     *    Description:
     *    此事件在系统要用到表单主实体模型时触发
     *    插件修改原始主实体，注册自定义属性，返回新的主实体给系统
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.datamodel.events.IDataModelListener#getEntityType(kd.bos.entity.datamodel.events.GetEntityTypeEventArgs)
     * @version 1.0
     */
    @Override
    public void getEntityType(GetEntityTypeEventArgs e) {
        // TODO 在此修改实体模型，增加属性
        
        // 取原始的主实体
        MainEntityType oldMainType = e.getOriginalEntityType();
        // 复制主实体
        MainEntityType newMainType = null;
        try{
            newMainType = (MainEntityType)oldMainType.clone();
        }
        catch (CloneNotSupportedException exp){
            throw new KDException(exp, new ErrorCode("LoadCustomControlMetasSample", exp.getMessage()));
        }

        // 为自定义的文本字段，向主实体注册文本属性
        this.registDynamicProps(newMainType);
        
        // 回传主实体给系统
        e.setNewEntityType(newMainType);
    }

    /**
     * <p>Title: createNewData</p>
     * <p>
     *    Description:
     *    此事件在表单创建界面数据包时触发
     *    由插件自行创建界面数据包，包含自定义字段
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.entity.datamodel.events.IDataModelListener#createNewData(kd.bos.entity.datamodel.events.BizDataEventArgs)
     * @version 1.0
     */
    @Override
    public void createNewData(BizDataEventArgs e) {
        // TODO 在此基于调整后的实体模型，创建界面数据包
        
        DynamicObject dataEntity = new DynamicObject(this.getModel().getDataEntityType());
        dataEntity.set(KEY_AUTOTEXT1, "动态文本字段1的值");
        
        DynamicObjectCollection rows = dataEntity.getDynamicObjectCollection(KEY_ENTRYENTITY);
        DynamicObject newRow = new DynamicObject(rows.getDynamicObjectType());
        newRow.set(KEY_AUTOTEXT2, "动态文本字段2的值");
        
        rows.add(newRow);
        
        e.setDataEntity(dataEntity);
    }
    
    /**
     * <p>Title: beforeBindData</p>
     * <p>
     *    Description:
     * 此事件在把数据绑定到界面之前触发：
     * 系统会调用FormDataBinder对象，把字段值输出给前端字段编辑控件；
     * 动态添加的字段，在FormDataBinder中并没有记录，因此，默认不会绑定动态添加的字段值；
     * 必须在此事件，向FormDataBinder中注册动态添加的字段
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.form.plugin.AbstractFormPlugin#beforeBindData(java.util.EventObject)
     * @version 1.0
     */
    @Override
    public void beforeBindData(EventObject e) {
        // TODO 在此向界面编程模型，动态添加字段编程模型(FieldEdit)
        
        // 单据头添加的字段、控件，注入到容器面板的控件编程模型中
        FlexPanelAp dynamicPanel = this.createDynamicPanel();
        Container myFldPanel = this.getView().getControl(KEY_MYFIELDCONTAINER);
        myFldPanel.getItems().addAll(dynamicPanel.buildRuntimeControl().getItems());
        this.getView().createControlIndex(myFldPanel.getItems());
        
        // 单据体添加的字段，注入到单据体表格的控件编程模型中
        EntryAp dynamicEntryAp = this.createDynamicEntryAp();
        EntryGrid entryGrid = this.getView().getControl(KEY_ENTRYENTITY);
        List<Control> fieldEdits = dynamicEntryAp.buildRuntimeControl().getItems();
        for(Control fieldEdit : fieldEdits){
            fieldEdit.setView(this.getView());
            entryGrid.getItems().add(fieldEdit);
        }
    }

    /**
     * <p>Title: onGetControl</p>
     * <p>
     *    Description:
     * 用户与自定义的控件进行交互时，会触发此事件
     * 插件在此事件中，创建自定义控件的编程模型，并侦听其事件
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @param e
     * @see kd.bos.form.plugin.AbstractFormPlugin#onGetControl(kd.bos.form.events.OnGetControlArgs)
     * @version 1.0
     */
    @Override
    public void onGetControl(OnGetControlArgs e) {
        // TODO 在此创建动态控件的实例，并捕获控件事件
        if (StringUtils.equals(KEY_AUTOBUTTON1, e.getKey())){
            // 用户点击按钮时，会触发此事件：创建按钮的控件编程模型Button实例返回
            
            Button button = new Button();
            button.setKey(KEY_AUTOBUTTON1); // 必须
            button.setView(this.getView()); // 必须
            
            button.addClickListener(this);
            e.setControl(button);
        }
        else if (StringUtils.equals(KEY_AUTOTEXT1, e.getKey())){
            // 用户修改了文本1字段值，前端上传字段值时，会先取字段的控件编程模型；
            // 如果没有本段代码，字段值上传失败，不会修改到数据模型中
            TextEdit textEdit = new TextEdit();
            textEdit.setKey(KEY_AUTOTEXT1);
            textEdit.setView(this.getView());
            e.setControl(textEdit);
        }
        else if (StringUtils.equals(KEY_AUTOTEXT2, e.getKey())){
            TextEdit textEdit = new TextEdit();
            textEdit.setKey(KEY_AUTOTEXT2);
            textEdit.setEntryKey(KEY_ENTRYENTITY);
            textEdit.setView(this.getView());
            e.setControl(textEdit);
        }
    }
    
    /**
     * <p>Title: click</p>
     * <p>
     *    Description:
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @param evt
     * @see kd.bos.form.plugin.AbstractFormPlugin#click(java.util.EventObject)
     * @version 1.0
     */
    @Override
    public void click(EventObject evt) {
        super.click(evt);
        Control source = (Control)evt.getSource();
        if (StringUtils.equals(source.getKey(), KEY_AUTOBUTTON1)){
            String text1 = (String)this.getModel().getValue(KEY_AUTOTEXT1);
            String text2 = (String)this.getModel().getValue(KEY_AUTOTEXT2);
            this.getView().showMessage("动态文本1：" + text1 + "   动态文本字段2：" + text2);
        }
    }
    
    /** 
     * FlexPanelAp</br>
     * <p>Title: createDynamicPanel</p>
     * <p>
     *    Description:
     * 创建一个面板，并向其中动态添加字段、控件
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @return the bare_field_name
     * @return
     * see_to_overridden
     * @version 1.0
     */
    private FlexPanelAp createDynamicPanel(){
        
        FlexPanelAp headPanelAp = new FlexPanelAp();
        headPanelAp.setKey("headAp");

        // 动态添加一个文本字段
        FieldAp fieldAp = new FieldAp();
        fieldAp.setId(KEY_AUTOTEXT1);
        fieldAp.setKey(KEY_AUTOTEXT1);
        fieldAp.setName(new LocaleString("自动文本1"));
        fieldAp.setBackColor("#FFFFFF");
        fieldAp.setFireUpdEvt(true);    // 即时触发值更新事件
        
        TextField field = new TextField();
        field.setId(KEY_AUTOTEXT1);
        field.setKey(KEY_AUTOTEXT1);
        fieldAp.setField(field);
        
        headPanelAp.getItems().add(fieldAp);
        
        // 动态添加一个按钮
        ButtonAp buttonAp = new ButtonAp();
        buttonAp.setId(KEY_AUTOBUTTON1);
        buttonAp.setKey(KEY_AUTOBUTTON1);
        buttonAp.setName(new LocaleString("自动添加的按钮"));
        
        headPanelAp.getItems().add(buttonAp);
        return headPanelAp;
    }
    
    /**
     * <p>Title: createDynamicEntryAp</p>
     * <p>
     *    Description:
     * 创建一个单据体表格，并向其中动态添加字段
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @return the bare_field_name
     * @return
     * see_to_overridden
     * @version 1.0
     */
    private EntryAp createDynamicEntryAp(){
        
        EntryAp entryAp = new EntryAp();
        entryAp.setKey("entryap");
        
        // 动态添加一个文本字段
        EntryFieldAp fieldAp = new EntryFieldAp();
        fieldAp.setId(KEY_AUTOTEXT2);
        fieldAp.setKey(KEY_AUTOTEXT2);
        fieldAp.setName(new LocaleString("自动文本2"));
        fieldAp.setFireUpdEvt(true);    // 即时触发值更新事件
        
        TextField field = new TextField();
        field.setId(KEY_AUTOTEXT2);
        field.setKey(KEY_AUTOTEXT2);
        fieldAp.setField(field);
        
        entryAp.getItems().add(fieldAp);
        
        return entryAp;
    }
    
    /**
     *  void</br>
     * <p>Title: registDynamicProps</p>
     * <p>
     *    Description:
     * 向主实体注册动态添加的属性
     * </p>
     * <p>Copyright: Copyright (c) 2020</p>
     * @author xx
     * @date 2020年3月6日
     * @param param the bare_field_name
     * @return the bare_field_name
     * @param newMainType
     * @version 1.0
     */
    private void registDynamicProps(MainEntityType newMainType){
        // 向单据头动态注册一个新的文本属性
        TextProp textProp1 = new TextProp();
        
        textProp1.setName(KEY_AUTOTEXT1);   // 标识
        textProp1.setDisplayName(new LocaleString("自动文本1"));    // 标题
        
        textProp1.setDbIgnore(true);    // 此字段不需到物理表格取数
        textProp1.setAlias("aa");           // 物理字段名
        
        // 把新字段，注册到单据头
        newMainType.registerSimpleProperty(textProp1);
        
        // 向单据体动态注册一个新的文本属性
        EntryType entryType = (EntryType)newMainType.getAllEntities().get(KEY_ENTRYENTITY);
        
        TextProp textProp2 = new TextProp();
        
        textProp2.setName(KEY_AUTOTEXT2);   // 标识
        textProp2.setDisplayName(new LocaleString("自动文本2"));    // 标题
        
        textProp2.setDbIgnore(true);    // 此字段不需到物理表格取数
        textProp2.setAlias("bb");           // 物理字段名
        
        // 把新字段，注册到单据体
        entryType.registerSimpleProperty(textProp2);
    }
}

重启debug启动DebugServer类后在页面注册插件
测试，如下图所示，自测通过

以上就是我关于 金蝶云苍穹动态表单插件loadCustomControlMetas事件案例 知识点的整理与总结的全部内容,希望对你有帮助。。。。。。

分割线

金蝶云苍穹动态表单插件loadCustomControlMeta
新建对话模态框动态表单向其内容区添加Flex面板(更改标识为myfieldcontainer)和单据体后保存新...
金蝶云苍穹动态表单插件beforeDoOperation事件案例
新建空白动态表单添加一个按钮为其添加事件后保存以关闭事件为例，将其操作代码项更改为pay 编码重启服务后注...
金蝶云苍穹动态表单插件itemClick事件案例
新建动态表单空白页面向其添加工具栏并更改标识为tbar_main，将工具栏的第一个按钮标识更改为baritem_...
金蝶云苍穹动态表单插件afterCreateNewData事件案
新建对话框模板动态表单在内容区添加单据体后添加整数控件并更改标识为integerfieldap1后保存新建插件...
金蝶云苍穹动态表单插件registerListener事件案例
新建动态表单对话框模板新增Flex面板在内容区添加工具栏在Flex面板中，并将其中的按钮删除只剩一个，将其标识...
金蝶云苍穹如何创建动态表单？
进入路径采购云 --> 采购应用 --> 首页，若没有则新建对应的新建分组创建页面如图所示则创建完成空白...
金蝶云苍穹插件开发
选择插件基类页面类型应用场景插件基类动态表单PC端界面AbstractFormPlugin移动端界面Abstra...
金蝶云苍穹基础资料的简单介绍
产品介绍基础资料实际上是一种特殊的单据金蝶云苍穹基础资料主要为以下几点：基于单据，继承了动态表单、单据的全部...
金蝶云苍穹弹窗自定义动态表单案例
前置条件新建请假申请单单据新建请假类型基础资料新建请假初始天数基础资料新建对话框动态表单编码请假申请单...
金蝶云苍穹插件开发之动态表单界面初始化事件测试
新建基础资料如图所示为我所新建的基础资料，新建步骤省略新建插件类如图所示为我所新建的插件类 DemoForm...