Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.primefaces.component.datatable
Class DataTable

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIData
              extended by org.primefaces.component.api.UIData
                  extended by org.primefaces.component.datatable.DataTable
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, Widget
public class DataTable
extends UIData
implements Widget, javax.faces.component.behavior.ClientBehaviorHolder

Nested Class Summary
protected static class DataTable.PropertyKeys
           
 
Field Summary
static String CELL_EDITOR_CLASS
           
static String CELL_EDITOR_INPUT_CLASS
           
static String CELL_EDITOR_OUTPUT_CLASS
           
static String COLUMN_CONTENT_WRAPPER
           
static String COLUMN_FILTER_CLASS
           
static String COLUMN_FOOTER_CLASS
           
static String COLUMN_FOOTER_CONTAINER_CLASS
           
static String COLUMN_HEADER_CLASS
           
static String COLUMN_HEADER_CONTAINER_CLASS
           
static String COLUMN_INPUT_FILTER_CLASS
           
static String COLUMN_RESIZER_CLASS
           
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String CONTAINER_CLASS
           
static String DATA_CLASS
           
static String DYNAMIC_COLUMN_HEADER_CLASS
           
static String EDITABLE_COLUMN_CLASS
           
static String EMPTY_MESSAGE_ROW_CLASS
           
static String EVEN_ROW_CLASS
           
static String EXPANDED_ROW_CLASS
           
static String EXPANDED_ROW_CONTENT_CLASS
           
static String FILTER_COLUMN_CLASS
           
static String FOOTER_CLASS
           
static String HEADER_CLASS
           
static String ODD_ROW_CLASS
           
static String RESIZABLE_COLUMN_CLASS
           
static String RESIZABLE_CONTAINER_CLASS
           
static String ROW_CLASS
           
static String ROW_EDITOR_CLASS
           
static String ROW_EDITOR_COLUMN_CLASS
           
static String ROW_TOGGLER_CLASS
           
static String SCROLLABLE_BODY_CLASS
           
static String SCROLLABLE_CONTAINER_CLASS
           
static String SCROLLABLE_FOOTER_BOX_CLASS
           
static String SCROLLABLE_FOOTER_CLASS
           
static String SCROLLABLE_HEADER_BOX_CLASS
           
static String SCROLLABLE_HEADER_CLASS
           
static String SELECTION_COLUMN_CLASS
           
static String SORTABLE_COLUMN_ASCENDING_ICON_CLASS
           
static String SORTABLE_COLUMN_CLASS
           
static String SORTABLE_COLUMN_DESCENDING_ICON_CLASS
           
static String SORTABLE_COLUMN_ICON_CLASS
           
static String SUBTABLE_FOOTER
           
static String SUBTABLE_HEADER
           
static String SUMMARY_ROW_CLASS
           
 
Fields inherited from class org.primefaces.component.api.UIData
PAGINATOR_ACTIVE_PAGE_CLASS, PAGINATOR_BOTTOM_CONTAINER_CLASS, PAGINATOR_CURRENT_CLASS, PAGINATOR_FIRST_PAGE_ICON_CLASS, PAGINATOR_FIRST_PAGE_LINK_CLASS, PAGINATOR_JTP_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_OPTIONS_CLASS, PAGINATOR_TOP_CONTAINER_CLASS
 
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 javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
DataTable()
           
 
Method Summary
 void clearLazyCache()
           
protected  SortOrder convertSortOrder()
           
 void enableFiltering()
           
 Column findColumn(String clientId)
           
 ColumnGroup getColumnGroup(String target)
           
 List<UIColumn> getColumns()
           
 int getColumnsCount()
           
 String getColumnSelectionMode()
           
 String getEmptyMessage()
           
 Collection<String> getEventNames()
           
