com.ibm.xsp.component
Class UIPager

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

All Implemented Interfaces:

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

Direct Known Subclasses:

XspPager

public class UIPager
extends javax.faces.component.UIPanel
implements ThemeControl, FacesComponent, FacesAttrsObject

Not intended to be subclassed.

Nested Class Summary

static class

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_FAMILY
static java.lang.String	COMPONENT_TYPE
static int	DEFAULT_PAGE_COUNT

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UIPager()

Method Summary

void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
void	broadcast(javax.faces.event.FacesEvent event)
void	buildContents(javax.faces.context.FacesContext context, FacesComponentBuilder builder) Build the component children and facets, the default implementation is usually: builder.buildAll(context, this, true); // includeFacets=true
UIPager.PagerState	createPagerState()
javax.faces.component.UIComponent	findSharedDataPagerParent()
java.util.List<Attr>	getAttrs() The extra attributes to be output on the base element at the root of this control or object tag.
java.lang.String	getFamily()
java.lang.String	getLayout() Return the value of the layout property.
int	getRowCount(UIPager.PagerState st, int maxCount)
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
void	gotoFirst()
void	gotoLast()
void	gotoNext()
void	gotoPage(int page)
void	gotoPrevious()
void	initAfterContents(javax.faces.context.FacesContext context) Perform component initialization after it's children and facets are added.
void	initBeforeContents(javax.faces.context.FacesContext context) Perform component initialization before its children and facets are added.
boolean	isPartialExecute()
void	processDecodes(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent e)
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAttrs(java.util.List<Attr> attrs) This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
void	setLayout(java.lang.String layout) Set the value of the layout property.
void	setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding)

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

DEFAULT_PAGE_COUNT

public static final int DEFAULT_PAGE_COUNT

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIPager

public UIPager()

Method Detail

getLayout

public java.lang.String getLayout()

Return the value of the layout property. Contents: Default layout of the child controls within the pager

setLayout

public void setLayout(java.lang.String layout)

Set the value of the layout property.

getAttrs

public java.util.List<Attr> getAttrs()

The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:

getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)

Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:

addAttr in interface FacesAttrsObject

Parameters:

action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)

This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)

Overrides:

setValueBinding in class javax.faces.component.UIComponentBase

buildContents

public void buildContents(javax.faces.context.FacesContext context,
                          FacesComponentBuilder builder)
                   throws javax.faces.FacesException

Description copied from interface: FacesComponent

Build the component children and facets, the default implementation is usually:
builder.buildAll(context, this, true); // includeFacets=true

Specified by:

buildContents in interface FacesComponent

Throws:

javax.faces.FacesException

initAfterContents

public void initAfterContents(javax.faces.context.FacesContext context)
                       throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization after it's children and facets are added.

Specified by:

initAfterContents in interface FacesComponent

Throws:

javax.faces.FacesException

initBeforeContents

public void initBeforeContents(javax.faces.context.FacesContext context)
                        throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization before its children and facets are added.

Specified by:

initBeforeContents in interface FacesComponent

Throws:

javax.faces.FacesException

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

isPartialExecute

public boolean isPartialExecute()

processDecodes

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

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

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 javax.faces.component.UIComponentBase

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

getRowCount

public int getRowCount(UIPager.PagerState st,
                       int maxCount)

Parameters:

st -

maxCount -

Returns:

gotoFirst

public void gotoFirst()

gotoPrevious

public void gotoPrevious()

gotoNext

public void gotoNext()

gotoLast

public void gotoLast()

gotoPage

public void gotoPage(int page)

findSharedDataPagerParent

public javax.faces.component.UIComponent findSharedDataPagerParent()

Returns:

createPagerState

public UIPager.PagerState createPagerState()

Returns: