});
/**
- * Generates an inherited class that replaces all the methods by null methods (methods
- * that does nothing and always return undefined).
- *
- * @param {Class} claz
- * @param {dict} add Additional functions to override.
- * @return {Class}
+ * OpenERP session aware controller
+ * a controller takes an already existing dom element and manage it
*/
- openerp.base.generate_null_object_class = function(claz, add) {
- var newer = {};
- var copy_proto = function(prototype) {
- for (var name in prototype) {
- if(typeof prototype[name] == "function") {
- newer[name] = function() {};
- }
- }
- if (prototype.prototype)
- copy_proto(prototype.prototype);
- };
- copy_proto(claz.prototype);
- newer.init = openerp.base.BasicController.prototype.init;
- var tmpclass = claz.extend(newer);
- return tmpclass.extend(add || {});
- };
-
- openerp.base.Notification = openerp.base.BasicController.extend({
+ openerp.base.Controller = openerp.base.Controller.extend( /** @lends openerp.base.Controller# */{
init: function(parent, element_id) {
this._super(parent, element_id);
- this.$element.notify({
- speed: 500,
- expires: 1500
- });
+ if(this.controller_parent && this.controller_parent.session) {
+ this.session = this.controller_parent.session;
+ }
},
- notify: function(title, text) {
- this.$element.notify('create', {
- title: title,
- text: text
- });
+ /**
+ * Performs a JSON-RPC call
+ *
+ * @param {String} url endpoint url
+ * @param {Object} data RPC parameters
+ * @param {Function} success RPC call success callback
+ * @param {Function} error RPC call error callback
+ * @returns {jQuery.Deferred} deferred object for the RPC call
+ */
+ rpc: function(url, data, success, error) {
+ return this.session.rpc(url, data, success, error);
},
- warn: function(title, text) {
- this.$element.notify('create', 'oe_notification_alert', {
- title: title,
- text: text
- });
+ do_action: function(action, on_finished) {
+ return this.parent.do_action(action, on_finished);
+ }
+ });
+
+ /**
+ * OpenERP session aware widget
+ * A widget is a controller that doesnt take an element_id
+ * it render its own html render() that you should insert into the dom
+ * and bind it at start()
+ */
+ openerp.base.BaseWidget = openerp.base.Controller.extend({
+ /**
+ * The name of the QWeb template that will be used for rendering. Must be
+ * redefined in subclasses or the render() method can not be used.
- *
++ *
+ * @type string
+ */
+ template: null,
+ /**
+ * The prefix used to generate an id automatically. Should be redefined in
+ * subclasses. If it is not defined, a default identifier will be used.
- *
++ *
+ * @type string
+ */
+ identifier_prefix: 'generic-identifier',
+ /**
+ * Base class for widgets. Handle rendering (based on a QWeb template),
+ * identifier generation, parenting and destruction of the widget.
+ * Also initialize the identifier.
+ *
+ * @constructs
+ * @params {openerp.base.search.BaseWidget} parent The parent widget.
+ */
+ init: function (parent) {
+ this._super(parent);
+ this.make_id(this.identifier_prefix);
+ },
+ /**
+ * Sets and returns a globally unique identifier for the widget.
+ *
+ * If a prefix is appended, the identifier will be appended to it.
+ *
+ * @params sections prefix sections, empty/falsy sections will be removed
+ */
+ make_id: function () {
+ this.element_id = _.uniqueId(_.toArray(arguments).join('_'));
+ return this.element_id;
+ },
+ /**
+ * Render the widget. This.template must be defined.
+ * The content of the current object is passed as context to the template.
- *
++ *
+ * @param {object} additional Additional context arguments to pass to the template.
+ */
+ render: function (additional) {
+ return QWeb.render(this.template, _.extend({}, this, additional != null ? additional : {}));
+ },
+ /**
+ * "Starts" the widgets. Called at the end of the rendering, this allows
+ * to get a jQuery object referring to the DOM ($element attribute).
+ */
+ start: function () {
+ this._super();
+ var tmp = document.getElementById(this.element_id);
+ this.$element = tmp ? $(tmp) : null;
+ },
+ /**
+ * "Stops" the widgets. Called when the view destroys itself, this
+ * lets the widgets clean up after themselves.
+ */
+ stop: function () {
+ if(this.$element != null) {
+ this.$element.remove();
+ }
}
});