egroupware_official/etemplate/js/et2_extension_nextmatch_controller.js

/**
 * eGroupWare eTemplate2 - Class which contains a the data model for nextmatch widgets
 *
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 * @package etemplate
 * @subpackage api
 * @link http://www.egroupware.org
 * @author Andreas Stöckel
 * @copyright Stylite 2012
 * @version $Id$
 */

"use strict";

/*egw:uses
	et2_core_common;
	et2_core_inheritance;

	et2_dataview_view_row;

	et2_dataview_controller;

	et2_dataview_interfaces;

	egw_data;
*/

var et2_nextmatch_controller = et2_dataview_controller.extend(
		et2_IDataProvider, {

	/**
	 * Initializes the nextmatch controller.
	 *
	 * @param _egw is the api instance
	 * @param _execId is the execId of the etemplate
	 * @param _widgetId is the id of the nextmatch-widget we are fetching data
	 * for.
	 */
	init: function (_egw, _execId, _widgetId, _grid, _rowProvider) {

		// Call the parent et2_dataview_controller constructor
		this._super(_grid, this, this._rowCallback, this);

		// Copy all parameters
		this.egw = _egw;
		this._execId = _execId;
		this._widgetId = _widgetId;
		this._rowProvider = _rowProvider;

		// We start with no filters
		this._filters = {};

		// Directly use the API-Implementation of dataRegisterUID and
		// dataUnregisterUID
		this.dataRegisterUID = _egw.dataRegisterUID;
		this.dataUnregisterUID = _egw.dataUnregisterUID;
	},

	/**
	 * Updates the filter instance.
	 */
	setFilters: function (_filters) {
		// Update the filters, reset the "lastModification"
		this._filters = _filters;
		this._lastModified = null;

		// Trigger an update
		this.update();
	},


	/** -- PRIVATE FUNCTIONS -- **/

	/**
	 * Overwrites the inherited _destroyCallback function in order to be able
	 * to free the "rowWidget".
	 */
	_destroyCallback: function (_row) {
		// Destroy any widget associated to the row
		if (this.entry.widget)
		{
			this.entry.widget.free();
			this.entry.widget = null;
		}

		// Call the inherited function
		this._super.call(this, arguments);
	},

	/**
	 * Creates the actual data row.
	 *
	 * @param _data is an array containing the row data
	 * @param _tr is the tr into which the data will be inserted
	 * @param _idx is the index of the row
	 * @param _entry is the internal row datastructure of the controller, in
	 * this special case used to store the rowWidget reference, so that it can
	 * be properly freed.
	 */
	_rowCallback: function (_data, _tr, _idx, _entry) {
		// Let the row provider fill in the data row -- store the returned
		// rowWidget inside the _entry
		_entry.widget = this._rowProvider.getDataRow(
			{ "content": _data }, _tr, _idx);
	},


	/** -- Implementation of et2_IDataProvider -- **/


	dataFetch: function (_queriedRange, _lastModification, _callback,
			_context) {
		// Pass the fetch call to the API, multiplex the data about the
		// nextmatch instance into the call.
		this.egw.dataFetch(
				this._execId,
				_queriedRange,
				this._filters,
				this._widgetId,
				_lastModification,
				_callback,
				_context);
	},

	dataRegisterUID: function () {
		// Overwritten in the constructor
	},

	dataUnregisterUID: function () {
		// Overwritten in the constructor
	}

});