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);
114 this.items.forEach(function(i) {
118 this.listeners = this.listeners || {};
121 // do we need to call 'beforeInit here?'
124 //if ((this.xtype == 'Include')) {
125 // o = this.pre_registry[cls];
127 var isSeed = typeof(Seed) != 'undefined';
129 // xtype= Gtk.Menu ?? what about c_new stuff?
130 if (XObject.debug) print("init: typeof(xtype): " + typeof(this.xtype));
131 if (!this.el && typeof(this.xtype) == 'function') {
132 if (XObject.debug) print("func?" + XObject.keys(this.config).join(','));
133 this.el = this.xtype(this.config);
135 if (!this.el && typeof(this.xtype) == 'object') {
136 if (XObject.debug) print("obj?" + XObject.keys(this.config).join(','));
137 this.el = new (this.xtype)(this.config);
140 if (!this.el && this.xns) {
142 var NS = imports.gi[this.xns];
144 Seed.print('Invalid xns: ' + this.xns);
146 constructor = NS[this.xtype];
148 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
150 this.el = isSeed ? new constructor(this.config) : new constructor();
153 if (XObject.debug) print("init: typeof(el):" + typeof(this.el));
155 // always overlay props..
156 // check for 'write' on object..
158 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
160 var gi = GIRepository.IRepository.get_default();
161 var ty = gi.find_by_gtype(this.xtype.type);
163 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
164 var p = GIRepository.object_info_get_property(ty,i);
165 if (GIRepository.property_info_get_flags(p) & 2) {
166 write.push(GIRepository.base_info_get_name(p));
169 XObject.writeablePropsCache[this.xtype.type] = write;
170 print(write.join(", "));
175 for (var i in this.config) {
176 // only write to writable properties
177 // if (XObject.writeablePropsCache[this.xtype.type].indexOf(i) < 0) {
180 this.el[i] = this.config[i];
183 //if (o.xnsid && o.id) {
184 // XObject.registry = XObject.registry || { };
185 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
186 // XObject.registry[o.xnsid][o.id] = this;
189 items.forEach(function(i) {
194 for (var i in this.listeners) {
195 this.addListener(i, this.listeners[i]);
197 // delete this.listeners ?
200 // do we need to call 'init here?'
206 * Adds an item to the object using a new XObject
207 * uses pack property to determine how to add it.
208 * @arg cfg {Object} same as XObject constructor.
210 addItem : function(o) {
211 if (typeof(o) == 'undefined') {
212 print("Invalid Item added to this!");
213 imports.console.dump(this);
217 var item = (o.constructor == XObject) ? o : new XObject(o);
220 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
221 // print("addItem - call init [" + item.pack.join(',') + ']');
224 imports.console.dump(item);
229 this.items.push(item);
231 if (item.pack===false) { // no
234 if (typeof(item.pack) == 'function') {
236 item.pack.apply(item, [ this , item ]);
242 if (typeof(item.pack) == 'string') {
245 pack_m = item.pack.shift();
250 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
251 Seed.print('pack method not available : ' + this.xtype + '.' + pack_m);
256 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
258 args.unshift(item.el);
259 if (XObject.debug) print('[' + args.join(',') +']');
260 //Seed.print('args: ' + args.length);
262 this.el[pack_m].apply(this.el, args);
269 * @method addListener
270 * Connects a method to a signal. (gjs/Seed aware)
272 * @arg sig {String} name of signal
273 * @arg fn {Function} handler.
275 addListener : function(sig, fn)
278 if (XObject.debug) Seed.print("Add signal " + sig);
280 var _li = XObject.createDelegate(fn,this);
281 // private listeners that are not copied to GTk.
283 if (typeof(Seed) != 'undefined') {
284 // Seed.print(typeof(_li));
285 this.el.signal[sig].connect(_li);
287 this.el.connect( sig, _li);
294 * Finds an object in the child elements using xid of object.
295 * prefix with '.' to look up the tree.. multiple '..' to look further up..
297 * @arg name {String} name of signal
298 * @return {XObject|false} the object if found.
304 return this.parent.get(xid.substring(1));
308 this.items.forEach(function(ch) {
321 this.items.forEach(function(ch) {
326 print("invalid item...");
327 imports.console.dump(_this);
341 * Copies all the properties of config to obj.
343 * Pretty much the same as JQuery/Prototype..
344 * @param {Object} obj The receiver of the properties
345 * @param {Object} config The source of the properties
346 * @param {Object} defaults A different object that will also be applied for default values
347 * @return {Object} returns obj
348 * @member XObject extend
352 XObject.extend = function(o, c, defaults){
354 // no "this" reference for friendly out of scope calls
355 XObject.extend(o, defaults);
357 if(o && c && typeof c == 'object'){
365 XObject.extend(XObject,
368 * @property {Boolean} debug XObject debugging. - set to true to debug.
373 * Copies all the properties of config to obj, if the do not exist.
374 * @param {Object} obj The receiver of the properties
375 * @param {Object} config The source of the properties
376 * @return {Object} returns obj
377 * @member Object extendIf
381 extendIf : function(o, c){
383 if(!o || !c || typeof c != 'object'){
387 if (typeof(o[p]) != 'undefined') {
398 * Extends one class with another class and optionally overrides members with the passed literal. This class
399 * also adds the function "override()" to the class that can be used to override
400 * members on an instance.
403 * MyObject = Object.define(
407 * parentClass, // or Object
409 * ... methods and properties.
412 * @param {Function} constructor The class inheriting the functionality
413 * @param {Object} superclass The class being extended
414 * @param {Object} overrides (optional) A literal with members
415 * @return {Function} constructor (eg. class
420 var io = function(o){
425 return function(constructor, parentClass, overrides) {
426 if (typeof(parentClass) == 'undefined') {
427 print("XObject.define: Missing parentClass: when applying: " );
428 print(new String(constructor));
431 if (typeof(parentClass.prototype) == 'undefined') {
432 print("Missing protype: when applying: " );
433 print(new String(constructor));
434 print(new String(parentClass));
437 var F = function(){};
439 var spp = parentClass.prototype;
442 sbp = constructor.prototype = new F();
443 sbp.constructor=constructor;
444 constructor.superclass=spp;
447 if(spp.constructor == Object.prototype.constructor){
448 spp.constructor=parentClass;
451 constructor.override = function(o){
452 Object.extend(constructor.prototype, o);
455 XObject.extend(constructor.prototype, overrides);
462 * returns a list of keys of the object.
463 * @param {Object} obj object to inspect
464 * @return {Array} returns list of kyes
465 * @member XObject keys
477 * @member XObject createDelegate
478 * creates a delage metdhod
479 * @param {Function} method to wrap
480 * @param {Object} scope
481 * @param {Array} args to add
482 * @param {Boolean|Number} append arguments or replace after N arguments.
483 * @return {Function} returns the delegate
486 createDelegate : function(method, obj, args, appendArgs){
489 var callArgs = args || arguments;
490 if(appendArgs === true){
491 callArgs = Array.prototype.slice.call(arguments, 0);
492 callArgs = callArgs.concat(args);
493 }else if(typeof appendArgs == "number"){
494 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
495 var applyArgs = [appendArgs, 0].concat(args); // create method call params
496 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
498 return method.apply(obj || window, callArgs);