Source: poll.js

  1. (function($, rf) {
  2.     rf.ui = rf.ui || {};
  3.     var defaultOptions = {
  4.     };
  5.     
  6.     /**
  7.      * Backing object for a4j:poll
  8.      * 
  9.      * @extends RichFaces.BaseComponent
  10.      * @memberOf! RichFaces.ui
  11.      * @constructs RichFaces.ui.Poll
  12.      * 
  13.      * @param componentId
  14.      * @param options
  15.      */
  16.     rf.ui.Poll = function(componentId, options) {
  17.         $super.constructor.call(this, componentId, options);
  18.         this.id = componentId;
  19.         this.attachToDom();
  20.         this.interval = options.interval || 1000;
  21.         this.ontimer = options.ontimer;
  23.         this.pollElement = rf.getDomElement(this.id);
  25.         rf.ui.pollTracker = rf.ui.pollTracker || {};
  27.         if (options.enabled) {
  28.             this.startPoll();
  29.         }
  30.     }
  32.     rf.BaseComponent.extend(rf.ui.Poll);
  33.     var $super = rf.ui.Poll.$super;
  34.     $.extend(rf.ui.Poll.prototype, (function() {
  35.         return {
  36.             name: "Poll",
  38.             /**
  39.              * Start the poll
  40.              * 
  41.              * @method
  42.              * @name RichFaces.ui.Poll#startPoll
  43.              */
  44.             startPoll: function() {
  45.                 this.stopPoll();
  46.                 var poll = this;
  47.                 rf.ui.pollTracker[poll.id] = window.setTimeout(function() {
  48.                     try {
  49.                         poll.ontimer.call(poll.pollElement || window);
  50.                         poll.startPoll();
  51.                     } catch (e) {
  52.                         // TODO: handle exception
  53.                     }
  54.                 }, poll.interval);
  55.             },
  57.             /**
  58.              * Stop the poll
  59.              * 
  60.              * @method
  61.              * @name RichFaces.ui.Poll#stopPoll
  62.              */
  63.             stopPoll : function() {
  64.                 if (rf.ui.pollTracker && rf.ui.pollTracker[this.id]) {
  65.                     window.clearTimeout(rf.ui.pollTracker[this.id]);
  66.                     delete rf.ui.pollTracker[this.id];
  67.                 }
  68.             },
  70.             setZeroRequestDelay : function(options) {
  71.                 if (typeof options.requestDelay == "undefined") {
  72.                     options.requestDelay = 0;
  73.                 }
  74.             },
  76.             destroy : function() {
  77.                 this.stopPoll();
  78.                 this.detach(this.id);
  79.                 // call parent's destroy method
  80.                 $super.destroy.call(this);
  81.             }
  83.         };
  84.     })());
  86. })(RichFaces.jQuery, RichFaces);