Package org.linkki.core.ui.table.column.annotation

Annotation Type UITableColumn

  • @Retention(RUNTIME)
@Target(METHOD)
@LinkkiAspect(TableColumnAspectDefinitionCreator.class)
public @interface UITableColumn
    Annotation that allows to customize the column for a PMO's field/method that is rendered in a table column.
    Implementation Note:
    This annotation is not required for a field/method to be rendered in a column. All fields/methods with one of the @UI... annotations (@UITextField, @UICheckBox etc.) are rendered automatically. This annotation allows optional customization and can be omitted if no customization is needed.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      UITableColumn.CollapseMode collapsible
      Configures whether a column can be collapsed and whether it initially is.
      int flexGrow
      Configures the flex grow ratio for the column.
      boolean sortable
      Configures whether a column can be sorted.
      TextAlignment textAlign
      Configures the alignment of text inside the table column, as well as the header and footer.
      int width
      Configures the width in pixels for the column.

    • Field Detail

      • UNDEFINED_WIDTH

        static final int UNDEFINED_WIDTH

      • UNDEFINED_FLEX_GROW

        static final int UNDEFINED_FLEX_GROW

    • Element Detail

      • width

        int width
        Configures the width in pixels for the column.
        See Also:
        Grid.Column.setWidth(String)
        Implementation Requirements:
        The default value of -1 means that the column can be sized freely by the layout.
        Default:
        -1

      • flexGrow

        int flexGrow
        Configures the flex grow ratio for the column.
        See Also:
        Grid.Column.setFlexGrow(int)
        Implementation Requirements:
        The flex grow ratio defines what part of excess available space the layout allots to this column. If not set, the column has flex grow of 1.

        If width() is set, flexGrow() will take effect in additional to width().

        Default:
        -1

      • collapsible

        UITableColumn.CollapseMode collapsible
        Configures whether a column can be collapsed and whether it initially is.
        Implementation Note:
        Table columns are by default not collapsible.
        Default:
        org.linkki.core.ui.table.column.annotation.UITableColumn.CollapseMode.NOT_COLLAPSIBLE

      • textAlign

        TextAlignment textAlign
        Configures the alignment of text inside the table column, as well as the header and footer.

        This does not affect the alignment of text inside fields.

        Default:
        org.linkki.core.ui.aspects.types.TextAlignment.DEFAULT

      • sortable

        boolean sortable
        Configures whether a column can be sorted. The annotated method
        • must be a getter method (model objects/model attributes are not supported)
        • must return a type that is Comparable
        Default:
        false