283 lines
11 KiB
JavaScript
283 lines
11 KiB
JavaScript
flectra.define('web.AbstractView', function (require) {
|
|
"use strict";
|
|
|
|
/**
|
|
* This is the base class inherited by all (JS) views. Flectra JS views are the
|
|
* widgets used to display information in the main area of the web client
|
|
* (note: the search view is not a "JS view" in that sense).
|
|
*
|
|
* The abstract view role is to take a set of fields, an arch (the xml
|
|
* describing the view in db), and some params, and then, to create a
|
|
* controller, a renderer and a model. This is the classical MVC pattern, but
|
|
* the word 'view' has historical significance in Flectra code, so we replaced the
|
|
* V in MVC by the 'renderer' word.
|
|
*
|
|
* JS views are supposed to be used like this:
|
|
* 1. instantiate a view with some arch, fields and params
|
|
* 2. call the getController method on the view instance. This returns a
|
|
* controller (with a model and a renderer as sub widgets)
|
|
* 3. append the controller somewhere
|
|
*
|
|
* Note that once a controller has been instantiated, the view class is no
|
|
* longer useful (unless you want to create another controller), and will be
|
|
* in most case discarded.
|
|
*/
|
|
|
|
var ajax = require('web.ajax');
|
|
var Class = require('web.Class');
|
|
var Context = require('web.Context');
|
|
var AbstractModel = require('web.AbstractModel');
|
|
var AbstractRenderer = require('web.AbstractRenderer');
|
|
var AbstractController = require('web.AbstractController');
|
|
|
|
var AbstractView = Class.extend({
|
|
// name displayed in view switchers
|
|
display_name: '',
|
|
// indicates whether or not the view is mobile-friendly
|
|
mobile_friendly: false,
|
|
// icon is the font-awesome icon to display in the view switcher
|
|
icon: 'fa-question',
|
|
// multi_record is used to distinguish views displaying a single record
|
|
// (e.g. FormView) from those that display several records (e.g. ListView)
|
|
multi_record: true,
|
|
|
|
// determine if a search view should be displayed in the control panel and
|
|
// allowed to interact with the view. Currently, the only not searchable
|
|
// views are the form view and the diagram view.
|
|
searchable: true,
|
|
|
|
config: {
|
|
Model: AbstractModel,
|
|
Renderer: AbstractRenderer,
|
|
Controller: AbstractController,
|
|
},
|
|
|
|
/**
|
|
* The constructor function is supposed to set 3 variables: rendererParams,
|
|
* controllerParams and loadParams. These values will be used to initialize
|
|
* the model, renderer and controllers.
|
|
*
|
|
* @constructs AbstractView
|
|
*
|
|
* @param {Object} viewInfo
|
|
* @param {Object} viewInfo.arch
|
|
* @param {Object} viewInfo.fields
|
|
* @param {Object} viewInfo.fieldsInfo
|
|
* @param {Object} params
|
|
* @param {string} params.modelName The actual model name
|
|
* @param {Object} params.context
|
|
* @param {number} [params.count]
|
|
* @param {string[]} params.domain
|
|
* @param {string[]} params.groupBy
|
|
* @param {number} [params.currentId]
|
|
* @param {number[]} [params.ids]
|
|
* @param {string} [params.action.help]
|
|
*/
|
|
init: function (viewInfo, params) {
|
|
this.rendererParams = {
|
|
arch: viewInfo.arch,
|
|
noContentHelp: params.action && params.action.help,
|
|
};
|
|
|
|
this.controllerParams = {
|
|
modelName: params.modelName,
|
|
activeActions: {
|
|
edit: viewInfo.arch.attrs.edit ? JSON.parse(viewInfo.arch.attrs.edit) : true,
|
|
create: viewInfo.arch.attrs.create ? JSON.parse(viewInfo.arch.attrs.create) : true,
|
|
delete: viewInfo.arch.attrs.delete ? JSON.parse(viewInfo.arch.attrs.delete) : true,
|
|
duplicate: viewInfo.arch.attrs.duplicate ? JSON.parse(viewInfo.arch.attrs.duplicate) : true,
|
|
},
|
|
};
|
|
|
|
this.loadParams = {
|
|
context: params.context,
|
|
count: params.count || ((this.controllerParams.ids !== undefined) &&
|
|
this.controllerParams.ids.length) || 0,
|
|
domain: params.domain,
|
|
groupedBy: params.groupBy,
|
|
modelName: params.modelName,
|
|
res_id: params.currentId,
|
|
res_ids: params.ids,
|
|
};
|
|
if (params.modelName) {
|
|
this.loadParams.modelName = params.modelName;
|
|
}
|
|
// default_order is like:
|
|
// 'name,id desc'
|
|
// but we need it like:
|
|
// [{name: 'id', asc: false}, {name: 'name', asc: true}]
|
|
var defaultOrder = viewInfo.arch.attrs.default_order;
|
|
if (defaultOrder) {
|
|
this.loadParams.orderedBy = _.map(defaultOrder.split(','), function (order) {
|
|
order = order.trim().split(' ');
|
|
return {name: order[0], asc: order[1] !== 'desc'};
|
|
});
|
|
}
|
|
|
|
this.userContext = params.userContext;
|
|
},
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Public
|
|
//--------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Main method of the view class. Create a controller, and make sure that
|
|
* data and libraries are loaded.
|
|
*
|
|
* There is a unusual thing going in this method with parents: we create
|
|
* renderer/model with parent as parent, then we have to reassign them at
|
|
* the end to make sure that we have the proper relationships. This is
|
|
* necessary to solve the problem that the controller need the model and the
|
|
* renderer to be instantiated, but the model need a parent to be able to
|
|
* load itself, and the renderer needs the data in its constructor.
|
|
*
|
|
* @param {Widget} parent The parent of the resulting Controller (most
|
|
* likely a view manager)
|
|
* @returns {Deferred} The deferred resolves to a controller
|
|
*/
|
|
getController: function (parent) {
|
|
var self = this;
|
|
// check if a model already exists, as if not, one will be created and
|
|
// we'll have to set the controller as its parent
|
|
var alreadyHasModel = !!this.model;
|
|
return $.when(this._loadData(parent), ajax.loadLibs(this)).then(function () {
|
|
var state = self.model.get(arguments[0]);
|
|
var renderer = self.getRenderer(parent, state);
|
|
var Controller = self.Controller || self.config.Controller;
|
|
var controllerParams = _.extend({
|
|
initialState: state,
|
|
}, self.controllerParams);
|
|
var controller = new Controller(parent, self.model, renderer, controllerParams);
|
|
renderer.setParent(controller);
|
|
|
|
if (!alreadyHasModel) {
|
|
// if we have a model, it already has a parent. Otherwise, we
|
|
// set the controller, so the rpcs from the model actually work
|
|
self.model.setParent(controller);
|
|
}
|
|
return controller;
|
|
});
|
|
},
|
|
/**
|
|
* Returns the view model or create an instance of it if none
|
|
*
|
|
* @param {Widget} parent the parent of the model, if it has to be created
|
|
* @return {Object} instance of the view model
|
|
*/
|
|
getModel: function (parent) {
|
|
if (!this.model) {
|
|
var Model = this.config.Model;
|
|
this.model = new Model(parent);
|
|
}
|
|
return this.model;
|
|
},
|
|
/**
|
|
* Returns the a new view renderer instance
|
|
*
|
|
* @param {Widget} parent the parent of the model, if it has to be created
|
|
* @param {Object} state the information related to the rendered view
|
|
* @return {Object} instance of the view renderer
|
|
*/
|
|
getRenderer: function (parent, state) {
|
|
var Renderer = this.config.Renderer;
|
|
return new Renderer(parent, state, this.rendererParams);
|
|
},
|
|
/**
|
|
* this is useful to customize the actual class to use before calling
|
|
* createView.
|
|
*
|
|
* @param {Controller} Controller
|
|
*/
|
|
setController: function (Controller) {
|
|
this.Controller = Controller;
|
|
},
|
|
|
|
//--------------------------------------------------------------------------
|
|
// Private
|
|
//--------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Load initial data from the model
|
|
*
|
|
* @private
|
|
* @param {Widget} parent the parent of the model
|
|
* @returns {Deferred<*>} a deferred that resolves to whatever the model
|
|
* decide to return
|
|
*/
|
|
_loadData: function (parent) {
|
|
var model = this.getModel(parent);
|
|
return model.load(this.loadParams);
|
|
},
|
|
/**
|
|
* Loads the subviews for x2many fields when they are not inline
|
|
*
|
|
* @private
|
|
* @param {Widget} parent the parent of the model, if it has to be created
|
|
* @returns {Deferred}
|
|
*/
|
|
_loadSubviews: function (parent) {
|
|
var self = this;
|
|
var defs = [];
|
|
if (this.loadParams && this.loadParams.fieldsInfo) {
|
|
var fields = this.loadParams.fields;
|
|
|
|
_.each(this.loadParams.fieldsInfo.form, function (attrs, fieldName) {
|
|
var field = fields[fieldName];
|
|
if (!field) {
|
|
// when a one2many record is opened in a form view, the fields
|
|
// of the main one2many view (list or kanban) are added to the
|
|
// fieldsInfo of its form view, but those fields aren't in the
|
|
// loadParams.fields, as they are not displayed in the view, so
|
|
// we can ignore them.
|
|
return;
|
|
}
|
|
if (field.type !== 'one2many' && field.type !== 'many2many') {
|
|
return;
|
|
}
|
|
|
|
if (attrs.Widget.prototype.useSubview && !attrs.__no_fetch && !attrs.views[attrs.mode]) {
|
|
var context = {};
|
|
var regex = /'([a-z]*_view_ref)' *: *'(.*?)'/g;
|
|
var matches;
|
|
while (matches = regex.exec(attrs.context)) {
|
|
context[matches[1]] = matches[2];
|
|
}
|
|
defs.push(parent.loadViews(
|
|
field.relation,
|
|
new Context(context, self.userContext, self.loadParams.context),
|
|
[[null, attrs.mode === 'tree' ? 'list' : attrs.mode]])
|
|
.then(function (views) {
|
|
for (var viewName in views) {
|
|
attrs.views[viewName] = views[viewName];
|
|
}
|
|
self._setSubViewLimit(attrs);
|
|
}));
|
|
} else {
|
|
self._setSubViewLimit(attrs);
|
|
}
|
|
});
|
|
}
|
|
return $.when.apply($, defs);
|
|
},
|
|
/**
|
|
* We set here the limit for the number of records fetched (in one page).
|
|
* This method is only called for subviews, not for main views.
|
|
*
|
|
* @private
|
|
* @param {Object} attrs
|
|
*/
|
|
_setSubViewLimit: function (attrs) {
|
|
var view = attrs.views && attrs.views[attrs.mode];
|
|
var limit = view && view.arch.attrs.limit && parseInt(view.arch.attrs.limit);
|
|
if (!limit && attrs.widget === 'many2many_tags') {
|
|
limit = 1000;
|
|
}
|
|
attrs.limit = limit || 40;
|
|
},
|
|
});
|
|
|
|
return AbstractView;
|
|
|
|
});
|