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

Interface SearchUIColumn

All Superinterfaces:
Field, ResultField
All Known Implementing Classes:
AbstractSearchUIColumn, MetadataSearchUIColumn, SystemSearchUIColumn
public interface SearchUIColumn extends ResultField
This class represents a result column.

  • Method Details

    • getLabel

      I18nizableText getLabel()
      Retrieves the label.
      Returns:
      the label.

    • getDescription

      I18nizableText getDescription()
      Retrieves the description.
      Returns:
      the description.

    • getWidth

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

    • isHidden

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

    • isEditable

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

    • isSortable

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

    • getDefaultSorter

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

    • getRenderer

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

    • getConverter

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

    • getWidget

      String getWidget()
      Retrieves the widget to use when editing.
      Returns:
      the widget or null if none is defined.

    • getWidgetParameters

      Map<String,I18nizableText> getWidgetParameters()
      Get the widget parameters.
      Returns:
      the widget parameters.

    • getValidator

      Validator getValidator()
      Get the validator.
      Returns:
      the validator or null if none is defined.

    • getSubColumns

      Map<String,SearchUIColumn> getSubColumns()
      Get the subcolumns informations (for repeaters for example)
      Returns:
      the full columns informations or null if none is defined.