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') || (typeof(cfg[i]) == 'function')) {
64 // these properties are not copied to cfg.
74 this.config[i] = cfg[i];
76 this.items = this.items || [];
78 this.pack = typeof(this.pack) == 'undefined' ? ['add'] : this.pack;
87 * @property el {GObject} the Gtk / etc. element.
91 * @property items {Array} list of sub elements
94 * @property parent {XObject} parent Element
98 * @property config {Object} the construction configuration.
102 * Initializes the Element (el) hooks up all the listeners
103 * and packs the children.
104 * you can override this, in child objects, then
105 * do this to do thi initaliztion.
107 * XObject.prototype.init.call(this);
112 var cfg = this.config;
115 this.items.forEach(function(i)) {
119 this.listeners = this.listeners || {};
122 // do we need to call 'beforeInit here?'
125 //if ((this.xtype == 'Include')) {
126 // o = this.pre_registry[cls];
128 var isSeed = typeof(Seed) != 'undefined';
130 // xtype= Gtk.Menu ?? what about c_new stuff?
131 print("init: typeof(xtype): " + typeof(this.xtype));
132 if (!this.el && typeof(this.xtype) == 'function') {
133 print("func?" + XObject.keys(o).join(','));
134 this.el = this.xtype(o);
136 if (!this.el && typeof(this.xtype) == 'object') {
137 print("obj?" + XObject.keys(o).join(','));
138 this.el = new (this.xtype)(o);
141 if (!this.el && o.xns) {
143 var NS = imports.gi[o.xns];
145 Seed.print('Invalid xns: ' + o.xns);
147 constructor = NS[o.xtype];
149 Seed.print('Invalid xtype: ' + o.xns + '.' + o.xtype);
151 this.el = isSeed ? new constructor(o) : new constructor();
154 print("init: typeof(el):" + typeof(this.el));
156 // always overlay props..
157 // check for 'write' on object..
159 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
161 var gi = GIRepository.IRepository.get_default();
162 var ty = gi.find_by_gtype(this.xtype.type);
164 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
165 var p = GIRepository.object_info_get_property(ty,i);
166 if (GIRepository.property_info_get_flags(p) & 2) {
167 write.push(GIRepository.base_info_get_name(p));
170 XObject.writeablePropsCache[this.xtype.type] = write;
171 print(write.join(", "));
177 // only write to writable properties
178 // if (XObject.writeablePropsCache[this.xtype.type].indexOf(i) < 0) {
184 //if (o.xnsid && o.id) {
185 // XObject.registry = XObject.registry || { };
186 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
187 // XObject.registry[o.xnsid][o.id] = this;
190 cfg.items.forEach(function(i) {
195 for (var i in this.listeners) {
196 this.addListener(i, this.listeners[i]);
198 // delete this.listeners ?
201 // do we need to call 'init here?'
207 * Adds an item to the object using a new XObject
208 * uses pack property to determine how to add it.
209 * @arg cfg {Object} same as XObject constructor.
211 addItem : function(o) {
212 if (typeof(o) == 'undefined') {
213 print("Invalid Item added to this!");
214 imports.console.dump(this);
218 var item = (o.constructor == XObject) ? o : new XObject(o);
221 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
222 // print("addItem - call init [" + item.pack.join(',') + ']');
225 imports.console.dump(item);
230 this.items.push(item);
232 if (item.pack===false) { // no
235 if (typeof(item.pack) == 'function') {
237 item.pack.apply(o, [ o , o.items[i] ]);
243 if (typeof(item.pack) == 'string') {
246 pack_m = item.pack.shift();
251 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
252 Seed.print('pack method not available : ' + this.xtype + '.' + pack_m);
257 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
259 args.unshift(item.el);
260 print('[' + args.join(',') +']');
261 //Seed.print('args: ' + args.length);
263 this.el[pack_m].apply(this.el, args);
270 * @method addListener
271 * Connects a method to a signal. (gjs/Seed aware)
273 * @arg sig {String} name of signal
274 * @arg fn {Function} handler.
276 addListener : function(sig, fn)
279 Seed.print("Add signal " + sig);
281 var _li = XObject.createDelegate(fn,this);
282 // private listeners that are not copied to GTk.
284 if (typeof(Seed) != 'undefined') {
285 // Seed.print(typeof(_li));
286 this.el.signal[sig].connect(_li);
288 this.el.connect( sig, _li);
295 * Finds an object in the child elements using xid of object.
296 * prefix with '.' to look up the tree.. multiple '..' to look further up..
298 * @arg name {String} name of signal
299 * @return {XObject|false} the object if found.
305 return this.parent.get(xid.substring(1));
309 this.items.forEach(function(ch) {
319 this.items.forEach(function(ch) {
332 XObject.writeablePropsCache = { };
335 * Copies all the properties of config to obj.
337 * Pretty much the same as JQuery/Prototype..
338 * @param {Object} obj The receiver of the properties
339 * @param {Object} config The source of the properties
340 * @param {Object} defaults A different object that will also be applied for default values
341 * @return {Object} returns obj
342 * @member XObject extend
346 XObject.extend = function(o, c, defaults){
348 // no "this" reference for friendly out of scope calls
349 XObject.extend(o, defaults);
351 if(o && c && typeof c == 'object'){
359 XObject.extend(XObject,
362 * Copies all the properties of config to obj, if the do not exist.
363 * @param {Object} obj The receiver of the properties
364 * @param {Object} config The source of the properties
365 * @return {Object} returns obj
366 * @member Object extendIf
370 extendIf : function(o, c){
372 if(!o || !c || typeof c != 'object'){
376 if (typeof(o[p]) != 'undefined') {
387 * Extends one class with another class and optionally overrides members with the passed literal. This class
388 * also adds the function "override()" to the class that can be used to override
389 * members on an instance.
392 * MyObject = Object.define(
396 * parentClass, // or Object
398 * ... methods and properties.
401 * @param {Function} constructor The class inheriting the functionality
402 * @param {Object} superclass The class being extended
403 * @param {Object} overrides (optional) A literal with members
404 * @return {Function} constructor (eg. class
409 var io = function(o){
414 return function(constructor, parentClass, overrides) {
415 if (typeof(parentClass) == 'undefined') {
416 print("XObject.define: Missing parentClass: when applying: " );
417 print(new String(constructor));
420 if (typeof(parentClass.prototype) == 'undefined') {
421 print("Missing protype: when applying: " );
422 print(new String(constructor));
423 print(new String(parentClass));
426 var F = function(){};
428 var spp = parentClass.prototype;
431 sbp = constructor.prototype = new F();
432 sbp.constructor=constructor;
433 constructor.superclass=spp;
436 if(spp.constructor == Object.prototype.constructor){
437 spp.constructor=parentClass;
440 constructor.override = function(o){
441 Object.extend(constructor.prototype, o);
444 XObject.extend(constructor.prototype, overrides);
451 * returns a list of keys of the object.
452 * @param {Object} obj object to inspect
453 * @return {Array} returns list of kyes
454 * @member XObject keys
466 * @member XObject createDelegate
467 * creates a delage metdhod
468 * @param {Function} method to wrap
469 * @param {Object} scope
470 * @param {Array} args to add
471 * @param {Boolean|Number} append arguments or replace after N arguments.
472 * @return {Function} returns the delegate
475 createDelegate : function(method, obj, args, appendArgs){
478 var callArgs = args || arguments;
479 if(appendArgs === true){
480 callArgs = Array.prototype.slice.call(arguments, 0);
481 callArgs = callArgs.concat(args);
482 }else if(typeof appendArgs == "number"){
483 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
484 var applyArgs = [appendArgs, 0].concat(args); // create method call params
485 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
487 return method.apply(obj || window, callArgs);