Class DataTableBase
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.primefaces.component.api.UIData
org.primefaces.component.api.UIPageableData
org.primefaces.component.datatable.DataTableBase
- All Implemented Interfaces:
EventListener,javax.faces.component.behavior.ClientBehaviorHolder,javax.faces.component.NamingContainer,javax.faces.component.PartialStateHolder,javax.faces.component.StateHolder,javax.faces.component.TransientStateHolder,javax.faces.component.UniqueIdVendor,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,ColumnAware,MultiViewStateAware<DataTableState>,Pageable,PrimeClientBehaviorHolder,RTLAware,TouchAware,UITable<DataTableState>,Widget
- Direct Known Subclasses:
DataTable
public abstract class DataTableBase
extends UIPageableData
implements Widget, RTLAware, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder, UITable<DataTableState>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.primefaces.component.api.UIPageableData
UIPageableData.InternalPropertyKeys -
Field Summary
FieldsFields inherited from class org.primefaces.component.api.UIPageableData
ARIA_FIRST_PAGE_LABEL, ARIA_HEADER_LABEL, ARIA_LAST_PAGE_LABEL, ARIA_NEXT_PAGE_LABEL, ARIA_PREVIOUS_PAGE_LABEL, EMPTY_MESSAGE, PAGINATOR_ACTIVE_PAGE_CLASS, PAGINATOR_BOTTOM_CONTAINER_CLASS, PAGINATOR_BOTTOM_LEFT_CONTENT_CLASS, PAGINATOR_BOTTOM_RIGHT_CONTENT_CLASS, PAGINATOR_CURRENT_CLASS, PAGINATOR_FIRST_PAGE_ICON_CLASS, PAGINATOR_FIRST_PAGE_LINK_CLASS, PAGINATOR_JTP_INPUT_CLASS, PAGINATOR_JTP_SELECT_CLASS, PAGINATOR_LAST_PAGE_ICON_CLASS, PAGINATOR_LAST_PAGE_LINK_CLASS, PAGINATOR_NEXT_PAGE_ICON_CLASS, PAGINATOR_NEXT_PAGE_LINK_CLASS, PAGINATOR_PAGE_CLASS, PAGINATOR_PAGES_CLASS, PAGINATOR_PREV_PAGE_ICON_CLASS, PAGINATOR_PREV_PAGE_LINK_CLASS, PAGINATOR_RPP_LABEL_CLASS, PAGINATOR_RPP_OPTIONS_CLASS, PAGINATOR_TOP_CONTAINER_CLASS, PAGINATOR_TOP_LEFT_CONTENT_CLASS, PAGINATOR_TOP_RIGHT_CONTENT_CLASS, ROWS_PER_PAGE_LABELFields inherited from class javax.faces.component.UIData
COMPONENT_TYPEFields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEYFields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHARFields inherited from interface org.primefaces.component.api.UITable
GLOBAL_FILTER_COMPONENT_IDFields inherited from interface org.primefaces.component.api.Widget
ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetDir()javax.el.MethodExpressionintintintjavax.el.MethodExpressionintintgetSize()getStyle()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisReflow()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanvoidsetAllowUnsorting(boolean allowUnsorting) voidsetAriaRowLabel(String ariaRowLabel) voidsetCellEditMode(String cellEditMode) voidsetCellSeparator(String cellSeparator) voidsetClientCache(boolean clientCache) voidsetDataLocale(Object dataLocale) voidvoidsetDisableContextMenuIfEmpty(boolean disableContextMenuIfEmpty) voidsetDisabledSelection(boolean disabledSelection) voidsetDisabledTextSelection(boolean disabledTextSelection) voidsetDraggableColumns(boolean draggableColumns) voidsetDraggableRows(boolean draggableRows) voidsetDraggableRowsFunction(javax.el.MethodExpression draggableRowsFunction) voidsetEditable(boolean editable) voidsetEditingRow(boolean editingRow) voidsetEditInitEvent(String editInitEvent) voidsetEditMode(String editMode) voidsetEscapeText(boolean escapeText) voidsetExpandedRow(boolean expandedRow) voidsetExportRowTag(String exportRowTag) voidsetExportTag(String exportTag) voidsetFilterBy(Object filterBy) voidsetFilterDelay(int filterDelay) voidsetFilterEvent(String filterEvent) voidsetFrozenColumns(int frozenColumns) voidsetFrozenRows(int frozenRows) voidsetGlobalFilter(String globalFilter) voidsetGlobalFilterFunction(javax.el.MethodExpression globalFilterFunction) voidsetGlobalFilterOnly(boolean globalFilterOnly) voidsetLiveResize(boolean liveResize) voidsetLiveScroll(boolean liveScroll) voidsetLiveScrollBuffer(int liveScrollBuffer) voidsetMultiViewState(boolean multiViewState) voidsetNativeElements(boolean nativeElements) voidsetOnExpandStart(String onExpandStart) voidsetOnRowClick(String onRowClick) voidsetPartialUpdate(boolean partialUpdate) voidsetReflow(boolean reflow) voidsetRenderEmptyFacets(boolean renderEmptyFacets) voidsetResizableColumns(boolean resizableColumns) voidsetResizeMode(String resizeMode) voidsetRowDragSelector(String rowDragSelector) voidsetRowEditMode(String rowEditMode) voidsetRowExpandMode(String rowExpandMode) voidsetRowHover(boolean rowHover) voidvoidsetRowSelectMode(String rowSelectMode) voidsetRowSelector(String rowSelector) voidsetRowStyleClass(String rowStyleClass) voidsetRowTitle(String rowTitle) voidsetSaveOnCellBlur(boolean saveOnCellBlur) voidsetScrollable(boolean scrollable) voidsetScrollHeight(String scrollHeight) voidsetScrollRows(int scrollRows) voidsetScrollWidth(String scrollWidth) voidsetSelectAllFilteredOnly(boolean selectAllFilteredOnly) voidsetSelection(Object selection) voidsetSelectionMode(String selectionMode) voidsetSelectionPageOnly(boolean selectionPageOnly) voidsetShowGridlines(boolean showGridlines) voidsetShowSelectAll(boolean showSelectAll) voidvoidsetSkipChildren(boolean skipChildren) voidvoidsetSortMode(String sortMode) voidsetStickyHeader(boolean stickyHeader) voidsetStickyTopAt(String stickyTopAt) voidsetStripedRows(boolean stripedRows) voidvoidsetStyleClass(String styleClass) voidsetSummary(String summary) voidsetTabindex(String tabindex) voidsetTableStyle(String tableStyle) voidsetTableStyleClass(String tableStyleClass) voidsetVirtualScroll(boolean virtualScroll) voidsetWidgetVar(String widgetVar) Methods inherited from class org.primefaces.component.api.UIPageableData
calculateFirst, calculateRows, getCurrentPageReportTemplate, getEmptyMessage, getPage, getPageCount, getPageLinks, getPaginatorPosition, getPaginatorTemplate, getRows, getRowsPerPage, getRowsPerPageLabel, getRowsPerPageTemplate, getRowsToRender, isPaginationRequest, isPaginator, isPaginatorAlwaysVisible, isTouchable, resetRows, setCurrentPageReportTemplate, setEmptyMessage, setFirst, setPageLinks, setPaginator, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setRows, setRowsPerPage, setRowsPerPageLabel, setRowsPerPageTemplate, setTouchable, updatePaginationDataMethods inherited from class org.primefaces.component.api.UIData
encodeBegin, getClientId, getContainerClientId, getDataModel, getIterableChildren, getRowIndex, getRowIndexVar, getSavedState, invokeOnComponent, isDefaultAndEmpty, isLazy, isNestedWithinIterator, isRowStatePreserved, markInitialState, preDecode, preEncode, preUpdate, preValidate, process, processChildren, processColumnFacets, processDecodes, processFacets, processPhase, processUpdates, processValidators, requiresColumns, restoreDescendantState, restoreDescendantState, restoreState, saveDescendantState, saveDescendantState, saveInputState, saveState, setDataModel, setId, setLazy, setRowIndex, setRowIndexVar, setRowModel, setRowStatePreserved, shouldProcessChild, shouldSkipChildren, shouldVisitChildren, visitColumnContent, visitColumnFacets, visitColumnGroup, visitColumnsAndColumnFacets, visitFacets, visitRows, visitTreeMethods inherited from class javax.faces.component.UIData
broadcast, createUniqueId, getFirst, getFooter, getHeader, getRowCount, getRowData, getValue, getVar, isRowAvailable, queueEvent, setFooter, setHeader, setValue, setValueBinding, setValueExpression, setVarMethods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventMethods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInViewMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods 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, setColumnsMethods inherited from interface org.primefaces.component.api.MultiViewStateAware
getMultiViewState, resetMultiViewState, restoreMultiViewStateMethods inherited from interface org.primefaces.component.api.Pageable
getClientId, getFacet, getFirst, getFooter, getHeader, getRowCountMethods inherited from interface org.primefaces.component.api.PrimeClientBehaviorHolder
getBehaviorEventMappingMethods inherited from interface org.primefaces.component.api.UITable
compare, decodeColumnDisplayOrderState, decodeColumnResizeState, decodeColumnTogglerState, filterAndSort, getActiveFilterMeta, getActiveSortMeta, getChildCount, getChildren, getClientId, getColumnsWidthForClientSide, getConvertedFieldValue, getFieldValue, getFilterByAsMap, getFilterValue, getHeaderRow, getHighestPriorityActiveSortMeta, getSortByAsMap, getSortMetaAsString, getVar, getWidth, hasFooterColumn, initFilterBy, initSortBy, isColumnFilterable, isColumnSortable, isDefaultFilter, isDefaultSort, isFilterByAsMapDefined, isFilteringCurrentlyActive, isFilteringEnabled, isSortingCurrentlyActive, isSortingEnabled, resetColumns, setDefaultFilter, setDefaultSort, setFilterByAsMap, setSortByAsMap, setWidth, updateFilterByValuesWithFilterRequest, updateFilterByWithGlobalFilter, updateFilterByWithMVS, updateFilterByWithUserFilterBy, updateSortByWithMVS, updateSortByWithUserSortByMethods inherited from interface org.primefaces.component.api.Widget
resolveWidgetVar, resolveWidgetVar
-
Field Details
-
COMPONENT_FAMILY
- See Also:
-
DEFAULT_RENDERER
- See Also:
-
-
Constructor Details
-
DataTableBase
public DataTableBase()
-
-
Method Details
-
getFamily
- Overrides:
getFamilyin classjavax.faces.component.UIData
-
getWidgetVar
-
setWidgetVar
-
isScrollable
public boolean isScrollable() -
setScrollable
public void setScrollable(boolean scrollable) -
getScrollHeight
-
setScrollHeight
-
getScrollWidth
-
setScrollWidth
-
getSelectionMode
-
setSelectionMode
-
getSelection
-
setSelection
-
getStyle
-
setStyle
-
getStyleClass
-
setStyleClass
-
isLiveScroll
public boolean isLiveScroll() -
setLiveScroll
public void setLiveScroll(boolean liveScroll) -
getRowStyleClass
-
setRowStyleClass
-
getRowTitle
-
setRowTitle
-
getOnExpandStart
-
setOnExpandStart
-
isResizableColumns
public boolean isResizableColumns() -
setResizableColumns
public void setResizableColumns(boolean resizableColumns) -
getScrollRows
public int getScrollRows() -
setScrollRows
public void setScrollRows(int scrollRows) -
getRowKey
-
setRowKey
-
getFilterEvent
-
setFilterEvent
-
getFilterDelay
public int getFilterDelay() -
setFilterDelay
public void setFilterDelay(int filterDelay) -
getTableStyle
-
setTableStyle
-
getTableStyleClass
-
setTableStyleClass
-
isDraggableColumns
public boolean isDraggableColumns() -
setDraggableColumns
public void setDraggableColumns(boolean draggableColumns) -
isEditable
public boolean isEditable() -
setEditable
public void setEditable(boolean editable) -
getSortMode
-
setSortMode
-
getSortBy
- Specified by:
getSortByin interfaceUITable<DataTableState>
-
setSortBy
- Specified by:
setSortByin interfaceUITable<DataTableState>
-
isAllowUnsorting
public boolean isAllowUnsorting() -
setAllowUnsorting
public void setAllowUnsorting(boolean allowUnsorting) -
getEditMode
-
setEditMode
-
isEditingRow
public boolean isEditingRow() -
setEditingRow
public void setEditingRow(boolean editingRow) -
getCellSeparator
-
setCellSeparator
-
getSummary
-
setSummary
-
getFrozenRows
public int getFrozenRows() -
setFrozenRows
public void setFrozenRows(int frozenRows) -
getDir
-
setDir
-
isLiveResize
public boolean isLiveResize() -
setLiveResize
public void setLiveResize(boolean liveResize) -
isStickyHeader
public boolean isStickyHeader() -
setStickyHeader
public void setStickyHeader(boolean stickyHeader) -
isExpandedRow
public boolean isExpandedRow() -
setExpandedRow
public void setExpandedRow(boolean expandedRow) -
isDisabledSelection
public boolean isDisabledSelection() -
setDisabledSelection
public void setDisabledSelection(boolean disabledSelection) -
getRowSelectMode
-
setRowSelectMode
-
getRowExpandMode
-
setRowExpandMode
-
getDataLocale
-
setDataLocale
-
isNativeElements
public boolean isNativeElements() -
setNativeElements
public void setNativeElements(boolean nativeElements) -
getFrozenColumns
public int getFrozenColumns() -
setFrozenColumns
public void setFrozenColumns(int frozenColumns) -
isDraggableRows
public boolean isDraggableRows() -
setDraggableRows
public void setDraggableRows(boolean draggableRows) -
isSkipChildren
public boolean isSkipChildren() -
setSkipChildren
public void setSkipChildren(boolean skipChildren) -
isDisabledTextSelection
public boolean isDisabledTextSelection() -
setDisabledTextSelection
public void setDisabledTextSelection(boolean disabledTextSelection) -
getTabindex
-
setTabindex
-
isReflow
public boolean isReflow() -
setReflow
public void setReflow(boolean reflow) -
getLiveScrollBuffer
public int getLiveScrollBuffer() -
setLiveScrollBuffer
public void setLiveScrollBuffer(int liveScrollBuffer) -
isRowHover
public boolean isRowHover() -
setRowHover
public void setRowHover(boolean rowHover) -
getResizeMode
-
setResizeMode
-
getAriaRowLabel
-
setAriaRowLabel
-
isSaveOnCellBlur
public boolean isSaveOnCellBlur() -
setSaveOnCellBlur
public void setSaveOnCellBlur(boolean saveOnCellBlur) -
isClientCache
public boolean isClientCache() -
setClientCache
public void setClientCache(boolean clientCache) -
isMultiViewState
public boolean isMultiViewState()- Specified by:
isMultiViewStatein interfaceMultiViewStateAware<DataTableState>
-
setMultiViewState
public void setMultiViewState(boolean multiViewState) -
getFilterBy
- Specified by:
getFilterByin interfaceUITable<DataTableState>
-
setFilterBy
- Specified by:
setFilterByin interfaceUITable<DataTableState>
-
getGlobalFilter
- Specified by:
getGlobalFilterin interfaceUITable<DataTableState>
-
setGlobalFilter
- Specified by:
setGlobalFilterin interfaceUITable<DataTableState>
-
isGlobalFilterOnly
public boolean isGlobalFilterOnly()- Specified by:
isGlobalFilterOnlyin interfaceUITable<DataTableState>
-
setGlobalFilterOnly
public void setGlobalFilterOnly(boolean globalFilterOnly) - Specified by:
setGlobalFilterOnlyin interfaceUITable<DataTableState>
-
getCellEditMode
-
setCellEditMode
-
isVirtualScroll
public boolean isVirtualScroll() -
setVirtualScroll
public void setVirtualScroll(boolean virtualScroll) -
isStripedRows
public boolean isStripedRows() -
setStripedRows
public void setStripedRows(boolean stripedRows) -
isShowGridlines
public boolean isShowGridlines() -
setShowGridlines
public void setShowGridlines(boolean showGridlines) -
getSize
-
setSize
-
getRowDragSelector
-
setRowDragSelector
-
getDraggableRowsFunction
public javax.el.MethodExpression getDraggableRowsFunction() -
setDraggableRowsFunction
public void setDraggableRowsFunction(javax.el.MethodExpression draggableRowsFunction) -
getOnRowClick
-
setOnRowClick
-
getEditInitEvent
-
setEditInitEvent
-
getRowSelector
-
setRowSelector
-
isDisableContextMenuIfEmpty
public boolean isDisableContextMenuIfEmpty() -
setDisableContextMenuIfEmpty
public void setDisableContextMenuIfEmpty(boolean disableContextMenuIfEmpty) -
isEscapeText
public boolean isEscapeText() -
setEscapeText
public void setEscapeText(boolean escapeText) -
getRowEditMode
-
setRowEditMode
-
getStickyTopAt
-
setStickyTopAt
-
getGlobalFilterFunction
public javax.el.MethodExpression getGlobalFilterFunction()- Specified by:
getGlobalFilterFunctionin interfaceUITable<DataTableState>
-
setGlobalFilterFunction
public void setGlobalFilterFunction(javax.el.MethodExpression globalFilterFunction) - Specified by:
setGlobalFilterFunctionin interfaceUITable<DataTableState>
-
isRenderEmptyFacets
public boolean isRenderEmptyFacets() -
setRenderEmptyFacets
public void setRenderEmptyFacets(boolean renderEmptyFacets) -
isSelectionPageOnly
public boolean isSelectionPageOnly() -
setSelectionPageOnly
public void setSelectionPageOnly(boolean selectionPageOnly) -
isPartialUpdate
public boolean isPartialUpdate() -
setPartialUpdate
public void setPartialUpdate(boolean partialUpdate) -
isShowSelectAll
public boolean isShowSelectAll() -
setShowSelectAll
public void setShowSelectAll(boolean showSelectAll) -
getExportRowTag
-
setExportRowTag
-
getExportTag
-
setExportTag
-
isSelectAllFilteredOnly
public boolean isSelectAllFilteredOnly() -
setSelectAllFilteredOnly
public void setSelectAllFilteredOnly(boolean selectAllFilteredOnly)
-