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