|
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
public abstract class AbstractAttachQueue
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.
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 | |
---|---|
AbstractAttachQueue()
|
Method Summary | |
---|---|
void |
associateWith(AjaxBehavior behavior)
Establishes association between attachQueue component and behavior passed as method argument. |
void |
associateWith(javax.faces.component.UIComponent component)
Establishes association between attachQueue component and component passed as method argument. |
String |
getFamily()
|
abstract String |
getName()
Identify the name of the destination queue |
abstract String |
getOnrequestdequeue()
The client-side script method to be called after the request is removed from the queue |
abstract String |
getOnrequestqueue()
The client-side script method to be called when the request is added to the queue |
String |
getQueueId()
|
abstract int |
getRequestDelay()
Attribute defines the time (in ms) the request will be waiting in the queue before it is ready to be sent. |
abstract String |
getRequestGroupingId()
Specify the groupingId to process multiple requests together. |
abstract 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 |
processEvent(javax.faces.event.ComponentSystemEvent event)
|
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 |
Field Detail |
---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
Constructor Detail |
---|
public AbstractAttachQueue()
Method Detail |
---|
public abstract String getRequestGroupingId()
public abstract int getRequestDelay()
public abstract boolean isIgnoreDupResponses()
public abstract String getOnrequestqueue()
public abstract String getOnrequestdequeue()
public abstract String getName()
public String getQueueId()
public String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void associateWith(javax.faces.component.UIComponent component)
Establishes association between attachQueue component and component passed as method argument.
Association can be established either immediately just before returning from this method, or postponed until attachQueue component will be added to view.
component
- public void associateWith(AjaxBehavior behavior)
Establishes association between attachQueue component and behavior passed as method argument.
Association can be established either immediately just before returning from this method, or postponed until attachQueue component will be added to view.
behavior
- public void processEvent(javax.faces.event.ComponentSystemEvent event) throws javax.faces.event.AbortProcessingException
processEvent
in interface javax.faces.event.ComponentSystemEventListener
processEvent
in class javax.faces.component.UIComponent
javax.faces.event.AbortProcessingException
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |