RichFaces
Tag datascroller


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


Tag Information
Tag Classorg.richfaces.taglib.DatascrollerTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
actionfalsefalsejavax.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
actionListenerfalsefalsejavax.el.MethodExpression
(signature must match void actionListener(javax.faces.event.ActionEvent))
MethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSinglefalsefalsejavax.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"
alignfalsefalsejavax.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".
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The attribute takes a value-binding expression for a component property of a backing bean
boundaryControlsfalsefalsejavax.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".
bypassUpdatesfalsefalsejavax.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
datafalsefalsejavax.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
eventsQueuefalsefalsejavax.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.)
fastControlsfalsefalsejavax.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".
fastStepfalsefalsejavax.el.ValueExpression
(must evaluate to int)
The attribute indicates pages quantity to switch onto when fast scrolling is used. Default value is "0".
focusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID of an element to set focus after request is completed on client side
forfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID of the table component whose data is scrollled
handleValuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Current handle value
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
ignoreDupResponsesfalsefalsejavax.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".
immediatefalsefalsejavax.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
inactiveStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style rules to be applied to the scroller inactive cells
inactiveStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the scroller inactive cells
lastPageModefalsefalsejavax.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".
limitToListfalsefalsejavax.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.
maxPagesfalsefalsejavax.el.ValueExpression
(must evaluate to int)
Maximum quantity of pages. Default value is "10".
onbeforedomupdatefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before DOM is updated
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is clicked
oncompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after the request is completed
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is double-clicked
onkeydownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is pressed down over the element
onkeypressfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is pressed over the element and released
onkeyupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is released
onmousedownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a mouse button is pressed down over the element
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved within the element
onmouseoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved away from the element
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved onto the element
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a mouse button is released
onpagechangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a page is changed
pagefalsefalsejavax.el.ValueExpression
(must evaluate to int)
If page >= 1 then it's a page number to show
pageIndexVarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Name of variable in request scope containing index of active page
pagesVarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Name of variable in request scope containing number of pages
processfalsefalsejavax.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
reRenderfalsefalsejavax.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
renderIfSinglePagefalsefalsejavax.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".
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", this component is not rendered
requestDelayfalsefalsejavax.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
scrollerListenerfalsefalsejavax.el.MethodExpression
(signature must match void scrollerListener(org.richfaces.event.DataScrollerEvent))
MethodBinding representing an action listener method that will be notified after scrolling
selectedStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style rules to be applied to the scroller selected cell
selectedStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the scroller selected cell
similarityGroupingIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
If there are any component requests with identical IDs then these requests will be grouped.
statusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID (in format of call UIComponent.findComponent()) of Request status component
stepControlsfalsefalsejavax.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".
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style rules to be applied to the component
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component. Corresponds to the HTML "class" attribute.
tableStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style rules to be applied to the wrapper table element of the component
tableStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the wrapper table element of the component
timeoutfalsefalsejavax.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
valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The current value for this component

Variables
No Variables Defined.


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.