Class: queue

RichFaces. queue

new queue()

RichFaces Queue API container
Source:

Members

(static, constant) DEFAULT_QUEUE_ID :string

Type:
  • string
Source:

Methods

(static) clear()

Remove all QueueEntry from the queue
Source:

(static) getSize() → {number}

Get current queue size
Source:
Returns:
size of items in the queue
Type
number

(static) isEmpty() → {boolean}

Check if queue is empty
Source:
Returns:
returns true if queue is empty
Type
boolean

(static) push(source, eventopt, optionsopt)

Create and push QueueEntry to the queue for ajax requests
Parameters:
Name Type Attributes Description
source string | DOMElement The DOM element or an id that triggered this ajax request
event object <optional>
The DOM event that triggered this ajax request
options object <optional>
The set name/value pairs that can be sent as request parameters to control client and/or server side request processing
Source:

(static) setQueueOptions(idopt, options)

Set queue default options
Parameters:
Name Type Attributes Description
id string | object <optional>
Queue id for storing options or hash with options for multiple options set
options object Queue options object
Source:

(static) submitFirst()

Extract and submit first QueueEntry in the queue if QueueEntry is ready to submit
Source: