org.primefaces.component.api

Class UIData

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

org.primefaces.component.api.UIData

All Implemented Interfaces:

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

Direct Known Subclasses:

Carousel, Columns, DataGrid, DataList, DataScroller, DataTable, Ring

public class UIData
extends javax.faces.component.UIData

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UIData.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGINATOR_ACTIVE_PAGE_CLASS
static String	PAGINATOR_BOTTOM_CONTAINER_CLASS
static String	PAGINATOR_CURRENT_CLASS
static String	PAGINATOR_FIRST_PAGE_ICON_CLASS
static String	PAGINATOR_FIRST_PAGE_LINK_CLASS
static String	PAGINATOR_JTP_CLASS
static String	PAGINATOR_LAST_PAGE_ICON_CLASS
static String	PAGINATOR_LAST_PAGE_LINK_CLASS
static String	PAGINATOR_NEXT_PAGE_ICON_CLASS
static String	PAGINATOR_NEXT_PAGE_LINK_CLASS
static String	PAGINATOR_PAGE_CLASS
static String	PAGINATOR_PAGES_CLASS
static String	PAGINATOR_PREV_PAGE_ICON_CLASS
static String	PAGINATOR_PREV_PAGE_LINK_CLASS
static String	PAGINATOR_RPP_LABEL_CLASS
static String	PAGINATOR_RPP_OPTIONS_CLASS
static String	PAGINATOR_TOP_CONTAINER_CLASS

Fields inherited from class javax.faces.component.UIData

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

Constructor Summary

Constructors

Constructor and Description
UIData()

Method Summary

Methods

Modifier and Type	Method and Description
void	calculateFirst()
void	encodeBegin(javax.faces.context.FacesContext context)
String	getClientId(javax.faces.context.FacesContext context)
String	getContainerClientId(javax.faces.context.FacesContext context)
String	getCurrentPageReportTemplate()
protected javax.faces.model.DataModel	getDataModel()
protected List<javax.faces.component.UIComponent>	getIterableChildren()
int	getPage()
int	getPageCount()
int	getPageLinks()
String	getPaginatorPosition()
String	getPaginatorTemplate()
int	getRowIndex()
String	getRowIndexVar()
String	getRowsPerPageLabel()
String	getRowsPerPageTemplate()
int	getRowsToRender()
boolean	isLazy()
boolean	isPaginationRequest(javax.faces.context.FacesContext context)
boolean	isPaginator()
boolean	isPaginatorAlwaysVisible()
boolean	isRowStatePreserved()
void	markInitialState()
protected void	process(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId)
protected void	processChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
protected void	processColumnFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	processDecodes(javax.faces.context.FacesContext context)
protected void	processFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
protected void	processPhase(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
protected boolean	requiresColumns()
protected void	restoreDescendantState()
protected void	restoreDescendantState(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
void	restoreState(javax.faces.context.FacesContext context, Object state)
protected void	saveDescendantState()
protected void	saveDescendantState(javax.faces.component.UIComponent component, javax.faces.context.FacesContext context)
Object	saveState(javax.faces.context.FacesContext context)
void	setCurrentPageReportTemplate(String _currentPageReportTemplate)
protected void	setDataModel(javax.faces.model.DataModel dataModel)
void	setId(String id)
void	setLazy(boolean _lazy)
void	setPageLinks(int _pageLinks)
void	setPaginator(boolean _paginator)
void	setPaginatorAlwaysVisible(boolean _paginatorAlwaysVisible)
void	setPaginatorPosition(String _paginatorPosition)
void	setPaginatorTemplate(String _paginatorTemplate)
void	setRowIndex(int rowIndex)
void	setRowIndexVar(String _rowIndexVar)
void	setRowModel(int rowIndex)
void	setRowsPerPageLabel(String _rowsPerPageLabel)
void	setRowsPerPageTemplate(String _rowsPerPageTemplate)
void	setRowStatePreserved(boolean _paginator)
protected boolean	shouldSkipChildren(javax.faces.context.FacesContext context)
protected boolean	shouldVisitChildren(javax.faces.component.visit.VisitContext context, boolean visitRows)
protected boolean	shouldVisitRows(javax.faces.context.FacesContext context, javax.faces.component.visit.VisitContext visitContext)
void	updatePaginationData(javax.faces.context.FacesContext context, UIData data)
protected boolean	visitColumnContent(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)
protected boolean	visitColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)
protected boolean	visitColumnGroup(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, ColumnGroup group)
protected boolean	visitColumnsAndColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows)
protected boolean	visitFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows)
protected boolean	visitRows(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows)
boolean	visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, queueEvent, setFirst, setFooter, setHeader, setRows, 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

