Overview | Library | Tag | Help
| FRAMES NO FRAMES

## RichFaces
Tag datascroller

The <rich:datascroller> component is designed for providing the functionality of tables scrolling using Ajax requests.

Tag Information
Tag Class | org.richfaces.taglib.DatascrollerTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
action | false | false | `javax.el.MethodExpression` (signature must match `java.lang.Object action()`) | MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by you, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property
actionListener | false | false | `javax.el.MethodExpression` (signature must match `void actionListener(javax.faces.event.ActionEvent)`) | MethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSingle | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only. Default value is "true"
align | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | This attribute specifies the position of the table with relatively to the document. Possible values are "left","center","right ". Default value is "center".
binding | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`) | The attribute takes a value-binding expression for a component property of a backing bean
boundaryControls | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | 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".
bypassUpdates | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
data | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
eventsQueue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.)
fastControls | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | 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 | false | `javax.el.ValueExpression` (must evaluate to `int`) | The attribute indicates pages quantity to switch onto when fast scrolling is used. Default value is "0".
focus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | id of element to set focus after request completed on client side
for | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | ID of the table component whose data is scrollled
handleValue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Current handle value
id | false | false | `java.lang.String` | Every component may have a unique id that is automatically created if omitted
ignoreDupResponses | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now. Default value is "true".
immediate | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase
inactiveStyle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML style attribute for the inactive cell on scroller
inactiveStyleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML class attribute for the inactive cell on scroller
limitToList | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
maxPages | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Maximum quantity of pages. Default value is "10".
onbeforedomupdate | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call before DOM has been updated on client side
onclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is clicked
oncomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call after request completed on client side
ondblclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is double-clicked
onkeydown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed down
onkeypress | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed and released
onkeyup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is released
onmousedown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is pressed down
onmousemove | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved within
onmouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved away
onmouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved onto
onmouseup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is released
onpagechange | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a page is changed
page | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | If page >= 1 then it's a page number to show
pageIndexVar | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Name of variable in request scope containing index of active page
pagesVar | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Name of variable in request scope containing number of pages
process | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
reRender | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
renderIfSinglePage | false | 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 | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", this component is not rendered
requestDelay | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already
scrollerListener | false | false | `javax.el.MethodExpression` (signature must match `void scrollerListener(org.richfaces.event.DataScrollerEvent)`) | MethodBinding representing an action listener method that will be notified after scrolling
selectedStyle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML style attribute for the selected cell on scroller
selectedStyleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML class attribute for the selected cell on scroller
similarityGroupingId | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | If there are any component requests with identical IDs then these requests will be grouped.
status | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | ID (in format of call UIComponent.findComponent()) of Request status component
stepControls | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | 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 | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style(s) is/are to be applied when this component is rendered
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML class attribute
tableStyle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style(s) is/are to be applied to outside table when this component is rendered
tableStyleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) that are be applied to outside table of this component
timeout | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Response waiting time on a particular request. If a response is not received during this time, the request is aborted
value | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | The current value for this component

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.