@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIDataScroller extends AbstractDataScroller implements javax.faces.component.behavior.ClientBehaviorHolder, IterationStateHolder, AjaxProps, CoreProps, 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 |
CONTROLS_SEPARATOR_FACET_NAME, FAST_FORWARD_DISABLED_FACET_NAME, FAST_FORWARD_FACET_NAME, FAST_REWIND_DISABLED_FACET_NAME, FAST_REWIND_FACET_NAME, FIRST_DISABLED_FACET_NAME, FIRST_FACET_NAME, LAST_DISABLED_FACET_NAME, LAST_FACET_NAME, NEXT_DISABLED_FACET_NAME, NEXT_FACET_NAME, PAGEMODE_FULL, PAGEMODE_SHORT, PAGES_FACET_NAME, PREVIOUS_DISABLED_FACET_NAME, PREVIOUS_FACET_NAME, SCROLLER_STATE_ATTRIBUTE
Constructor and Description |
---|
UIDataScroller() |
Modifier and Type | Method and Description |
---|---|
DataScrollerControlsMode |
getBoundaryControls()
The attribute specifies the visibility of boundaryControls.
|
Object |
getData()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
Object |
getExecute()
IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
|
String |
getFamily() |
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()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbegin()
The client-side script method to be called before an ajax request.
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
javax.faces.component.UIComponent |
getPrevious() |
Object |
getRender()
IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
javax.el.MethodExpression |
getScrollListener() |
String |
getStatus()
Name of the request status component that will indicate the status of the Ajax request
|
DataScrollerControlsMode |
getStepControls()
The attribute specifies the visibility of stepControls.
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTitle()
Advisory title information about markup elements generated for this component.
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
boolean |
isRenderIfSinglePage()
If renderIfSinglePage is "true" then datascroller is displayed on condition that the data hold on one page.
|
boolean |
isResetValues()
If true, indicate that this particular Ajax transaction is a value reset transaction.
|
void |
setBoundaryControls(DataScrollerControlsMode boundaryControls) |
void |
setData(Object data) |
void |
setExecute(Object execute) |
void |
setFastControls(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 |
setResetValues(boolean resetValues) |
void |
setScrollListener(javax.el.MethodExpression scrollListener) |
void |
setStatus(String status) |
void |
setStepControls(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, getPassThroughAttributes, 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, getPassThroughAttributes, 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
getIterationState, setIterationState
addScrollListener, getScrollListeners, removeScrollListener
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 DataScrollerControlsMode getBoundaryControls()
AbstractDataScroller
getBoundaryControls
in class AbstractDataScroller
public void setBoundaryControls(DataScrollerControlsMode boundaryControls)
public Object getData()
AjaxActivatorProps
getData
in interface AjaxActivatorProps
public void setData(Object data)
public Object getExecute()
AjaxProps
getExecute
in interface AjaxProps
public void setExecute(Object execute)
public DataScrollerControlsMode getFastControls()
AbstractDataScroller
getFastControls
in class AbstractDataScroller
public void setFastControls(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()
AjaxActivatorProps
isLimitRender
in interface AjaxActivatorProps
public void setLimitRender(boolean limitRender)
public int getMaxPages()
AbstractDataScroller
getMaxPages
in class AbstractDataScroller
public void setMaxPages(int maxPages)
public String getOnbeforedomupdate()
AjaxActivatorProps
getOnbeforedomupdate
in interface AjaxActivatorProps
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbegin()
AjaxProps
getOnbegin
in interface AjaxProps
public void setOnbegin(String onbegin)
public String getOncomplete()
AjaxActivatorProps
getOncomplete
in interface AjaxActivatorProps
public void setOncomplete(String oncomplete)
public Object getRender()
AjaxActivatorProps
getRender
in interface AjaxActivatorProps
public void setRender(Object render)
public boolean isRenderIfSinglePage()
AbstractDataScroller
isRenderIfSinglePage
in class AbstractDataScroller
public void setRenderIfSinglePage(boolean renderIfSinglePage)
public boolean isResetValues()
AjaxActivatorProps
isResetValues
in interface AjaxActivatorProps
public void setResetValues(boolean resetValues)
public javax.el.MethodExpression getScrollListener()
getScrollListener
in class AbstractDataScroller
public void setScrollListener(javax.el.MethodExpression scrollListener)
public String getStatus()
AjaxProps
public void setStatus(String status)
public DataScrollerControlsMode getStepControls()
AbstractDataScroller
getStepControls
in class AbstractDataScroller
public void setStepControls(DataScrollerControlsMode stepControls)
public String getStyle()
CoreProps
public void setStyle(String style)
public String getStyleClass()
CoreProps
getStyleClass
in interface CoreProps
public void setStyleClass(String styleClass)
public String getTitle()
CoreProps
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 © 2015 JBoss by Red Hat. All Rights Reserved.