The <rich:dataScroller> component is used for navigating through multiple pages of tables or grids.
Info | Value |
---|---|
Component Type | org.richfaces.DataScroller |
Handler Class | org.richfaces.taglib.DataScrollerHandler |
Renderer Type | org.richfaces.DataScrollerRenderer |
Description | The <rich:dataScroller> component is used for navigating through multiple pages of tables or grids. |
Name | Required | Type | Description |
---|---|---|---|
binding |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent )
| The value binding expression used to wire up this component to a component property of a JavaBean class |
boundaryControls |
false
| javax.el.ValueExpression
(must evaluate to org.richfaces.component.DataScrollerControlsMode )
| The attribute specifies the visibility of boundaryControls. Possible values are: "show" (controls are always visible ). "hide" (controls are hidden. "auto" (unnecessary controls are hidden). Default value is "show". |
data |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object )
| Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data |
execute |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object )
| IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of IDs, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords |
fastControls |
false
| javax.el.ValueExpression
(must evaluate to org.richfaces.component.DataScrollerControlsMode )
| The attribute specifies the visibility of fastControls. Possible values are: "show" (controls are always visible ). "hide" (controls are hidden. "auto" (unnecessary controls are hidden). Default value is "show". |
fastStep |
false
| javax.el.ValueExpression
(must evaluate to int )
| The attribute indicates pages quantity to switch onto when fast scrolling is used. Default value is "1". @return |
for |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Component ID of the table whose data is scrolled |
id |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
lastPageMode |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The attribute to control whether last page of datascroller shows "rows" number of items or just the rest. Possible values are "full" and "short". Default value is "short". |
limitRender |
false
| javax.el.ValueExpression
(must evaluate to boolean )
| If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels |
maxPages |
false
| javax.el.ValueExpression
(must evaluate to int )
| Maximum quantity of pages. Default value is "10". |
onbeforedomupdate |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The client-side script method to be called after the ajax response comes back, but before the DOM is updated |
onbegin |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The client-side script method to be called before an ajax request. |
oncomplete |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| The client-side script method to be called after the DOM is updated |
page |
false
| javax.el.ValueExpression
(must evaluate to int )
| If page >= 1 then it's a page number to show |
render |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object )
| IDs of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords |
renderIfSinglePage |
false
| javax.el.ValueExpression
(must evaluate to boolean )
| If renderIfSinglePage is "true" then datascroller is displayed on condition that the data hold on one page. Default value is "true". |
rendered |
false
| javax.el.ValueExpression
(must evaluate to boolean )
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
resetValues |
false
| javax.el.ValueExpression
(must evaluate to boolean )
| If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made. |
scrollListener |
false
| javax.el.ValueExpression
(must evaluate to javax.el.MethodExpression )
| No Description |
status |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Name of the request status component that will indicate the status of the Ajax request |
stepControls |
false
| javax.el.ValueExpression
(must evaluate to org.richfaces.component.DataScrollerControlsMode )
| The attribute specifies the visibility of stepControls. Possible values are: "show" (controls are always visible ). "hide" (controls are hidden. "auto" (unnecessary controls are hidden). Default value is "show". |
style |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| CSS style(s) to be applied when this component is rendered. |
styleClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
title |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String )
| Advisory title information about markup elements generated for this component. |
Output generated by Vdldoc View Declaration Language Documentation Generator.