ProgressBarTag (RichFaces JSF components library 3.3.1.GA-NX9 API)

java.lang.Object
- javax.faces.webapp.UIComponentTagBase
- - javax.faces.webapp.UIComponentClassicTagBase
  - - javax.faces.webapp.UIComponentELTag
    - - org.richfaces.webapp.taglib.UIComponentELTagBase
      - org.ajax4jsf.webapp.taglib.UIComponentTagBase
        
        org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
        
        org.richfaces.taglib.ProgressBarTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class ProgressBarTag
extends org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
```

Field Summary
- Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase
  bodyContent, pageContext, UNIQUE_ID_PREFIX
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
- Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
  EVAL_BODY_BUFFERED, EVAL_BODY_TAG
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN

Constructor Summary

Constructors
Constructor and Description

ProgressBarTag()

Constructors
Constructor and Description
`ProgressBarTag()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getComponentType()`
`java.lang.String`	`getRendererType()`
`void`	`release()`
`void`	`setActionListener(javax.el.MethodExpression __actionListener)` MethodBinding pointing at method accepting an ActionEvent with return type void Setter for actionListener
`void`	`setAjaxSingle(javax.el.ValueExpression __ajaxSingle)` boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only Setter for ajaxSingle
`void`	`setBypassUpdates(javax.el.ValueExpression __bypassUpdates)` If "true", after process validations phase it skips updates of model beans on a force render response.
`void`	`setCompleteClass(javax.el.ValueExpression __completeClass)` CSS class that defines style for progress line rendering Setter for completeClass
`void`	`setData(javax.el.ValueExpression __data)` Serialized (on default with JSON) data passed on the client by a developer on AJAX request.
`void`	`setEnabled(javax.el.ValueExpression __enabled)` Enables/disables polling.
`void`	`setEventsQueue(javax.el.ValueExpression __eventsQueue)` Name of requests queue to avoid send next request before complete other from same event.
`void`	`setFinishClass(javax.el.ValueExpression __finishClass)` CSS class that defines style for complete state of the component Setter for finishClass
`void`	`setFocus(javax.el.ValueExpression __focus)` id of element to set focus after request completed on client side Setter for focus
`void`	`setIgnoreDupResponses(javax.el.ValueExpression __ignoreDupResponses)` Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already.
`void`	`setImmediate(javax.el.ValueExpression __immediate)` True means, that the default ActionListener should be executed immediately (i.e.
`void`	`setInitialClass(javax.el.ValueExpression __initialClass)` CSS class that defines style for initial state of the component Setter for initialClass
`void`	`setInterval(javax.el.ValueExpression __interval)` Interval (in ms) for call poll requests.
`void`	`setLabel(javax.el.ValueExpression __label)` Attribute defines a simple label instead of rendering children component Setter for label
`void`	`setLimitToList(javax.el.ValueExpression __limitToList)` 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.
`void`	`setMaxValue(javax.el.ValueExpression __maxValue)` Max value, after which complete state should be rendered.
`void`	`setMinValue(javax.el.ValueExpression __minValue)` Min value when initial state should be rendered.
`void`	`setMode(javax.el.ValueExpression __mode)` Attributes defines AJAX or CLIENT modes for component.
`void`	`setOnbeforedomupdate(javax.el.ValueExpression __onbeforedomupdate)` The client side script method to be called before DOM is updated Setter for onbeforedomupdate
`void`	`setOncomplete(javax.el.ValueExpression __oncomplete)` The client side script method to be called after the request is completed Setter for oncomplete
`void`	`setOnsubmit(javax.el.ValueExpression __onsubmit)` JavaScript code for call before submission of ajax event Setter for onsubmit
`void`	`setParameters(javax.el.ValueExpression __parameters)` Parameters for macrosubstitution in the label Setter for parameters
`void`	`setProcess(javax.el.ValueExpression __process)` Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component.
`void`	`setProgressVar(javax.el.ValueExpression __progressVar)` DEPRECATED.
`protected void`	`setProperties(javax.faces.component.UIComponent component)`
`void`	`setRemainClass(javax.el.ValueExpression __remainClass)` CSS class that defines style for remained part of progress bar Setter for remainClass
`void`	`setReRender(javax.el.ValueExpression __reRender)` Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component.
`void`	`setReRenderAfterComplete(javax.el.ValueExpression __reRenderAfterComplete)` Set of componets to rerender after completion Setter for reRenderAfterComplete
`void`	`setSimilarityGroupingId(javax.el.ValueExpression __similarityGroupingId)` If there are any component requests with identical IDs then these requests will be grouped.
`void`	`setStatus(javax.el.ValueExpression __status)` ID (in format of call UIComponent.findComponent()) of Request status component Setter for status
`void`	`setTimeout(javax.el.ValueExpression __timeout)` Response waiting time on a particular request.
`void`	`setValue(javax.el.ValueExpression __value)` Sets the current value of the progress Setter for value

Methods inherited from class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
setDir, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setStyleClass, setTitle

Methods inherited from class org.ajax4jsf.webapp.taglib.UIComponentTagBase
getExpressionFactory, isValueReference, setActionListenerProperty, setActionProperty, setBooleanProperty, setBooleanProperty, setDoubleProperty, setDoubleProperty, setFloatProperty, setFloatProperty, setIntegerProperty, setIntegerProperty, setLongProperty, setLongProperty, setProperty, setProperty, setStringProperty, setStringProperty, setValueChangedListenerProperty, setValueProperty, setValueProperty

Methods inherited from class org.richfaces.webapp.taglib.UIComponentELTagBase
setActionListenerProperty, setActionProperty, setConverterProperty, setRowKeyConverterProperty, setValidatorProperty, setValueChangeListenerProperty

Methods inherited from class javax.faces.webapp.UIComponentELTag
createComponent, getELContext, hasBinding, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, setPageContext, setParent

- Constructor Detail
  - ProgressBarTag
```
public ProgressBarTag()
```
- Method Detail
  - setActionListener
```
public void setActionListener(javax.el.MethodExpression __actionListener)
```
    MethodBinding pointing at method accepting an ActionEvent with return type void Setter for actionListener
    
    Parameters:
    actionListener - - new value
  - setAjaxSingle
```
public void setAjaxSingle(javax.el.ValueExpression __ajaxSingle)
```
    boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only Setter for ajaxSingle
    
    Parameters:
    ajaxSingle - - new value
  - setBypassUpdates
```
public void setBypassUpdates(javax.el.ValueExpression __bypassUpdates)
```
    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 Setter for bypassUpdates
    
    Parameters:
    bypassUpdates - - new value
  - setCompleteClass
```
public void setCompleteClass(javax.el.ValueExpression __completeClass)
```
    CSS class that defines style for progress line rendering Setter for completeClass
    
    Parameters:
    completeClass - - new value
  - setData
```
public void setData(javax.el.ValueExpression __data)
```
    Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax Setter for data
    
    Parameters:
    data - - new value
  - setEnabled
```
public void setEnabled(javax.el.ValueExpression __enabled)
```
    Enables/disables polling. Default value is "true". Setter for enabled
    
    Parameters:
    enabled - - new value
  - setEventsQueue
```
public void setEventsQueue(javax.el.ValueExpression __eventsQueue)
```
    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.) Setter for eventsQueue
    
    Parameters:
    eventsQueue - - new value
  - setFinishClass
```
public void setFinishClass(javax.el.ValueExpression __finishClass)
```
    CSS class that defines style for complete state of the component Setter for finishClass
    
    Parameters:
    finishClass - - new value
  - setFocus
```
public void setFocus(javax.el.ValueExpression __focus)
```
    id of element to set focus after request completed on client side Setter for focus
    
    Parameters:
    focus - - new value
  - setIgnoreDupResponses
```
public void setIgnoreDupResponses(javax.el.ValueExpression __ignoreDupResponses)
```
    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 Setter for ignoreDupResponses
    
    Parameters:
    ignoreDupResponses - - new value
  - setImmediate
```
public void setImmediate(javax.el.ValueExpression __immediate)
```
    True means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase Setter for immediate
    
    Parameters:
    immediate - - new value
  - setInitialClass
```
public void setInitialClass(javax.el.ValueExpression __initialClass)
```
    CSS class that defines style for initial state of the component Setter for initialClass
    
    Parameters:
    initialClass - - new value
  - setInterval
```
public void setInterval(javax.el.ValueExpression __interval)
```
    Interval (in ms) for call poll requests. Default value 1000 ms (1 sec) Setter for interval
    
    Parameters:
    interval - - new value
  - setLabel
```
public void setLabel(javax.el.ValueExpression __label)
```
    Attribute defines a simple label instead of rendering children component Setter for label
    
    Parameters:
    label - - new value
  - setLimitToList
```
public void setLimitToList(javax.el.ValueExpression __limitToList)
```
    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. Setter for limitToList
    
    Parameters:
    limitToList - - new value
  - setMaxValue
```
public void setMaxValue(javax.el.ValueExpression __maxValue)
```
    Max value, after which complete state should be rendered. Default value is "100". Setter for maxValue
    
    Parameters:
    maxValue - - new value
  - setMinValue
```
public void setMinValue(javax.el.ValueExpression __minValue)
```
    Min value when initial state should be rendered. Default value is "0". Setter for minValue
    
    Parameters:
    minValue - - new value
  - setMode
```
public void setMode(javax.el.ValueExpression __mode)
```
    Attributes defines AJAX or CLIENT modes for component. Possible values are "ajax", "client". Default value is "ajax". Setter for mode
    
    Parameters:
    mode - - new value
  - setOnbeforedomupdate
```
public void setOnbeforedomupdate(javax.el.ValueExpression __onbeforedomupdate)
```
    The client side script method to be called before DOM is updated Setter for onbeforedomupdate
    
    Parameters:
    onbeforedomupdate - - new value
  - setOncomplete
```
public void setOncomplete(javax.el.ValueExpression __oncomplete)
```
    The client side script method to be called after the request is completed Setter for oncomplete
    
    Parameters:
    oncomplete - - new value
  - setOnsubmit
```
public void setOnsubmit(javax.el.ValueExpression __onsubmit)
```
    JavaScript code for call before submission of ajax event Setter for onsubmit
    
    Parameters:
    onsubmit - - new value
  - setParameters
```
public void setParameters(javax.el.ValueExpression __parameters)
```
    Parameters for macrosubstitution in the label Setter for parameters
    
    Parameters:
    parameters - - new value
  - setProcess
```
public void setProcess(javax.el.ValueExpression __process)
```
    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 Setter for process
    
    Parameters:
    process - - new value
  - setProgressVar
```
public void setProgressVar(javax.el.ValueExpression __progressVar)
```
    DEPRECATED. Provides access to value of the component on the client Setter for progressVar
    
    Parameters:
    progressVar - - new value
  - setReRender
```
public void setReRender(javax.el.ValueExpression __reRender)
```
    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 Setter for reRender
    
    Parameters:
    reRender - - new value
  - setReRenderAfterComplete
```
public void setReRenderAfterComplete(javax.el.ValueExpression __reRenderAfterComplete)
```
    Set of componets to rerender after completion Setter for reRenderAfterComplete
    
    Parameters:
    reRenderAfterComplete - - new value
  - setRemainClass
```
public void setRemainClass(javax.el.ValueExpression __remainClass)
```
    CSS class that defines style for remained part of progress bar Setter for remainClass
    
    Parameters:
    remainClass - - new value
  - setSimilarityGroupingId
```
public void setSimilarityGroupingId(javax.el.ValueExpression __similarityGroupingId)
```
    If there are any component requests with identical IDs then these requests will be grouped. Setter for similarityGroupingId
    
    Parameters:
    similarityGroupingId - - new value
  - setStatus
```
public void setStatus(javax.el.ValueExpression __status)
```
    ID (in format of call UIComponent.findComponent()) of Request status component Setter for status
    
    Parameters:
    status - - new value
  - setTimeout
```
public void setTimeout(javax.el.ValueExpression __timeout)
```
    Response waiting time on a particular request. If a response is not received during this time, the request is aborted Setter for timeout
    
    Parameters:
    timeout - - new value
  - setValue
```
public void setValue(javax.el.ValueExpression __value)
```
    Sets the current value of the progress Setter for value
    
    Parameters:
    value - - new value
  - release
```
public void release()
```
    Specified by:
    
    release in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    release in class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
  - setProperties
```
protected void setProperties(javax.faces.component.UIComponent component)
```
    Overrides:
    
    setProperties in class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
  - getComponentType
```
public java.lang.String getComponentType()
```
    Specified by:
    
    getComponentType in class javax.faces.webapp.UIComponentTagBase
  - getRendererType
```
public java.lang.String getRendererType()
```
    Specified by:
    
    getRendererType in class javax.faces.webapp.UIComponentTagBase

Class ProgressBarTag

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

Fields inherited from interface javax.servlet.jsp.tagext.Tag

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

Constructor Summary

Method Summary

Methods inherited from class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase

Methods inherited from class org.ajax4jsf.webapp.taglib.UIComponentTagBase

Methods inherited from class org.richfaces.webapp.taglib.UIComponentELTagBase

Methods inherited from class javax.faces.webapp.UIComponentELTag

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Detail

ProgressBarTag

Method Detail

setActionListener

setAjaxSingle

setBypassUpdates

setCompleteClass

setData

setEnabled

setEventsQueue

setFinishClass

setFocus

setIgnoreDupResponses

setImmediate

setInitialClass

setInterval

setLabel

setLimitToList

setMaxValue

setMinValue

setMode

setOnbeforedomupdate

setOncomplete

setOnsubmit

setParameters

setProcess

setProgressVar

setReRender

setReRenderAfterComplete

setRemainClass

setSimilarityGroupingId

setStatus

setTimeout

setValue

release

setProperties

getComponentType

getRendererType