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