org.richfaces.component
Class UIDataScroller

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.richfaces.component.UIDataScroller

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.ajax4jsf.component.IterationStateHolder, org.richfaces.event.DataScrollerSource

public class UIDataScroller
extends javax.faces.component.UIComponentBase
implements org.richfaces.event.DataScrollerSource, org.ajax4jsf.component.IterationStateHolder

Nested Class Summary

protected static class

UIDataScroller.PropertyKeys

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	FAST_FORWARD_FACET_NAME
static java.lang.String	FAST_REWIND_FACET_NAME
static java.lang.String	FIRST_DISABLED_FACET_NAME
static java.lang.String	FIRST_FACET_NAME
static java.lang.String	LAST_DISABLED_FACET_NAME
static java.lang.String	LAST_FACET_NAME
static java.lang.String	PAGEMODE_FULL
static java.lang.String	PAGEMODE_SHORT
static java.lang.String	SCROLLER_STATE_ATTRIBUTE

Fields inherited from class javax.faces.component.UIComponent

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

Constructor Summary

UIDataScroller()

Method Summary

void	addScrollerListener(org.richfaces.event.DataScrollerListener listener)
void	broadcast(javax.faces.event.FacesEvent event)
java.lang.String	getBoundaryControls()
javax.faces.component.UIComponent	getDataTable() Finds the dataTable which id is mapped to the "for" property
java.lang.String	getFamily()
java.lang.String	getFastControls()
javax.faces.component.UIComponent	getFastForward()
javax.faces.component.UIComponent	getFastRewind()
int	getFastStep()
javax.faces.component.UIComponent	getFirst()
java.lang.String	getFor()
java.lang.Object	getIterationState()
javax.faces.component.UIComponent	getLast()
java.lang.String	getLastPageMode()
int	getMaxPages()
int	getPage()
int	getPageCount()
int	getPageCount(javax.faces.component.UIComponent data)
int	getPageCount(javax.faces.component.UIComponent data, int rowCount, int rows)
int	getPageForFacet(java.lang.String facetName)
int	getRowCount()
int	getRowCount(javax.faces.component.UIComponent data)
int	getRows(javax.faces.component.UIComponent data)
org.richfaces.event.DataScrollerListener[]	getScrollerListeners()
boolean	isLocalPageSet()
void	removeScrollerListener(org.richfaces.event.DataScrollerListener listener)
void	resetLocalPage()
void	setBoundaryControls(java.lang.String boundaryControls)
void	setFastControls(java.lang.String fastControls)
void	setFastStep(int fastStep)
void	setFor(java.lang.String f)
void	setIterationState(java.lang.Object state)
void	setLastPageMode(java.lang.String lastPageMode)
void	setMaxPages(int maxPages)
void	setPage(int newPage)

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, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, 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

SCROLLER_STATE_ATTRIBUTE

public static final java.lang.String SCROLLER_STATE_ATTRIBUTE

See Also:

Constant Field Values

FIRST_FACET_NAME

public static final java.lang.String FIRST_FACET_NAME

See Also:

Constant Field Values

LAST_FACET_NAME

public static final java.lang.String LAST_FACET_NAME

See Also:

Constant Field Values

FAST_FORWARD_FACET_NAME

public static final java.lang.String FAST_FORWARD_FACET_NAME

See Also:

Constant Field Values

FAST_REWIND_FACET_NAME

public static final java.lang.String FAST_REWIND_FACET_NAME

See Also:

Constant Field Values

FIRST_DISABLED_FACET_NAME

public static final java.lang.String FIRST_DISABLED_FACET_NAME

See Also:

Constant Field Values

LAST_DISABLED_FACET_NAME

public static final java.lang.String LAST_DISABLED_FACET_NAME

See Also:

Constant Field Values

PAGEMODE_FULL

public static final java.lang.String PAGEMODE_FULL

See Also:

Constant Field Values

PAGEMODE_SHORT

public static final java.lang.String PAGEMODE_SHORT

See Also:

Constant Field Values

Constructor Detail

UIDataScroller

public UIDataScroller()

Method Detail

getLastPageMode

public java.lang.String getLastPageMode()

setLastPageMode

public void setLastPageMode(java.lang.String lastPageMode)

getFastStep

public int getFastStep()

setFastStep

public void setFastStep(int fastStep)

getFor

public java.lang.String getFor()

setFor

public void setFor(java.lang.String f)

getMaxPages

public int getMaxPages()

setMaxPages

public void setMaxPages(int maxPages)

getBoundaryControls

public java.lang.String getBoundaryControls()

setBoundaryControls

public void setBoundaryControls(java.lang.String boundaryControls)

getFastControls

public java.lang.String getFastControls()

setFastControls

public void setFastControls(java.lang.String fastControls)

addScrollerListener

public void addScrollerListener(org.richfaces.event.DataScrollerListener listener)

Specified by:

addScrollerListener in interface org.richfaces.event.DataScrollerSource

getScrollerListeners

public org.richfaces.event.DataScrollerListener[] getScrollerListeners()

Specified by:

getScrollerListeners in interface org.richfaces.event.DataScrollerSource

removeScrollerListener

public void removeScrollerListener(org.richfaces.event.DataScrollerListener listener)

Specified by:

removeScrollerListener in interface org.richfaces.event.DataScrollerSource

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

getDataTable

public javax.faces.component.UIComponent getDataTable()

Finds the dataTable which id is mapped to the "for" property

Returns:

the dataTable component

getPageForFacet

public int getPageForFacet(java.lang.String facetName)

getPageCount

public int getPageCount(javax.faces.component.UIComponent data)

getPageCount

public int getPageCount(javax.faces.component.UIComponent data,
                        int rowCount,
                        int rows)

getPageCount

public int getPageCount()

Returns:

the page count of the uidata

getRowCount

public int getRowCount(javax.faces.component.UIComponent data)

getRowCount

public int getRowCount()

Returns:

int

getRows

public int getRows(javax.faces.component.UIComponent data)

getFirst

public javax.faces.component.UIComponent getFirst()

getLast

public javax.faces.component.UIComponent getLast()

getFastForward

public javax.faces.component.UIComponent getFastForward()

getFastRewind

public javax.faces.component.UIComponent getFastRewind()

setPage

public void setPage(int newPage)

getPage

public int getPage()

isLocalPageSet

public boolean isLocalPageSet()

resetLocalPage

public void resetLocalPage()

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getIterationState

public java.lang.Object getIterationState()

Specified by:

getIterationState in interface org.ajax4jsf.component.IterationStateHolder

setIterationState

public void setIterationState(java.lang.Object state)

Specified by:

setIterationState in interface org.ajax4jsf.component.IterationStateHolder