com.ibm.xsp.component.xp
Class XspPagerControl

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

All Implemented Interfaces:

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

public class XspPagerControl
extends UIPagerControl

A pager control that is placed inside the common pager

XPages Container Controls - Pager Child Control

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_TYPE

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

COMPONENT_FAMILY, TYPE_FIRST, TYPE_FIRSTARROW, TYPE_FIRSTIMAGE, TYPE_GOTO, TYPE_GROUP, TYPE_LAST, TYPE_LASTARROW, TYPE_LASTIMAGE, TYPE_NEXT, TYPE_NEXTARROW, TYPE_NEXTIMAGE, TYPE_PREVIOUS, TYPE_PREVIOUSARROW, TYPE_PREVIOUSIMAGE, TYPE_SEPARATOR, TYPE_SEPARATORPAGE, TYPE_STATUS

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspPagerControl()

Method Summary

java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getAlt() Return the value of the alt property.
java.lang.String	getCurrentStyleClass() Return the value of the currentStyleClass property.
java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getFirstStyleClass() Return the value of the firstStyleClass property.
java.lang.String	getImage() Return the value of the image property.
java.lang.String	getLang() Return the value of the lang property.
java.lang.String	getLastStyleClass() Return the value of the lastStyleClass property.
java.lang.String	getOnblur() Return the value of the onblur property.
java.lang.String	getOnclick() Return the value of the onclick property.
java.lang.String	getOndblclick() Return the value of the ondblclick property.
java.lang.String	getOnfocus() Return the value of the onfocus property.
java.lang.String	getOnkeydown() Return the value of the onkeydown property.
java.lang.String	getOnkeypress() Return the value of the onkeypress property.
java.lang.String	getOnkeyup() Return the value of the onkeyup property.
java.lang.String	getOnmousedown() Return the value of the onmousedown property.
java.lang.String	getOnmousemove() Return the value of the onmousemove property.
java.lang.String	getOnmouseout() Return the value of the onmouseout property.
java.lang.String	getOnmouseover() Return the value of the onmouseover property.
java.lang.String	getOnmouseup() Return the value of the onmouseup 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	getTabindex() Return the value of the tabindex property.
java.lang.String	getTitle() Return the value of the title property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setAlt(java.lang.String alt) Set the value of the alt property.
void	setCurrentStyleClass(java.lang.String currentStyleClass) Set the value of the currentStyleClass property.
void	setDir(java.lang.String dir) Set the value of the dir property.
void	setFirstStyleClass(java.lang.String firstStyleClass) Set the value of the firstStyleClass property.
void	setImage(java.lang.String image) Set the value of the image property.
void	setLang(java.lang.String lang) Set the value of the lang property.
void	setLastStyleClass(java.lang.String lastStyleClass) Set the value of the lastStyleClass property.
void	setOnblur(java.lang.String onblur) Set the value of the onblur property.
void	setOnclick(java.lang.String onclick) Set the value of the onclick property.
void	setOndblclick(java.lang.String ondblclick) Set the value of the ondblclick property.
void	setOnfocus(java.lang.String onfocus) Set the value of the onfocus property.
void	setOnkeydown(java.lang.String onkeydown) Set the value of the onkeydown property.
void	setOnkeypress(java.lang.String onkeypress) Set the value of the onkeypress property.
void	setOnkeyup(java.lang.String onkeyup) Set the value of the onkeyup property.
void	setOnmousedown(java.lang.String onmousedown) Set the value of the onmousedown property.
void	setOnmousemove(java.lang.String onmousemove) Set the value of the onmousemove property.
void	setOnmouseout(java.lang.String onmouseout) Set the value of the onmouseout property.
void	setOnmouseover(java.lang.String onmouseover) Set the value of the onmouseover property.
void	setOnmouseup(java.lang.String onmouseup) Set the value of the onmouseup 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	setTabindex(java.lang.String tabindex) Set the value of the tabindex property.
void	setTitle(java.lang.String title) Set the value of the title property.

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

getFamily, getStyleKitFamily, getType, setType

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

Constructor Detail

XspPagerControl

public XspPagerControl()

Method Detail

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property. Contents:

Transfers focus to the control when pressed

getAlt

public java.lang.String getAlt()

Return the value of the alt property. Contents:

An alternative descriptive text that will be shown if the image cannot be displayed.

getCurrentStyleClass

public java.lang.String getCurrentStyleClass()

Return the value of the currentStyleClass property. Contents:

Space-separated list of CSS style class(es) added to the existing control style for the current page displayed.

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

getFirstStyleClass

public java.lang.String getFirstStyleClass()

Return the value of the firstStyleClass property. Contents:

Space-separated list of CSS style class(es) added to the existing control style for the first page displayed.

getImage

public java.lang.String getImage()

Return the value of the image property. Contents:

A URL to the image that should appear on the navigation control.

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.

getLastStyleClass

public java.lang.String getLastStyleClass()

Return the value of the lastStyleClass property. Contents:

Space-separated list of CSS style class(es) added to the existing control style for the last page displayed.

getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property. Contents:

JavaScript code executed when this control loses focus

getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control

getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property. Contents:

JavaScript code executed when a pointer control is double clicked over this control

getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property. Contents:

JavaScript code executed when this control receives focus

getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control

getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.

getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control

getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control

getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control

getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control

getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control

getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control

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.

getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property. Contents:

Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

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 UIPagerControl

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIPagerControl

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

setAlt

public void setAlt(java.lang.String alt)

Set the value of the alt property.

setCurrentStyleClass

public void setCurrentStyleClass(java.lang.String currentStyleClass)

Set the value of the currentStyleClass property.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setFirstStyleClass

public void setFirstStyleClass(java.lang.String firstStyleClass)

Set the value of the firstStyleClass property.

setImage

public void setImage(java.lang.String image)

Set the value of the image property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setLastStyleClass

public void setLastStyleClass(java.lang.String lastStyleClass)

Set the value of the lastStyleClass property.

setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.

setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.

setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup 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.

setTabindex

public void setTabindex(java.lang.String tabindex)

Set the value of the tabindex property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.