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
 125         if (typeof(item.pack) == 'function') {
 126             // parent, child
 127             item.pack.apply(o, [ o , o.items[i] ]);
 128             item.parent = this;
 129             return;
 130         }
 131
 132
 133         var pack_m = typeof(item.pack) == 'string' ?  item.pack :  item.pack.shift();
 134
 135         // handle error.
 136         if (pack_m && typeof(o.el[pack_m]) == 'undefined') {
 137             Seed.print('pack method not available : ' + o.xtype + '.' +  pack_m);
 138             return;
 139         }
 140
 141
 142         //Seed.print('Pack ' + o.xtype + '.'+ pack_m + '(' + o.items[i].xtype + ')');
 143         // copy.
 144         var args = Array.prototype.slice.call(typeof(item.pack) == 'string' ? [] : item.pack);
 145         item.pack.unshift(item.el);
 146         //Seed.print('args: ' + args.length);
 147         if (pack_m) {
 148             this.el[pack_m].apply(item.el, args);
 149         }
 150
 151         item.parent = this;
 152
 153     },
 154     /**
 155       * @method addListener
 156       * Connects a method to a signal. (gjs/Seed aware)
 157       *
 158       * @arg sig  {String} name of signal
 159       * @arg fn  {Function} handler.
 160       */
 161     addListener  : function(sig, fn)
 162     {
 163
 164         Seed.print("Add signal " + sig);
 165
 166         var _li = XObject.createDelegate(fn,this);
 167         // private listeners that are not copied to GTk.
 168
 169         if (typeof(Seed) != 'undefined') {
 170           //   Seed.print(typeof(_li));
 171             this.el.signal[sig].connect(_li);
 172         } else {
 173             this.el.connect( sig, _li);
 174         }
 175
 176
 177     },
 178      /**
 179       * @method get
 180       * Finds an object in the child elements using xid of object.
 181       *
 182       * @arg name  {String} name of signal
 183       * @return   {XObject|false} the object if found.
 184       */
 185     get : function(xid)
 186     {
 187         var ret=  false;
 188         this.items.each(function(ch) {
 189             if (ch.xid == xid) {
 190                 ret = ch;
 191                 return true;
 192             }
 193         })
 194         if (ret) {
 195             return ret;
 196         }
 197         // iterate children.
 198         this.items.each(function(ch) {
 199             ret = ch.get(xid);
 200             if (ret) {
 201                 return true;
 202             }
 203         })
 204         return ret;
 205     }
 206
 207
 208 }
 209
 210
 211 /**
 212  * Copies all the properties of config to obj.
 213  *
 214  * Pretty much the same as JQuery/Prototype..
 215  * @param {Object} obj The receiver of the properties
 216  * @param {Object} config The source of the properties
 217  * @param {Object} defaults A different object that will also be applied for default values
 218  * @return {Object} returns obj
 219  * @member XObject extend
 220  */
 221
 222
 223 XObject.extend = function(o, c, defaults){
 224     if(defaults){
 225         // no "this" reference for friendly out of scope calls
 226         XObject.extend(o, defaults);
 227     }
 228     if(o && c && typeof c == 'object'){
 229         for(var p in c){
 230             o[p] = c[p];
 231         }
 232     }
 233     return o;
 234 };
 235
 236 XObject.extend(XObject,
 237 {
 238     /**
 239      * Copies all the properties of config to obj, if the do not exist.
 240      * @param {Object} obj The receiver of the properties
 241      * @param {Object} config The source of the properties
 242      * @return {Object} returns obj
 243      * @member Object extendIf
 244      */
 245
 246
 247     extendIf : function(o, c){
 248
 249         if(!o || !c || typeof c != 'object'){
 250             return o;
 251         }
 252         for(var p in c){
 253             if (typeof(o[p]) != 'undefined') {
 254                 continue;
 255             }
 256             o[p] = c[p];
 257         }
 258         return o;
 259     },
 260
 261
 262
 263     /**
 264      * Extends one class with another class and optionally overrides members with the passed literal. This class
 265      * also adds the function "override()" to the class that can be used to override
 266      * members on an instance.
 267      *
 268      * usage:
 269      * MyObject = Object.define(
 270      *     function(...) {
 271      *          ....
 272      *     },
 273      *     parentClass, // or Object
 274      *     {
 275      *        ... methods and properties.
 276      *     }
 277      * });
 278      * @param {Function} constructor The class inheriting the functionality
 279      * @param {Object} superclass The class being extended
 280      * @param {Object} overrides (optional) A literal with members
 281      * @return {Function} constructor (eg. class
 282      * @method define
 283      */
 284     define : function(){
 285         // inline overrides
 286         var io = function(o){
 287             for(var m in o){
 288                 this[m] = o[m];
 289             }
 290         };
 291         return function(sb, sp, overrides) {
 292             if (typeof(sp) == 'undefined') {
 293                 // error condition - try and dump..
 294                 throw "Missing superclass: when applying: " + sb
 295             }
 296
 297             var F = function(){}, sbp, spp = sp.prototype;
 298             F.prototype = spp;
 299             sbp = sb.prototype = new F();
 300             sbp.constructor=sb;
 301             sb.superclass=spp;
 302
 303             // extends Object.
 304             if(spp.constructor == Object.prototype.constructor){
 305                 spp.constructor=sp;
 306             }
 307
 308             sb.override = function(o){
 309                 Object.extend(sb.prototype, o);
 310             };
 311             sbp.override = io;
 312             Object.extend(sb.prototype, overrides);
 313             return sb;
 314         };
 315     }(),
 316
 317
 318     /**
 319      * returns a list of keys of the object.
 320      * @param {Object} obj object to inspect
 321      * @return {Array} returns list of kyes
 322      * @member XObject keys
 323      */
 324     keys : function(o)
 325     {
 326         var ret = [];
 327         for(var i in o) {
 328             ret.push[i];
 329         }
 330         return ret;
 331     },
 332
 333     /**
 334      * @member XObject createDelegate
 335      * creates a delage metdhod
 336      * @param {Function} method to wrap
 337      * @param {Object} scope
 338      * @param {Array} args to add
 339      * @param {Boolean|Number} append arguments or replace after N arguments.
 340      * @return {Function} returns the delegate
 341      */
 342
 343     createDelegate : function(method, obj, args, appendArgs){
 344
 345         return function() {
 346             var callArgs = args || arguments;
 347             if(appendArgs === true){
 348                 callArgs = Array.prototype.slice.call(arguments, 0);
 349                 callArgs = callArgs.concat(args);
 350             }else if(typeof appendArgs == "number"){
 351                 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
 352                     var applyArgs = [appendArgs, 0].concat(args); // create method call params
 353                     Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
 354                 }
 355                 return method.apply(obj || window, callArgs);
 356             };
 357     }
 358
 359 });