1 //<script type="text/javascript">
2 GIRepository = imports.gi.GIRepository;
3 GObject = imports.gi.GObject;
6 * Yet another attempt to create a usable object construction library for seed..
9 * A) It turns rather messy code into a tree structure, making it easy to find code relating to
10 * an interface element
11 * B) In theory it should be gjs/Seed compatible..
12 * C) It provides getElementById style lookups for elements.
13 * D) It provides classic OO constructors for Javascript (extend/define)
14 * E) It does not modify any buildin prototypes..
16 * Extend this.. to use it's wonderful features..
19 * XObject = imports.XObject.XObject;
28 * Xyz.init(); // create and show.
31 * use XObject.debug = 1 to turn on debugging
33 * If XObject/[xns]/[xtype].js exists, it will use this to override properties..
36 * He's some questions.
37 * - should we have a special property to use as the constructor / gobject.properties rather
38 * than sending all basic types to this?
40 * @cfg xtype {String|Function} constructor or string.
41 * @cfg id {String} (optional) id for registry
42 * @cfg xns {String|Object} (optional) namespace eg. Gtk or 'Gtk' - used with xtype.
43 * @cfg items {Array} (optional) list of child elements which will be constructed.. using XObject
44 * @cfg listeners {Object} (optional) map Gobject signals to functions
45 * @cfg pack {Function|String|Array} (optional) how this object gets added to it's parent
46 * @cfg el {Object} (optional) premade GObject
55 function XObject (cfg) {
56 // first apply cfg if set.
57 //print("new XOBJECT!!!");
59 //print ("XObject ctr");
62 this.constructor = XObject;
66 // start by seeing if we have a base class....
68 // loocks for XObject/Gtk/TreeView.js [ TreeView = { .... } ]
69 // xns is not a string!!!?
71 if (typeof(cfg.xtype) == 'object') {
72 gname = GObject.type_name(cfg.xtype.type);
73 // print("GNAME:" +gname + " GTYPE:"+cfg.xtype.type);
76 var base = gname ? imports.XObjectBase[gname][gname] : false;
78 // print("Overlaying XOBJBECT-BASE." + cfg.xtype);
79 XObject.extend(this,base);
84 XObject.log("error finding " + gname + " - " + e.toString());
88 // copy down all elements into self..
89 // make an extra copy in this.config?? - which is the one used in the constructor later
93 if (typeof(cfg[i]) == 'function') { // do we skip objects.
96 // these properties are not copied to cfg.
107 this.config[i] = cfg[i];
111 this.items = this.items || [];
114 // pack can be false!
115 if (typeof(this.pack) == 'undefined') {
117 this.pack = [ 'add' ]
119 var Gtk = imports.gi.Gtk;
122 case (this.xtype == Gtk.MenuItem): this.pack = [ 'append' ]; break;
129 // interesting question should we call constructor on items here...
130 // as the real work is done in init anyway..
134 this.items.forEach(function(i) {
138 // create XObject for all the children.
139 items.forEach(function(i,n) {
141 var item = (i.constructor == XObject) ? o : new XObject(i);
143 _this.items.push(item);
146 if (this.onConstruct) {
147 this.onConstruct.call(this);
154 XObject.prototype = {
156 * @property el {GObject} the Gtk / etc. element.
160 * @property items {Array} list of sub elements
163 * @property parent {XObject} parent Element
167 * @property config {Object} the construction configuration.
171 * Initializes the Element (el) hooks up all the listeners
172 * and packs the children.
173 * you can override this, in child objects, then
174 * do this to do thi initaliztion.
176 * XObject.prototype.init.call(this);
183 //this.items.forEach(function(i) {
187 this.listeners = this.listeners || {};
190 // do we need to call 'beforeInit here?'
193 //if ((this.xtype == 'Include')) {
194 // o = this.pre_registry[cls];
196 var isSeed = typeof(Seed) != 'undefined';
198 // xtype= Gtk.Menu ?? what about c_new stuff?
199 XObject.log("init: ID:"+ this.id +" typeof(xtype): " + typeof(this.xtype));
200 if (!this.el && typeof(this.xtype) == 'function') {
201 XObject.log("func?" + XObject.keys(this.config).join(','));
202 this.el = this.xtype(this.config);
205 if (!this.el && typeof(this.xtype) == 'object') {
206 XObject.log("obj?" + XObject.keys(this.config).join(','));
207 this.el = new (this.xtype)(this.config);
211 if (!this.el && this.xns) {
213 var NS = imports.gi[this.xns];
215 XObject.error('Invalid xns: ' + this.xns, true);
217 constructor = NS[this.xtype];
219 XObject.error('Invalid xtype: ' + this.xns + '.' + this.xtype);
221 this.el = isSeed ? new constructor(this.config) : new constructor();
224 XObject.log("init: ID:"+ this.id +" typeof(el):" + this.el);
226 // always overlay props..
227 // check for 'write' on object..
229 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
231 var gi = GIRepository.IRepository.get_default();
232 var ty = gi.find_by_gtype(this.xtype.type);
234 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
235 var p = GIRepository.object_info_get_property(ty,i);
236 if (GIRepository.property_info_get_flags(p) & 2) {
237 write.push(GIRepository.base_info_get_name(p));
240 XObject.writeablePropsCache[this.xtype.type] = write;
241 print(write.join(", "));
247 for (var i in this.config) {
248 if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
251 if (i == 'buttons') { // problem with Gtk.MessageDialog..
254 if (i[0] == '.') { // parent? -
257 this.el[i] = this.config[i];
261 //if (o.xnsid && o.id) {
262 // XObject.registry = XObject.registry || { };
263 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
264 // XObject.registry[o.xnsid][o.id] = this;
267 var type = this.xtype.type ? GObject.type_name(this.xtype.type) : '';
268 XObject.log("add children to " + type);
271 this.items.forEach(function(i,n) {
276 for (var i in this.listeners) {
277 this.addListener(i, this.listeners[i]);
280 this.init = XObject.emptyFn;
282 // delete this.listeners ?
283 // do again so child props work!
285 // do we need to call 'init here?'
291 * Adds an item to the object using a new XObject
292 * uses pack property to determine how to add it.
293 * @arg cfg {Object} same as XObject constructor.
295 addItem : function(item, pos)
298 if (typeof(item) == 'undefined') {
299 XObject.error("Invalid Item added to this!");
300 imports.console.dump(this);
303 // what about extended items!?!?!?
306 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
307 // print("addItem - call init [" + item.pack.join(',') + ']');
309 XObject.err("NO EL!");
310 imports.console.dump(item);
315 if (item.pack===false) { // no packing.. various items have this ..
319 if (typeof(item.pack) == 'function') { // pack is a function..
321 item.pack.apply(item, [ this , item ]);
329 if (typeof(item.pack) == 'string') {
331 item.pack.split(',').forEach(function(e, i) {
333 if (e == 'false') { args.push( false); return; }
334 if (e == 'true') { args.push( true); return; }
335 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
338 //print(args.join(","));
340 pack_m = args.shift();
342 pack_m = item.pack.shift();
347 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
350 name: "ArgumentError",
351 message : 'pack method not available : ' + this.id + " : " + this.xtype + '.' + pack_m + " ADDING " + item.el
359 // finally call the pack method
360 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
362 args.unshift(item.el);
368 XObject.log(pack_m + '[' + args.join(',') +']');
369 //Seed.print('args: ' + args.length);
371 this.el[pack_m].apply(this.el, args);
378 * @method addListener
379 * Connects a method to a signal. (gjs/Seed aware)
381 * @arg sig {String} name of signal
382 * @arg fn {Function} handler.
384 addListener : function(sig, fn)
387 XObject.log("Add signal " + sig);
389 var _li = XObject.createDelegate(fn,this);
390 // private listeners that are not copied to GTk.
392 if (typeof(Seed) != 'undefined') {
393 // Seed.print(typeof(_li));
394 this.el.signal[sig].connect(_li);
396 this.el.connect( sig, _li);
403 * Finds an object in the child elements using xid of object.
404 * prefix with '.' to look up the tree..
405 * prefix with multiple '..' to look further up..
406 * prefix with '/' to look from the top, eg. '^LeftTree.model'
408 * @arg name {String} name of signal
409 * @return {XObject|false} the object if found.
413 XObject.log("SEARCH FOR " + xid + " in " + this.id);
418 name: "ArgumentError",
419 message : "ID not found : empty id"
424 return this.parent.get(xid.substring(1));
428 if (typeof(XObject.cache[xid]) != 'undefined') {
429 return XObject.cache[xid];
431 if (xid.indexOf('.') > -1) {
433 var child = xid.split('.');
434 var nxid = child.shift();
436 child = child.join('.');
437 if (typeof(XObject.cache[nxid]) != 'undefined') {
438 return XObject.cache[nxid].get(child);
449 ret = e.get(xid.substring(1));
454 name: "ArgumentError",
455 message : "ID not found : " + oid
458 XObject.cache[xid] = ret;
459 return XObject.cache[xid];
463 if (xid.indexOf('.') > -1) {
464 child = xid.split('.');
467 child = child.join('.');
470 if (xid == this.id) {
472 return child === false ? this : this.get(child);
475 name: "ArgumentError",
476 message : "ID not found : " + oid
483 this.items.forEach(function(ch) {
493 return child === false ? ret : ret.get(child);
496 name: "ArgumentError",
497 message : "ID not found : " + oid
504 this.items.forEach(function(ch) {
509 XObject.error("invalid item...");
510 imports.console.dump(_this);
521 name: "ArgumentError",
522 message : "ID not found : " + oid
526 return child === false ? ret : ret.get(child);
529 name: "ArgumentError",
530 message : "ID not found : " + oid
540 * Copies all the properties of config to obj.
542 * Pretty much the same as JQuery/Prototype.. or Roo.apply
543 * @param {Object} obj The receiver of the properties
544 * @param {Object} config The source of the properties
545 * @param {Object} defaults A different object that will also be applied for default values
546 * @return {Object} returns obj
547 * @member XObject extend
551 XObject.extend = function(o, c, defaults){
553 // no "this" reference for friendly out of scope calls
554 XObject.extend(o, defaults);
556 if(o && c && typeof c == 'object'){
564 XObject.extend(XObject,
568 * @property {Boolean} debug XObject debugging. - set to true to debug.
573 * @property {Object} cache - cache of object ids
581 emptyFn : function () { },
587 * @param {String|Object} output String to print.
589 log : function(output)
594 print("LOG:" + output);
599 * @param {String|Object} output String to print.
601 error : function(output)
603 print("ERROR: " + output);
608 * Copies all the properties of config to obj, if the do not exist.
609 * @param {Object} obj The receiver of the properties
610 * @param {Object} config The source of the properties
611 * @return {Object} returns obj
612 * @member Object extendIf
616 extendIf : function(o, c)
619 if(!o || !c || typeof c != 'object'){
623 if (typeof(o[p]) != 'undefined') {
634 * Extends one class with another class and optionally overrides members with the passed literal. This class
635 * also adds the function "override()" to the class that can be used to override
636 * members on an instance.
639 * MyObject = Object.define(
643 * parentClass, // or Object
645 * ... methods and properties.
648 * @param {Function} constructor The class inheriting the functionality
649 * @param {Object} superclass The class being extended
650 * @param {Object} overrides (optional) A literal with members
651 * @return {Function} constructor (eg. class
657 var io = function(o){
662 return function(constructor, parentClass, overrides) {
663 if (typeof(parentClass) == 'undefined') {
664 XObject.error("XObject.define: Missing parentClass: when applying: " );
665 XObject.error(new String(constructor));
668 if (typeof(parentClass.prototype) == 'undefined') {
669 XObject.error("Missing protype: when applying: " );
670 XObject.error(new String(constructor));
671 XObject.error(new String(parentClass));
674 var F = function(){};
676 var spp = parentClass.prototype;
679 sbp = constructor.prototype = new F();
680 sbp.constructor=constructor;
681 constructor.superclass=spp;
684 if(spp.constructor == Object.prototype.constructor){
685 spp.constructor=parentClass;
688 constructor.override = function(o){
689 Object.extend(constructor.prototype, o);
692 XObject.extend(constructor.prototype, overrides);
699 * returns a list of keys of the object.
700 * @param {Object} obj object to inspect
701 * @return {Array} returns list of kyes
702 * @member XObject keys
714 * @member XObject createDelegate
715 * creates a delage metdhod
716 * @param {Function} method to wrap
717 * @param {Object} scope
718 * @param {Array} args to add
719 * @param {Boolean|Number} append arguments or replace after N arguments.
720 * @return {Function} returns the delegate
723 createDelegate : function(method, obj, args, appendArgs){
726 XObject.log("CALL: " + obj.id + ':'+ method.id);
728 var callArgs = args || arguments;
729 if(appendArgs === true){
730 callArgs = Array.prototype.slice.call(arguments, 0);
731 callArgs = callArgs.concat(args);
732 }else if(typeof appendArgs == "number"){
733 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
734 var applyArgs = [appendArgs, 0].concat(args); // create method call params
735 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
737 return method.apply(obj || window, callArgs);