|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.richfaces.component.AbstractAttachQueue
org.richfaces.component.UIAttachQueue
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIAttachQueue
The <a4j:attachQueue> behavior is used together with a <a4j:queue> component to further customize queuing for particular components and behaviors. The <a4j:attachQueue> behavior can override the scope-wide queue settings for an individual component, or attach specific requests to a queue.
| Nested Class Summary | |
|---|---|
protected static class |
UIAttachQueue.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class javax.faces.component.UIComponent |
|---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
| Constructor Summary | |
|---|---|
UIAttachQueue()
|
|
| Method Summary | |
|---|---|
String |
getFamily()
|
String |
getName()
Identify the name of the destination queue |
String |
getOnrequestdequeue()
The client-side script method to be called after the request is removed from the queue |
String |
getOnrequestqueue()
The client-side script method to be called when the request is added to the queue |
int |
getRequestDelay()
Attribute defines the time (in ms) the request will be waiting in the queue before it is ready to be sent. |
String |
getRequestGroupingId()
Specify the groupingId to process multiple requests together. |
boolean |
isIgnoreDupResponses()
Attribute allows you to ignore an Ajax response produced by a request if the newest 'similar' request is in the queue already. |
void |
setIgnoreDupResponses(boolean ignoreDupResponses)
|
void |
setName(String name)
|
void |
setOnrequestdequeue(String onrequestdequeue)
|
void |
setOnrequestqueue(String onrequestqueue)
|
void |
setRequestDelay(int requestDelay)
|
void |
setRequestGroupingId(String requestGroupingId)
|
| Methods inherited from class org.richfaces.component.AbstractAttachQueue |
|---|
associateWith, associateWith, getQueueId, processEvent |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.faces.event.ComponentSystemEventListener |
|---|
processEvent |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIAttachQueue()
| Method Detail |
|---|
public String getFamily()
getFamily in class AbstractAttachQueuepublic boolean isIgnoreDupResponses()
AbstractAttachQueue
isIgnoreDupResponses in class AbstractAttachQueuepublic void setIgnoreDupResponses(boolean ignoreDupResponses)
public String getName()
AbstractAttachQueue
getName in class AbstractAttachQueuepublic void setName(String name)
public String getOnrequestdequeue()
AbstractAttachQueue
getOnrequestdequeue in class AbstractAttachQueuepublic void setOnrequestdequeue(String onrequestdequeue)
public String getOnrequestqueue()
AbstractAttachQueue
getOnrequestqueue in class AbstractAttachQueuepublic void setOnrequestqueue(String onrequestqueue)
public int getRequestDelay()
AbstractAttachQueue
getRequestDelay in class AbstractAttachQueuepublic void setRequestDelay(int requestDelay)
public String getRequestGroupingId()
AbstractAttachQueue
getRequestGroupingId in class AbstractAttachQueuepublic void setRequestGroupingId(String requestGroupingId)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||