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 Summary

Fields

Modifier and Type	Field	Description
static Pattern	OLD_SYNTAX_COLUMN_PROPERTY_REGEX	Backward compatibility for column properties (e.g sortBy, filterBy) using old syntax #{car[column.property]}) instead of #{column.property}

Method Summary

Modifier and Type	Method	Description
static javax.el.ValueExpression	createValueExprFromVarField(javax.faces.context.FacesContext context, String var, String field)
default void	decodeColumnDisplayOrderState(javax.faces.context.FacesContext context)
default void	decodeColumnResizeState(javax.faces.context.FacesContext context)
default void	decodeColumnTogglerState(javax.faces.context.FacesContext context)
default Map<String,FilterMeta>	getActiveFilterMeta()	Returns actives filter meta.
default Map<String,SortMeta>	getActiveSortMeta()	Returns actives sort meta.
String	getClientId(javax.faces.context.FacesContext context)
default String	getColumnsWidthForClientSide()
default String	getConvertedFieldValue(javax.faces.context.FacesContext context, UIColumn column)
Object	getFilterBy()
Map<String,FilterMeta>	getFilterByAsMap()
default Object	getFilterValue(UIColumn column)
String	getGlobalFilter()
javax.el.MethodExpression	getGlobalFilterFunction()
default HeaderRow	getHeaderRow()
default SortMeta	getHighestPriorityActiveSortMeta()
Object	getSortBy()
Map<String,SortMeta>	getSortByAsMap()
default String	getSortMetaAsString()
String	getVar()
String	getWidth()
default Map<String,FilterMeta>	initFilterBy(javax.faces.context.FacesContext context)
default Map<String,SortMeta>	initSortBy(javax.faces.context.FacesContext context)
default boolean	isColumnFilterable(UIColumn column)
default boolean	isColumnSortable(javax.faces.context.FacesContext context, UIColumn column)
boolean	isDefaultFilter()
boolean	isDefaultSort()
boolean	isFilterByAsMapDefined()
default boolean	isFilteringCurrentlyActive()
default boolean	isFilteringEnabled()
default boolean	isSortingCurrentlyActive()
default boolean	isSortingEnabled()
static String	resolveDynamicField(javax.faces.context.FacesContext context, javax.el.ValueExpression exprVE)	Get bean's property value from a value expression.
static String	resolveStaticField(javax.el.ValueExpression expression)
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	setSortBy(Object sortBy)
void	setSortByAsMap(Map<String,SortMeta> sortBy)
void	setWidth(String width)
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, 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 Detail

OLD_SYNTAX_COLUMN_PROPERTY_REGEX

static final Pattern OLD_SYNTAX_COLUMN_PROPERTY_REGEX

Backward compatibility for column properties (e.g sortBy, filterBy) using old syntax #{car[column.property]}) instead of #{column.property}

Method Detail

resolveStaticField

static String resolveStaticField(javax.el.ValueExpression expression)

resolveDynamicField

static String resolveDynamicField(javax.faces.context.FacesContext context,
                                  javax.el.ValueExpression exprVE)

Get bean's property value from a value expression. Support old syntax (e.g #{car[column.property]}) instead of #{column.property}

Parameters:

context -

exprVE -

Returns:

createValueExprFromVarField

static javax.el.ValueExpression createValueExprFromVarField(javax.faces.context.FacesContext context,
                                                            String var,
                                                            String field)

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,
                                            AtomicBoolean filtered)

updateFilterByWithGlobalFilter

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

isColumnFilterable

default boolean isColumnFilterable(UIColumn column)

updateFilterByValuesWithFilterRequest

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

getFilterValue

default Object getFilterValue(UIColumn column)

isDefaultFilter

boolean isDefaultFilter()

setDefaultFilter

void setDefaultFilter(boolean defaultFilter)

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)

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)

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

void setWidth(String width)

decodeColumnDisplayOrderState

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

getColumnsWidthForClientSide

default String getColumnsWidthForClientSide()

getConvertedFieldValue

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

isFilteringCurrentlyActive

default boolean isFilteringCurrentlyActive()