com.liferay.faces.bridge.component.icefaces
Class DataPaginator

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              javax.faces.component.html.HtmlPanelGroup
                  com.liferay.faces.bridge.component.icefaces.DataPaginator

All Implemented Interfaces:

EventListener, javax.faces.component.ActionSource, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

DataPaginatorWrapper

public abstract class DataPaginator
extends javax.faces.component.html.HtmlPanelGroup
implements javax.faces.component.ActionSource

This class is part of a workaround for ICE-6398.

Author:

Neil Griffin

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlPanelGroup

javax.faces.component.html.HtmlPanelGroup.PropertyKeys

Field Summary

static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

DataPaginator()

Method Summary

abstract void	addActionListener(javax.faces.event.ActionListener listener)
abstract void	broadcast(javax.faces.event.FacesEvent event)
abstract javax.faces.component.UIData	findUIData(javax.faces.context.FacesContext facesContext)
abstract javax.faces.el.MethodBinding	getAction()
abstract javax.faces.el.MethodBinding	getActionListener()
abstract javax.faces.event.ActionListener[]	getActionListeners()
abstract String	getBaseStyleClass()
abstract String	getComponentType()
abstract String	getDisplayedRowsCountVar()
abstract String	getEnabledOnUserRole()
abstract String	getFamily()
abstract javax.faces.component.UIComponent	getFastForward()
abstract javax.faces.component.UIComponent	getFastRewind()
abstract int	getFastStep()
abstract javax.faces.component.UIComponent	getFirst()
abstract int	getFirstRow()
abstract String	getFirstRowIndexVar()
abstract String	getFor()
abstract javax.faces.component.UIComponent	getLast()
abstract String	getLastRowIndexVar()
abstract javax.faces.component.UIComponent	getNext()
abstract int	getPageCount()
abstract String	getPageCountVar()
abstract int	getPageIndex()
abstract String	getPageIndexVar()
abstract String	getPaginatorActiveColumnClass()
abstract String	getPaginatorColumnClass()
abstract int	getPaginatorMaxPages()
abstract String	getPaginatorTableClass()
abstract javax.faces.component.UIComponent	getPrevious()
abstract String	getRenderedOnUserRole()
abstract String	getRendererType()
abstract boolean	getRendersChildren()
abstract int	getRowCount()
abstract int	getRows()
abstract String	getRowsCountVar()
abstract String	getscrollButtonCellClass()
abstract String	getStyle()
abstract String	getStyleClass()
abstract int	getTabindex()
abstract javax.faces.component.UIData	getUIData()
abstract void	gotoFastForward()
abstract void	gotoFastRewind()
abstract void	gotoFirstPage()
abstract void	gotoLastPage()
abstract void	gotoNextPage()
abstract void	gotoPreviousPage()
abstract boolean	isDisabled()
abstract boolean	isImmediate()
abstract boolean	isKeyboardNavigationEnabled()
abstract boolean	isLastPage()
abstract boolean	isModelResultSet()
abstract boolean	isPaginator()
abstract boolean	isRendered()
abstract boolean	isRenderFacetsIfSinglePage()
abstract boolean	isVertical()
abstract void	queueEvent(javax.faces.event.FacesEvent event)
abstract void	removeActionListener(javax.faces.event.ActionListener listener)
abstract void	restoreState(javax.faces.context.FacesContext context, Object state)
abstract Object	saveState(javax.faces.context.FacesContext context)
abstract void	setAction(javax.faces.el.MethodBinding action)
abstract void	setActionListener(javax.faces.el.MethodBinding actionListener)
abstract void	setDisabled(boolean disabled)
abstract void	setDisplayedRowsCountVar(String displayedRowsCountVar)
abstract void	setEnabledOnUserRole(String enabledOnUserRole)
abstract void	setFastForward(javax.faces.component.UIComponent previous)
abstract void	setFastRewind(javax.faces.component.UIComponent previous)
abstract void	setFastStep(int fastStep)
abstract void	setFirst(javax.faces.component.UIComponent first)
abstract void	setFirstRowIndexVar(String firstRowIndexVar)
abstract void	setFor(String forValue)
abstract void	setImmediate(boolean immediate)
abstract void	setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
abstract void	setLast(javax.faces.component.UIComponent last)
abstract void	setLastRowIndexVar(String lastRowIndexVar)
abstract void	setNext(javax.faces.component.UIComponent next)
abstract void	setPageCountVar(String pageCountVar)
abstract void	setPageIndexVar(String pageIndexVar)
abstract void	setPaginator(boolean paginator)
abstract void	setPaginatorMaxPages(int paginatorMaxPages)
abstract void	setPrevious(javax.faces.component.UIComponent previous)
abstract void	setRenderedOnUserRole(String renderedOnUserRole)
abstract void	setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
abstract void	setRowsCountVar(String rowsCountVar)
abstract void	setStyle(String style)
abstract void	setStyleClass(String styleClass)
abstract void	setTabindex(int tabindex)
abstract void	setUIData(javax.faces.component.UIData uiData)
abstract void	setVertical(boolean vertical)

Methods inherited from class javax.faces.component.html.HtmlPanelGroup

getLayout, setLayout

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getValueBinding, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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 String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

DataPaginator

public DataPaginator()

Method Detail

addActionListener

public abstract void addActionListener(javax.faces.event.ActionListener listener)

Specified by:

addActionListener in interface javax.faces.component.ActionSource

broadcast

public abstract 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

findUIData

public abstract javax.faces.component.UIData findUIData(javax.faces.context.FacesContext facesContext)
                                                 throws Exception

Throws:

Exception

getscrollButtonCellClass

public abstract String getscrollButtonCellClass()

gotoFastForward

public abstract void gotoFastForward()

gotoFastRewind

public abstract void gotoFastRewind()

gotoFirstPage

public abstract void gotoFirstPage()

gotoLastPage

public abstract void gotoLastPage()

gotoNextPage

public abstract void gotoNextPage()

gotoPreviousPage

public abstract void gotoPreviousPage()

queueEvent

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

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

removeActionListener

public abstract void removeActionListener(javax.faces.event.ActionListener listener)

Specified by:

removeActionListener in interface javax.faces.component.ActionSource

restoreState

public abstract void restoreState(javax.faces.context.FacesContext context,
                                  Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

saveState

public abstract Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

getAction

public abstract javax.faces.el.MethodBinding getAction()

Specified by:

getAction in interface javax.faces.component.ActionSource

setAction

public abstract void setAction(javax.faces.el.MethodBinding action)

Specified by:

setAction in interface javax.faces.component.ActionSource

getActionListener

public abstract javax.faces.el.MethodBinding getActionListener()

Specified by:

getActionListener in interface javax.faces.component.ActionSource

setActionListener

public abstract void setActionListener(javax.faces.el.MethodBinding actionListener)

Specified by:

setActionListener in interface javax.faces.component.ActionSource

getActionListeners

public abstract javax.faces.event.ActionListener[] getActionListeners()

Specified by:

getActionListeners in interface javax.faces.component.ActionSource

getBaseStyleClass

public abstract String getBaseStyleClass()

getComponentType

public abstract String getComponentType()

isDisabled

public abstract boolean isDisabled()

isKeyboardNavigationEnabled

public abstract boolean isKeyboardNavigationEnabled()

isRendered

public abstract boolean isRendered()

Overrides:

isRendered in class javax.faces.component.UIComponentBase

setDisabled

public abstract void setDisabled(boolean disabled)

getDisplayedRowsCountVar

public abstract String getDisplayedRowsCountVar()

setDisplayedRowsCountVar

public abstract void setDisplayedRowsCountVar(String displayedRowsCountVar)

isImmediate

public abstract boolean isImmediate()

Specified by:

isImmediate in interface javax.faces.component.ActionSource

isLastPage

public abstract boolean isLastPage()

isRenderFacetsIfSinglePage

public abstract boolean isRenderFacetsIfSinglePage()

getEnabledOnUserRole

public abstract String getEnabledOnUserRole()

setEnabledOnUserRole

public abstract void setEnabledOnUserRole(String enabledOnUserRole)

getFamily

public abstract String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

getFastForward

public abstract javax.faces.component.UIComponent getFastForward()

setFastForward

public abstract void setFastForward(javax.faces.component.UIComponent previous)

getFastRewind

public abstract javax.faces.component.UIComponent getFastRewind()

setFastRewind

public abstract void setFastRewind(javax.faces.component.UIComponent previous)

getFastStep

public abstract int getFastStep()

setFastStep

public abstract void setFastStep(int fastStep)

getFirst

public abstract javax.faces.component.UIComponent getFirst()

setFirst

public abstract void setFirst(javax.faces.component.UIComponent first)

getFirstRow

public abstract int getFirstRow()

getFirstRowIndexVar

public abstract String getFirstRowIndexVar()

setFirstRowIndexVar

public abstract void setFirstRowIndexVar(String firstRowIndexVar)

getFor

public abstract String getFor()

setFor

public abstract void setFor(String forValue)

setImmediate

public abstract void setImmediate(boolean immediate)

Specified by:

setImmediate in interface javax.faces.component.ActionSource

setKeyboardNavigationEnabled

public abstract void setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)

