Package org.primefaces.component.datagrid

Class DataGrid

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.datagrid.DataGridBase

org.primefaces.component.datagrid.DataGrid

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, FlexAware, MultiViewStateAware<DataGridState>, Pageable, PrimeClientBehaviorHolder, TouchAware, Widget

public class DataGrid
extends DataGridBase

Nested Class Summary

Nested classes/interfaces inherited from class org.primefaces.component.datagrid.DataGridBase

DataGridBase.PropertyKeys

Nested classes/interfaces inherited from class org.primefaces.component.api.UIPageableData

UIPageableData.InternalPropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_CLASS
static final String	COMPONENT_TYPE
static final String	DATAGRID_CLASS
static final String	EMPTY_CONTENT_CLASS
static final String	FOOTER_CLASS
static final String	GRID_CONTENT_CLASS
static final String	HEADER_CLASS
static final String	TABLE_CLASS
static final String	TABLE_CONTENT_CLASS
static final String	TABLE_ROW_CLASS

Fields inherited from class org.primefaces.component.datagrid.DataGridBase

COMPONENT_FAMILY, 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 javax.faces.component.NamingContainer

SEPARATOR_CHAR

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
DataGrid()

Method Summary

Modifier and Type	Method	Description
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
Collection<String>	getEventNames()
DataGridState	getMultiViewState(boolean create)
void	loadLazyData()
void	queueEvent(javax.faces.event.FacesEvent event)
void	resetMultiViewState()
void	restoreMultiViewState()
protected boolean	shouldSkipChildren(javax.faces.context.FacesContext context)

Methods inherited from class org.primefaces.component.datagrid.DataGridBase

getColumns, getFamily, getLayout, getRowStyle, getRowStyleClass, getRowTitle, getStyle, getStyleClass, getWidgetVar, isFlex, isMultiViewState, setColumns, setFlex, setLayout, setMultiViewState, setRowStyle, setRowStyleClass, setRowTitle, setStyle, setStyleClass, setWidgetVar

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, 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, 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, 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, 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

Methods inherited from interface org.primefaces.component.api.Pageable

getClientId, getFacet, getFirst, getFooter, getHeader, getRowCount

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

• Constant Field Values

DATAGRID_CLASS

public static final String DATAGRID_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

TABLE_CONTENT_CLASS

public static final String TABLE_CONTENT_CLASS

See Also:

• Constant Field Values

EMPTY_CONTENT_CLASS

public static final String EMPTY_CONTENT_CLASS

See Also:

• Constant Field Values

TABLE_CLASS

public static final String TABLE_CLASS

See Also:

• Constant Field Values

TABLE_ROW_CLASS

public static final String TABLE_ROW_CLASS

See Also:

• Constant Field Values

GRID_CONTENT_CLASS

public static final String GRID_CONTENT_CLASS

See Also:

• Constant Field Values

COLUMN_CLASS

public static final String COLUMN_CLASS

See Also:

• Constant Field Values

Constructor Details

DataGrid

public DataGrid()

Method Details

getBehaviorEventMapping

public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

loadLazyData

public void loadLazyData()

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIData

shouldSkipChildren

protected boolean shouldSkipChildren(javax.faces.context.FacesContext context)

Overrides:

shouldSkipChildren in class UIData

restoreMultiViewState

public void restoreMultiViewState()

getMultiViewState

public DataGridState getMultiViewState(boolean create)

resetMultiViewState

public void resetMultiViewState()