protected  javax.faces.context.FacesContext getFacesContext()
           
 String getFamily()
           
 int getFilterDelay()
           
 List getFilteredValue()
           
 String getFilterEvent()
           
 Map<String,String> getFilters()
           
 Object getLocalSelection()
           
 String getOnExpandStart()
           
 Object getRowData(String rowKey)
           
 RowExpansion getRowExpansion()
           
 Object getRowKey()
           
 Object getRowKeyFromModel(Object object)
           
 String getRowStyleClass()
           
 int getScrollHeight()
           
 int getScrollRows()
           
 String getScrollState()
           
 int getScrollWidth()
           
 Object getSelection()
           
 String getSelectionMode()
           
 Object getSortBy()
           
 UIColumn getSortColumn()
           
 javax.el.MethodExpression getSortFunction()
           
 String getSortOrder()
           
 String getStyle()
           
 String getStyleClass()
           
 SubTable getSubTable()
           
 SummaryRow getSummaryRow()
           
 String getTableStyle()
           
 String getTableStyleClass()
           
 Object getValue()
          Override to support filtering, we return the filtered subset in getValue instead of actual data.
 String getWidgetVar()
           
 void handleAttribute(String name, Object value)
           
 boolean hasFooterColumn()
           
 boolean isBodyUpdate(javax.faces.context.FacesContext context)
           
 boolean isColumnSelectionEnabled()
           
 boolean isDraggableColumns()
           
 boolean isEditable()
           
 boolean isFilteringEnabled()
           
 boolean isLiveScroll()
           
 boolean isRequestSource(javax.faces.context.FacesContext context)
           
 boolean isReset()
           
 boolean isResizableColumns()
           
 boolean isRowEditCancelRequest(javax.faces.context.FacesContext context)
           
 boolean isRowEditRequest(javax.faces.context.FacesContext context)
           
 boolean isRowSelectionEnabled()
           
 boolean isScrollable()
           
 boolean isSelectionEnabled()
           
 boolean isSingleSelectionMode()
           
 void loadLazyData()
           
 void processUpdates(javax.faces.context.FacesContext context)
           
 void queueEvent(javax.faces.event.FacesEvent event)
           
 void reset()
           
 void resetValue()
           
 String resolveDynamicField(javax.el.ValueExpression expression)
           
protected  String resolveSortField()
           
 String resolveStaticField(javax.el.ValueExpression expression)
           
 String resolveWidgetVar()
           
 void setColumns(List<UIColumn> columns)
           
 void setDraggableColumns(boolean _draggableColumns)
           
 void setEditable(boolean _editable)
           
 void setEmptyMessage(String _emptyMessage)
           
 void setFilterDelay(int _filterDelay)
           
 void setFilteredValue(List _filteredValue)
           
 void setFilterEvent(String _filterEvent)
           
 void setFilters(Map<String,String> filters)
           
 void setLiveScroll(boolean _liveScroll)
           
 void setOnExpandStart(String _onExpandStart)
           
 void setResizableColumns(boolean _resizableColumns)
           
 void setRowKey(Object _rowKey)
           
 void setRowStyleClass(String _rowStyleClass)
           
 void setScrollable(boolean _scrollable)
           
 void setScrollHeight(int _scrollHeight)
           
 void setScrollRows(int _scrollRows)
           
 void setScrollWidth(int _scrollWidth)
           
 void setSelection(Object _selection)
           
 void setSelectionMode(String _selectionMode)
           
 void setSortBy(Object _sortBy)
           
 void setSortColumn(UIColumn column)
           
 void setSortFunction(javax.el.MethodExpression _sortFunction)
           
 void setSortOrder(String _sortOrder)
           
 void setStyle(String _style)
           
 void setStyleClass(String _styleClass)
           
 void setTableStyle(String _tableStyle)
           
 void setTableStyleClass(String _tableStyleClass)
           
 void setWidgetVar(String _widgetVar)
           
 boolean shouldEncodeFeature(javax.faces.context.FacesContext context)
           
protected  boolean shouldProcessChildren(javax.faces.context.FacesContext context)
           
 
Methods inherited from class org.primefaces.component.api.UIData
calculatePage, getClientId, getContainerClientId, getCurrentPageReportTemplate, getDataModel, getPage, getPageCount, getPageLinks, getPaginatorPosition, getPaginatorTemplate, getRowIndex, getRowIndexVar, getRowsPerPageTemplate, getRowsToRender, isLazy, isPaginationRequest, isPaginator, isPaginatorAlwaysVisible, process, processChildren, processChildrenFacets, processDecodes, processFacets, processPhase, processValidators, restoreDescendantState, restoreDescendantState, saveDescendantState, saveDescendantState, setCurrentPageReportTemplate, setDataModel, setId, setLazy, setPageLinks, setPaginator, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setRowIndex, setRowIndexVar, setRowModel, setRowsPerPageTemplate, shouldVisitChildren, shouldVisitRows, updatePaginationData, visitChildrenFacets, visitFacets, visitRows, visitTree
 
Methods inherited from class javax.faces.component.UIData
broadcast, createUniqueId, encodeBegin, getFirst, getFooter, getHeader, getRowCount, getRowData, getRows, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, restoreState, saveState, setFirst, setFooter, setHeader, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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, 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
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

CONTAINER_CLASS

public static final String CONTAINER_CLASS
See Also:
Constant Field Values

COLUMN_HEADER_CLASS

public static final String COLUMN_HEADER_CLASS
See Also:
Constant Field Values

DYNAMIC_COLUMN_HEADER_CLASS

public static final String DYNAMIC_COLUMN_HEADER_CLASS
See Also:
Constant Field Values

COLUMN_HEADER_CONTAINER_CLASS

public static final String COLUMN_HEADER_CONTAINER_CLASS
See Also:
Constant Field Values