isVertical

public abstract boolean isVertical()

getLast

public abstract javax.faces.component.UIComponent getLast()

setLast

public abstract void setLast(javax.faces.component.UIComponent last)

getLastRowIndexVar

public abstract String getLastRowIndexVar()

setLastRowIndexVar

public abstract void setLastRowIndexVar(String lastRowIndexVar)

getNext

public abstract javax.faces.component.UIComponent getNext()

setNext

public abstract void setNext(javax.faces.component.UIComponent next)

getPageCount

public abstract int getPageCount()

getPageCountVar

public abstract String getPageCountVar()

setPageCountVar

public abstract void setPageCountVar(String pageCountVar)

getPageIndex

public abstract int getPageIndex()

getPageIndexVar

public abstract String getPageIndexVar()

setPageIndexVar

public abstract void setPageIndexVar(String pageIndexVar)

setPaginator

public abstract void setPaginator(boolean paginator)

getPaginatorActiveColumnClass

public abstract String getPaginatorActiveColumnClass()

getPaginatorColumnClass

public abstract String getPaginatorColumnClass()

getPaginatorMaxPages

public abstract int getPaginatorMaxPages()

setPaginatorMaxPages

public abstract void setPaginatorMaxPages(int paginatorMaxPages)

getPaginatorTableClass

public abstract String getPaginatorTableClass()

getPrevious

public abstract javax.faces.component.UIComponent getPrevious()

setPrevious

public abstract void setPrevious(javax.faces.component.UIComponent previous)

isPaginator

public abstract boolean isPaginator()

getRenderedOnUserRole

public abstract String getRenderedOnUserRole()

setRenderedOnUserRole

public abstract void setRenderedOnUserRole(String renderedOnUserRole)

getRendererType

public abstract String getRendererType()

Overrides:

getRendererType in class javax.faces.component.UIComponentBase

setRenderFacetsIfSinglePage

public abstract void setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)

getRendersChildren

public abstract boolean getRendersChildren()

Overrides:

getRendersChildren in class javax.faces.component.UIComponentBase

getRowCount

public abstract int getRowCount()

getRows

public abstract int getRows()

getRowsCountVar

public abstract String getRowsCountVar()

setRowsCountVar

public abstract void setRowsCountVar(String rowsCountVar)

getStyle

public abstract String getStyle()

Overrides:

getStyle in class javax.faces.component.html.HtmlPanelGroup

setStyle

public abstract void setStyle(String style)

Overrides:

setStyle in class javax.faces.component.html.HtmlPanelGroup

getStyleClass

public abstract String getStyleClass()

Overrides:

getStyleClass in class javax.faces.component.html.HtmlPanelGroup

setStyleClass

public abstract void setStyleClass(String styleClass)

Overrides:

setStyleClass in class javax.faces.component.html.HtmlPanelGroup

isModelResultSet

public abstract boolean isModelResultSet()

getTabindex

public abstract int getTabindex()

setTabindex

public abstract void setTabindex(int tabindex)

getUIData

public abstract javax.faces.component.UIData getUIData()
                                                throws Exception

Throws:

Exception

setUIData

public abstract void setUIData(javax.faces.component.UIData uiData)
                        throws Exception

Throws:

Exception

setVertical

public abstract void setVertical(boolean vertical)