Package org.primefaces.component.api

Class UIPageableData

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

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

Direct Known Subclasses:

DataGridBase, DataListBase, DataTableBase, DataViewBase

public class UIPageableData
extends UIData
implements Pageable, TouchAware

UIData for pageable components

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	UIPageableData.InternalPropertyKeys
static class	UIPageableData.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static String	ARIA_FIRST_PAGE_LABEL
static String	ARIA_HEADER_LABEL
static String	ARIA_LAST_PAGE_LABEL
static String	ARIA_NEXT_PAGE_LABEL
static String	ARIA_PREVIOUS_PAGE_LABEL
static String	EMPTY_MESSAGE
static String	PAGINATOR_ACTIVE_PAGE_CLASS
static String	PAGINATOR_BOTTOM_CONTAINER_CLASS
static String	PAGINATOR_BOTTOM_LEFT_CONTENT_CLASS
static String	PAGINATOR_BOTTOM_RIGHT_CONTENT_CLASS
static String	PAGINATOR_CURRENT_CLASS
static String	PAGINATOR_FIRST_PAGE_ICON_CLASS
static String	PAGINATOR_FIRST_PAGE_LINK_CLASS
static String	PAGINATOR_JTP_INPUT_CLASS
static String	PAGINATOR_JTP_SELECT_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
static String	PAGINATOR_TOP_LEFT_CONTENT_CLASS
static String	PAGINATOR_TOP_RIGHT_CONTENT_CLASS
static String	ROWS_PER_PAGE_LABEL

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	Description
UIPageableData()

Method Summary

Modifier and Type	Method	Description
void	calculateFirst()
String	getCurrentPageReportTemplate()
String	getEmptyMessage()
int	getPage()
int	getPageCount()
int	getPageLinks()
String	getPaginatorPosition()
String	getPaginatorTemplate()
int	getRows()
String	getRowsPerPageLabel()
String	getRowsPerPageTemplate()
int	getRowsToRender()
boolean	isPaginationRequest(javax.faces.context.FacesContext context)
boolean	isPaginator()
boolean	isPaginatorAlwaysVisible()
boolean	isTouchable()	Is this component touch enabled?
void	resetRows()
void	setCurrentPageReportTemplate(String currentPageReportTemplate)
void	setEmptyMessage(String emptyMessage)
void	setFirst(int first)
void	setPageLinks(int pageLinks)
void	setPaginator(boolean paginator)
void	setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)
void	setPaginatorPosition(String paginatorPosition)
void	setPaginatorTemplate(String paginatorTemplate)
void	setRows(int rows)
void	setRowsPerPageLabel(String rowsPerPageLabel)
void	setRowsPerPageTemplate(String rowsPerPageTemplate)
void	setTouchable(boolean touchable)	Enable/disable touch support for this component.
void	updatePaginationData(javax.faces.context.FacesContext context)

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, getFamily, 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 org.primefaces.component.api.Pageable

getClientId, getFacet, getFirst, getFooter, getHeader, getRowCount

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_TOP_LEFT_CONTENT_CLASS

public static final String PAGINATOR_TOP_LEFT_CONTENT_CLASS

See Also:

Constant Field Values

PAGINATOR_TOP_RIGHT_CONTENT_CLASS

public static final String PAGINATOR_TOP_RIGHT_CONTENT_CLASS

See Also:

Constant Field Values

PAGINATOR_BOTTOM_LEFT_CONTENT_CLASS

public static final String PAGINATOR_BOTTOM_LEFT_CONTENT_CLASS

See Also:

Constant Field Values

PAGINATOR_BOTTOM_RIGHT_CONTENT_CLASS

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

public static final String PAGINATOR_JTP_SELECT_CLASS

See Also:

Constant Field Values

PAGINATOR_JTP_INPUT_CLASS

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

ARIA_HEADER_LABEL

public static final String ARIA_HEADER_LABEL

See Also:

Constant Field Values

ARIA_FIRST_PAGE_LABEL

public static final String ARIA_FIRST_PAGE_LABEL

See Also:

Constant Field Values

ARIA_PREVIOUS_PAGE_LABEL

public static final String ARIA_PREVIOUS_PAGE_LABEL

See Also:

Constant Field Values

ARIA_NEXT_PAGE_LABEL

public static final String ARIA_NEXT_PAGE_LABEL

See Also:

Constant Field Values

ARIA_LAST_PAGE_LABEL

public static final String ARIA_LAST_PAGE_LABEL

See Also:

Constant Field Values

ROWS_PER_PAGE_LABEL

public static final String ROWS_PER_PAGE_LABEL

See Also:

Constant Field Values

EMPTY_MESSAGE

public static final String EMPTY_MESSAGE

See Also:

Constant Field Values

Constructor Detail

UIPageableData

public UIPageableData()

Method Detail

getEmptyMessage

public String getEmptyMessage()

setEmptyMessage

public void setEmptyMessage(String emptyMessage)

isTouchable

public boolean isTouchable()

Description copied from interface: TouchAware

Is this component touch enabled?

Specified by:

isTouchable in interface TouchAware

Returns:

false to disable

setTouchable

public void setTouchable(boolean touchable)

Description copied from interface: TouchAware

Enable/disable touch support for this component.

Specified by:

setTouchable in interface TouchAware

Parameters:

touchable - true for touch support

isPaginator

public boolean isPaginator()

setPaginator

public void setPaginator(boolean paginator)

getPaginatorTemplate

public String getPaginatorTemplate()

Specified by:

getPaginatorTemplate in interface Pageable

setPaginatorTemplate

public void setPaginatorTemplate(String paginatorTemplate)

getRowsPerPageTemplate

public String getRowsPerPageTemplate()

Specified by:

getRowsPerPageTemplate in interface Pageable

setRowsPerPageTemplate

public void setRowsPerPageTemplate(String rowsPerPageTemplate)

getRowsPerPageLabel

public String getRowsPerPageLabel()

Specified by:

getRowsPerPageLabel in interface Pageable

setRowsPerPageLabel

public void setRowsPerPageLabel(String rowsPerPageLabel)

getCurrentPageReportTemplate

public String getCurrentPageReportTemplate()

Specified by:

getCurrentPageReportTemplate in interface Pageable

setCurrentPageReportTemplate

public void setCurrentPageReportTemplate(String currentPageReportTemplate)

getPageLinks

public int getPageLinks()

Specified by:

getPageLinks in interface Pageable

setPageLinks

public void setPageLinks(int pageLinks)

getPaginatorPosition

public String getPaginatorPosition()

Specified by:

getPaginatorPosition in interface Pageable

setPaginatorPosition

public void setPaginatorPosition(String paginatorPosition)

isPaginatorAlwaysVisible

public boolean isPaginatorAlwaysVisible()

Specified by:

isPaginatorAlwaysVisible in interface Pageable

setPaginatorAlwaysVisible

public void setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)

getRows

public int getRows()

Specified by:

getRows in interface Pageable

Overrides:

getRows in class javax.faces.component.UIData

setRows

public void setRows(int rows)

Overrides:

setRows in class javax.faces.component.UIData

setFirst

public void setFirst(int first)

Overrides:

setFirst in class javax.faces.component.UIData

resetRows

public void resetRows()

calculateFirst

public void calculateFirst()

getPage

public int getPage()

Specified by:

getPage in interface Pageable

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface Pageable

getRowsToRender

public int getRowsToRender()

Specified by:

getRowsToRender in interface Pageable

isPaginationRequest

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

updatePaginationData

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