Package org.primefaces.component.api
Interface UITable<T extends UITableState>
- All Superinterfaces:
ColumnAware
,MultiViewStateAware<T>
- All Known Implementing Classes:
DataTable
,DataTableBase
,TreeTable
,TreeTableBase
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiondefault int
compare
(javax.faces.context.FacesContext context, String var, SortMeta sortMeta, Object o1, Object o2, Collator collator, Locale locale) default void
decodeColumnDisplayOrderState
(javax.faces.context.FacesContext context) default void
decodeColumnResizeState
(javax.faces.context.FacesContext context) default void
decodeColumnTogglerState
(javax.faces.context.FacesContext context) void
Recalculates filteredValue after adding, updating or removing object to/from a filtered UITable.default Map<String,
FilterMeta> Returns actives filter meta.Returns actives sort meta.int
List<javax.faces.component.UIComponent>
getClientId
(javax.faces.context.FacesContext context) default String
default String
getConvertedFieldValue
(javax.faces.context.FacesContext context, UIColumn column) default Object
getFieldValue
(javax.faces.context.FacesContext context, UIColumn column) default Object
getFilterValue
(UIColumn column) javax.el.MethodExpression
default HeaderRow
default SortMeta
default String
getVar()
getWidth()
default boolean
default Map<String,
FilterMeta> initFilterBy
(javax.faces.context.FacesContext context) initSortBy
(javax.faces.context.FacesContext context) default boolean
isColumnFilterable
(javax.faces.context.FacesContext context, UIColumn column) default boolean
isColumnSortable
(javax.faces.context.FacesContext context, UIColumn column) boolean
boolean
boolean
default boolean
default boolean
boolean
default boolean
default boolean
default void
Resets all column related state after adding/removing/moving columns.void
setDefaultFilter
(boolean defaultFilter) void
setDefaultSort
(boolean defaultSort) void
setFilterBy
(Object filterBy) void
setFilterByAsMap
(Map<String, FilterMeta> sortBy) void
setGlobalFilter
(String globalFilter) void
setGlobalFilterFunction
(javax.el.MethodExpression globalFilterFunction) void
setGlobalFilterOnly
(boolean globalFilterOnly) void
void
setSortByAsMap
(Map<String, SortMeta> sortBy) void
default void
updateFilterByValuesWithFilterRequest
(javax.faces.context.FacesContext context, Map<String, FilterMeta> filterBy) default void
updateFilterByWithGlobalFilter
(javax.faces.context.FacesContext context, Map<String, FilterMeta> filterBy, AtomicBoolean filtered) default void
updateFilterByWithMVS
(javax.faces.context.FacesContext context, Map<String, FilterMeta> tsFilterBy) default void
updateFilterByWithUserFilterBy
(javax.faces.context.FacesContext context, Map<String, FilterMeta> intlFilterBy, Object usrFilterBy, AtomicBoolean filtered) default void
updateSortByWithMVS
(Map<String, SortMeta> tsSortBy) default void
updateSortByWithUserSortBy
(javax.faces.context.FacesContext context, Map<String, SortMeta> intlSortBy, Object usrSortBy, AtomicBoolean sorted) Methods inherited from interface org.primefaces.component.api.ColumnAware
collectColumns, findColumn, findColumnInGroup, forEachColumn, forEachColumn, forEachColumn, forEachColumnGroupRow, getColumnGroup, getColumnMeta, getColumns, getColumnsCount, getColumnsCount, getColumnsCountWithSpan, getColumnsCountWithSpan, getFrozenColumnsCount, getOrderedColumnKeys, invokeOnColumn, invokeOnColumn, resetDynamicColumns, setColumnMeta, setColumns
Methods inherited from interface org.primefaces.component.api.MultiViewStateAware
getMultiViewState, isMultiViewState, resetMultiViewState, restoreMultiViewState
-
Field Details
-
GLOBAL_FILTER_COMPONENT_ID
ID of the global filter component- See Also:
-
-
Method Details
-
getVar
String getVar() -
getClientId
-
initFilterBy
-
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, AtomicBoolean filtered) -
updateFilterByWithGlobalFilter
default void updateFilterByWithGlobalFilter(javax.faces.context.FacesContext context, Map<String, FilterMeta> filterBy, AtomicBoolean filtered) -
isColumnFilterable
-
updateFilterByValuesWithFilterRequest
default void updateFilterByValuesWithFilterRequest(javax.faces.context.FacesContext context, Map<String, FilterMeta> filterBy) -
getFilterValue
-
isDefaultFilter
boolean isDefaultFilter() -
setDefaultFilter
void setDefaultFilter(boolean defaultFilter) -
getFilterBy
Object getFilterBy() -
setFilterBy
-
isFilterByAsMapDefined
boolean isFilterByAsMapDefined() -
getFilterByAsMap
Map<String,FilterMeta> getFilterByAsMap() -
setFilterByAsMap
-
getActiveFilterMeta
Returns actives filter meta.- Returns:
- map with
FilterMeta.getField()
as key andFilterMeta
as value
-
getGlobalFilter
String getGlobalFilter() -
setGlobalFilter
-
getGlobalFilterFunction
javax.el.MethodExpression getGlobalFilterFunction() -
setGlobalFilterFunction
void setGlobalFilterFunction(javax.el.MethodExpression globalFilterFunction) -
isGlobalFilterOnly
boolean isGlobalFilterOnly() -
setGlobalFilterOnly
void setGlobalFilterOnly(boolean globalFilterOnly) -
initSortBy
-
updateSortByWithMVS
-
updateSortByWithUserSortBy
default void updateSortByWithUserSortBy(javax.faces.context.FacesContext context, Map<String, SortMeta> intlSortBy, Object usrSortBy, AtomicBoolean sorted) -
getHighestPriorityActiveSortMeta
-
getActiveSortMeta
Returns actives sort meta. SeeSortMeta.compareTo(SortMeta)
- Returns:
- map with
SortMeta.getField()
as key andSortMeta
as value
-
isSortingCurrentlyActive
default boolean isSortingCurrentlyActive() -
isColumnSortable
-
getSortMetaAsString
-
isSortingEnabled
default boolean isSortingEnabled() -
getHeaderRow
-
getSortByAsMap
-
setSortByAsMap
-
isFilteringEnabled
default boolean isFilteringEnabled() -
getSortBy
Object getSortBy() -
setSortBy
-
isDefaultSort
boolean isDefaultSort() -
setDefaultSort
void setDefaultSort(boolean defaultSort) -
decodeColumnTogglerState
default void decodeColumnTogglerState(javax.faces.context.FacesContext context) -
decodeColumnResizeState
default void decodeColumnResizeState(javax.faces.context.FacesContext context) -
getWidth
String getWidth() -
setWidth
-
decodeColumnDisplayOrderState
default void decodeColumnDisplayOrderState(javax.faces.context.FacesContext context) -
getColumnsWidthForClientSide
-
getFieldValue
-
getConvertedFieldValue
-
isFilteringCurrentlyActive
default boolean isFilteringCurrentlyActive() -
compare
-
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. -
getChildCount
int getChildCount() -
getChildren
List<javax.faces.component.UIComponent> getChildren()
-