com.ibm.xsp.component.xp
Class XspPager

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              com.ibm.xsp.component.UIPager
                  com.ibm.xsp.component.xp.XspPager

All Implemented Interfaces:

FacesAttrsObject, FacesComponent, ThemeControl, javax.faces.component.StateHolder

Direct Known Subclasses:

UIViewPager

public class XspPager
extends UIPager

A common control that allows traversal of data pages

XPages Core Controls - Pager

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.xsp.component.UIPager

UIPager.PagerState

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class com.ibm.xsp.component.UIPager

COMPONENT_FAMILY, DEFAULT_PAGE_COUNT

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspPager()

Method Summary

java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getFor() Return the value of the for property.
java.lang.String	getLang() Return the value of the lang property.
java.lang.String	getOuterStyleClass() Return the value of the outerStyleClass property.
int	getPageCount() Return the value of the pageCount property.
java.lang.String	getPanelPosition() Return the value of the panelPosition property.
java.lang.String	getRole() Return the value of the role property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getTitle() Return the value of the title property.
boolean	isAlwaysCalculateLast() Return the value of the alwaysCalculateLast property.
boolean	isPartialExecute() Return the value of the partialExecute property.
boolean	isPartialRefresh() Return the value of the partialRefresh property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setAlwaysCalculateLast(boolean alwaysCalculateLast) Set the value of the alwaysCalculateLast property.
void	setDir(java.lang.String dir) Set the value of the dir property.
void	setFor(java.lang.String _for) Set the value of the for property.
void	setLang(java.lang.String lang) Set the value of the lang property.
void	setOuterStyleClass(java.lang.String outerStyleClass) Set the value of the outerStyleClass property.
void	setPageCount(int pageCount) Set the value of the pageCount property.
void	setPanelPosition(java.lang.String panelPosition) Set the value of the panelPosition property.
void	setPartialExecute(boolean partialExecute) Set the value of the partialExecute property.
void	setPartialRefresh(boolean partialRefresh) Set the value of the partialRefresh property.
void	setRole(java.lang.String role) Set the value of the role property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTitle(java.lang.String title) Set the value of the title property.

Methods inherited from class com.ibm.xsp.component.UIPager

addAttr, broadcast, buildContents, createPagerState, findSharedDataPagerParent, getAttrs, getFamily, getLayout, getRowCount, getStyleKitFamily, gotoFirst, gotoLast, gotoNext, gotoPage, gotoPrevious, initAfterContents, initBeforeContents, processDecodes, queueEvent, setAttrs, setLayout, setValueBinding

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

XspPager

public XspPager()

Method Detail

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

getFor

public java.lang.String getFor()

Return the value of the for property. Contents:

Holds the id of the Table that this pager is to effect

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.

getOuterStyleClass

public java.lang.String getOuterStyleClass()

Return the value of the outerStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is set, the renderer generates an enclosing span using this style as the "class" attribute on generated markup.

getPageCount

public int getPageCount()

Return the value of the pageCount property. Contents:

The number of pages displayed in a group control.

getPanelPosition

public java.lang.String getPanelPosition()

Return the value of the panelPosition property. Contents:

Specifies where in the specified location, the pager should appear. Valid values are top, left, right and bottom. If the pager and the view title are set to the same position, the title will always appear before the pager.

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

isAlwaysCalculateLast

public boolean isAlwaysCalculateLast()

Return the value of the alwaysCalculateLast property. Contents:

Always calculate last document in container. There can be an associated performance hit when this is set to true.

isPartialExecute

public boolean isPartialExecute()

Return the value of the partialExecute property. Contents:

Specifies to only execute the control that the pager points to, thus bypassing the lifecycle for other controls.

Overrides:

isPartialExecute in class UIPager

isPartialRefresh

public boolean isPartialRefresh()

Return the value of the partialRefresh property. Contents:

Only refreshes the control (table, repeat...) that the pager points to, using an Ajax request.

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UIPager

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIPager

setAlwaysCalculateLast

public void setAlwaysCalculateLast(boolean alwaysCalculateLast)

Set the value of the alwaysCalculateLast property.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setFor

public void setFor(java.lang.String _for)

Set the value of the for property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setOuterStyleClass

public void setOuterStyleClass(java.lang.String outerStyleClass)

Set the value of the outerStyleClass property.

setPageCount

public void setPageCount(int pageCount)

Set the value of the pageCount property.

setPanelPosition

public void setPanelPosition(java.lang.String panelPosition)

Set the value of the panelPosition property.

setPartialExecute

public void setPartialExecute(boolean partialExecute)

Set the value of the partialExecute property.

setPartialRefresh

public void setPartialRefresh(boolean partialRefresh)

Set the value of the partialRefresh property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.