Package org.ametys.cms.search.ui.model

Interface SearchUIColumn<T extends ModelItem>

Type Parameters:
T - type of the referenced model item
All Superinterfaces:
Labelable, ModelViewItem<T>, ModifiableLabelable, ViewItem
All Known Implementing Classes:
RepeaterSearchUIColumn, ViewElementAccessorSearchUIColumn, ViewElementSearchUIColumn
public interface SearchUIColumn<T extends ModelItem> extends ModelViewItem<T>
This class represents a result column.

  • Method Details

    • getWidth

      int getWidth()
      The column's width
      Returns:
      The width

    • setWidth

      void setWidth(int width)
      Set the column's width
      Parameters:
      width - The width to set

    • isHidden

      boolean isHidden()
      Determines if the column is hidden by default
      Returns:
      true if the column is hidden by default

    • setHidden

      void setHidden(boolean hidden)
      Set the hidden property
      Parameters:
      hidden - true to hidden the columns by default

    • isEditable

      boolean isEditable()
      Determines if the property is editable
      Returns:
      true if the property is editable

    • setEditable

      void setEditable(boolean editable)
      Set the editable property
      Parameters:
      editable - true to authorized edition

    • isSortable

      boolean isSortable()
      Determines if the column is sortable
      Returns:
      true if the column is sortable

    • setSortable

      void setSortable(boolean sortable)
      Set the sortable property
      Parameters:
      sortable - true to authorized sort

    • allowSortOnMultipleJoin

      boolean allowSortOnMultipleJoin()
      Determines if sort is allowed on multiple join
      Returns:
      true if sort is allowed on multiple join, false otherwise

    • setAllowSortOnMultipleJoin

      void setAllowSortOnMultipleJoin(boolean allowSortOnMultipleJoin)
      Set the allowSortOnMultipleJoin property
      Parameters:
      allowSortOnMultipleJoin - true to authorized sort on multiple join

    • getDefaultSorter

      String getDefaultSorter()
      If the column should be the default sorter 'ASC' or 'DESC'. Null otherwise.
      Returns:
      'ASC', 'DESC' or null

    • setDefaultSorter

      void setDefaultSorter(Optional<String> defaultSorter)
      Set the default sorter property
      Parameters:
      defaultSorter - If the column should be a default sorter, 'ASC' for ascending 'DESC' for descending. Null otherwise.

    • getRenderer

      String getRenderer()
      Get the JS class name for renderer
      Returns:
      The renderer

    • setRenderer

      void setRenderer(Optional<String> renderer)
      Set the JS class name for renderer
      Parameters:
      renderer - The renderer

    • getConverter

      String getConverter()
      Get the JS class name for converting field's value
      Returns:
      The convert JS class name

    • setConverter

      void setConverter(Optional<String> converter)
      Set the JS class name for converting field's value
      Parameters:
      converter - The convert JS class name