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') {
80 var Gtk = imports.gi.Gtk;
84 case (this.xtype == Gtk.MenuItem): this.pack = [ 'append' ]; break;
98 * @property el {GObject} the Gtk / etc. element.
102 * @property items {Array} list of sub elements
105 * @property parent {XObject} parent Element
109 * @property config {Object} the construction configuration.
113 * Initializes the Element (el) hooks up all the listeners
114 * and packs the children.
115 * you can override this, in child objects, then
116 * do this to do thi initaliztion.
118 * XObject.prototype.init.call(this);
125 this.items.forEach(function(i) {
129 this.listeners = this.listeners || {};
132 // do we need to call 'beforeInit here?'
135 //if ((this.xtype == 'Include')) {
136 // o = this.pre_registry[cls];
138 var isSeed = typeof(Seed) != 'undefined';
140 // xtype= Gtk.Menu ?? what about c_new stuff?
141 if (XObject.debug) print("init: typeof(xtype): " + typeof(this.xtype));
142 if (!this.el && typeof(this.xtype) == 'function') {
143 if (XObject.debug) print("func?" + XObject.keys(this.config).join(','));
144 this.el = this.xtype(this.config);
147 if (!this.el && typeof(this.xtype) == 'object') {
148 if (XObject.debug) print("obj?" + XObject.keys(this.config).join(','));
149 this.el = new (this.xtype)(this.config);
153 if (!this.el && this.xns) {
155 var NS = imports.gi[this.xns];
157 Seed.print('Invalid xns: ' + this.xns);
159 constructor = NS[this.xtype];
161 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
163 this.el = isSeed ? new constructor(this.config) : new constructor();
166 if (XObject.debug) print("init: typeof(el):" + typeof(this.el));
168 // always overlay props..
169 // check for 'write' on object..
171 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
173 var gi = GIRepository.IRepository.get_default();
174 var ty = gi.find_by_gtype(this.xtype.type);
176 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
177 var p = GIRepository.object_info_get_property(ty,i);
178 if (GIRepository.property_info_get_flags(p) & 2) {
179 write.push(GIRepository.base_info_get_name(p));
182 XObject.writeablePropsCache[this.xtype.type] = write;
183 print(write.join(", "));
189 for (var i in this.config) {
190 if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
193 this.el[i] = this.config[i];
197 //if (o.xnsid && o.id) {
198 // XObject.registry = XObject.registry || { };
199 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
200 // XObject.registry[o.xnsid][o.id] = this;
203 items.forEach(function(i) {
208 for (var i in this.listeners) {
209 this.addListener(i, this.listeners[i]);
211 // delete this.listeners ?
214 // do we need to call 'init here?'
220 * Adds an item to the object using a new XObject
221 * uses pack property to determine how to add it.
222 * @arg cfg {Object} same as XObject constructor.
224 addItem : function(o) {
225 if (typeof(o) == 'undefined') {
226 print("Invalid Item added to this!");
227 imports.console.dump(this);
230 // what about extended items!?!?!?
231 var item = (o.constructor == XObject) ? o : new XObject(o);
234 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
235 // print("addItem - call init [" + item.pack.join(',') + ']');
238 imports.console.dump(item);
243 this.items.push(item);
245 if (item.pack===false) { // no
248 if (typeof(item.pack) == 'function') {
250 item.pack.apply(item, [ this , item ]);
256 if (typeof(item.pack) == 'string') {
257 var args = item.pack.split(',');
258 args.forEach(function(e, i) {
259 if (e == 'false') { args[i] = false; return; }
260 if (e == 'true') { args[i] = true; return; }
261 if (parseInt(e) == NaN) { args[i] = parseInt(e); return; }
263 pack_m = args.shift();
265 pack_m = item.pack.shift();
270 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
271 Seed.print('pack method not available : ' + this.xtype + '.' + pack_m);
276 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
278 args.unshift(item.el);
279 if (XObject.debug) print('[' + args.join(',') +']');
280 //Seed.print('args: ' + args.length);
282 this.el[pack_m].apply(this.el, args);
289 * @method addListener
290 * Connects a method to a signal. (gjs/Seed aware)
292 * @arg sig {String} name of signal
293 * @arg fn {Function} handler.
295 addListener : function(sig, fn)
298 if (XObject.debug) Seed.print("Add signal " + sig);
300 var _li = XObject.createDelegate(fn,this);
301 // private listeners that are not copied to GTk.
303 if (typeof(Seed) != 'undefined') {
304 // Seed.print(typeof(_li));
305 this.el.signal[sig].connect(_li);
307 this.el.connect( sig, _li);
314 * Finds an object in the child elements using xid of object.
315 * prefix with '.' to look up the tree..
316 * prefix with multiple '..' to look further up..
317 * prefix with '/' to look from the top, eg. '^LeftTree.model'
319 * @arg name {String} name of signal
320 * @return {XObject|false} the object if found.
326 return this.parent.get(xid.substring(1));
333 return e.get(xid.substring(1));
336 if (xid.indexOf('.') > -1) {
337 child = xid.split('.');
339 child = child.join('.');
342 this.items.forEach(function(ch) {
351 return child === false ? ret : ret.get(child);
355 this.items.forEach(function(ch) {
360 print("invalid item...");
361 imports.console.dump(_this);
367 return !ret || child === false ? ret : ret.get(child);;
375 * Copies all the properties of config to obj.
377 * Pretty much the same as JQuery/Prototype..
378 * @param {Object} obj The receiver of the properties
379 * @param {Object} config The source of the properties
380 * @param {Object} defaults A different object that will also be applied for default values
381 * @return {Object} returns obj
382 * @member XObject extend
386 XObject.extend = function(o, c, defaults){
388 // no "this" reference for friendly out of scope calls
389 XObject.extend(o, defaults);
391 if(o && c && typeof c == 'object'){
399 XObject.extend(XObject,
402 * @property {Boolean} debug XObject debugging. - set to true to debug.
407 * Copies all the properties of config to obj, if the do not exist.
408 * @param {Object} obj The receiver of the properties
409 * @param {Object} config The source of the properties
410 * @return {Object} returns obj
411 * @member Object extendIf
415 extendIf : function(o, c){
417 if(!o || !c || typeof c != 'object'){
421 if (typeof(o[p]) != 'undefined') {
432 * Extends one class with another class and optionally overrides members with the passed literal. This class
433 * also adds the function "override()" to the class that can be used to override
434 * members on an instance.
437 * MyObject = Object.define(
441 * parentClass, // or Object
443 * ... methods and properties.
446 * @param {Function} constructor The class inheriting the functionality
447 * @param {Object} superclass The class being extended
448 * @param {Object} overrides (optional) A literal with members
449 * @return {Function} constructor (eg. class
454 var io = function(o){
459 return function(constructor, parentClass, overrides) {
460 if (typeof(parentClass) == 'undefined') {
461 print("XObject.define: Missing parentClass: when applying: " );
462 print(new String(constructor));
465 if (typeof(parentClass.prototype) == 'undefined') {
466 print("Missing protype: when applying: " );
467 print(new String(constructor));
468 print(new String(parentClass));
471 var F = function(){};
473 var spp = parentClass.prototype;
476 sbp = constructor.prototype = new F();
477 sbp.constructor=constructor;
478 constructor.superclass=spp;
481 if(spp.constructor == Object.prototype.constructor){
482 spp.constructor=parentClass;
485 constructor.override = function(o){
486 Object.extend(constructor.prototype, o);
489 XObject.extend(constructor.prototype, overrides);
496 * returns a list of keys of the object.
497 * @param {Object} obj object to inspect
498 * @return {Array} returns list of kyes
499 * @member XObject keys
511 * @member XObject createDelegate
512 * creates a delage metdhod
513 * @param {Function} method to wrap
514 * @param {Object} scope
515 * @param {Array} args to add
516 * @param {Boolean|Number} append arguments or replace after N arguments.
517 * @return {Function} returns the delegate
520 createDelegate : function(method, obj, args, appendArgs){
523 var callArgs = args || arguments;
524 if(appendArgs === true){
525 callArgs = Array.prototype.slice.call(arguments, 0);
526 callArgs = callArgs.concat(args);
527 }else if(typeof appendArgs == "number"){
528 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
529 var applyArgs = [appendArgs, 0].concat(args); // create method call params
530 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
532 return method.apply(obj || window, callArgs);