org.richfaces.component

## Class AbstractAttachQueue

- java.lang.Object
- - javax.faces.component.UIComponent
  - - javax.faces.component.UIComponentBase
    - - org.richfaces.component.AbstractAttachQueue

- All Implemented Interfaces:
    EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
  Direct Known Subclasses:
    UIAttachQueue

      public abstract class AbstractAttachQueue
      extends javax.faces.component.UIComponentBase
      implements javax.faces.event.ComponentSystemEventListener

  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.

  Author:
    Nick Belaevski

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `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

    Constructors
    Constructor and Description
    `AbstractAttachQueue()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `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

    - #### COMPONENT_TYPE

          public static final String COMPONENT_TYPE

      See Also:
        Constant Field Values

    - #### COMPONENT_FAMILY

          public static final String COMPONENT_FAMILY

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### AbstractAttachQueue

          public AbstractAttachQueue()

  - ### Method Detail

    - #### getRequestGroupingId

          public abstract String getRequestGroupingId()

      Specify the groupingId to process multiple requests together. Requests from multiple behaviors can use the same identifier to group requests together

    - #### getRequestDelay

          public abstract int getRequestDelay()

      Attribute defines the time (in ms) the request will be waiting in the queue before it is ready to be sent.

    - #### isIgnoreDupResponses

          public 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. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows avoiding unnecessary updates on the client side if the response isn't actual now

    - #### getOnrequestqueue

          public abstract String getOnrequestqueue()

      The client-side script method to be called when the request is added to the queue

    - #### getOnrequestdequeue

          public abstract String getOnrequestdequeue()

      The client-side script method to be called after the request is removed from the queue

    - #### getName

          public abstract String getName()

      Identify the name of the destination queue

    - #### getQueueId

          public String getQueueId()

    - #### getFamily

          public String getFamily()

      Specified by:
        `getFamily` in class `javax.faces.component.UIComponent`

    - #### associateWith

          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.

      Parameters:
        `component` -

    - #### associateWith

          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.

      Parameters:
        `behavior` -

    - #### processEvent

          public void processEvent(javax.faces.event.ComponentSystemEvent event)
                            throws javax.faces.event.AbortProcessingException

      Specified by:
        `processEvent` in interface `javax.faces.event.ComponentSystemEventListener`
      Overrides:
        `processEvent` in class `javax.faces.component.UIComponent`
      Throws:
        `javax.faces.event.AbortProcessingException`

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.