COLUMN_FOOTER_CLASS

public static final String COLUMN_FOOTER_CLASS
See Also:
Constant Field Values

COLUMN_FOOTER_CONTAINER_CLASS

public static final String COLUMN_FOOTER_CONTAINER_CLASS
See Also:
Constant Field Values

DATA_CLASS

public static final String DATA_CLASS
See Also:
Constant Field Values

ROW_CLASS

public static final String ROW_CLASS
See Also:
Constant Field Values

EMPTY_MESSAGE_ROW_CLASS

public static final String EMPTY_MESSAGE_ROW_CLASS
See Also:
Constant Field Values

HEADER_CLASS

public static final String HEADER_CLASS
See Also:
Constant Field Values

FOOTER_CLASS

public static final String FOOTER_CLASS
See Also:
Constant Field Values

SORTABLE_COLUMN_CLASS

public static final String SORTABLE_COLUMN_CLASS
See Also:
Constant Field Values

SORTABLE_COLUMN_ICON_CLASS

public static final String SORTABLE_COLUMN_ICON_CLASS
See Also:
Constant Field Values

SORTABLE_COLUMN_ASCENDING_ICON_CLASS

public static final String SORTABLE_COLUMN_ASCENDING_ICON_CLASS
See Also:
Constant Field Values

SORTABLE_COLUMN_DESCENDING_ICON_CLASS

public static final String SORTABLE_COLUMN_DESCENDING_ICON_CLASS
See Also:
Constant Field Values

FILTER_COLUMN_CLASS

public static final String FILTER_COLUMN_CLASS
See Also:
Constant Field Values

COLUMN_FILTER_CLASS

public static final String COLUMN_FILTER_CLASS
See Also:
Constant Field Values

COLUMN_INPUT_FILTER_CLASS

public static final String COLUMN_INPUT_FILTER_CLASS
See Also:
Constant Field Values

RESIZABLE_COLUMN_CLASS

public static final String RESIZABLE_COLUMN_CLASS
See Also:
Constant Field Values

EXPANDED_ROW_CLASS

public static final String EXPANDED_ROW_CLASS
See Also:
Constant Field Values

EXPANDED_ROW_CONTENT_CLASS

public static final String EXPANDED_ROW_CONTENT_CLASS
See Also:
Constant Field Values

ROW_TOGGLER_CLASS

public static final String ROW_TOGGLER_CLASS
See Also:
Constant Field Values

EDITABLE_COLUMN_CLASS

public static final String EDITABLE_COLUMN_CLASS
See Also:
Constant Field Values

CELL_EDITOR_CLASS

public static final String CELL_EDITOR_CLASS
See Also:
Constant Field Values

CELL_EDITOR_INPUT_CLASS

public static final String CELL_EDITOR_INPUT_CLASS
See Also:
Constant Field Values

CELL_EDITOR_OUTPUT_CLASS

public static final String CELL_EDITOR_OUTPUT_CLASS
See Also:
Constant Field Values

ROW_EDITOR_COLUMN_CLASS

public static final String ROW_EDITOR_COLUMN_CLASS
See Also:
Constant Field Values

ROW_EDITOR_CLASS

public static final String ROW_EDITOR_CLASS
See Also:
Constant Field Values

SELECTION_COLUMN_CLASS

public static final String SELECTION_COLUMN_CLASS
See Also:
Constant Field Values

EVEN_ROW_CLASS

public static final String EVEN_ROW_CLASS
See Also:
Constant Field Values

ODD_ROW_CLASS

public static final String ODD_ROW_CLASS
See Also:
Constant Field Values

SCROLLABLE_CONTAINER_CLASS

public static final String SCROLLABLE_CONTAINER_CLASS
See Also:
Constant Field Values

SCROLLABLE_HEADER_CLASS

public static final String SCROLLABLE_HEADER_CLASS
See Also:
Constant Field Values

SCROLLABLE_HEADER_BOX_CLASS

public static final String SCROLLABLE_HEADER_BOX_CLASS
See Also:
Constant Field Values

SCROLLABLE_BODY_CLASS

public static final String SCROLLABLE_BODY_CLASS
See Also:
Constant Field Values

SCROLLABLE_FOOTER_CLASS

public static final String SCROLLABLE_FOOTER_CLASS
See Also:
Constant Field Values

SCROLLABLE_FOOTER_BOX_CLASS

public static final String SCROLLABLE_FOOTER_BOX_CLASS
See Also:
Constant Field Values

COLUMN_RESIZER_CLASS

public static final String COLUMN_RESIZER_CLASS
See Also:
Constant Field Values

RESIZABLE_CONTAINER_CLASS

public static final String RESIZABLE_CONTAINER_CLASS
See Also:
Constant Field Values

COLUMN_CONTENT_WRAPPER

