com.ibm.xsp.component
Class UIPagerControl

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.ibm.xsp.component.UIPagerControl

All Implemented Interfaces:

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

Direct Known Subclasses:

XspPagerControl

public class UIPagerControl
extends javax.faces.component.UICommand
implements ThemeControl, FacesAttrsObject

Not intended to be subclassed.

Nested Class Summary

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 java.lang.String	TYPE_FIRST
static java.lang.String	TYPE_FIRSTARROW
static java.lang.String	TYPE_FIRSTIMAGE
static java.lang.String	TYPE_GOTO
static java.lang.String	TYPE_GROUP
static java.lang.String	TYPE_LAST
static java.lang.String	TYPE_LASTARROW
static java.lang.String	TYPE_LASTIMAGE
static java.lang.String	TYPE_NEXT
static java.lang.String	TYPE_NEXTARROW
static java.lang.String	TYPE_NEXTIMAGE
static java.lang.String	TYPE_PREVIOUS
static java.lang.String	TYPE_PREVIOUSARROW
static java.lang.String	TYPE_PREVIOUSIMAGE
static java.lang.String	TYPE_SEPARATOR
static java.lang.String	TYPE_SEPARATORPAGE
static java.lang.String	TYPE_STATUS

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UIPagerControl()

Method Summary

void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
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	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.
java.lang.String	getType() Return the value of the type property.
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	setType(java.lang.String type) Set the value of the type property.

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

TYPE_FIRST

public static final java.lang.String TYPE_FIRST

See Also:

Constant Field Values

TYPE_FIRSTIMAGE

public static final java.lang.String TYPE_FIRSTIMAGE

See Also:

Constant Field Values

TYPE_FIRSTARROW

public static final java.lang.String TYPE_FIRSTARROW

See Also:

Constant Field Values

TYPE_LAST

public static final java.lang.String TYPE_LAST

See Also:

Constant Field Values

TYPE_LASTIMAGE

public static final java.lang.String TYPE_LASTIMAGE

See Also:

Constant Field Values

TYPE_LASTARROW

public static final java.lang.String TYPE_LASTARROW

See Also:

Constant Field Values

TYPE_NEXT

public static final java.lang.String TYPE_NEXT

See Also:

Constant Field Values

TYPE_NEXTIMAGE

public static final java.lang.String TYPE_NEXTIMAGE

See Also:

Constant Field Values

TYPE_NEXTARROW

public static final java.lang.String TYPE_NEXTARROW

See Also:

Constant Field Values

TYPE_PREVIOUS

public static final java.lang.String TYPE_PREVIOUS

See Also:

Constant Field Values

TYPE_PREVIOUSIMAGE

public static final java.lang.String TYPE_PREVIOUSIMAGE

See Also:

Constant Field Values

TYPE_PREVIOUSARROW

public static final java.lang.String TYPE_PREVIOUSARROW

See Also:

Constant Field Values

TYPE_GROUP

public static final java.lang.String TYPE_GROUP

See Also:

Constant Field Values

TYPE_STATUS

public static final java.lang.String TYPE_STATUS

See Also:

Constant Field Values

TYPE_GOTO

public static final java.lang.String TYPE_GOTO

See Also:

Constant Field Values

TYPE_SEPARATOR

public static final java.lang.String TYPE_SEPARATOR

See Also:

Constant Field Values

TYPE_SEPARATORPAGE

public static final java.lang.String TYPE_SEPARATORPAGE

See Also:

Constant Field Values

Constructor Detail

UIPagerControl

public UIPagerControl()

Method Detail

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.

getType

public java.lang.String getType()

Return the value of the type property. Contents:

The type of pager nav control.

setType

public void setType(java.lang.String type)

Set the value of the type property.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

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.

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.UICommand

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.UICommand