@Generated(value={"RichFaces CDK","4.3.0.20121214-M3"}) public class UIDataScroller extends AbstractDataScroller implements javax.faces.component.behavior.ClientBehaviorHolder, org.ajax4jsf.component.IterationStateHolder, org.richfaces.event.DataScrollSource
The <rich:dataScroller> component is used for navigating through multiple pages of tables or grids.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIDataScroller.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
FAST_FORWARD_FACET_NAME, FAST_REWIND_FACET_NAME, FIRST_DISABLED_FACET_NAME, FIRST_FACET_NAME, LAST_DISABLED_FACET_NAME, LAST_FACET_NAME, NEXT_FACET_NAME, PAGEMODE_FULL, PAGEMODE_SHORT, PREVIOUS_FACET_NAME, SCROLLER_STATE_ATTRIBUTE
Constructor and Description |
---|
UIDataScroller() |
Modifier and Type | Method and Description |
---|---|
org.richfaces.component.DataScrollerControlsMode |
getBoundaryControls()
The attribute specifies the visibility of boundaryControls.
|
Object |
getData() |
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
Object |
getExecute() |
String |
getFamily() |
org.richfaces.component.DataScrollerControlsMode |
getFastControls()
The attribute specifies the visibility of fastControls.
|
javax.faces.component.UIComponent |
getFastForward() |
javax.faces.component.UIComponent |
getFastRewind() |
int |
getFastStep()
The attribute indicates pages quantity to switch onto when fast scrolling is used.
|
javax.faces.component.UIComponent |
getLast() |
String |
getLastPageMode()
The attribute to control whether last page of datascroller shows "rows" number of items or just the rest.
|
int |
getMaxPages()
Maximum quantity of pages.
|
javax.faces.component.UIComponent |
getNext() |
String |
getOnbeforedomupdate() |
String |
getOnbegin() |
String |
getOncomplete() |
javax.faces.component.UIComponent |
getPrevious() |
Object |
getRender() |
javax.el.MethodExpression |
getScrollListener() |
String |
getStatus() |
org.richfaces.component.DataScrollerControlsMode |
getStepControls()
The attribute specifies the visibility of stepControls.
|
String |
getStyle() |
String |
getStyleClass() |
String |
getTitle() |
boolean |
isLimitRender() |
boolean |
isRenderIfSinglePage()
If renderIfSinglePage is "true" then datascroller is displayed on condition that the data hold on one page.
|
void |
setBoundaryControls(org.richfaces.component.DataScrollerControlsMode boundaryControls) |
void |
setData(Object data) |
void |
setExecute(Object execute) |
void |
setFastControls(org.richfaces.component.DataScrollerControlsMode fastControls) |
void |
setFastForward(javax.faces.component.UIComponent facet) |
void |
setFastRewind(javax.faces.component.UIComponent facet) |
void |
setFastStep(int fastStep) |
void |
setLast(javax.faces.component.UIComponent facet) |
void |
setLastPageMode(String lastPageMode) |
void |
setLimitRender(boolean limitRender) |
void |
setMaxPages(int maxPages) |
void |
setNext(javax.faces.component.UIComponent facet) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbegin(String onbegin) |
void |
setOncomplete(String oncomplete) |
void |
setPrevious(javax.faces.component.UIComponent facet) |
void |
setRender(Object render) |
void |
setRenderIfSinglePage(boolean renderIfSinglePage) |
void |
setScrollListener(javax.el.MethodExpression scrollListener) |
void |
setStatus(String status) |
void |
setStepControls(org.richfaces.component.DataScrollerControlsMode stepControls) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTitle(String title) |
addScrollListener, broadcast, getDataTable, getFastStepOrDefault, getFirst, getFor, getIterationState, getMaxPagesOrDefault, getPage, getPageCount, getPageCount, getPageCount, getPageForFacet, getRowCount, getRowCount, getRows, getScrollListeners, isLocalPageSet, removeScrollListener, resetLocalPage, setFor, setIterationState, setPage
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, 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, subscribeToEvent, unsubscribeFromEvent
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addClientBehavior, getClientBehaviors
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UIComponent
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public org.richfaces.component.DataScrollerControlsMode getBoundaryControls()
AbstractDataScroller
getBoundaryControls
in class AbstractDataScroller
public void setBoundaryControls(org.richfaces.component.DataScrollerControlsMode boundaryControls)
public Object getData()
public void setData(Object data)
public Object getExecute()
public void setExecute(Object execute)
public org.richfaces.component.DataScrollerControlsMode getFastControls()
AbstractDataScroller
getFastControls
in class AbstractDataScroller
public void setFastControls(org.richfaces.component.DataScrollerControlsMode fastControls)
public int getFastStep()
AbstractDataScroller
getFastStep
in class AbstractDataScroller
public void setFastStep(int fastStep)
public String getLastPageMode()
AbstractDataScroller
getLastPageMode
in class AbstractDataScroller
public void setLastPageMode(String lastPageMode)
public boolean isLimitRender()
public void setLimitRender(boolean limitRender)
public int getMaxPages()
AbstractDataScroller
getMaxPages
in class AbstractDataScroller
public void setMaxPages(int maxPages)
public String getOnbeforedomupdate()
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
public void setOnbegin(String onbegin)
public String getOncomplete()
public void setOncomplete(String oncomplete)
public Object getRender()
getRender
in class AbstractDataScroller
public void setRender(Object render)
public boolean isRenderIfSinglePage()
AbstractDataScroller
isRenderIfSinglePage
in class AbstractDataScroller
public void setRenderIfSinglePage(boolean renderIfSinglePage)
public javax.el.MethodExpression getScrollListener()
getScrollListener
in class AbstractDataScroller
public void setScrollListener(javax.el.MethodExpression scrollListener)
public String getStatus()
public void setStatus(String status)
public org.richfaces.component.DataScrollerControlsMode getStepControls()
AbstractDataScroller
getStepControls
in class AbstractDataScroller
public void setStepControls(org.richfaces.component.DataScrollerControlsMode stepControls)
public String getStyle()
public void setStyle(String style)
public String getStyleClass()
public void setStyleClass(String styleClass)
public String getTitle()
public void setTitle(String title)
public javax.faces.component.UIComponent getLast()
getLast
in class AbstractDataScroller
public void setLast(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getPrevious()
getPrevious
in class AbstractDataScroller
public void setPrevious(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getFastForward()
getFastForward
in class AbstractDataScroller
public void setFastForward(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getNext()
getNext
in class AbstractDataScroller
public void setNext(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getFastRewind()
getFastRewind
in class AbstractDataScroller
public void setFastRewind(javax.faces.component.UIComponent facet)
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.