src/js/widgets/polemicWidget.js
branchpopcorn-port
changeset 528 a5894f09825a
parent 490 2a7fca4f0cc4
child 565 903435828e6c
--- a/src/js/widgets/polemicWidget.js	Fri Dec 23 16:39:49 2011 +0100
+++ b/src/js/widgets/polemicWidget.js	Fri Dec 23 16:40:16 2011 +0100
@@ -18,6 +18,7 @@
 */
 // CHART TIMELINE / VERSION PROTOTYPE  ::
 
+/** the polemic widget */
 IriSP.PolemicWidget = function(Popcorn, config, Serializer) {
   IriSP.Widget.call(this, Popcorn, config, Serializer);
  
@@ -354,6 +355,7 @@
     this._Popcorn.listen("timeupdate", IriSP.wrap(this, this.sliderUpdater));
 }
 
+/** update the positionMarker as time passes */
 IriSP.PolemicWidget.prototype.sliderUpdater = function() {
 
     var time = +this._Popcorn.currentTime();
@@ -363,7 +365,8 @@
         
     this.sliderTip.attr("x", time * (this.width / (duration / 1000)));
 };
-    
+
+/** reacts to IriSP.search events */    
 IriSP.PolemicWidget.prototype.searchHandler = function(searchString) {
   if (searchString == "")
     return;
@@ -395,6 +398,7 @@
   this.oldSearchMatches = matches;
 };
 
+/** reacts to IriSP.search.cleared messages */
 IriSP.PolemicWidget.prototype.searchFieldClearedHandler = function() {
   // clean up the blocks that were in the previous search
   // but who aren't in the current one.
@@ -405,6 +409,7 @@
  
 };
 
+/** reacts to IriSP.search.closed messages by clearing the highlighted elements */
 IriSP.PolemicWidget.prototype.searchFieldClosedHandler = function() {
   // clean up the blocks that were in the previous search
   // but who aren't in the current one.