Package org.primefaces.component.datagrid

Class DataGridBase

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

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

Direct Known Subclasses:

DataGrid

public abstract class DataGridBase
extends UIPageableData
implements Widget, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder, FlexAware, MultiViewStateAware<DataGridState>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	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	COMPONENT_FAMILY
static final 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.UIData

COMPONENT_TYPE

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

Method Summary

Modifier and Type	Method	Description
int	getColumns()
String	getFamily()
String	getLayout()
String	getRowStyle()
String	getRowStyleClass()
String	getRowTitle()
String	getStyle()
String	getStyleClass()
String	getWidgetVar()
boolean	isFlex()	Use PrimeFlex (instead Grid CSS) for this component?
boolean	isMultiViewState()
void	setColumns(int columns)
void	setFlex(boolean flex)
void	setLayout(String layout)
void	setMultiViewState(boolean multiViewState)
void	setRowStyle(String rowStyle)
void	setRowStyleClass(String rowStyleClass)
void	setRowTitle(String rowTitle)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setWidgetVar(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, 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.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.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

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

Constructor Details

DataGridBase

public DataGridBase()

Method Details

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

getColumns

public int getColumns()

setColumns

public void setColumns(int columns)

getStyle

public String getStyle()

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String styleClass)

getLayout

public String getLayout()

setLayout

public void setLayout(String layout)

isMultiViewState

public boolean isMultiViewState()

Specified by:

isMultiViewState in interface MultiViewStateAware<DataGridState>

setMultiViewState

public void setMultiViewState(boolean multiViewState)

getRowStyle

public String getRowStyle()

setRowStyle

public void setRowStyle(String rowStyle)

getRowStyleClass

public String getRowStyleClass()

setRowStyleClass

public void setRowStyleClass(String rowStyleClass)

getRowTitle

public String getRowTitle()

setRowTitle

public void setRowTitle(String rowTitle)

isFlex

public boolean isFlex()

Description copied from interface: FlexAware

Use PrimeFlex (instead Grid CSS) for this component?

Specified by:

isFlex in interface FlexAware

Returns:

true to use PrimeFlex instead of Grid CSS.

setFlex

public void setFlex(boolean flex)