Package org.primefaces.component.api

Interface ColumnAware

All Known Subinterfaces:
UITable<T>
All Known Implementing Classes:
DataTable, DataTableBase, SubTable, TreeTable, TreeTableBase
public interface ColumnAware

  • Method Details

    • forEachColumn

      default void forEachColumn(Predicate<UIColumn> callback)

    • forEachColumn

      default void forEachColumn(boolean unwrapDynamicColumns, boolean skipUnrendered, boolean skipColumnGroups, Predicate<UIColumn> callback)

    • forEachColumn

      default boolean forEachColumn(javax.faces.context.FacesContext context, javax.faces.component.UIComponent root, boolean unwrapDynamicColumns, boolean skipUnrendered, boolean skipColumnGroups, Predicate<UIColumn> callback)
      NOTE: this is for internal usage only!
      Parameters:
      context - the FacesContext
      root - the UIComponent where the search starts from
      unwrapDynamicColumns - if the callback should be called for each item of p:columns with DynamicColumn, or just once with Columns
      skipUnrendered - If unrendered components should be skipped
      skipColumnGroups - If ColumnGroup components should be skipped
      callback - The callback, which will be invoked for each column. If it returns false, the algorithm will be cancelled
      Returns:
      false when the algorithm was cancelled

    • forEachColumnGroupRow

      default boolean forEachColumnGroupRow(javax.faces.context.FacesContext context, ColumnGroup cg, boolean skipUnrendered, Predicate<Row> callback)
      Return each Row in a Column Group.
      Parameters:
      context - the FacesContext
      cg - the ColumnGroup to get
      skipUnrendered - If unrendered components should be skipped
      callback - The callback, which will be invoked for each row. If it returns false, the algorithm will be cancelled
      Returns:
      false when the algorithm was cancelled

    • invokeOnColumn

      default void invokeOnColumn(String columnKey, Consumer<UIColumn> callback)

    • invokeOnColumn

      default void invokeOnColumn(String columnKey, int rowIndex, Consumer<UIColumn> callback)

    • findColumn

      default UIColumn findColumn(String columnKey)

    • getFrozenColumnsCount

      default int getFrozenColumnsCount()

    • findColumnInGroup

      default UIColumn findColumnInGroup(String columnKey, ColumnGroup group)

    • getColumnGroup

      default ColumnGroup getColumnGroup(String type)

    • getColumns

      List<UIColumn> getColumns()

    • setColumns

      void setColumns(List<UIColumn> columns)

    • collectColumns

      default List<UIColumn> collectColumns()

    • getColumnsCount

      default int getColumnsCount()

    • getColumnsCount

      default int getColumnsCount(boolean visibleOnly)

    • getColumnsCountWithSpan

      default int getColumnsCountWithSpan()

    • getColumnsCountWithSpan

      default int getColumnsCountWithSpan(boolean visibleOnly)

    • getColumnMeta

      Map<String,ColumnMeta> getColumnMeta()

    • setColumnMeta

      void setColumnMeta(Map<String,ColumnMeta> columnMeta)

    • getOrderedColumnKeys

      default String getOrderedColumnKeys()