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 XObjectBase/[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");
61 this.config = {}; // used to initialize GObject
63 this.cfg = XObject.extend({}, cfg); // used to store original configuration.. for referencing..
65 // we could use this to determine if
66 // we are actually inside a inherited class...
67 // as define() should actually set this up..
69 if (!this.constructor) {
71 this.constructor = XObject;
72 var base = XObject.baseXObject(cfg);
74 XObject.extend(this,base.prototype);
79 // copy down all elements into self..
80 // make an extra copy in this.config?? - which is the one used in the constructor later
84 if (typeof(cfg[i]) == 'function') { // do we skip objects.
87 // these properties are not copied to cfg.
98 this.config[i] = cfg[i];
102 this.items = this.items || [];
105 // pack can be false!
106 if (typeof(this.pack) == 'undefined') {
108 this.pack = [ 'add' ]
110 var Gtk = imports.gi.Gtk;
113 case (this.xtype == Gtk.MenuItem): this.pack = [ 'append' ]; break;
120 // interesting question should we call constructor on items here...
121 // as the real work is done in init anyway..
125 this.items.forEach(function(i) {
129 // create XObject for all the children.
130 items.forEach(function(i,n) {
132 var item = (i.constructor == XObject) ? o : new XObject(i);
134 _this.items.push(item);
137 if (this.onConstruct) {
138 this.onConstruct.call(this);
145 XObject.prototype = {
147 * @property el {GObject} the Gtk / etc. element.
151 * @property items {Array} list of sub elements
154 * @property parent {XObject} parent Element
158 * @property config {Object} the construction configuration.
162 * Initializes the Element (el) hooks up all the listeners
163 * and packs the children.
164 * you can override this, in child objects, then
165 * do this to do thi initaliztion.
167 * XObject.prototype.init.call(this);
174 //this.items.forEach(function(i) {
178 this.listeners = this.listeners || {};
181 // do we need to call 'beforeInit here?'
184 //if ((this.xtype == 'Include')) {
185 // o = this.pre_registry[cls];
187 var isSeed = typeof(Seed) != 'undefined';
189 // xtype= Gtk.Menu ?? what about c_new stuff?
190 XObject.log("init: ID:"+ this.id +" typeof(xtype): " + typeof(this.xtype));
191 if (!this.el && typeof(this.xtype) == 'function') {
192 XObject.log("func?" + XObject.keys(this.config).join(','));
193 this.el = this.xtype(this.config);
196 if (!this.el && typeof(this.xtype) == 'object') {
197 XObject.log("obj?" + XObject.keys(this.config).join(','));
198 this.el = new (this.xtype)(this.config);
202 if (!this.el && this.xns) {
204 var NS = imports.gi[this.xns];
206 XObject.error('Invalid xns: ' + this.xns, true);
208 constructor = NS[this.xtype];
210 XObject.error('Invalid xtype: ' + this.xns + '.' + this.xtype);
212 this.el = isSeed ? new constructor(this.config) : new constructor();
215 XObject.log("init: ID:"+ this.id +" typeof(el):" + this.el);
217 // always overlay props..
218 // check for 'write' on object..
220 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
222 var gi = GIRepository.IRepository.get_default();
223 var ty = gi.find_by_gtype(this.xtype.type);
225 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
226 var p = GIRepository.object_info_get_property(ty,i);
227 if (GIRepository.property_info_get_flags(p) & 2) {
228 write.push(GIRepository.base_info_get_name(p));
231 XObject.writeablePropsCache[this.xtype.type] = write;
232 print(write.join(", "));
238 for (var i in this.config) {
239 if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
242 if (i == 'buttons') { // problem with Gtk.MessageDialog..
245 if (i[0] == '.') { // parent? -
248 this.el[i] = this.config[i];
252 //if (o.xnsid && o.id) {
253 // XObject.registry = XObject.registry || { };
254 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
255 // XObject.registry[o.xnsid][o.id] = this;
258 var type = this.xtype.type ? GObject.type_name(this.xtype.type) : '';
259 XObject.log("add children to " + type);
262 this.items.forEach(function(i,n) {
267 for (var i in this.listeners) {
268 this.addListener(i, this.listeners[i]);
271 this.init = XObject.emptyFn;
273 // delete this.listeners ?
274 // do again so child props work!
276 // do we need to call 'init here?'
282 * Adds an item to the object using a new XObject
283 * uses pack property to determine how to add it.
284 * @arg cfg {Object} same as XObject constructor.
286 addItem : function(item, pos)
289 if (typeof(item) == 'undefined') {
290 XObject.error("Invalid Item added to this!");
291 imports.console.dump(this.cfg);
294 // what about extended items!?!?!?
297 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
298 // print("addItem - call init [" + item.pack.join(',') + ']');
300 XObject.error("NO EL!");
301 imports.console.dump(item);
304 print(XObject.type(this.xtype) + ":pack=" + item.pack);
306 if (item.pack===false) { // no packing.. various items have this ..
310 if (typeof(item.pack) == 'function') { // pack is a function..
312 item.pack.apply(item, [ this , item ]);
320 if (typeof(item.pack) == 'string') {
322 item.pack.split(',').forEach(function(e, i) {
324 if (e == 'false') { args.push( false); return; }
325 if (e == 'true') { args.push( true); return; }
326 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
329 //print(args.join(","));
331 pack_m = args.shift();
333 pack_m = item.pack.shift();
338 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
341 name: "ArgumentError",
342 message : 'pack method not available : ' + this.id + " : " + this.xtype + '.' + pack_m + " ADDING " + item.el
350 // finally call the pack method
351 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
353 args.unshift(item.el);
359 XObject.log(pack_m + '[' + args.join(',') +']');
360 //Seed.print('args: ' + args.length);
362 this.el[pack_m].apply(this.el, args);
369 * @method addListener
370 * Connects a method to a signal. (gjs/Seed aware)
372 * @arg sig {String} name of signal
373 * @arg fn {Function} handler.
375 addListener : function(sig, fn)
378 XObject.log("Add signal " + sig);
380 var _li = XObject.createDelegate(fn,this);
381 // private listeners that are not copied to GTk.
383 if (typeof(Seed) != 'undefined') {
384 // Seed.print(typeof(_li));
385 this.el.signal[sig].connect(_li);
387 this.el.connect( sig, _li);
394 * Finds an object in the child elements using xid of object.
395 * prefix with '.' to look up the tree..
396 * prefix with multiple '..' to look further up..
397 * prefix with '/' to look from the top, eg. '^LeftTree.model'
399 * @arg name {String} name of signal
400 * @return {XObject|false} the object if found.
404 XObject.log("SEARCH FOR " + xid + " in " + this.id);
409 name: "ArgumentError",
410 message : "ID not found : empty id"
415 return this.parent.get(xid.substring(1));
419 if (typeof(XObject.cache[xid]) != 'undefined') {
420 return XObject.cache[xid];
422 if (xid.indexOf('.') > -1) {
424 var child = xid.split('.');
425 var nxid = child.shift();
427 child = child.join('.');
428 if (typeof(XObject.cache[nxid]) != 'undefined') {
429 return XObject.cache[nxid].get(child);
440 ret = e.get(xid.substring(1));
445 name: "ArgumentError",
446 message : "ID not found : " + oid
449 XObject.cache[xid] = ret;
450 return XObject.cache[xid];
454 if (xid.indexOf('.') > -1) {
455 child = xid.split('.');
458 child = child.join('.');
461 if (xid == this.id) {
463 return child === false ? this : this.get(child);
466 name: "ArgumentError",
467 message : "ID not found : " + oid
474 this.items.forEach(function(ch) {
484 return child === false ? ret : ret.get(child);
487 name: "ArgumentError",
488 message : "ID not found : " + oid
495 this.items.forEach(function(ch) {
500 XObject.error("invalid item...");
501 imports.console.dump(_this);
512 name: "ArgumentError",
513 message : "ID not found : " + oid
517 return child === false ? ret : ret.get(child);
520 name: "ArgumentError",
521 message : "ID not found : " + oid
531 * Copies all the properties of config to obj.
533 * Pretty much the same as JQuery/Prototype.. or Roo.apply
534 * @param {Object} obj The receiver of the properties
535 * @param {Object} config The source of the properties
536 * @param {Object} defaults A different object that will also be applied for default values
537 * @return {Object} returns obj
538 * @member XObject extend
542 XObject.extend = function(o, c, defaults){
544 // no "this" reference for friendly out of scope calls
545 XObject.extend(o, defaults);
547 if(o && c && typeof c == 'object'){
555 XObject.extend(XObject,
559 * @property {Boolean} debug XObject debugging. - set to true to debug.
564 * @property {Object} cache - cache of object ids
572 emptyFn : function () { },
578 * @param {String|Object} output String to print.
580 log : function(output)
585 print("LOG:" + output);
590 * @param {String|Object} output String to print.
592 error : function(output)
594 print("ERROR: " + output);
598 * @param {String|Object} output String to print.
600 fatal : function(output)
604 name: "ArgumentError",
611 * Copies all the properties of config to obj, if the do not exist.
612 * @param {Object} obj The receiver of the properties
613 * @param {Object} config The source of the properties
614 * @return {Object} returns obj
615 * @member Object extendIf
619 extendIf : function(o, c)
622 if(!o || !c || typeof c != 'object'){
626 if (typeof(o[p]) != 'undefined') {
637 * Extends one class with another class and optionally overrides members with the passed literal. This class
638 * also adds the function "override()" to the class that can be used to override
639 * members on an instance.
642 * MyObject = Object.define(
646 * parentClass, // or Object
648 * ... methods and properties.
651 * @param {Function} constructor The class inheriting the functionality
652 * @param {Object} superclass The class being extended
653 * @param {Object} overrides (optional) A literal with members
654 * @return {Function} constructor (eg. class
660 var io = function(o){
665 return function(constructor, parentClass, overrides) {
666 if (typeof(parentClass) == 'undefined') {
667 XObject.error("XObject.define: Missing parentClass: when applying: " );
668 XObject.error(new String(constructor));
671 if (typeof(parentClass.prototype) == 'undefined') {
672 XObject.error("Missing protype: when applying: " );
673 XObject.error(new String(constructor));
674 XObject.error(new String(parentClass));
677 var F = function(){};
679 var spp = parentClass.prototype;
682 sbp = constructor.prototype = new F();
683 sbp.constructor=constructor;
684 constructor.superclass=spp;
687 if(spp.constructor == Object.prototype.constructor){
688 spp.constructor=parentClass;
691 constructor.override = function(o){
692 Object.extend(constructor.prototype, o);
695 XObject.extend(constructor.prototype, overrides);
702 * returns a list of keys of the object.
703 * @param {Object} obj object to inspect
704 * @return {Array} returns list of kyes
705 * @member XObject keys
716 * return the Gobject name of a constructor
717 * @param {Object} gobject ctr
718 * @return {String} returns name
719 * @member XObject type
723 if (typeof(o) == 'object') {
724 return GObject.type_name(o.type);
725 // print("GNAME:" +gname + " GTYPE:"+cfg.xtype.type);
730 * return the XObjectBase class for a cfg (which includes an xtype)
731 * @param {Object} configuration.
732 * @return {function} constructor
733 * @member XObject baseXObject
735 baseXObject : function(cfg)
738 // loocks for XObject/Gtk/TreeView.js [ TreeView = { .... } ]
739 // xns is not a string!!!?
741 if (typeof(cfg.xtype) == 'object') {
742 gname = XObject.type(cfg.xtype);
746 // in the situation where we have been called and there is a base object
747 // defining the behavior..
748 // then we should copy the prototypes from the base object into this..
749 var base = gname ? imports.XObjectBase[gname][gname] : false;
754 XObject.log("error finding " + gname + " - " + e.toString());
762 * @member XObject createDelegate
763 * creates a delage metdhod
764 * @param {Function} method to wrap
765 * @param {Object} scope
766 * @param {Array} args to add
767 * @param {Boolean|Number} append arguments or replace after N arguments.
768 * @return {Function} returns the delegate
771 createDelegate : function(method, obj, args, appendArgs){
774 XObject.log("CALL: " + obj.id + ':'+ method.id);
776 var callArgs = args || arguments;
777 if(appendArgs === true){
778 callArgs = Array.prototype.slice.call(arguments, 0);
779 callArgs = callArgs.concat(args);
780 }else if(typeof appendArgs == "number"){
781 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
782 var applyArgs = [appendArgs, 0].concat(args); // create method call params
783 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
785 return method.apply(obj || window, callArgs);