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 if (typeof(this.pack) == 'undefined') {
79 var Gtk = imports.gi.Gtk;
83 case (this.xtype == Gtk.MenuItem): this.pack = [ 'append' ]; break;
97 * @property el {GObject} the Gtk / etc. element.
101 * @property items {Array} list of sub elements
104 * @property parent {XObject} parent Element
108 * @property config {Object} the construction configuration.
112 * Initializes the Element (el) hooks up all the listeners
113 * and packs the children.
114 * you can override this, in child objects, then
115 * do this to do thi initaliztion.
117 * XObject.prototype.init.call(this);
124 this.items.forEach(function(i) {
128 this.listeners = this.listeners || {};
131 // do we need to call 'beforeInit here?'
134 //if ((this.xtype == 'Include')) {
135 // o = this.pre_registry[cls];
137 var isSeed = typeof(Seed) != 'undefined';
139 // xtype= Gtk.Menu ?? what about c_new stuff?
140 if (XObject.debug) print("init: typeof(xtype): " + typeof(this.xtype));
141 if (!this.el && typeof(this.xtype) == 'function') {
142 if (XObject.debug) print("func?" + XObject.keys(this.config).join(','));
143 this.el = this.xtype(this.config);
145 if (!this.el && typeof(this.xtype) == 'object') {
146 if (XObject.debug) print("obj?" + XObject.keys(this.config).join(','));
147 this.el = new (this.xtype)(this.config);
150 if (!this.el && this.xns) {
152 var NS = imports.gi[this.xns];
154 Seed.print('Invalid xns: ' + this.xns);
156 constructor = NS[this.xtype];
158 Seed.print('Invalid xtype: ' + this.xns + '.' + this.xtype);
160 this.el = isSeed ? new constructor(this.config) : new constructor();
163 if (XObject.debug) print("init: typeof(el):" + typeof(this.el));
165 // always overlay props..
166 // check for 'write' on object..
168 if (typeof(XObject.writeablePropsCache[this.xtype.type]) == 'undefined') {
170 var gi = GIRepository.IRepository.get_default();
171 var ty = gi.find_by_gtype(this.xtype.type);
173 for (var i =0; i < GIRepository.object_info_get_n_properties(ty);i++) {
174 var p = GIRepository.object_info_get_property(ty,i);
175 if (GIRepository.property_info_get_flags(p) & 2) {
176 write.push(GIRepository.base_info_get_name(p));
179 XObject.writeablePropsCache[this.xtype.type] = write;
180 print(write.join(", "));
185 for (var i in this.config) {
186 // only write to writable properties
187 // if (XObject.writeablePropsCache[this.xtype.type].indexOf(i) < 0) {
190 this.el[i] = this.config[i];
193 //if (o.xnsid && o.id) {
194 // XObject.registry = XObject.registry || { };
195 // XObject.registry[o.xnsid] = XObject.registry[o.xnsid] || {};
196 // XObject.registry[o.xnsid][o.id] = this;
199 items.forEach(function(i) {
204 for (var i in this.listeners) {
205 this.addListener(i, this.listeners[i]);
207 // delete this.listeners ?
210 // do we need to call 'init here?'
216 * Adds an item to the object using a new XObject
217 * uses pack property to determine how to add it.
218 * @arg cfg {Object} same as XObject constructor.
220 addItem : function(o) {
221 if (typeof(o) == 'undefined') {
222 print("Invalid Item added to this!");
223 imports.console.dump(this);
227 var item = (o.constructor == XObject) ? o : new XObject(o);
230 //print("CTR:PROTO:" + ( item.id ? item.id : '??'));
231 // print("addItem - call init [" + item.pack.join(',') + ']');
234 imports.console.dump(item);
239 this.items.push(item);
241 if (item.pack===false) { // no
244 if (typeof(item.pack) == 'function') {
246 item.pack.apply(item, [ this , item ]);
252 if (typeof(item.pack) == 'string') {
255 pack_m = item.pack.shift();
260 if (pack_m && typeof(this.el[pack_m]) == 'undefined') {
261 Seed.print('pack method not available : ' + this.xtype + '.' + pack_m);
266 //Seed.print('Pack ' + this.el + '.'+ pack_m + '(' + item.el + ')');
268 args.unshift(item.el);
269 if (XObject.debug) print('[' + args.join(',') +']');
270 //Seed.print('args: ' + args.length);
272 this.el[pack_m].apply(this.el, args);
279 * @method addListener
280 * Connects a method to a signal. (gjs/Seed aware)
282 * @arg sig {String} name of signal
283 * @arg fn {Function} handler.
285 addListener : function(sig, fn)
288 if (XObject.debug) Seed.print("Add signal " + sig);
290 var _li = XObject.createDelegate(fn,this);
291 // private listeners that are not copied to GTk.
293 if (typeof(Seed) != 'undefined') {
294 // Seed.print(typeof(_li));
295 this.el.signal[sig].connect(_li);
297 this.el.connect( sig, _li);
304 * Finds an object in the child elements using xid of object.
305 * prefix with '.' to look up the tree.. multiple '..' to look further up..
307 * @arg name {String} name of signal
308 * @return {XObject|false} the object if found.
314 return this.parent.get(xid.substring(1));
318 this.items.forEach(function(ch) {
331 this.items.forEach(function(ch) {
336 print("invalid item...");
337 imports.console.dump(_this);
351 * Copies all the properties of config to obj.
353 * Pretty much the same as JQuery/Prototype..
354 * @param {Object} obj The receiver of the properties
355 * @param {Object} config The source of the properties
356 * @param {Object} defaults A different object that will also be applied for default values
357 * @return {Object} returns obj
358 * @member XObject extend
362 XObject.extend = function(o, c, defaults){
364 // no "this" reference for friendly out of scope calls
365 XObject.extend(o, defaults);
367 if(o && c && typeof c == 'object'){
375 XObject.extend(XObject,
378 * @property {Boolean} debug XObject debugging. - set to true to debug.
383 * Copies all the properties of config to obj, if the do not exist.
384 * @param {Object} obj The receiver of the properties
385 * @param {Object} config The source of the properties
386 * @return {Object} returns obj
387 * @member Object extendIf
391 extendIf : function(o, c){
393 if(!o || !c || typeof c != 'object'){
397 if (typeof(o[p]) != 'undefined') {
408 * Extends one class with another class and optionally overrides members with the passed literal. This class
409 * also adds the function "override()" to the class that can be used to override
410 * members on an instance.
413 * MyObject = Object.define(
417 * parentClass, // or Object
419 * ... methods and properties.
422 * @param {Function} constructor The class inheriting the functionality
423 * @param {Object} superclass The class being extended
424 * @param {Object} overrides (optional) A literal with members
425 * @return {Function} constructor (eg. class
430 var io = function(o){
435 return function(constructor, parentClass, overrides) {
436 if (typeof(parentClass) == 'undefined') {
437 print("XObject.define: Missing parentClass: when applying: " );
438 print(new String(constructor));
441 if (typeof(parentClass.prototype) == 'undefined') {
442 print("Missing protype: when applying: " );
443 print(new String(constructor));
444 print(new String(parentClass));
447 var F = function(){};
449 var spp = parentClass.prototype;
452 sbp = constructor.prototype = new F();
453 sbp.constructor=constructor;
454 constructor.superclass=spp;
457 if(spp.constructor == Object.prototype.constructor){
458 spp.constructor=parentClass;
461 constructor.override = function(o){
462 Object.extend(constructor.prototype, o);
465 XObject.extend(constructor.prototype, overrides);
472 * returns a list of keys of the object.
473 * @param {Object} obj object to inspect
474 * @return {Array} returns list of kyes
475 * @member XObject keys
487 * @member XObject createDelegate
488 * creates a delage metdhod
489 * @param {Function} method to wrap
490 * @param {Object} scope
491 * @param {Array} args to add
492 * @param {Boolean|Number} append arguments or replace after N arguments.
493 * @return {Function} returns the delegate
496 createDelegate : function(method, obj, args, appendArgs){
499 var callArgs = args || arguments;
500 if(appendArgs === true){
501 callArgs = Array.prototype.slice.call(arguments, 0);
502 callArgs = callArgs.concat(args);
503 }else if(typeof appendArgs == "number"){
504 callArgs = Array.prototype.slice.call(arguments, 0); // copy arguments first
505 var applyArgs = [appendArgs, 0].concat(args); // create method call params
506 Array.prototype.splice.apply(callArgs, applyArgs); // splice them in
508 return method.apply(obj || window, callArgs);