Author: pyaschenko Date: 2010-04-02 13:49:39 -0400 (Fri, 02 Apr 2010) New Revision: 16713 Modified: root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces-queue.js root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces.js Log: queue js docs (https://jira.jboss.org/jira/browse/RF-7897) Modified: root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces-queue.js =================================================================== --- root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces-queue.js 2010-04-02 15:27:09 UTC (rev 16712) +++ root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces-queue.js 2010-04-02 17:49:39 UTC (rev 16713) @@ -1,7 +1,30 @@ (function(jQuery, richfaces, jsf) { + /** + * @class + * @name ajax + * + * */ richfaces.ajax = richfaces.ajax || {}; + + /** + * JSF 2.0 original method that sends an asynchronous ajax request to the server + * see jsf.ajax.request method for parameter's description + * @methodOf + * @name ajax.request + * + * */ richfaces.ajax.request = jsf.ajax.request; + + /** + * RichFaces wrapper function of JSF 2.0 original method jsf.ajax.request + * @methodOf + * @name jsf_ajax.request + * + * @param {string|DOMElement} source - The DOM element or an id that triggered this ajax request + * @param {object} [event] - The DOM event that triggered this ajax request + * @param {object} [options] - The set name/value pairs that can be sent as request parameters to control client and/or server side request processing + * */ jsf.ajax.request = function request(source, event, options) { //richfaces.ajax.request(source, event, options); richfaces.queue.push(source, event, options); @@ -11,6 +34,10 @@ var QUEUE_MODE_PUSH = 'push'; var defaultQueueOptions = {mode: QUEUE_MODE_PULL, requestDelay:0}; + /** + * @class + * @name queue + * */ richfaces.queue = function(opts){ var QueueEntry = function(queue, source, event, options) { @@ -178,10 +205,40 @@ return { + /** + * Get current queue size + * @methodOf + * @name queue.getSize + * + * @return {number} size of items in the queue + * */ getSize: getSize, + + /** + * Check if queue is empty + * @methodOf + * @name queue.isEmpty + * + * @return {boolean} returns true if queue is empty + * */ isEmpty: isEmpty, + + /** + * Extract and submit first QueueEntry in the queue if QueueEntry is ready to submit + * @methodOf + * @name queue.submitFirst + * */ submitFirst: submitFirst, + /** + * Create and push QueueEntry to the queue for ajax requests + * @methodOf + * @name queue.push + * + * @param {string|DOMElement} source - The DOM element or an id that triggered this ajax request + * @param {object} [event] - The DOM event that triggered this ajax request + * @param {object} [options] - The set name/value pairs that can be sent as request parameters to control client and/or server side request processing + * */ push: function (source, event, options) { var entry = new QueueEntry(this, source, event, options); var similarityGroupingId = entry.getSimilarityGroupingId(); Modified: root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces.js =================================================================== --- root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces.js 2010-04-02 15:27:09 UTC (rev 16712) +++ root/framework/trunk/impl/src/main/resources/META-INF/resources/richfaces.js 2010-04-02 17:49:39 UTC (rev 16713) @@ -1,3 +1,13 @@ + +/** + * Global object container for RichFaces API. + * All classes should be defined here + * @class + * @name RichFaces + * + * */ +window.RichFaces = {}; + (function(richfaces, jQuery) { //form.js richfaces.submitForm = function(form, parameters, target) { @@ -644,5 +654,5 @@ }; }())); -}(window.RichFaces = {}, jQuery)); +}(RichFaces, jQuery));