Field Detail

PAGINATOR_TOP_CONTAINER_CLASS

public static final String PAGINATOR_TOP_CONTAINER_CLASS

See Also:

Constant Field Values

PAGINATOR_BOTTOM_CONTAINER_CLASS

public static final String PAGINATOR_BOTTOM_CONTAINER_CLASS

See Also:

Constant Field Values

PAGINATOR_PAGES_CLASS

public static final String PAGINATOR_PAGES_CLASS

See Also:

Constant Field Values

PAGINATOR_PAGE_CLASS

public static final String PAGINATOR_PAGE_CLASS

See Also:

Constant Field Values

PAGINATOR_ACTIVE_PAGE_CLASS

public static final String PAGINATOR_ACTIVE_PAGE_CLASS

See Also:

Constant Field Values

PAGINATOR_CURRENT_CLASS

public static final String PAGINATOR_CURRENT_CLASS

See Also:

Constant Field Values

PAGINATOR_RPP_OPTIONS_CLASS

public static final String PAGINATOR_RPP_OPTIONS_CLASS

See Also:

Constant Field Values

PAGINATOR_RPP_LABEL_CLASS

public static final String PAGINATOR_RPP_LABEL_CLASS

See Also:

Constant Field Values

PAGINATOR_JTP_CLASS

public static final String PAGINATOR_JTP_CLASS

See Also:

Constant Field Values

PAGINATOR_FIRST_PAGE_LINK_CLASS

public static final String PAGINATOR_FIRST_PAGE_LINK_CLASS

See Also:

Constant Field Values

PAGINATOR_FIRST_PAGE_ICON_CLASS

public static final String PAGINATOR_FIRST_PAGE_ICON_CLASS

See Also:

Constant Field Values

PAGINATOR_PREV_PAGE_LINK_CLASS

public static final String PAGINATOR_PREV_PAGE_LINK_CLASS

See Also:

Constant Field Values

PAGINATOR_PREV_PAGE_ICON_CLASS

public static final String PAGINATOR_PREV_PAGE_ICON_CLASS

See Also:

Constant Field Values

PAGINATOR_NEXT_PAGE_LINK_CLASS

public static final String PAGINATOR_NEXT_PAGE_LINK_CLASS

See Also:

Constant Field Values

PAGINATOR_NEXT_PAGE_ICON_CLASS

public static final String PAGINATOR_NEXT_PAGE_ICON_CLASS

See Also:

Constant Field Values

PAGINATOR_LAST_PAGE_LINK_CLASS

public static final String PAGINATOR_LAST_PAGE_LINK_CLASS

See Also:

Constant Field Values

PAGINATOR_LAST_PAGE_ICON_CLASS

public static final String PAGINATOR_LAST_PAGE_ICON_CLASS

See Also:

Constant Field Values

Constructor Detail

UIData

public UIData()

Method Detail

isPaginator

public boolean isPaginator()

setPaginator

public void setPaginator(boolean _paginator)

getPaginatorTemplate

public String getPaginatorTemplate()

setPaginatorTemplate

public void setPaginatorTemplate(String _paginatorTemplate)

getRowsPerPageTemplate

public String getRowsPerPageTemplate()

setRowsPerPageTemplate

public void setRowsPerPageTemplate(String _rowsPerPageTemplate)

getRowsPerPageLabel

public String getRowsPerPageLabel()

setRowsPerPageLabel

public void setRowsPerPageLabel(String _rowsPerPageLabel)

getCurrentPageReportTemplate

public String getCurrentPageReportTemplate()

setCurrentPageReportTemplate

public void setCurrentPageReportTemplate(String _currentPageReportTemplate)

getPageLinks

public int getPageLinks()

setPageLinks

public void setPageLinks(int _pageLinks)

getPaginatorPosition

public String getPaginatorPosition()

setPaginatorPosition

public void setPaginatorPosition(String _paginatorPosition)

isPaginatorAlwaysVisible

public boolean isPaginatorAlwaysVisible()

setPaginatorAlwaysVisible

public void setPaginatorAlwaysVisible(boolean _paginatorAlwaysVisible)

isLazy

public boolean isLazy()

setLazy

public void setLazy(boolean _lazy)

getRowIndexVar

public String getRowIndexVar()

setRowIndexVar

public void setRowIndexVar(String _rowIndexVar)

isRowStatePreserved

public boolean isRowStatePreserved()

Overrides:

isRowStatePreserved in class javax.faces.component.UIData

setRowStatePreserved

public void setRowStatePreserved(boolean _paginator)

Overrides:

setRowStatePreserved in class javax.faces.component.UIData

calculateFirst

public void calculateFirst()

getPage

public int getPage()

getPageCount

public int getPageCount()

getRowsToRender

public int getRowsToRender()

isPaginationRequest

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

updatePaginationData

public void updatePaginationData(javax.faces.context.FacesContext context,
                        UIData data)

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIData

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIData

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIData

processPhase

protected void processPhase(javax.faces.context.FacesContext context,
                javax.faces.event.PhaseId phaseId)

processFacets

protected void processFacets(javax.faces.context.FacesContext context,
                 javax.faces.event.PhaseId phaseId)

processColumnFacets

protected void processColumnFacets(javax.faces.context.FacesContext context,
                       javax.faces.event.PhaseId phaseId)

processChildren

protected void processChildren(javax.faces.context.FacesContext context,
                   javax.faces.event.PhaseId phaseId)

process

protected void process(javax.faces.context.FacesContext context,
           javax.faces.component.UIComponent component,
           javax.faces.event.PhaseId phaseId)

getClientId

public String getClientId(javax.faces.context.FacesContext context)

Overrides:

getClientId in class javax.faces.component.UIData

getContainerClientId

public String getContainerClientId(javax.faces.context.FacesContext context)

Overrides:

getContainerClientId in class javax.faces.component.UIComponent

setId

public void setId(String id)

Overrides:

setId in class javax.faces.component.UIComponentBase

setRowIndex

public void setRowIndex(int rowIndex)

Overrides:

setRowIndex in class javax.faces.component.UIData

setRowModel

public void setRowModel(int rowIndex)

getRowIndex

public int getRowIndex()

Overrides:

getRowIndex in class javax.faces.component.UIData

saveDescendantState

protected void saveDescendantState()

saveDescendantState

protected void saveDescendantState(javax.faces.component.UIComponent component,
                       javax.faces.context.FacesContext context)

restoreDescendantState

protected void restoreDescendantState()

restoreDescendantState

protected void restoreDescendantState(javax.faces.component.UIComponent component,
                          javax.faces.context.FacesContext context)

getDataModel

protected javax.faces.model.DataModel getDataModel()

Overrides:

getDataModel in class javax.faces.component.UIData

setDataModel

protected void setDataModel(javax.faces.model.DataModel dataModel)

Overrides:

setDataModel in class javax.faces.component.UIData

shouldSkipChildren

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

shouldVisitChildren

protected boolean shouldVisitChildren(javax.faces.component.visit.VisitContext context,
                          boolean visitRows)

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext context,
                javax.faces.component.visit.VisitCallback callback)

Overrides:

visitTree in class javax.faces.component.UIData

visitFacets

protected boolean visitFacets(javax.faces.component.visit.VisitContext context,
                  javax.faces.component.visit.VisitCallback callback,
                  boolean visitRows)

visitColumnsAndColumnFacets

protected boolean visitColumnsAndColumnFacets(javax.faces.component.visit.VisitContext context,
                                  javax.faces.component.visit.VisitCallback callback,
                                  boolean visitRows)

visitColumnGroup

protected boolean visitColumnGroup(javax.faces.component.visit.VisitContext context,
                       javax.faces.component.visit.VisitCallback callback,
                       ColumnGroup group)

visitColumnFacets

protected boolean visitColumnFacets(javax.faces.component.visit.VisitContext context,
                        javax.faces.component.visit.VisitCallback callback,
                        javax.faces.component.UIComponent component)

visitRows

protected boolean visitRows(javax.faces.component.visit.VisitContext context,
                javax.faces.component.visit.VisitCallback callback,
                boolean visitRows)

visitColumnContent

protected boolean visitColumnContent(javax.faces.component.visit.VisitContext context,
                         javax.faces.component.visit.VisitCallback callback,
                         javax.faces.component.UIComponent component)

shouldVisitRows

protected boolean shouldVisitRows(javax.faces.context.FacesContext context,
                      javax.faces.component.visit.VisitContext visitContext)

requiresColumns

protected boolean requiresColumns()

getIterableChildren

protected List<javax.faces.component.UIComponent> getIterableChildren()

markInitialState

public void markInitialState()

Specified by:

markInitialState in interface javax.faces.component.PartialStateHolder

Overrides:

markInitialState in class javax.faces.component.UIData

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIData

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIData

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class javax.faces.component.UIData

Throws:

IOException