Package io.jmix.kanbanflowui.kit.component

Interface HasKanbanColumns

All Known Implementing Classes:
JmixKanban, Kanban, KanbanColumn
public interface HasKanbanColumns
An object that supports KanbanColumn as internal elements.

  • Method Details

    • getColumns

      List<KanbanColumn> getColumns()
      Returns:
      an unmodifiable list of all KanbanColumn, including transitive columns

    • getOwnColumns

      List<KanbanColumn> getOwnColumns()
      Returns:
      an unmodifiable list of KanbanColumn that are direct elements of this component

    • getColumnByDataField

      @Nullable KanbanColumn getColumnByDataField(@Nullable String dataField)
      Parameters:
      dataField - the dataField attribute of the column to get
      Returns:
      the column corresponding to the given column dataField, or null if no column has such dataField
      See Also:

    • removeColumn

      void removeColumn(KanbanColumn column)
      Removes a KanbanColumn from the component. Updates the client-side of the component.
      Parameters:
      column - the column to be removed, not null
      Throws:
      IllegalArgumentException - if the passed column is null

    • removeColumnByDataField

      void removeColumnByDataField(String dataField)
      Removes a KanbanColumn with the given dataField from the component.
      Parameters:
      dataField - the dataField attribute of the column
      Throws:
      IllegalArgumentException - if the passed dataField is null or the found column is not part of component

    • replaceColumn

      void replaceColumn(String dataField, KanbanColumn newColumn)
      Finds a KanbanColumn with the passed dataField and replaces it with the new one.
      Parameters:
      dataField - dataField attribute of the column being replaced
      newColumn - a column for replacement
      Throws:
      IllegalArgumentException - if any argument is null

    • addColumn

      void addColumn(KanbanColumn column)
      Adds a new column to the component.
      Parameters:
      column - column to add, not null
      Throws:
      IllegalArgumentException - if the passed column is null

    • setColumns

      void setColumns(List<KanbanColumn> columns)
      Sets a list of columns for a component.
      Parameters:
      columns - list of columns to set
      Throws:
      IllegalArgumentException - if the passed list is null