com.webmethods.caf.faces.component.table

Class DataPager

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

com.webmethods.caf.faces.component.BaseComponent

com.webmethods.caf.faces.component.table.DataPager

All Implemented Interfaces:

ITableRowStateHolder, Serializable, EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

Direct Known Subclasses:

ColumnSortLink, DataPages, FilterInput, PrevNext

public class DataPager
extends BaseComponent
implements ITableRowStateHolder

Abstract data paging component (ie next/prev, items-per-page, etc.).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataPager.PagingActionListener Applies the pager's submitted values when an action event is recieved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAMILY
protected String	m_submittedFilter
protected Integer	m_submittedFirst
protected String	m_submittedFirstByID
protected Integer	m_submittedRows
protected ISortInfo	m_submittedSort
static String	TYPE
protected static Integer	ZERO

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

Constructor Summary

Constructors

Constructor and Description
DataPager()

Method Summary

Modifier and Type	Method and Description
void	applySubmittedValues() Applies the submitted values to this pager's table.
UIData	getData() Returns UIData this pager is for, or null.
String	getFamily()
String	getFilterParamName()
String	getFirstParamName()
String	getFor()
String	getRowsParamName()
String	getSortParamName()
String	getSubmittedFilter()
Integer	getSubmittedFirst()
String	getSubmittedFirstByID()
Integer	getSubmittedRows()
ISortInfo	getSubmittedSort()
Object	getTableRowState() Gets this control's per-row state.
void	restoreState(FacesContext context, Object state)
void	setFor(String for1)
void	setSubmittedFilter(String submittedFilter)
void	setSubmittedFirst(Integer submittedFirst)
void	setSubmittedFirstByID(String submittedFirstByID)
void	setSubmittedRows(Integer submittedRows)
void	setSubmittedSort(ISortInfo submittedSort)
void	setTableRowState(Object o) Sets this control's per-row state.

Methods inherited from class com.webmethods.caf.faces.component.BaseComponent

getAttributes, getPropertyOrBindingValue, saveState, setBindingValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FAMILY

public static final String FAMILY

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

ZERO

protected static final Integer ZERO

m_submittedFirst

protected transient Integer m_submittedFirst

m_submittedFirstByID

protected transient String m_submittedFirstByID

m_submittedRows

protected transient Integer m_submittedRows

m_submittedSort

protected transient ISortInfo m_submittedSort

m_submittedFilter

protected transient String m_submittedFilter

Constructor Detail

DataPager

public DataPager()

Method Detail

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class BaseComponent

getTableRowState

public Object getTableRowState()

Gets this control's per-row state.

Specified by:

getTableRowState in interface ITableRowStateHolder

setTableRowState

public void setTableRowState(Object o)

Sets this control's per-row state.

Specified by:

setTableRowState in interface ITableRowStateHolder

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

getData

public UIData getData()

Returns UIData this pager is for, or null.

applySubmittedValues

public void applySubmittedValues()

Applies the submitted values to this pager's table.

getFor

public String getFor()

setFor

public void setFor(String for1)

getFirstParamName

public String getFirstParamName()

getRowsParamName

public String getRowsParamName()

getSortParamName

public String getSortParamName()

getFilterParamName

public String getFilterParamName()

getSubmittedFirst

public Integer getSubmittedFirst()

setSubmittedFirst

public void setSubmittedFirst(Integer submittedFirst)

getSubmittedFirstByID

public String getSubmittedFirstByID()

setSubmittedFirstByID

public void setSubmittedFirstByID(String submittedFirstByID)

getSubmittedRows

public Integer getSubmittedRows()

setSubmittedRows

public void setSubmittedRows(Integer submittedRows)

getSubmittedSort

public ISortInfo getSubmittedSort()

setSubmittedSort

public void setSubmittedSort(ISortInfo submittedSort)

getSubmittedFilter

public String getSubmittedFilter()

setSubmittedFilter

public void setSubmittedFilter(String submittedFilter)