1 //<script type="text/javascript">
2 var GIRepository = imports.gi.GIRepository;
3 var 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 // gjs implements xtype as function in seed they are undefined..
147 if (XObject.debug) print("func?" + XObject.keys(this.config).join(','));
149 this.el = this.xtype(this.config);
156 if (!this.el && typeof(this.xtype) == 'object') {
157 if (XObject.debug) print("obj?" + XObject.keys(this.config).join(','));
158 this.el = new (this.xtype)(this.config);
162 if (!this.el && this.xns) {
164 var NS = imports.gi[this.xns];
166 Seed.print('Invalid xns: ' + this.xns);
168 constructor = NS[this.xtype];
170 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
172 this.el = isSeed ? new constructor(this.config) : new constructor();
175 if (XObject.debug) print("init: ID:"+ this.id +" typeof(el):" + this.el);
177 // always overlay props..
178 // check for 'write' on object..
180 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
182 var gi = GIRepository.IRepository.get_default();
183 var ty = gi.find_by_gtype(this.xtype.type);
185 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
186 var p = GIRepository.object_info_get_property(ty,i);
187 if (GIRepository.property_info_get_flags(p) & 2) {
188 write.push(GIRepository.base_info_get_name(p));
191 XObject.writeablePropsCache[this.xtype.type] = write;
192 print(write.join(", "));
198 for (var i in this.config) {
199 if (i == 'type') { // problem with Gtk.Window... - not decided on a better way to handle this.
202 if (i == 'buttons') { // problem with Gtk.MessageDialog..
205 if (i[0] == '.') { // parent? -
208 this.el[i] = this.config[i];
212 //if (o.xnsid && o.id) {
213 // XObject.registry = XObject.registry || { };
214 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
215 // XObject.registry[o.xnsid][o.id] = this;
218 var type = this.xtype && this.xtype.type ? GObject.type_name(this.xtype.type) : '';
219 print("MAKE " + type);
223 items.forEach(function(i,n) {
225 if (type == 'GtkTable' && i.pack == 'add') {
226 var c = n % _this.config.n_columns;
227 var r = Math.floor(n/_this.config.n_columns);
228 i.pack = [ 'attach', c, c+1, r, r+1,
229 typeof(i.x_options) == 'undefined' ? 5 : i.x_options,
230 typeof(i.y_options) == 'undefined' ? 5 : i.y_options,
231 typeof(i.x_padding) == 'undefined' ? 0 : i.x_padding,
232 typeof(i.x_padding) == 'undefined' ? 0 : i.x_padding
241 for (var i in this.listeners) {
242 this.addListener(i, this.listeners[i]);
245 // delete this.listeners ?
246 // do again so child props work!
248 // do we need to call 'init here?'
253 * Adds an item to the object using a new XObject
254 * uses pack property to determine how to add it.
255 * @arg cfg {Object} same as XObject constructor.
257 addItem : function(o) {
258 if (typeof(o) == 'undefined') {
259 print("Invalid Item added to this!");
260 imports.console.dump(this);
263 // what about extended items!?!?!?
264 var item = (o.constructor == XObject) ? o : new XObject(o);
266 this.items.push(item);
268 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
269 // print("addItem - call init [" + item.pack.join(',') + ']');
272 imports.console.dump(item);
277 if (item.pack===false) { // no
280 if (typeof(item.pack) == 'function') {
282 item.pack.apply(item, [ this , item ]);
288 if (typeof(item.pack) == 'string') {
290 item.pack.split(',').forEach(function(e, i) {
292 if (e == 'false') { args.push( false); return; }
293 if (e == 'true') { args.push( true); return; }
294 if (!isNaN(parseInt(e))) { args.push( parseInt(e)); return; }
297 //print(args.join(","));
299 pack_m = args.shift();
301 pack_m = item.pack.shift();
306 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
309 name: "ArgumentError",
310 message : 'pack method not available : ' + this.id + " : " + this.xtype + '.' + pack_m + " ADDING " + item.el
321 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
323 args.unshift(item.el);
324 if (XObject.debug) print(pack_m + '[' + args.join(',') +']');
325 //Seed.print('args: ' + args.length);
327 this.el[pack_m].apply(this.el, args);
334 * @method addListener
335 * Connects a method to a signal. (gjs/Seed aware)
337 * @arg sig {String} name of signal
338 * @arg fn {Function} handler.
340 addListener : function(sig, fn)
343 if (XObject.debug) Seed.print("Add signal " + sig);
345 var _li = XObject.createDelegate(fn,this);
346 // private listeners that are not copied to GTk.
348 if (typeof(Seed) != 'undefined') {
349 // Seed.print(typeof(_li));
350 this.el.signal[sig].connect(_li);
352 this.el.connect( sig, _li);
359 * Finds an object in the child elements using xid of object.
360 * prefix with '.' to look up the tree..
361 * prefix with multiple '..' to look further up..
362 * prefix with '/' to look from the top, eg. '^LeftTree.model'
364 * @arg name {String} name of signal
365 * @return {XObject|false} the object if found.
369 if (XObject.debug) print("SEARCH FOR " + xid + " in " + this.id);
374 name: "ArgumentError",
375 message : "ID not found : empty id"
380 return this.parent.get(xid.substring(1));
384 if (typeof(XObject.cache[xid]) != 'undefined') {
385 return XObject.cache[xid];
387 if (xid.indexOf('.') > -1) {
389 var child = xid.split('.');
390 var nxid = child.shift();
392 child = child.join('.');
393 if (typeof(XObject.cache[nxid]) != 'undefined') {
394 return XObject.cache[nxid].get(child);
405 ret = e.get(xid.substring(1));
410 name: "ArgumentError",
411 message : "ID not found : " + oid
414 XObject.cache[xid] = ret;
415 return XObject.cache[xid];
419 if (xid.indexOf('.') > -1) {
420 child = xid.split('.');
423 child = child.join('.');
426 if (xid == this.id) {
428 return child === false ? this : this.get(child);
431 name: "ArgumentError",
432 message : "ID not found : " + oid
439 this.items.forEach(function(ch) {
449 return child === false ? ret : ret.get(child);
452 name: "ArgumentError",
453 message : "ID not found : " + oid
460 this.items.forEach(function(ch) {
465 print("invalid item...");
466 imports.console.dump(_this);
477 name: "ArgumentError",
478 message : "ID not found : " + oid
482 return child === false ? ret : ret.get(child);
485 name: "ArgumentError",
486 message : "ID not found : " + oid
496 * Copies all the properties of config to obj.
498 * Pretty much the same as JQuery/Prototype..
499 * @param {Object} obj The receiver of the properties
500 * @param {Object} config The source of the properties
501 * @param {Object} defaults A different object that will also be applied for default values
502 * @return {Object} returns obj
503 * @member XObject extend
507 XObject.extend = function(o, c, defaults){
509 // no "this" reference for friendly out of scope calls
510 XObject.extend(o, defaults);
512 if(o && c && typeof c == 'object'){
520 XObject.extend(XObject,
524 * @property {Boolean} debug XObject debugging. - set to true to debug.
529 * @property {Object} cache - cache of object ids
535 * Copies all the properties of config to obj, if the do not exist.
536 * @param {Object} obj The receiver of the properties
537 * @param {Object} config The source of the properties
538 * @return {Object} returns obj
539 * @member Object extendIf
543 extendIf : function(o, c){
545 if(!o || !c || typeof c != 'object'){
549 if (typeof(o[p]) != 'undefined') {
560 * Extends one class with another class and optionally overrides members with the passed literal. This class
561 * also adds the function "override()" to the class that can be used to override
562 * members on an instance.
565 * MyObject = XObject.define(
569 * parentClass, // or Object
571 * ... methods and properties.
574 * @param {Function} constructor The class inheriting the functionality
575 * @param {Object} superclass The class being extended
576 * @param {Object} overrides (optional) A literal with members
577 * @return {Function} constructor (eg. class
582 var io = function(o){
587 return function(constructor, parentClass, overrides) {
588 if (typeof(parentClass) == 'undefined') {
589 print("XObject.define: Missing parentClass: when applying: " );
590 print(new String(constructor));
593 if (typeof(parentClass.prototype) == 'undefined') {
594 print("Missing protype: when applying: " );
595 print(new String(constructor));
596 print(new String(parentClass));
599 var F = function(){};
601 var spp = parentClass.prototype;
604 sbp = constructor.prototype = new F();
605 sbp.constructor=constructor;
606 constructor.superclass=spp;
609 if(spp.constructor == Object.prototype.constructor){
610 spp.constructor=parentClass;
613 constructor.override = function(o){
614 Object.extend(constructor.prototype, o);
617 XObject.extend(constructor.prototype, overrides);
624 * returns a list of keys of the object.
625 * @param {Object} obj object to inspect
626 * @return {Array} returns list of kyes
627 * @member XObject keys
639 * @member XObject createDelegate
640 * creates a delage metdhod
641 * @param {Function} method to wrap
642 * @param {Object} scope
643 * @param {Array} args to add
644 * @param {Boolean|Number} append arguments or replace after N arguments.
645 * @return {Function} returns the delegate
648 createDelegate : function(method, obj, args, appendArgs){
651 if (XObject.debug) print("CALL: " + obj.id + ':'+ method.id);
653 var callArgs = args || arguments;
654 if(appendArgs === true){
655 callArgs = Array.prototype.slice.call(arguments, 0);
656 callArgs = callArgs.concat(args);
657 }else if(typeof appendArgs == "number"){
658 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
659 var applyArgs = [appendArgs, 0].concat(args); // create method call params
660 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
662 return method.apply(obj || window, callArgs);