org.ajax4jsf.taglib.html.jsp
Class QueueTag

java.lang.Object
  extended by javax.faces.webapp.UIComponentTagBase
      extended by javax.faces.webapp.UIComponentClassicTagBase
          extended by javax.faces.webapp.UIComponentELTag
              extended by org.richfaces.webapp.taglib.UIComponentELTagBase
                  extended by org.ajax4jsf.webapp.taglib.UIComponentTagBase
                      extended by org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
                          extended by org.ajax4jsf.taglib.html.jsp.QueueTag
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 QueueTag
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
QueueTag()
           
 
Method Summary
 java.lang.String getComponentType()
           
 java.lang.String getRendererType()
           
 void release()
           
 void setDisabled(javax.el.ValueExpression __disabled)
          If "true", disable this component on page.
 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 setName(javax.el.ValueExpression __name)
          The optional name of this component Setter for name
 void setOnbeforedomupdate(javax.el.ValueExpression __onbeforedomupdate)
          JavaScript code for call before DOM has been updated on client side Setter for onbeforedomupdate
 void setOncomplete(javax.el.ValueExpression __oncomplete)
          JavaScript code for call after request completed on client side Setter for oncomplete
 void setOnerror(javax.el.ValueExpression __onerror)
          HTML: a script expression; event fires whenever an JavaScript error occurs Setter for onerror
 void setOnsizeexceeded(javax.el.ValueExpression __onsizeexceeded)
          A script expression; a size is exceed Setter for onsizeexceeded
 void setOnsubmit(javax.el.ValueExpression __onsubmit)
          JavaScript code for call before submission of ajax event Setter for onsubmit
protected  void setProperties(javax.faces.component.UIComponent component)
           
 void setRequestDelay(javax.el.ValueExpression __requestDelay)
          Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send.
 void setSize(javax.el.ValueExpression __size)
          Defines the number of items allowed in the queue at one time.
 void setSizeExceededBehavior(javax.el.ValueExpression __sizeExceededBehavior)
          Defines the strategies of the queue's behavior if the number of the requests waiting in the queue is exceeded.
 void setTimeout(javax.el.ValueExpression __timeout)
          Response waiting time on a particular request.
 
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

QueueTag

public QueueTag()
Method Detail

setDisabled

public void setDisabled(javax.el.ValueExpression __disabled)
If "true", disable this component on page. Setter for disabled

Parameters:
disabled - - 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

setName

public void setName(javax.el.ValueExpression __name)
The optional name of this component Setter for name

Parameters:
name - - new value

setOnbeforedomupdate

public void setOnbeforedomupdate(javax.el.ValueExpression __onbeforedomupdate)
JavaScript code for call before DOM has been updated on client side Setter for onbeforedomupdate

Parameters:
onbeforedomupdate - - new value

setOncomplete

public void setOncomplete(javax.el.ValueExpression __oncomplete)
JavaScript code for call after request completed on client side Setter for oncomplete

Parameters:
oncomplete - - new value

setOnerror

public void setOnerror(javax.el.ValueExpression __onerror)
HTML: a script expression; event fires whenever an JavaScript error occurs Setter for onerror

Parameters:
onerror - - new value

setOnsizeexceeded

public void setOnsizeexceeded(javax.el.ValueExpression __onsizeexceeded)
A script expression; a size is exceed Setter for onsizeexceeded

Parameters:
onsizeexceeded - - 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

setRequestDelay

public void setRequestDelay(javax.el.ValueExpression __requestDelay)
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 Setter for requestDelay

Parameters:
requestDelay - - new value

setSize

public void setSize(javax.el.ValueExpression __size)
Defines the number of items allowed in the queue at one time. Setter for size

Parameters:
size - - new value

setSizeExceededBehavior

public void setSizeExceededBehavior(javax.el.ValueExpression __sizeExceededBehavior)
Defines the strategies of the queue's behavior if the number of the requests waiting in the queue is exceeded. There are four strategies: dropNext (by default), dropNew, fireNext , fireNew. Setter for sizeExceededBehavior

Parameters:
sizeExceededBehavior - - 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

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


Copyright © 2008. All Rights Reserved.