com.infragistics.faces.shared.component.html
Class HtmlPager

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.infragistics.faces.shared.component.Pager
              com.infragistics.faces.shared.component.html.HtmlPager

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlPager

extends Pager

A pager is a component providing a user interface to navigate through a large number of items. It is typically displayed as links to navigate to the first/previous/next/last page or specific page indexes.

Look and Feel
The look and feel of the pager is fully customizable.

Page Indexes
It is possible to show/hide page indexes by calling #setDisplayPageIndexes(boolean)

Facets

The following facets can be nested inside the component:

Facet Name	Description
firstPage	allows to specify the component used to display the "first page" link.
previousPage	allows to specify the component used to display the "previous page" link.
nextPage	allows to specify the component used to display the "next page" link.
lastPage	allows to specify the component used to display the "last page" link.

Field Summary

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

Constructor Summary

HtmlPager()

Method Summary

java.lang.String	getFamily()
java.lang.String	getPageNumberHoverStyleClass() Returns the name of the css class applied to a page number when the mouse cursor is over it
java.lang.String	getPageNumberSelectedStyleClass() Returns the name of the css class applied to a selected page number
java.lang.String	getPageNumberStyleClass() Returns the name of the css class applied to page numbers
java.lang.String	getStyle() Returns the default Style applied to the pager
java.lang.String	getStyleClass() Returns the name of the css class applied to the pager
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setPageNumberHoverStyleClass(java.lang.String pageNumberHoverStyleClass) Sets the name of the css class applied to a page number when the mouse cursor is over it
void	setPageNumberSelectedStyleClass(java.lang.String pageNumberSelectedStyleClass) Sets the name of the css class applied to a selected page number
void	setPageNumberStyleClass(java.lang.String pageNumberStyleClass) Sets the name of the css class applied to page numbers
void	setStyle(java.lang.String style) Sets the default Style applied to the pager
void	setStyleClass(java.lang.String cssName) Sets the default Style applied to the pager

Methods inherited from class com.infragistics.faces.shared.component.Pager

getFirstPage, getForComponent, getForComponentId, getLastPage, getMaximumPageNumbers, getNextPage, getPreviousPage, isFirstLastRendered, isPageNumbersRendered, isPreviousNextRendered, setFirstLastRendered, setFirstPage, setForComponentId, setLastPage, setMaximumPageNumbers, setNextPage, setPageNumbersRendered, setPreviousNextRendered, setPreviousPage

Methods inherited from class javax.faces.component.UIComponentBase

broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static java.lang.String COMPONENT_FAMILY

COMPONENT_TYPE

public static java.lang.String COMPONENT_TYPE

RENDERER_TYPE

public static java.lang.String RENDERER_TYPE

Constructor Detail

HtmlPager

public HtmlPager()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class Pager

getPageNumberHoverStyleClass

public java.lang.String getPageNumberHoverStyleClass()

Returns the name of the css class applied to a page number when the mouse cursor is over it

Returns:

java.lang.String

getPageNumberSelectedStyleClass

public java.lang.String getPageNumberSelectedStyleClass()

Returns the name of the css class applied to a selected page number

Returns:

java.lang.String

getPageNumberStyleClass

public java.lang.String getPageNumberStyleClass()

Returns the name of the css class applied to page numbers

Returns:

java.lang.String

getStyle

public java.lang.String getStyle()

Returns the default Style applied to the pager

Returns:

a String

getStyleClass

public java.lang.String getStyleClass()

Returns the name of the css class applied to the pager

Returns:

a String

setPageNumberHoverStyleClass

public void setPageNumberHoverStyleClass(java.lang.String pageNumberHoverStyleClass)

Sets the name of the css class applied to a page number when the mouse cursor is over it

Parameters:

pageNumberHoverStyleClass - String

setPageNumberSelectedStyleClass

public void setPageNumberSelectedStyleClass(java.lang.String pageNumberSelectedStyleClass)

Sets the name of the css class applied to a selected page number

Parameters:

pageNumberSelectedStyleClass - String

setPageNumberStyleClass

public void setPageNumberStyleClass(java.lang.String pageNumberStyleClass)

Sets the name of the css class applied to page numbers

Parameters:

pageNumberStyleClass - String

setStyle

public void setStyle(java.lang.String style)

Sets the default Style applied to the pager

Parameters:

style -

setStyleClass

public void setStyleClass(java.lang.String cssName)

Sets the default Style applied to the pager

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 Pager

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class Pager