Module io.github.mmm.ui.api.data
Package io.github.mmm.ui.api.widget.data

Interface UiColumn<R,V>

Type Parameters:
R - type of the row data. Typically a Bean.
V - type of the value for the cells in this column.
All Superinterfaces:
AttributeReadAttached, AttributeReadEnabled, AttributeReadId, AttributeReadTitle, AttributeReadValid, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteId, AttributeWriteReadOnly, AttributeWriteResizable, AttributeWriteTitle, AttributeWriteTooltip, AttributeWriteVisible, io.github.mmm.event.EventSource<UiEvent,UiEventListener>, UiWidget
public interface UiColumn<R,V> extends UiWidget, AttributeWriteTitle, AttributeWriteResizable
UiWidget for a column of a UiAbstractDataWidget.
By default a column is read-only. If you set read-only to false, the cells in this column will be editable. In case you set read-only fixed to Boolean.TRUE, you can force the cells of this row to be immutable even for inline editing.
Since:
1.0.0

  • Method Details

    • isFiltering

      boolean isFiltering()
      Returns:
      true if this column allows filtering, false otherwise. Typically filtering renders a text input at the bottom of the column header that allows to search for data in the cells. All rows that have values in this column which do not contain the filter text will be hidden from the data widget.

    • setFiltering

      void setFiltering(boolean filtering)
      Parameters:
      filtering -

    • getFilterText

      String getFilterText()
      Returns:
      the current filter text for filtering.

    • getSortOrder

      io.github.mmm.base.sort.SortOrder getSortOrder()
      Returns:
      the current SortOrder of this column or null if unsorted.

    • isSortable

      default boolean isSortable()
      Returns:
      true if a sort comparator is not null and the data can be sorted according to this column, false otherwise.

    • getSortComparator

      Comparator<V> getSortComparator()
      Returns:
      the Comparator used to sort the values. May be null to disable sorting.

    • setSortComparator

      void setSortComparator(Comparator<V> sortComparator)
      Parameters:
      sortComparator - the new value of getSortComparator(). May be null to disable sorting.
      See Also:

    • isEditable

      default boolean isEditable()
      Returns:
      true if this column is editable so the end-user can potentially edit the cell values of this column with inline editing.
      See Also:

    • setEditable

      default void setEditable(boolean editable)
      Parameters:
      editable - the new value of isEditable().
      See Also: