src/js/widgets.js
author veltr
Tue, 17 Apr 2012 20:19:46 +0200
branchnew-model
changeset 868 a525cc2214e7
parent 866 3bf7aa8216e5
child 870 2c025db10a10
permissions -rw-r--r--
Started big refactoring
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
66
13013b9452af Added a new file to the build, widgets.js, to contain widget classes.
hamidouk
parents:
diff changeset
     1
/* the widget classes and definitions */
13013b9452af Added a new file to the build, widgets.js, to contain widget classes.
hamidouk
parents:
diff changeset
     2
520
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents: 287
diff changeset
     3
/**
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
     4
 * @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
     5
 *
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
     6
 *  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
     7
 *  defined in init.js
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
     8
 *
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
     9
 * @constructor
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    10
 * @param player - a reference to the player widget
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    11
 * @param config - configuration options for the widget
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    12
 */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    13
IriSP.Widget = function(player, config) {
287
5c7495102bd7 added a spacer div to simplify some graphic animations.
hamidouk
parents: 170
diff changeset
    14
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    15
    if( typeof player === "undefined") {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    16
        /* Probably an abstract call of the class when
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    17
         * individual widgets set their prototype */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    18
        return;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    19
    }
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    20
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    21
    /* Setting all the configuration options */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    22
    var _type = config.type,
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    23
        _config = IriSP._.defaults({}, config, _player.config.gui.default_options, IriSP.widgetsDefaults[_type]),
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    24
        _this = this;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    25
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    26
    /* Creating containers if needed */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    27
    if (typeof _config.container === "undefined") {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    28
        var _divs = _player.layoutDivs(_type);
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    29
        _config.container = _divs[0];
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    30
        _config.spacer = _divs[1];
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    31
    }
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    32
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    33
    IriSP._(_config).forEach(function(_value, _key) {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    34
       _this[_key] = _value;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    35
    });
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    36
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    37
    /* Setting this.player at the end in case it's been overriden
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    38
     * by a configuration option of the same name :-(
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    39
     */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    40
    this.player = player;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    41
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    42
    /* Getting metadata */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    43
    this.source = _player.loadMetadata(this.metadata);
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    44
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    45
    /* Call draw when loaded */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    46
    this.source.onLoad(function() {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    47
        _this.draw();
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    48
    })
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    49
   
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    50
    /* Adding classes and html attributes */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    51
    this.selector = IriSP.jQuery(this.container);
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    52
    this.selector.addClass("Ldt-TraceMe").addClass("Ldt-Widget").attr("widget-type", _type);
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    53
    
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    54
    /* Does the widget require other widgets ? */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    55
    if (typeof this.requires !== "undefined") {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    56
        for (var _i = 0; _i < this.requires.length; _i++) {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    57
            var _subconfig = this.requires[_i],
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    58
                _div = IriSP.jQuery('<div>');
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    59
            _subconfig.container = IriSP.guid(this.container + '_' + _subconfig.type + '_');
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    60
            _div.id = _subconfig.container;
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    61
            this.selector.append(_div);
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    62
            this[_subconfig.type] = new IriSP.Widgets(_player, _subconfig);
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    63
        }
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    64
    }
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    65
    
66
13013b9452af Added a new file to the build, widgets.js, to contain widget classes.
hamidouk
parents:
diff changeset
    66
};
74
d7a7d7216371 lots of changes to the player widget...
hamidouk
parents: 66
diff changeset
    67
520
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents: 287
diff changeset
    68
/**
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    69
 * This method responsible of drawing a widget on screen.
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    70
 */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    71
IriSP.Widget.prototype.draw = function() {
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    72
    /* implemented by "sub-classes" */
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    73
};
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    74
/**
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    75
 * Optional method if you want your widget to support redraws.
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    76
 */
74
d7a7d7216371 lots of changes to the player widget...
hamidouk
parents: 66
diff changeset
    77
IriSP.Widget.prototype.redraw = function() {
868
a525cc2214e7 Started big refactoring
veltr
parents: 866
diff changeset
    78
    /* implemented by "sub-classes" */
74
d7a7d7216371 lots of changes to the player widget...
hamidouk
parents: 66
diff changeset
    79
};