报表界面插件-插件基类

栏目:云苍穹知识作者:金蝶来源:金蝶云社区发布:2024-09-23浏览:1

报表界面插件-插件基类

1 插件介绍

报表界面插件基类为 AbstractReportFormPlugin,继承自动态表单界面插件基类AbstractFormPlugin。

主要作用:

    1、获取查询参数;

    2、返回报表的视图view;

    3、处理数据行;

    4、设置表头是否支持过滤和排序;

    5、自定义报表导出时的融合列规则;

    6、重设前端展示的数据行数等等。

    

基类定义:

package kd.bos.bill;
public class AbstractReportFormPlugin extends AbstractFormPlugin  {


常用方法:


方法名参数返回值作用
protected getQueryParam()
ReportQueryParam返回查询参数对象,不用重写
public getView()
IReportView
返回报表视图
public packageData
PackageDataEvent
发送到前端的数据打包事件
public setSortAndFilterList<SortAndFilterEvent>
设置过滤排序列
public verifyQueryReportQueryParam boolean查询前条件验证
public resetDataCount
int重设前端展示的数据行数
public setMergeColumsList<String> columns
自定义指定报表融合列
public setSortAndFilterList<SortAndFilterEvent> allColumns
设置表头是否支持过滤和排序


2 创建并注册插件

注册报表插件方式,与动态表单基类插件一致,只是插件继承基类必须为AbstractReportFormPlugin,重写基类方法,实现具体业务逻辑。

示例

public class ReportFormPlugin extends AbstractReportFormPlugin {


    /**
     * 设置过滤排序列
     *
     * @param allColumns 报表列
     */
    @Override
    public void setSortAndFilter(List<SortAndFilterEvent> allColumns) {
        super.setSortAndFilter(allColumns);
        for (SortAndFilterEvent ent : allColumns) {
            ent.setFilter(true);
            ent.setSort(true);
        }
    }

    /**
     * 表格列创建完成后事件
     *
     * @param event 报表列
     */
    @Override
    public void afterCreateColumn(CreateColumnEvent event) {
        super.afterCreateColumn(event);
        List<AbstractReportColumn> columns = event.getColumns();
        for (AbstractReportColumn column : columns) {
            if (column instanceof ReportColumn) {
                ReportColumn reportColumn = (ReportColumn) column;
                if (reportColumn.getFieldKey().equals("textareafield1")) {
                    reportColumn.setHide(false);
                }
            }
        }
    }

    /**
     * 重设前端展示的数据行数
     */
    @Override
    public Integer resetDataCount(){
        super.resetDataCount();
        return 10;
    }

}


3 注册插件位置

【报表】→【表单根节点】→【插件】控件属性。

路径示例

kd.bos.plugin.test.ReportFormPlugin



报表界面插件-插件基类

1 插件介绍报表界面插件基类为 AbstractReportFormPlugin,继承自动态表单界面插件基类AbstractFormPlugin。主要作用: 1、获取查询参...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息