Package org.primefaces.component.api

Interface UITable<T extends UITableState>

All Superinterfaces:
ColumnAware, MultiViewStateAware<T>
All Known Implementing Classes:
DataTable, DataTableBase, TreeTable, TreeTableBase
public interface UITable<T extends UITableState> extends ColumnAware, MultiViewStateAware<T>

  • Field Details

    • GLOBAL_FILTER_COMPONENT_ID

      static final String GLOBAL_FILTER_COMPONENT_ID
      ID of the global filter component
      See Also:

  • Method Details

    • getVar

      String getVar()

    • getClientId

      String getClientId(javax.faces.context.FacesContext context)

    • initFilterBy

      default Map<String,FilterMeta> initFilterBy(javax.faces.context.FacesContext context)

    • updateFilterByWithMVS

      default void updateFilterByWithMVS(javax.faces.context.FacesContext context, Map<String,FilterMeta> tsFilterBy)

    • updateFilterByWithUserFilterBy

      default void updateFilterByWithUserFilterBy(javax.faces.context.FacesContext context, Map<String,FilterMeta> intlFilterBy, Object usrFilterBy)

    • updateFilterByWithGlobalFilter

      default void updateFilterByWithGlobalFilter(javax.faces.context.FacesContext context, Map<String,FilterMeta> filterBy)

    • isColumnFilterable

      default boolean isColumnFilterable(javax.faces.context.FacesContext context, UIColumn column)

    • updateFilterByValuesWithFilterRequest

      default void updateFilterByValuesWithFilterRequest(javax.faces.context.FacesContext context, Map<String,FilterMeta> filterBy)

    • getFilterValue

      default Object getFilterValue(UIColumn column)

    • getFilterBy

      Object getFilterBy()

    • setFilterBy

      void setFilterBy(Object filterBy)

    • isFilterByAsMapDefined

      boolean isFilterByAsMapDefined()

    • getFilterByAsMap

      Map<String,FilterMeta> getFilterByAsMap()

    • setFilterByAsMap

      void setFilterByAsMap(Map<String,FilterMeta> sortBy)

    • getActiveFilterMeta

      default Map<String,FilterMeta> getActiveFilterMeta()
      Returns actives filter meta.
      Returns:
      map with FilterMeta.getField() as key and FilterMeta as value

    • getGlobalFilter

      String getGlobalFilter()

    • setGlobalFilter

      void setGlobalFilter(String globalFilter)

    • getGlobalFilterFunction

      javax.el.MethodExpression getGlobalFilterFunction()

    • setGlobalFilterFunction

      void setGlobalFilterFunction(javax.el.MethodExpression globalFilterFunction)

    • isGlobalFilterOnly

      boolean isGlobalFilterOnly()

    • setGlobalFilterOnly

      void setGlobalFilterOnly(boolean globalFilterOnly)

    • initSortBy

      default Map<String,SortMeta> initSortBy(javax.faces.context.FacesContext context)

    • updateSortByWithMVS

      default void updateSortByWithMVS(Map<String,SortMeta> tsSortBy)

    • updateSortByWithUserSortBy

      default void updateSortByWithUserSortBy(javax.faces.context.FacesContext context, Map<String,SortMeta> intlSortBy, Object usrSortBy, AtomicBoolean sorted)

    • getHighestPriorityActiveSortMeta

      default SortMeta getHighestPriorityActiveSortMeta()

    • getActiveSortMeta

      default Map<String,SortMeta> getActiveSortMeta()
      Returns actives sort meta. See SortMeta.compareTo(SortMeta)
      Returns:
      map with SortMeta.getField() as key and SortMeta as value

    • isSortingCurrentlyActive

      default boolean isSortingCurrentlyActive()

    • isColumnSortable

      default boolean isColumnSortable(javax.faces.context.FacesContext context, UIColumn column)

    • getSortMetaAsString

      default String getSortMetaAsString()

    • isSortingEnabled

      default boolean isSortingEnabled()

    • getHeaderRow

      default HeaderRow getHeaderRow()

    • getSortByAsMap

      Map<String,SortMeta> getSortByAsMap()

    • setSortByAsMap

      void setSortByAsMap(Map<String,SortMeta> sortBy)

    • isFilteringEnabled

      default boolean isFilteringEnabled()

    • getSortBy

      Object getSortBy()

    • setSortBy

      void setSortBy(Object sortBy)

    • decodeColumnTogglerState

      default void decodeColumnTogglerState(javax.faces.context.FacesContext context)

    • decodeColumnResizeState

      default void decodeColumnResizeState(javax.faces.context.FacesContext context)

    • getWidth

      String getWidth()

    • setWidth

      void setWidth(String width)

    • decodeColumnDisplayOrderState

      default void decodeColumnDisplayOrderState(javax.faces.context.FacesContext context)

    • getColumnsWidthForClientSide

      default String getColumnsWidthForClientSide()

    • getFieldValue

      default Object getFieldValue(javax.faces.context.FacesContext context, UIColumn column)

    • getConvertedFieldValue

      default String getConvertedFieldValue(javax.faces.context.FacesContext context, UIColumn column)

    • isFilteringCurrentlyActive

      default boolean isFilteringCurrentlyActive()

    • filterAndSort

      void filterAndSort()
      Recalculates filteredValue after adding, updating or removing object to/from a filtered UITable.

    • resetColumns

      default void resetColumns()
      Resets all column related state after adding/removing/moving columns.

    • hasFooterColumn

      default boolean hasFooterColumn()

    • resolveDataLocale

      default Locale resolveDataLocale(javax.faces.context.FacesContext context)

    • getChildCount

      int getChildCount()

    • getChildren

      List<javax.faces.component.UIComponent> getChildren()

    • getDataLocale

      Object getDataLocale()