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.
32 * @arg xtype {String|Function} constructor or string.
33 * @arg id {String} (optional) id for registry
34 * @arg xns {String|Object} (optional) namespace eg. Gtk or 'Gtk' - used with xtype.
35 * @arg items {Array} (optional) list of child elements which will be constructed.. using XObject
36 * @arg listeners {Object} (optional) map Gobject signals to functions
37 * @arg pack {Function|String|Array} (optional) how this object gets added to it's parent
38 * @arg el {Object} (optional) premade GObject
40 * --- needs a xdebug option!
43 * He's some questions.
44 * - should we generate ID's for all elements? (if so we probably need to garbage collect)
45 * - should we have a special property to use as the constructor / gobject.properties rather
46 * than sending all basic types to this?
51 function XObject (cfg) {
52 // first apply cfg if set.
53 //print("new XOBJECT!!!");
55 this.constructor = XObject;
57 // copy down all elements into self..
61 if (typeof(cfg[i]) == 'function') { // do we skip objects.
64 // these properties are not copied to cfg.
75 this.config[i] = cfg[i];
77 this.items = this.items || [];
79 if (typeof(this.pack) == 'undefined') {
83 var Gtk = imports.gi.Gtk;
86 case (this.xtype == Gtk.MenuItem): this.pack = [ 'append' ]; break;
101 * @property el {GObject} the Gtk / etc. element.
105 * @property items {Array} list of sub elements
108 * @property parent {XObject} parent Element
112 * @property config {Object} the construction configuration.
116 * Initializes the Element (el) hooks up all the listeners
117 * and packs the children.
118 * you can override this, in child objects, then
119 * do this to do thi initaliztion.
121 * XObject.prototype.init.call(this);
128 this.items.forEach(function(i) {
132 this.listeners = this.listeners || {};
135 // do we need to call 'beforeInit here?'
138 //if ((this.xtype == 'Include')) {
139 // o = this.pre_registry[cls];
141 var isSeed = typeof(Seed) != 'undefined';
143 // xtype= Gtk.Menu ?? what about c_new stuff?
144 if (XObject.debug) print("init: ID:"+ this.id +" typeof(xtype): " + typeof(this.xtype));
145 if (!this.el && typeof(this.xtype) == 'function') {
146 if (XObject.debug) print("func?" + XObject.keys(this.config).join(','));
147 this.el = this.xtype(this.config);
150 if (!this.el && typeof(this.xtype) == 'object') {
151 if (XObject.debug) print("obj?" + XObject.keys(this.config).join(','));
152 this.el = new (this.xtype)(this.config);
156 if (!this.el && this.xns) {
158 var NS = imports.gi[this.xns];
160 Seed.print('Invalid xns: ' + this.xns);
162 constructor = NS[this.xtype];
164 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
166 this.el = isSeed ? new constructor(this.config) : new constructor();
169 if (XObject.debug) print("init: ID:"+ this.id +" typeof(el):" + this.el);
171 // always overlay props..
172 // check for 'write' on object..
174 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
176 var gi = GIRepository.IRepository.get_default();
177 var ty = gi.find_by_gtype(this.xtype.type);
179 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
180 var p = GIRepository.object_info_get_property(ty,i);
181 if (GIRepository.property_info_get_flags(p) & 2) {
182 write.push(GIRepository.base_info_get_name(p));
185 XObject.writeablePropsCache[this.xtype.type] = write;
186 print(write.join(", "));
192 for (var i in this.config) {
193 if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
196 if (i == 'buttons') { // problem with Gtk.MessageDialog..
199 if (i[0] == '.') { // parent? -
202 this.el[i] = this.config[i];
206 //if (o.xnsid && o.id) {
207 // XObject.registry = XObject.registry || { };
208 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
209 // XObject.registry[o.xnsid][o.id] = this;
212 var type = this.xtype.type ? GObject.type_name(this.xtype.type) : '';
213 print("MAKE " + type);
217 items.forEach(function(i,n) {
219 if (type == 'GtkTable' && i.pack == 'add') {
220 var c = n % _this.config.n_columns;
221 var r = Math.floor(n/_this.config.n_columns);
222 i.pack = [ 'attach', c, c+1, r, r+1,
223 i.x_options || 5, i.x_padding || 0,
224 i.y_options || 5, i.y_padding || 0
232 for (var i in this.listeners) {
233 this.addListener(i, this.listeners[i]);
236 // delete this.listeners ?
237 // do again so child props work!
239 // do we need to call 'init here?'
245 * Adds an item to the object using a new XObject
246 * uses pack property to determine how to add it.
247 * @arg cfg {Object} same as XObject constructor.
249 addItem : function(o) {
250 if (typeof(o) == 'undefined') {
251 print("Invalid Item added to this!");
252 imports.console.dump(this);
255 // what about extended items!?!?!?
256 var item = (o.constructor == XObject) ? o : new XObject(o);
258 this.items.push(item);
260 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
261 // print("addItem - call init [" + item.pack.join(',') + ']');
264 imports.console.dump(item);
269 if (item.pack===false) { // no
272 if (typeof(item.pack) == 'function') {
274 item.pack.apply(item, [ this , item ]);
280 if (typeof(item.pack) == 'string') {
282 item.pack.split(',').forEach(function(e, i) {
284 if (e == 'false') { args.push( false); return; }
285 if (e == 'true') { args.push( true); return; }
286 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
289 //print(args.join(","));
291 pack_m = args.shift();
293 pack_m = item.pack.shift();
298 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
301 name: "ArgumentError",
302 message : 'pack method not available : ' + this.id + " : " + this.xtype + '.' + pack_m + " ADDING " + item.el
313 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
315 args.unshift(item.el);
316 if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
317 //Seed.print('args: ' + args.length);
319 this.el[pack_m].apply(this.el, args);
326 * @method addListener
327 * Connects a method to a signal. (gjs/Seed aware)
329 * @arg sig {String} name of signal
330 * @arg fn {Function} handler.
332 addListener : function(sig, fn)
335 if (XObject.debug) Seed.print("Add signal " + sig);
337 var _li = XObject.createDelegate(fn,this);
338 // private listeners that are not copied to GTk.
340 if (typeof(Seed) != 'undefined') {
341 // Seed.print(typeof(_li));
342 this.el.signal[sig].connect(_li);
344 this.el.connect( sig, _li);
351 * Finds an object in the child elements using xid of object.
352 * prefix with '.' to look up the tree..
353 * prefix with multiple '..' to look further up..
354 * prefix with '/' to look from the top, eg. '^LeftTree.model'
356 * @arg name {String} name of signal
357 * @return {XObject|false} the object if found.
361 if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
366 name: "ArgumentError",
367 message : "ID not found : empty id"
372 return this.parent.get(xid.substring(1));
376 if (typeof(XObject.cache[xid]) != 'undefined') {
377 return XObject.cache[xid];
379 if (xid.indexOf('.') > -1) {
381 var child = xid.split('.');
382 var nxid = child.shift();
384 child = child.join('.');
385 if (typeof(XObject.cache[nxid]) != 'undefined') {
386 return XObject.cache[nxid].get(child);
397 ret = e.get(xid.substring(1));
402 name: "ArgumentError",
403 message : "ID not found : " + oid
406 XObject.cache[xid] = ret;
407 return XObject.cache[xid];
411 if (xid.indexOf('.') > -1) {
412 child = xid.split('.');
415 child = child.join('.');
418 if (xid == this.id) {
420 return child === false ? this : this.get(child);
423 name: "ArgumentError",
424 message : "ID not found : " + oid
431 this.items.forEach(function(ch) {
441 return child === false ? ret : ret.get(child);
444 name: "ArgumentError",
445 message : "ID not found : " + oid
452 this.items.forEach(function(ch) {
457 print("invalid item...");
458 imports.console.dump(_this);
469 name: "ArgumentError",
470 message : "ID not found : " + oid
474 return child === false ? ret : ret.get(child);
477 name: "ArgumentError",
478 message : "ID not found : " + oid
488 * Copies all the properties of config to obj.
490 * Pretty much the same as JQuery/Prototype..
491 * @param {Object} obj The receiver of the properties
492 * @param {Object} config The source of the properties
493 * @param {Object} defaults A different object that will also be applied for default values
494 * @return {Object} returns obj
495 * @member XObject extend
499 XObject.extend = function(o, c, defaults){
501 // no "this" reference for friendly out of scope calls
502 XObject.extend(o, defaults);
504 if(o && c && typeof c == 'object'){
512 XObject.extend(XObject,
516 * @property {Boolean} debug XObject debugging. - set to true to debug.
521 * @property {Object} cache - cache of object ids
527 * Copies all the properties of config to obj, if the do not exist.
528 * @param {Object} obj The receiver of the properties
529 * @param {Object} config The source of the properties
530 * @return {Object} returns obj
531 * @member Object extendIf
535 extendIf : function(o, c){
537 if(!o || !c || typeof c != 'object'){
541 if (typeof(o[p]) != 'undefined') {
552 * Extends one class with another class and optionally overrides members with the passed literal. This class
553 * also adds the function "override()" to the class that can be used to override
554 * members on an instance.
557 * MyObject = Object.define(
561 * parentClass, // or Object
563 * ... methods and properties.
566 * @param {Function} constructor The class inheriting the functionality
567 * @param {Object} superclass The class being extended
568 * @param {Object} overrides (optional) A literal with members
569 * @return {Function} constructor (eg. class
574 var io = function(o){
579 return function(constructor, parentClass, overrides) {
580 if (typeof(parentClass) == 'undefined') {
581 print("XObject.define: Missing parentClass: when applying: " );
582 print(new String(constructor));
585 if (typeof(parentClass.prototype) == 'undefined') {
586 print("Missing protype: when applying: " );
587 print(new String(constructor));
588 print(new String(parentClass));
591 var F = function(){};
593 var spp = parentClass.prototype;
596 sbp = constructor.prototype = new F();
597 sbp.constructor=constructor;
598 constructor.superclass=spp;
601 if(spp.constructor == Object.prototype.constructor){
602 spp.constructor=parentClass;
605 constructor.override = function(o){
606 Object.extend(constructor.prototype, o);
609 XObject.extend(constructor.prototype, overrides);
616 * returns a list of keys of the object.
617 * @param {Object} obj object to inspect
618 * @return {Array} returns list of kyes
619 * @member XObject keys
631 * @member XObject createDelegate
632 * creates a delage metdhod
633 * @param {Function} method to wrap
634 * @param {Object} scope
635 * @param {Array} args to add
636 * @param {Boolean|Number} append arguments or replace after N arguments.
637 * @return {Function} returns the delegate
640 createDelegate : function(method, obj, args, appendArgs){
643 if (XObject.debug) print("CALL: " + obj.id + ':'+ method.id);
645 var callArgs = args || arguments;
646 if(appendArgs === true){
647 callArgs = Array.prototype.slice.call(arguments, 0);
648 callArgs = callArgs.concat(args);
649 }else if(typeof appendArgs == "number"){
650 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
651 var applyArgs = [appendArgs, 0].concat(args); // create method call params
652 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
654 return method.apply(obj || window, callArgs);