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 Classes Modifier and Type Class Description static class
DataTableBase.PropertyKeys
-
Nested classes/interfaces inherited from class org.primefaces.component.api.UIPageableData
UIPageableData.InternalPropertyKeys
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
DEFAULT_RENDERER
-
Fields 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_LABEL
-
Fields 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_KEY
-
Fields inherited from interface org.primefaces.component.api.UITable
GLOBAL_FILTER_COMPONENT_ID
-
Fields inherited from interface org.primefaces.component.api.Widget
ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY
-
-
Constructor Summary
Constructors Constructor Description DataTableBase()
-
Method Summary
-
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, updatePaginationData
-
Methods inherited from class org.primefaces.component.api.UIData
encodeBegin, getClientId, getContainerClientId, getDataModel, getIterableChildren, getRowIndex, getRowIndexVar, invokeOnComponent, isLazy, isNestedWithinIterator, isRowStatePreserved, markInitialState, preDecode, preEncode, preUpdate, preValidate, process, processChildren, processColumnFacets, processDecodes, processFacets, processPhase, processUpdates, processValidators, requiresColumns, restoreDescendantState, restoreDescendantState, restoreState, saveDescendantState, saveDescendantState, saveState, setDataModel, setId, setLazy, setRowIndex, setRowIndexVar, setRowModel, setRowStatePreserved, shouldProcessChild, shouldSkipChildren, shouldVisitChildren, visitColumnContent, visitColumnFacets, visitColumnGroup, visitColumnsAndColumnFacets, visitFacets, visitRows, visitTree
-
Methods inherited from class javax.faces.component.UIData
broadcast, createUniqueId, getFirst, getFooter, getHeader, getRowCount, getRowData, getValue, getVar, isRowAvailable, queueEvent, setFooter, setHeader, setValue, setValueBinding, setValueExpression, setVar
-
Methods 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, unsubscribeFromEvent
-
Methods 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, setInView
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
-
Methods inherited from interface org.primefaces.component.api.ColumnAware
collectColumns, findColumn, findColumnInGroup, forEachColumn, forEachColumn, 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, resetMultiViewState, restoreMultiViewState
-
Methods inherited from interface org.primefaces.component.api.Pageable
getClientId, getFacet, getFirst, getFooter, getHeader, getRowCount
-
Methods inherited from interface org.primefaces.component.api.PrimeClientBehaviorHolder
getBehaviorEventMapping
-
Methods inherited from interface org.primefaces.component.api.UITable
compare, decodeColumnDisplayOrderState, decodeColumnResizeState, decodeColumnTogglerState, getActiveFilterMeta, getActiveSortMeta, getClientId, getColumnsWidthForClientSide, getConvertedFieldValue, getFilterByAsMap, getFilterComponent, getFilterValue, getHeaderRow, getHighestPriorityActiveSortMeta, getSortByAsMap, getSortMetaAsString, getVar, getWidth, initFilterBy, initSortBy, isColumnFilterable, isColumnSortable, isDefaultFilter, isDefaultSort, isFilterByAsMapDefined, isFilteringCurrentlyActive, isFilteringEnabled, isSortingCurrentlyActive, isSortingEnabled, setDefaultFilter, setDefaultSort, setFilterByAsMap, setSortByAsMap, setWidth, updateFilterByValuesWithFilterRequest, updateFilterByWithGlobalFilter, updateFilterByWithMVS, updateFilterByWithUserFilterBy, updateSortByWithMVS, updateSortByWithUserSortBy
-
Methods inherited from interface org.primefaces.component.api.Widget
resolveWidgetVar, resolveWidgetVar
-
-
-
-
Field Detail
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
DEFAULT_RENDERER
public static final String DEFAULT_RENDERER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjavax.faces.component.UIData
-
getWidgetVar
public String getWidgetVar()
-
setWidgetVar
public void setWidgetVar(String widgetVar)
-
isScrollable
public boolean isScrollable()
-
setScrollable
public void setScrollable(boolean scrollable)
-
getScrollHeight
public String getScrollHeight()
-
setScrollHeight
public void setScrollHeight(String scrollHeight)
-
getScrollWidth
public String getScrollWidth()
-
setScrollWidth
public void setScrollWidth(String scrollWidth)
-
getSelectionMode
public String getSelectionMode()
-
setSelectionMode
public void setSelectionMode(String selectionMode)
-
getSelection
public Object getSelection()
-
setSelection
public void setSelection(Object selection)
-
getStyle
public String getStyle()
-
setStyle
public void setStyle(String style)
-
getStyleClass
public String getStyleClass()
-
setStyleClass
public void setStyleClass(String styleClass)
-
isLiveScroll
public boolean isLiveScroll()
-
setLiveScroll
public void setLiveScroll(boolean liveScroll)
-
getRowStyleClass
public String getRowStyleClass()
-
setRowStyleClass
public void setRowStyleClass(String rowStyleClass)
-
getOnExpandStart
public String getOnExpandStart()
-
setOnExpandStart
public void setOnExpandStart(String onExpandStart)
-
isResizableColumns
public boolean isResizableColumns()
-
setResizableColumns
public void setResizableColumns(boolean resizableColumns)
-
getScrollRows
public int getScrollRows()
-
setScrollRows
public void setScrollRows(int scrollRows)
-
getRowKey
public String getRowKey()
-
setRowKey
public void setRowKey(String rowKey)
-
getFilterEvent
public String getFilterEvent()
-
setFilterEvent
public void setFilterEvent(String filterEvent)
-
getFilterDelay
public int getFilterDelay()
-
setFilterDelay
public void setFilterDelay(int filterDelay)
-
getTableStyle
public String getTableStyle()
-
setTableStyle
public void setTableStyle(String tableStyle)
-
getTableStyleClass
public String getTableStyleClass()
-
setTableStyleClass
public void setTableStyleClass(String tableStyleClass)
-
isDraggableColumns
public boolean isDraggableColumns()
-
setDraggableColumns
public void setDraggableColumns(boolean draggableColumns)
-
isEditable
public boolean isEditable()
-
setEditable
public void setEditable(boolean editable)
-
getFilteredValue
public List<?> getFilteredValue()
-
setFilteredValue
public void setFilteredValue(List<?> filteredValue)
-
getSortMode
public String getSortMode()
-
setSortMode
public void setSortMode(String sortMode)
-
getSortBy
public Object getSortBy()
- Specified by:
getSortBy
in interfaceUITable<DataTableState>
-
setSortBy
public void setSortBy(Object sortBy)
- Specified by:
setSortBy
in interfaceUITable<DataTableState>
-
isAllowUnsorting
public boolean isAllowUnsorting()
-
setAllowUnsorting
public void setAllowUnsorting(boolean allowUnsorting)
-
getEditMode
public String getEditMode()
-
setEditMode
public void setEditMode(String editMode)
-
isEditingRow
public boolean isEditingRow()
-
setEditingRow
public void setEditingRow(boolean editingRow)
-
getCellSeparator
public String getCellSeparator()
-
setCellSeparator
public void setCellSeparator(String cellSeparator)
-
getSummary
public String getSummary()
-
setSummary
public void setSummary(String summary)
-
getFrozenRows
public int getFrozenRows()
-
setFrozenRows
public void setFrozenRows(int frozenRows)
-
setDir
public void setDir(String dir)
-
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
public String getRowSelectMode()
-
setRowSelectMode
public void setRowSelectMode(String rowSelectMode)
-
getRowExpandMode
public String getRowExpandMode()
-
setRowExpandMode
public void setRowExpandMode(String rowExpandMode)
-
getDataLocale
public Object getDataLocale()
-
setDataLocale
public void setDataLocale(Object dataLocale)
-
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
public String getTabindex()
-
setTabindex
public void setTabindex(String tabindex)
-
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
public String getResizeMode()
-
setResizeMode
public void setResizeMode(String resizeMode)
-
getAriaRowLabel
public String getAriaRowLabel()
-
setAriaRowLabel
public void setAriaRowLabel(String ariaRowLabel)
-
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:
isMultiViewState
in interfaceMultiViewStateAware<DataTableState>
-
setMultiViewState
public void setMultiViewState(boolean multiViewState)
-
getFilterBy
public Object getFilterBy()
- Specified by:
getFilterBy
in interfaceUITable<DataTableState>
-
setFilterBy
public void setFilterBy(Object filterBy)
- Specified by:
setFilterBy
in interfaceUITable<DataTableState>
-
getGlobalFilter
public String getGlobalFilter()
- Specified by:
getGlobalFilter
in interfaceUITable<DataTableState>
-
setGlobalFilter
public void setGlobalFilter(String globalFilter)
- Specified by:
setGlobalFilter
in interfaceUITable<DataTableState>
-
isGlobalFilterOnly
public boolean isGlobalFilterOnly()
- Specified by:
isGlobalFilterOnly
in interfaceUITable<DataTableState>
-
setGlobalFilterOnly
public void setGlobalFilterOnly(boolean globalFilterOnly)
- Specified by:
setGlobalFilterOnly
in interfaceUITable<DataTableState>
-
getCellEditMode
public String getCellEditMode()
-
setCellEditMode
public void setCellEditMode(String cellEditMode)
-
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
public String getSize()
-
setSize
public void setSize(String size)
-
getRowDragSelector
public String getRowDragSelector()
-
setRowDragSelector
public void setRowDragSelector(String rowDragSelector)
-
getDraggableRowsFunction
public javax.el.MethodExpression getDraggableRowsFunction()
-
setDraggableRowsFunction
public void setDraggableRowsFunction(javax.el.MethodExpression draggableRowsFunction)
-
getOnRowClick
public String getOnRowClick()
-
setOnRowClick
public void setOnRowClick(String onRowClick)
-
getEditInitEvent
public String getEditInitEvent()
-
setEditInitEvent
public void setEditInitEvent(String editInitEvent)
-
getRowSelector
public String getRowSelector()
-
setRowSelector
public void setRowSelector(String rowSelector)
-
isDisableContextMenuIfEmpty
public boolean isDisableContextMenuIfEmpty()
-
setDisableContextMenuIfEmpty
public void setDisableContextMenuIfEmpty(boolean disableContextMenuIfEmpty)
-
isEscapeText
public boolean isEscapeText()
-
setEscapeText
public void setEscapeText(boolean escapeText)
-
getRowEditMode
public String getRowEditMode()
-
setRowEditMode
public void setRowEditMode(String rowEditMode)
-
getStickyTopAt
public String getStickyTopAt()
-
setStickyTopAt
public void setStickyTopAt(String stickyTopAt)
-
getGlobalFilterFunction
public javax.el.MethodExpression getGlobalFilterFunction()
- Specified by:
getGlobalFilterFunction
in interfaceUITable<DataTableState>
-
setGlobalFilterFunction
public void setGlobalFilterFunction(javax.el.MethodExpression globalFilterFunction)
- Specified by:
setGlobalFilterFunction
in 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)
-
-