git.roojs.org Git - gitlive/blob - XObject.js

   1 //<script type="text/javascript">
   2
   3 /**
   4  * XObject
   5  * Yet another attempt to create a usable object construction library for seed..
   6  *
   7  * Extend this.. to use it's wonderful features..
   8  *
   9  *
  10  * @arg xtype {String|Function} constructor or string.
  11  * @arg xid {String}  (optional) id for registry
  12  * @arg xns {String|Object}   (optional) namespace eg. Gtk or 'Gtk' - used with xtype.
  13  * @arg items {Array}   (optional) list of child elements which will be constructed.. using XObject
  14  * @arg listeners {Object}   (optional) map Gobject signals to functions
  15  * @arg pack {Function|String|Array}   (optional) how this object gets added to it's parent
  16  * @arg el {Object}   (optional) premade GObject
  17  */
  18
  19 function XObject (cfg) {
  20     // first apply cfg if set.
  21     o =  {};
  22
  23     cfg.items = cfg.items || [];
  24
  25     XObject.extend(o, cfg); // copy everything into o.
  26
  27     o.pack = typeof(o.pack) == 'undefined' ? 'add' : o.pack;
  28
  29     XObject.extend(this, o);
  30
  31     // remove items.
  32
  33     this.listeners = this.listeners || {};
  34     this.items = [];
  35
  36     // remove objects/functions from o, so they can be sent to the contructor.
  37     for (var i in o) {
  38         if ((typeof(o[i]) == 'object') ||
  39             (typeof(o[i]) == 'function') ||
  40             i == 'pack' ||
  41             i == 'xid' ||
  42             i == 'xtype' ||
  43             i == 'xns'
  44         ) {
  45             delete o[i];
  46         }
  47     }
  48
  49     // do we need to call 'beforeInit here?'
  50
  51     // handle include?
  52     //if ((this.xtype == 'Include')) {
  53     //    o = this.pre_registry[cls];
  54     //}
  55     var isSeed = typeof(Seed) != 'undefined';
  56
  57     // xtype= Gtk.Menu ?? what about c_new stuff?
  58     if (typeof(this.xtype) == 'function') {
  59         this.el = this.el ||  this.xtype(o);
  60     }
  61     if (typeof(this.xtype) == 'object') {
  62         this.el = this.el ||  new this.xtype(o);
  63     }
  64     print(this.el);
  65     if (!this.el && o.xns) {
  66
  67         var NS = imports.gi[o.xns];
  68         if (!NS) {
  69             Seed.print('Invalid xns: ' + o.xns);
  70         }
  71         constructor = NS[o.xtype];
  72         if (!constructor) {
  73             Seed.print('Invalid xtype: ' + o.xns + '.' + o.xtype);
  74         }
  75         this.el  =   isSeed ? new constructor(o) : new constructor();
  76         if (!isSeed) {
  77             // this might work for gjs!?
  78             for (var i in o) {
  79                 this.el[i] = o;
  80             }
  81         }
  82     }
  83
  84     // register it!
  85     //if (o.xnsid  && o.xid) {
  86      //   XObject.registry = XObject.registry || { };
  87      //   XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
  88      //   XObject.registry[o.xnsid][o.xid] = this;
  89     //}
  90
  91     cfg.items.forEach(this.addItem, this);
  92
  93     for (var i in this.listeners) {
  94         this.addListener(i, this.listeners[i]);
  95     }
  96     // delete this.listeners ?
  97
  98
  99     // do we need to call 'init here?'
 100
 101 }
 102
 103
 104
 105 XObject.prototype = {
 106     /**
 107      * @property el {GObject} the Gtk / etc. element.
 108      */
 109     el : false,
 110     /*
 111      * @property items {Array} list of sub elements
 112      */
 113     /**
 114      * @property parent {XObject} parent Element
 115      */
 116      /**
 117       * @method addItem
 118       * Adds an item to the object using a new XObject
 119       * uses pack property to determine how to add it.
 120       * @arg cfg {Object} same as XObject constructor.
 121       */
 122     addItem : function(o) {
 123         var item = new XObject(o);
 124
 125         this.items.push(item);
 126
 127         if (item.pack===false) {  // no
 128             return;
 129         }
 130         if (typeof(item.pack) == 'function') {
 131             // parent, child
 132             item.pack.apply(o, [ o , o.items[i] ]);
 133             item.parent = this;
 134             return;
 135         }
 136
 137
 138
 139         var pack_m = typeof(item.pack) == 'string' ?  item.pack :  item.pack.shift();
 140
 141         // handle error.
 142         if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
 143             Seed.print('pack method not available : ' + this.xtype + '.' +  pack_m);
 144             return;
 145         }
 146
 147
 148         Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
 149         // copy.
 150         var args = Array.prototype.slice.call(typeof(item.pack) == 'string' ? [] : item.pack);
 151         args.unshift(item.el);
 152         //Seed.print('args: ' + args.length);
 153         if (pack_m) {
 154             this.el[pack_m].apply(item.el, args);
 155         }
 156
 157         item.parent = this;
 158
 159     },
 160     /**
 161       * @method addListener
 162       * Connects a method to a signal. (gjs/Seed aware)
 163       *
 164       * @arg sig  {String} name of signal
 165       * @arg fn  {Function} handler.
 166       */
 167     addListener  : function(sig, fn)
 168     {
 169
 170         Seed.print("Add signal " + sig);
 171
 172         var _li = XObject.createDelegate(fn,this);
 173         // private listeners that are not copied to GTk.
 174
 175         if (typeof(Seed) != 'undefined') {
 176           //   Seed.print(typeof(_li));
 177             this.el.signal[sig].connect(_li);
 178         } else {
 179             this.el.connect( sig, _li);
 180         }
 181
 182
 183     },
 184      /**
 185       * @method get
 186       * Finds an object in the child elements using xid of object.
 187       *
 188       * @arg name  {String} name of signal
 189       * @return   {XObject|false} the object if found.
 190       */
 191     get : function(xid)
 192     {
 193         var ret=  false;
 194         this.items.forEach(function(ch) {
 195             if (ch.xid == xid) {
 196                 ret = ch;
 197                 return true;
 198             }
 199         })
 200         if (ret) {
 201             return ret;
 202         }
 203         // iterate children.
 204         this.items.forEach(function(ch) {
 205             ret = ch.get(xid);
 206             if (ret) {
 207                 return true;
 208             }
 209         })
 210         return ret;
 211     }
 212
 213
 214 }
 215
 216
 217 /**
 218  * Copies all the properties of config to obj.
 219  *
 220  * Pretty much the same as JQuery/Prototype..
 221  * @param {Object} obj The receiver of the properties
 222  * @param {Object} config The source of the properties
 223  * @param {Object} defaults A different object that will also be applied for default values
 224  * @return {Object} returns obj
 225  * @member XObject extend
 226  */
 227
 228
 229 XObject.extend = function(o, c, defaults){
 230     if(defaults){
 231         // no "this" reference for friendly out of scope calls
 232         XObject.extend(o, defaults);
 233     }
 234     if(o && c && typeof c == 'object'){
 235         for(var p in c){
 236             o[p] = c[p];
 237         }
 238     }
 239     return o;
 240 };
 241
 242 XObject.extend(XObject,
 243 {
 244     /**
 245      * Copies all the properties of config to obj, if the do not exist.
 246      * @param {Object} obj The receiver of the properties
 247      * @param {Object} config The source of the properties
 248      * @return {Object} returns obj
 249      * @member Object extendIf
 250      */
 251
 252
 253     extendIf : function(o, c){
 254
 255         if(!o || !c || typeof c != 'object'){
 256             return o;
 257         }
 258         for(var p in c){
 259             if (typeof(o[p]) != 'undefined') {
 260                 continue;
 261             }
 262             o[p] = c[p];
 263         }
 264         return o;
 265     },
 266
 267
 268
 269     /**
 270      * Extends one class with another class and optionally overrides members with the passed literal. This class
 271      * also adds the function "override()" to the class that can be used to override
 272      * members on an instance.
 273      *
 274      * usage:
 275      * MyObject = Object.define(
 276      *     function(...) {
 277      *          ....
 278      *     },
 279      *     parentClass, // or Object
 280      *     {
 281      *        ... methods and properties.
 282      *     }
 283      * });
 284      * @param {Function} constructor The class inheriting the functionality
 285      * @param {Object} superclass The class being extended
 286      * @param {Object} overrides (optional) A literal with members
 287      * @return {Function} constructor (eg. class
 288      * @method define
 289      */
 290     define : function(){
 291         // inline overrides
 292         var io = function(o){
 293             for(var m in o){
 294                 this[m] = o[m];
 295             }
 296         };
 297         return function(sb, sp, overrides) {
 298             if (typeof(sp) == 'undefined') {
 299                 // error condition - try and dump..
 300                 throw "Missing superclass: when applying: " + sb
 301             }
 302
 303             var F = function(){}, sbp, spp = sp.prototype;
 304             F.prototype = spp;
 305             sbp = sb.prototype = new F();
 306             sbp.constructor=sb;
 307             sb.superclass=spp;
 308
 309             // extends Object.
 310             if(spp.constructor == Object.prototype.constructor){
 311                 spp.constructor=sp;
 312             }
 313
 314             sb.override = function(o){
 315                 Object.extend(sb.prototype, o);
 316             };
 317             sbp.override = io;
 318             Object.extend(sb.prototype, overrides);
 319             return sb;
 320         };
 321     }(),
 322
 323
 324     /**
 325      * returns a list of keys of the object.
 326      * @param {Object} obj object to inspect
 327      * @return {Array} returns list of kyes
 328      * @member XObject keys
 329      */
 330     keys : function(o)
 331     {
 332         var ret = [];
 333         for(var i in o) {
 334             ret.push[i];
 335         }
 336         return ret;
 337     },
 338
 339     /**
 340      * @member XObject createDelegate
 341      * creates a delage metdhod
 342      * @param {Function} method to wrap
 343      * @param {Object} scope
 344      * @param {Array} args to add
 345      * @param {Boolean|Number} append arguments or replace after N arguments.
 346      * @return {Function} returns the delegate
 347      */
 348
 349     createDelegate : function(method, obj, args, appendArgs){
 350
 351         return function() {
 352             var callArgs = args || arguments;
 353             if(appendArgs === true){
 354                 callArgs = Array.prototype.slice.call(arguments, 0);
 355                 callArgs = callArgs.concat(args);
 356             }else if(typeof appendArgs == "number"){
 357                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
 358                     var applyArgs = [appendArgs, 0].concat(args); // create method call params
 359                     Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
 360                 }
 361                 return method.apply(obj || window, callArgs);
 362             };
 363     }
 364
 365 });