Skip to content

布局定义 @Layout ​

版本支持:1.12.0 及以上版本

@Layout 注解用于定义页面的布局、分页方式、列固定等 UI 行为。

代码示例 ​

java
@Erupt(
       name = "Erupt",
       orderBy = "EruptTest.no desc",
       layout = @Layout(
           // 固定前三列
           tableLeftFixed = 3, 
           // 使用前端分页
           pagingType = Layout.PagingType.FRONT,
           // 每页显示 20 条数据
           pageSize = 20
        )
)
public class EruptTest extends BaseModel {
    
}

注解定义与属性说明 ​

java
public @interface Layout {

    // 表单大小
    FormSize formSize() default FormSize.DEFAULT;

    // 分步表单向导模式(2.1.1+)
    boolean formSteps() default false;

    // 表格左侧列固定数量
    int tableLeftFixed() default 0;

    // 表格右侧列固定数量
    int tableRightFixed() default 0;

    // 分页方式
    PagingType pagingType() default PagingType.BACKEND;

    // 分页大小
    int pageSize() default 10;

    // 可选分页数
    int[] pageSizes() default {10, 20, 30, 50, 100, 300, 500};

    // 页面数据更新时间,单位:毫秒 1.12.13 及以上版本支持
    int refreshTime() default -1;

    // 表格总宽度,不配置则根据字段数量自动计算 1.12.20 及以上版本支持
    // 配置示例 tableWidth = "1000px"
    String tableWidth() default "";

    // 表格操作区宽度,不配置则根据字段数量自动计算 1.12.21 及以上版本支持
    // 配置示例 tableOperatorWidth = "100px"
    String tableOperatorWidth() default "";

    // 将表格行的查看详情、修改、删除按钮折叠到下拉菜单(2.0.0+)
    boolean collapseActionButton() default false;

    // 单元格超出列宽时是否以省略号截断,false 则换行显示,同时保证操作列的按钮全部可见(2.3.0+)
    boolean tableTruncate() default true;

    enum FormSize {
        // 默认布局,每行显示三个表单组件
        DEFAULT, 
        // 整行布局,每行显示一个表单组件
        FULL_LINE
    }

    enum PagingType {
        // 后端分页
        BACKEND,
        // 前端分页
        FRONT,
        // 不分页,最多显示:pageSizes[pageSizes.length - 1] * 10 条
        NONE
    }

}

FormSize ​

用于控制表单组件的布局方式:

  • DEFAULT:默认布局,每行最多显示三个表单组件
  • FULL_LINE:整行布局,每行只显示一个表单组件,使其占据整行宽度

PagingType ​

用于定义表格的分页方式:

  • BACKEND:后端分页(默认),每次翻页时向服务器请求数据
  • FRONT:前端分页,一次性加载所有数据到前端,由前端处理分页逻辑
  • NONE:不分页

formSteps 分步表单 v2.1.1+ ​

设置 formSteps = true 后,表单将渲染为分步向导(Step Wizard)模式:以 DIVIDE 分割线字段为分步边界,逐步填写。

详见独立文档:分步表单 formSteps

collapseActionButton v2.0.0+ ​

设置 collapseActionButton = true 后,表格每行的查看详情、修改、删除按钮将折叠到一个下拉菜单中,节省操作列宽度,使表格更紧凑。

java
@Erupt(
    name = "示例",
    layout = @Layout(collapseActionButton = true)
)

tableTruncate 单元格换行 v2.3.0+ ​

表格默认把超出列宽的内容截断为省略号,悬浮查看完整值。设置 tableTruncate = false 后,单元格改为换行显示,长文本、多标签、多按钮都能一次看全:

java
@Erupt(
    name = "示例",
    layout = @Layout(tableTruncate = false)
)
  • 数据列去掉 nowrap / 省略号,按内容自动换行
  • 操作列按一行图标的宽度计算,多出的按钮顺延到下一行——行操作很多的模型不再有按钮被省略号吞掉
  • 行高随内容变化,因此这类表格不启用固定行高的虚拟滚动,数据量特别大的模型建议保持默认值

列固定(Fixed Columns) ​

通过 tableLeftFixed 和 tableRightFixed 属性可以锁定表格左右两侧的列,使其在水平滚动时保持可见,提升数据查看体验。

贡献者

The avatar of contributor named as YuePeng YuePeng

页面历史

Released under the Apache-2.0 License.