public static final String COLUMN_CONTENT_WRAPPER
See Also:
Constant Field Values

SUBTABLE_HEADER

public static final String SUBTABLE_HEADER
See Also:
Constant Field Values

SUBTABLE_FOOTER

public static final String SUBTABLE_FOOTER
See Also:
Constant Field Values

SUMMARY_ROW_CLASS

public static final String SUMMARY_ROW_CLASS
See Also:
Constant Field Values
Constructor Detail

DataTable

public DataTable()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.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 int getScrollHeight()

setScrollHeight

public void setScrollHeight(int _scrollHeight)

getScrollWidth

public int getScrollWidth()

setScrollWidth

public void setScrollWidth(int _scrollWidth)

getSelectionMode

public String getSelectionMode()

setSelectionMode

public void setSelectionMode(String _selectionMode)

getSelection

public Object getSelection()

setSelection

public void setSelection(Object _selection)

getEmptyMessage

public String getEmptyMessage()

setEmptyMessage

public void setEmptyMessage(String _emptyMessage)

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)

getSortBy

public Object getSortBy()

setSortBy

public void setSortBy(Object _sortBy)

getSortOrder

public String getSortOrder()

setSortOrder

public void setSortOrder(String _sortOrder)

getSortFunction

public javax.el.MethodExpression getSortFunction()

setSortFunction

public void setSortFunction(javax.el.MethodExpression _sortFunction)

getScrollRows

public int getScrollRows()

setScrollRows

public void setScrollRows(int _scrollRows)

getRowKey

public Object getRowKey()

setRowKey

public void setRowKey(Object _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)

shouldEncodeFeature

public boolean shouldEncodeFeature(javax.faces.context.FacesContext context)

isRowEditRequest

public boolean isRowEditRequest(javax.faces.context.FacesContext context)

isRowEditCancelRequest

public boolean isRowEditCancelRequest(javax.faces.context.FacesContext context)

isRowSelectionEnabled

public boolean isRowSelectionEnabled()

isColumnSelectionEnabled

public boolean isColumnSelectionEnabled()

getColumnSelectionMode

public String getColumnSelectionMode()

isSelectionEnabled

public boolean isSelectionEnabled()

isSingleSelectionMode

public boolean isSingleSelectionMode()

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)
Overrides:
processUpdates in class UIData

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)
Overrides:
queueEvent in class javax.faces.component.UIData

findColumn

public Column findColumn(String clientId)

getColumnGroup

public ColumnGroup getColumnGroup(String target)

hasFooterColumn

public boolean hasFooterColumn()

loadLazyData

public void loadLazyData()

resolveSortField

protected String resolveSortField()

convertSortOrder

protected SortOrder convertSortOrder()

resolveStaticField

public String resolveStaticField(javax.el.ValueExpression expression)

resolveDynamicField

public String resolveDynamicField(javax.el.ValueExpression expression)

clearLazyCache

public void clearLazyCache()

getFilters

public Map<String,String> getFilters()

setFilters

public void setFilters(Map<String,String> filters)

isReset

public boolean isReset()

resetValue

public void resetValue()

reset

public void reset()

isFilteringEnabled

public boolean isFilteringEnabled()

enableFiltering

public void enableFiltering()

getRowExpansion

public RowExpansion getRowExpansion()

getValue

public Object getValue()
Override to support filtering, we return the filtered subset in getValue instead of actual data. In case selectableDataModel is bound, we wrap it with filtered data.

Overrides:
getValue in class javax.faces.component.UIData

getLocalSelection

public Object getLocalSelection()

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.UIComponentBase

isRequestSource

public boolean isRequestSource(javax.faces.context.FacesContext context)

isBodyUpdate

public boolean isBodyUpdate(javax.faces.context.FacesContext context)

getSubTable

public SubTable getSubTable()

getRowKeyFromModel

public Object getRowKeyFromModel(Object object)

getRowData

public Object getRowData(String rowKey)

getSummaryRow

public SummaryRow getSummaryRow()

getColumnsCount

public int getColumnsCount()

getColumns

public List<UIColumn> getColumns()

setColumns

public void setColumns(List<UIColumn> columns)

getScrollState

public String getScrollState()

shouldProcessChildren

protected boolean shouldProcessChildren(javax.faces.context.FacesContext context)
Overrides:
shouldProcessChildren in class UIData

setSortColumn

public void setSortColumn(UIColumn column)

getSortColumn

public UIColumn getSortColumn()

getFacesContext

protected javax.faces.context.FacesContext getFacesContext()
Overrides:
getFacesContext in class javax.faces.component.UIComponentBase

resolveWidgetVar

public String resolveWidgetVar()
Specified by:
resolveWidgetVar in interface Widget

handleAttribute

public void handleAttribute(String name,
                            Object value)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012. All Rights Reserved.