Module org.apache.wicket.extensions
Package org.apache.wicket.extensions.markup.html.repeater.data.table

Interface IColumn<T,S>

Type Parameters:
T - the type of the object that will be rendered in this column's cells
S - the type of the sorting parameter
All Superinterfaces:
ICellPopulator<T>, IClusterable, IDetachable, Serializable
All Known Subinterfaces:
IExportableColumn<T,S>, IFilteredColumn<T,S>, IStyledColumn<T,S>, ITreeColumn<T,S>
All Known Implementing Classes:
AbstractColumn, AbstractExportableColumn, AbstractTreeColumn, ChoiceFilteredPropertyColumn, FilteredAbstractColumn, FilteredPropertyColumn, HeaderlessColumn, LambdaColumn, PropertyColumn, TextFilteredPropertyColumn, TreeColumn
public interface IColumn<T,S> extends ICellPopulator<T>
An interface that represents a column in the DefaultDataTable
Author:
Igor Vaynberg ( ivaynberg )

  • Method Summary

    Modifier and Type
    Method
    Description
    Component
    getHeader(String componentId)
    Returns the component that will be used as the header for the column.
    default int
    getHeaderColspan()
     
    default int
    getHeaderRowspan()
     
    S
    getSortProperty()
    Returns the property that this header sorts on.
    default boolean
    isSortable()
    Returns true if the header of the column should be sortable

    Methods inherited from interface org.apache.wicket.extensions.markup.html.repeater.data.grid.ICellPopulator

    populateItem

    Methods inherited from interface org.apache.wicket.model.IDetachable

    detach

  • Method Details

    • getHeader

      Component getHeader(String componentId)
      Returns the component that will be used as the header for the column. This component will be contained in <span> tags.
      Parameters:
      componentId - component id for the returned Component
      Returns:
      component that will be used as the header for the column

    • getSortProperty

      S getSortProperty()
      Returns the property that this header sorts on. If null is returned the header will be not sortable.
      Returns:
      the sort property

    • isSortable

      default boolean isSortable()
      Returns true if the header of the column should be sortable
      Returns:
      true if header should be sortable

    • getHeaderRowspan

      default int getHeaderRowspan()
      Returns:
      The number of rows the header of this column should span

    • getHeaderColspan

      default int getHeaderColspan()
      Returns:
      The number of columns the header of this column should span