src/js/widgets.js
author veltr
Wed, 27 Jun 2012 19:03:37 +0200
branchnew-model
changeset 922 096c06aea8b5
parent 916 ec6849bbbdcc
child 924 64c2eaafe5e2
permissions -rw-r--r--
Minor changes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
     1
/* Definition of an ancestor for the Widget classes */
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
     2
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
     3
if (typeof IriSP.Widgets === "undefined") {
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
     4
    IriSP.Widgets = {}
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
     5
}
66
13013b9452af Added a new file to the build, widgets.js, to contain widget classes.
hamidouk
parents:
diff changeset
     6
520
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents: 287
diff changeset
     7
/**
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
     8
 * @class IriSP.Widget is an "abstract" class. It's mostly used to define some properties common to every widget.
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
     9
 *
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    10
 *  Note that widget constructors are never called directly by the user. Instead, the widgets are instantiated by functions
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    11
 *  defined in init.js
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    12
 *
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    13
 * @constructor
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    14
 * @param player - a reference to the player widget
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    15
 * @param config - configuration options for the widget
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    16
 */
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    17
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    18
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    19
IriSP.Widgets.Widget = function(player, config) {
287
5c7495102bd7 added a spacer div to simplify some graphic animations.
hamidouk
parents: 170
diff changeset
    20
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    21
    if( typeof player === "undefined") {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    22
        /* Probably an abstract call of the class when
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    23
         * individual widgets set their prototype */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    24
        return;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    25
    }
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    26
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    27
    /* Setting all the configuration options */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    28
    var _type = config.type,
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    29
        _config = IriSP._.defaults({}, config, player.config.gui.default_options, this.defaults),
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    30
        _this = this;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    31
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    32
    IriSP._(_config).forEach(function(_value, _key) {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    33
       _this[_key] = _value;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    34
    });
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    35
    
872
d777d05a16e4 finished AnnotationsList and started New PolemicWidget
veltr
parents: 870
diff changeset
    36
    if (typeof this.width === "undefined") {
d777d05a16e4 finished AnnotationsList and started New PolemicWidget
veltr
parents: 870
diff changeset
    37
        this.width = player.config.gui.width;
d777d05a16e4 finished AnnotationsList and started New PolemicWidget
veltr
parents: 870
diff changeset
    38
    }
d777d05a16e4 finished AnnotationsList and started New PolemicWidget
veltr
parents: 870
diff changeset
    39
    
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    40
    /* Setting this.player at the end in case it's been overriden
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    41
     * by a configuration option of the same name :-(
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    42
     */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    43
    this.player = player;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    44
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    45
    /* Getting metadata */
870
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
    46
    this.source = player.loadMetadata(this.metadata);
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    47
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    48
    /* Call draw when loaded */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    49
    this.source.onLoad(function() {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    50
        _this.draw();
870
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
    51
    });
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    52
   
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    53
    /* Adding classes and html attributes */
870
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
    54
    this.$ = IriSP.jQuery('#' + this.container);
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    55
    this.$.addClass("Ldt-TraceMe Ldt-Widget").attr("widget-type", _type);
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    56
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    57
    /* Does the widget require other widgets ? */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    58
    if (typeof this.requires !== "undefined") {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    59
        for (var _i = 0; _i < this.requires.length; _i++) {
874
38b65761a7d5 TooltipWidget, SliderWidget, corrections in AnnotationList, CSS are now split
veltr
parents: 872
diff changeset
    60
            var _subconfig = this.requires[_i];
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    61
            _subconfig.container = IriSP._.uniqueId(this.container + '_' + _subconfig.type + '_');
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    62
            this.$.append(IriSP.jQuery('<div>').attr("id",_subconfig.container));
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    63
            this.player.loadWidget(_subconfig, function(_widget) {
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    64
                _this[_subconfig.type.replace(/^./,function(_s){return _s.toLowerCase();})] = _widget
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    65
            });
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    66
        }
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    67
    }
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    68
    
916
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    69
    this.l10n = (
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    70
        typeof this.messages[IriSP.language] !== "undefined"
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    71
        ? this.messages[IriSP.language]
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    72
        : (
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    73
            IriSP.language.length > 2 && typeof this.messages[IriSP.language.substr(0,2)] !== "undefined"
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    74
            ? this.messages[IriSP.language.substr(0,2)]
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    75
            : this.messages["en"]
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    76
        )
ec6849bbbdcc Removed Namespacing before rewrite
veltr
parents: 908
diff changeset
    77
    );
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    78
    
66
13013b9452af Added a new file to the build, widgets.js, to contain widget classes.
hamidouk
parents:
diff changeset
    79
};
74
d7a7d7216371 lots of changes to the player widget...
hamidouk
parents: 66
diff changeset
    80
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    81
IriSP.Widgets.Widget.prototype.defaults = {}
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    82
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    83
IriSP.Widgets.Widget.prototype.template = '';
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    84
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    85
IriSP.Widgets.Widget.prototype.messages = {"en":{}};
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    86
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    87
IriSP.Widgets.Widget.prototype.templateToHtml = function(_template) {
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    88
    return Mustache.to_html(_template, this);
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    89
}
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    90
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    91
IriSP.Widgets.Widget.prototype.renderTemplate = function() {
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    92
    this.$.append(this.templateToHtml(this.template));
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    93
}
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    94
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
    95
IriSP.Widgets.Widget.prototype.functionWrapper = function(_name) {
870
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
    96
    var _this = this,
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
    97
        _function = this[_name];
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
    98
    if (typeof _function !== "undefined") {
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
    99
        return function() {
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   100
            return _function.apply(_this, Array.prototype.slice.call(arguments, 0));
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   101
        }
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   102
    } else {
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   103
        console.log("Error, Unknown function IriSP." + this.type + "." + _name)
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   104
    }
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   105
}
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   106
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
   107
IriSP.Widgets.Widget.prototype.bindPopcorn = function(_popcornEvent, _functionName) {
870
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   108
    this.player.popcorn.listen(_popcornEvent, this.functionWrapper(_functionName))
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   109
}
2c025db10a10 Migrated playerWidget and started annotationsListWidget
veltr
parents: 868
diff changeset
   110
876
03967b6ada7c ArrowWidget, AnnotationWidget
veltr
parents: 875
diff changeset
   111
IriSP.Widgets.Widget.prototype.getWidgetAnnotations = function() {
900
7673d645a8e0 Metadataplayer Mashup
veltr
parents: 876
diff changeset
   112
    var _curmedia = this.source.currentMedia;
7673d645a8e0 Metadataplayer Mashup
veltr
parents: 876
diff changeset
   113
    return typeof this.annotation_type !== "undefined" && this.annotation_type ? _curmedia.getAnnotationsByTypeTitle(this.annotation_type) : _curmedia.getAnnotations();
876
03967b6ada7c ArrowWidget, AnnotationWidget
veltr
parents: 875
diff changeset
   114
}
03967b6ada7c ArrowWidget, AnnotationWidget
veltr
parents: 875
diff changeset
   115
922
096c06aea8b5 Minor changes
veltr
parents: 916
diff changeset
   116
IriSP.Widgets.Widget.prototype.getWidgetAnnotationsAtTime = function() {
096c06aea8b5 Minor changes
veltr
parents: 916
diff changeset
   117
    var _time = Math.floor(this.player.popcorn.currentTime() * 1000);
096c06aea8b5 Minor changes
veltr
parents: 916
diff changeset
   118
    return this.getWidgetAnnotations().filter(function(_annotation) {
096c06aea8b5 Minor changes
veltr
parents: 916
diff changeset
   119
        return _annotation.begin <= _time && _annotation.end > _time;
096c06aea8b5 Minor changes
veltr
parents: 916
diff changeset
   120
    });
096c06aea8b5 Minor changes
veltr
parents: 916
diff changeset
   121
}
096c06aea8b5 Minor changes
veltr
parents: 916
diff changeset
   122
520
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents: 287
diff changeset
   123
/**
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
   124
 * This method responsible of drawing a widget on screen.
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
   125
 */
875
43629caa77bc Big refactoring of widget files + started migration of segmentwidget
veltr
parents: 874
diff changeset
   126
IriSP.Widgets.Widget.prototype.draw = function() {
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
   127
    /* implemented by "sub-classes" */
908
f56199193fad CreateAnnotation widget now posts annotations, Tagcloud can be made segment-dependent
veltr
parents: 900
diff changeset
   128
};