Method Detail

• protected void $afterListDataTable(Map result)

  获得数据列表后、渲染结果前的事件

  可以通过重载本方法，往 result 里传些自定义的数据，然后在前台使用 o.dataTable.on 绑定 draw 事件、获得 json 数据。

  再例如，可以在 data 列表添加一行合计数据，前台自动渲染。

  Parameters:

  result - 包括 [data: list, recordsFiltered: filtered, recordsTotal: total] 的列表数据

• @Action@grails.web.Action @Transactional@grails.transaction.Transactional(readOnly = true) Object exportAttachments()

  根据当前列表的查询条件，导出文档中的所有附件

  Parameters:

  downloadName - 下载的压缩包名称，会自动添加时间后缀和 zip 扩展名

  folderField - 用于生成压缩包中文档子文件夹名称的属性名，如 title，默认为 id

• @Action@grails.web.Action @Transactional@grails.transaction.Transactional(readOnly = true) Object exportDataTable()

  根据当前列表的排序和查询条件，导出列表为 Excel

• protected Map getDataTable(List<Map> listMapping, Map params, Map options)

  获得基于 DataTable 的列表视图的返回结果

  Returns:

  [draw: x, error: x, recordsTotal: x, recordsFiltered: x, data: x]

  Parameters:

  options.where - 补充的查询条件，如鉴权条件等

• protected String getDocumentPermissionHql(Class clazz, String alias, String prefix)

  获得业务文档鉴权的 hql 部分

  Returns:

  形如 “id in (...)” 的 hql 片段

  Parameters:

  clazz - 业务文档的 Domain 类，null 则从 scaffold 取

  alias - 表的别名，如 d

  prefix - 前缀，如 and

• protected List<Map> getExportDataTableColumns()

  获得 exportDataTable 要导出的列定义，供用户选择

  如下面的 Map 列表：
   name : 字段名称；
       title: 字段显示名；
       type : 字段 java 类型，如 java.lang.String

• protected List<Map> getExportDataTableColumnsChildren()

  获得 exportDataTable 要导出的子文档的列定义，供用户选择

  需要返回形如如下面的 Map 列表：
   children     : 父文档中关联子文档的属性名称，如 children；
       childrenTitle: 父文档中关联子文档的属性显示名；
       clazz        : 子文档的 Domain 类名，如 "bropen.bpmlite.DocumentChild"；
       parent       : 子文档中关联父文档的属性名称，如 parent；
       name         : 子文档的字段名称；
       title        : 子文档的字段显示名；
       type         : 子文档的字段 java 类型全名，如 "java.lang.String"]

• protected Class getListClass(String actionName)

  获得列表要查询的 Domain 类

  比如脚手架控制器模板 ScaffoldController 中，固定返回为控制器类的泛型或 _scaffold 属性。

  Parameters:

  actionName - 当前操作名称

• protected List<Map> getListMapping(Map params, String viewPath)

• protected Map handleGetDataTableSearchParams(Map params)

  合并查询参数：将 search.precondition 拼接到 search.where 中

  Returns:

  合并后的 params

• protected boolean listDataTable(String viewPath)

  渲染 DataTable 的列表视图

  通常被 list 操作调用。

  前台调用参见 _datatables.js 方法 getData。

  Parameters:

  params.draw - 如果为空，则渲染视图；
  否则通常为 ajax 请求，其值由 datatable 自动生成（从 1 开始每次请求自动加一），并返回当前页的 JSON 结果；
  此外，如果 draw 有值、且 cacheOnly 也有值，则返回数据缓存的 key。

  params.ns - 列表定义（listFields）的命名空间

  params.offset - 翻页参数：起始序号

  params.max - 翻页参数：每页最多显示条数

  params.all - 翻页参数：所有数据（忽略 max）

  params.sort.xxx - 排序参数，可以有多个，如 sort.creator_name = asc

  params.search.where - 查询条件，如 {"_creator.name":{"~":"x"}}

  params.search.precondition - 前置查询条件，会限制返回结果中的 total，并且自动拼接到 search.where 作为查询条件的一部分

  params.search.raw - 对于 like 表达式，是否需要进行语法分析（比如括号、引号、加减号等分隔符）；如果为 true 则无需进行分析

  params.listMapping - 列表定义（JSON 格式，简化了的 listFields）

  params.cacheOnly - 导出列表（exportDataTable）或导出附件（exportAttachments）等操作时， 加上本参数，获得所有数据后，直接将数据缓存下来，并返回数据缓存的 key；此时 all 通常为 true。

  viewPath - 渲染列表视图的 gsp 文件路径，常见如 VIEW_PATH + "list"。

• protected void renderDataTable(Map params, Map options, String viewPath)

  See Also:

  ListFieldsTagLib.initListMapping