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

Class AbstractColumn<T,S>

java.lang.Object
org.apache.wicket.extensions.markup.html.repeater.data.table.AbstractColumn<T,S>
Type Parameters:
T - the type of the object that will be rendered in this column's cells
S - the type of the sort property
All Implemented Interfaces:
Serializable, ICellPopulator<T>, IColumn<T,S>, IStyledColumn<T,S>, IDetachable, IClusterable
Direct Known Subclasses:
AbstractExportableColumn, AbstractTreeColumn, FilteredAbstractColumn, HeaderlessColumn, LambdaColumn, PropertyColumn
public abstract class AbstractColumn<T,S> extends Object implements IStyledColumn<T,S>
A helper implementation for the IColumn interface
Author:
Igor Vaynberg ( ivaynberg )
See Also:

  • Constructor Details

    • AbstractColumn

      public AbstractColumn(IModel<String> displayModel, S sortProperty)
      Parameters:
      displayModel - model used to generate header text
      sortProperty - sort property this column represents

    • AbstractColumn

      public AbstractColumn(IModel<String> displayModel)
      Parameters:
      displayModel - model used to generate header text

  • Method Details

    • getDisplayModel

      public IModel<String> getDisplayModel()
      Returns:
      returns display model to be used for the header component

    • getSortProperty

      public S getSortProperty()
      Description copied from interface: IColumn
      Returns the property that this header sorts on. If null is returned the header will be not sortable.
      Specified by:
      getSortProperty in interface IColumn<T,S>
      Returns:
      the sort property

    • getHeader

      public Component getHeader(String componentId)
      Description copied from interface: IColumn
      Returns the component that will be used as the header for the column. This component will be contained in <span> tags.
      Specified by:
      getHeader in interface IColumn<T,S>
      Parameters:
      componentId - component id for the returned Component
      Returns:
      component that will be used as the header for the column

    • detach

      public void detach()
      Description copied from interface: IDetachable
      Detaches model after use. This is generally used to null out transient references that can be re-attached later.
      Specified by:
      detach in interface IDetachable

    • getCssClass

      public String getCssClass()
      Description copied from interface: IStyledColumn
      Returns the css class for this column.
      Specified by:
      getCssClass in interface IStyledColumn<T,S>
      Returns:
      CSS class name