web-apps/apps/spreadsheeteditor/main/app/view/WatchDialog.js

/*
 *
 * (c) Copyright Ascensio System SIA 2010-2022
 *
 * This program is a free software product. You can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License (AGPL)
 * version 3 as published by the Free Software Foundation. In accordance with
 * Section 7(a) of the GNU AGPL its Section 15 shall be amended to the effect
 * that Ascensio System SIA expressly excludes the warranty of non-infringement
 * of any third-party rights.
 *
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
 * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
 *
 * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
 * street, Riga, Latvia, EU, LV-1050.
 *
 * The  interactive user interfaces in modified source and object code versions
 * of the Program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU AGPL version 3.
 *
 * Pursuant to Section 7(b) of the License you must retain the original Product
 * logo when distributing the program. Pursuant to Section 7(e) we decline to
 * grant you any rights under trademark law for use of our trademarks.
 *
 * All the Product's GUI elements, including illustrations and icon sets, as
 * well as technical writing content are licensed under the terms of the
 * Creative Commons Attribution-ShareAlike 4.0 International. See the License
 * terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
 *
*/
/**
 *
 *  WatchDialog.js
 *
 *  Created by Julia.Radzhabova on 24.06.22
 *  Copyright (c) 2022 Ascensio System SIA. All rights reserved.
 *
 */

define([  'text!spreadsheeteditor/main/app/template/WatchDialog.template',
    'common/main/lib/view/AdvancedSettingsWindow',
    'common/main/lib/component/ListView'
], function (contentTemplate) {
    'use strict';

    SSE.Views = SSE.Views || {};

    SSE.Views.WatchDialog =  Common.Views.AdvancedSettingsWindow.extend(_.extend({

        options: {
            alias: 'WatchDialog',
            contentWidth: 560,
            height: 294,
            modal: false,
            buttons: null
        },

        initialize: function (options) {
            var me = this;
            _.extend(this.options, {
                title: this.txtTitle,
                template: [
                    '<div class="box" style="height:' + (this.options.height-85) + 'px;">',
                    '<div class="content-panel" style="padding: 0;">' + _.template(contentTemplate)({scope: this}) + '</div>',
                    '</div>',
                    '<div class="footer center">',
                    '<button class="btn normal dlg-btn" result="cancel" style="width: 86px;">' + this.closeButtonText + '</button>',
                    '</div>'
                ].join('')
            }, options);

            this.api        = options.api;
            this.handler    = options.handler;

            this.wrapEvents = {
                onRefreshWatchList: _.bind(this.refreshList, this)
            };

            Common.Views.AdvancedSettingsWindow.prototype.initialize.call(this, this.options);
        },
        render: function () {
            Common.Views.AdvancedSettingsWindow.prototype.render.call(this);
            var me = this;

            this.watchList = new Common.UI.ListView({
                el: $('#watch-dialog-list', this.$window),
                multiSelect: true,
                store: new Common.UI.DataViewStore(),
                simpleAddMode: true,
                itemTemplate: _.template([
                    '<div id="<%= id %>" class="list-item" style="width: 100%;display:inline-block;pointer-events:none;">',
                        '<div style="width:70px;padding-right: 5px;"><%= Common.Utils.String.htmlEncode(book) %></div>',
                        '<div style="width:70px;padding-right: 5px;"><%= Common.Utils.String.htmlEncode(sheet) %></div>',
                        '<div style="width:70px;padding-right: 5px;"><%= Common.Utils.String.htmlEncode(name) %></div>',
                        '<div style="width:70px;padding-right: 5px;"><%= cell %></div>',
                        '<div style="width:110px;padding-right: 5px;"><%= value %></div>',
                        '<div style="width:135px;"><%= formula %></div>',
                    '</div>'
                ].join('')),
                tabindex: 1
            });
            this.watchList.on('item:select', _.bind(this.onSelectWatch, this))
                           .on('item:keydown', _.bind(this.onKeyDown, this));

            this.btnAdd = new Common.UI.Button({
                el: $('#watch-dialog-btn-add', this.$window)
            });
            this.btnAdd.on('click', _.bind(this.onAddWatch, this, false));

            this.btnDelete = new Common.UI.Button({
                parentEl: $('#watch-dialog-btn-delete', this.$window),
                cls: 'btn-text-split-default auto',
                caption: this.textDelete,
                split: true,
                menu        : new Common.UI.Menu({
                    style: 'min-width:100px;',
                    items: [
                        {
                            caption: this.textDelete,
                            value: 0
                        },
                        {
                            caption:  this.textDeleteAll,
                            value: 1
                        }]
                })
            });
            $(this.btnDelete.cmpEl.find('button')[0]).css('min-width', '87px');
            this.btnDelete.on('click', _.bind(this.onDeleteWatch, this));
            this.btnDelete.menu.on('item:click', _.bind(this.onDeleteMenu, this));
            this.afterRender();
        },

        afterRender: function() {
            this._setDefaults();
        },

        getFocusedComponents: function() {
            return [ this.btnAdd, this.btnDelete, this.watchList ];
        },

        getDefaultFocusableComponent: function () {
            return this.watchList;
        },

        _setDefaults: function (props) {
            this.refreshList();
            this.api.asc_registerCallback('asc_onUpdateCellWatches', this.wrapEvents.onRefreshWatchList);
        },

        refreshList: function(watches) {
            if (watches) { // change existing watches
                for (var idx in watches) {
                    if (watches.hasOwnProperty(idx)) {
                        var index = parseInt(idx),
                            item = watches[idx],
                            store = this.watchList.store;
                        if (index>=0 && index<store.length) {
                            var rec = store.at(index);
                            rec.set({
                                book: item.asc_getWorkbook(),
                                sheet: item.asc_getSheet(),
                                name: item.asc_getName(),
                                cell: item.asc_getCell(),
                                value: item.asc_getValue(),
                                formula: item.asc_getFormula(),
                                props: item
                            });
                        }
                    }
                }
            } else { // get list of watches
                var arr = [];
                watches = this.api.asc_getCellWatches();
                if (watches) {
                    for (var i=0; i<watches.length; i++) {
                        var watch = watches[i];
                        arr.push({
                            book: watch.asc_getWorkbook(),
                            sheet: watch.asc_getSheet(),
                            name: watch.asc_getName(),
                            cell: watch.asc_getCell(),
                            value: watch.asc_getValue(),
                            formula: watch.asc_getFormula(),
                            props: watch
                        });
                    }
                }
                this.watchList.store.reset(arr);
                if (this._deletedIndex!==undefined) {
                    var store = this.watchList.store;
                    (store.length>0) && this.watchList.selectByIndex(this._deletedIndex<store.length ? this._deletedIndex : store.length-1);
                    var selectedRec = this.watchList.getSelectedRec();
                    (selectedRec && selectedRec.length > 0) && this.watchList.scrollToRecord(selectedRec[0]);
                    this._fromKeyDown && this.watchList.focus();
                    this._fromKeyDown = false;
                    this._deletedIndex=undefined;
                }
                this.updateButtons();
            }
        },

        onAddWatch: function() {
            var range = '';
            var me = this;
            if (me.api) {
                var handlerDlg = function(dlg, result) {
                    if (result == 'ok') {
                        me.api.asc_addCellWatches(dlg.getSettings());
                    }
                };

                var win = new SSE.Views.CellRangeDialog({
                    handler: handlerDlg
                }).on('close', function() {
                    me.show();
                });

                var xy = me.$window.offset();
                me.hide();
                win.show(xy.left + 65, xy.top + 77);
                win.setSettings({
                    api     : me.api,
                    range   : me.api.asc_getWorksheetName(me.api.asc_getActiveWorksheetIndex()) + '!' + me.api.asc_getActiveRangeStr(Asc.referenceType.A),
                    type    : Asc.c_oAscSelectionDialogType.Chart
                });
            }
        },

        onDeleteWatch: function() {
            var me = this;
            var rec = this.watchList.getSelectedRec();
            if (rec) {
                var props=[];
                _.each(rec, function (r, i) {
                    me._deletedIndex = me.watchList.store.indexOf(r)-props.length;
                    props[i] =r.get('props');
                });
                this.api.asc_deleteCellWatches(props);
            }
        },

        onDeleteMenu: function(menu, item) {
            if (item.value == 1) {
                this.api.asc_deleteCellWatches(undefined, true);
            } else
                this.onDeleteWatch();
        },

        onSelectWatch: function(lisvView, itemView, record) {
            this.updateButtons();
        },

        onKeyDown: function (lisvView, record, e) {
            if (e.keyCode==Common.UI.Keys.DELETE && !this.btnDelete.isDisabled()) {
                this._fromKeyDown = true;
                this.onDeleteWatch();
            }
        },

        updateButtons: function() {
            var rec = this.watchList.getSelectedRec();
            this.btnDelete.setDisabled(!(rec && rec.length>0));
            this.watchList.scroller && this.watchList.scroller.update({alwaysVisibleY: true});
        },

        close: function () {
            this.api.asc_unregisterCallback('asc_onUpdateCellWatches', this.wrapEvents.onRefreshWatchList);

            Common.Views.AdvancedSettingsWindow.prototype.close.call(this);
        },

        txtTitle: 'Watch Window',
        textAdd: 'Add watch',
        textDelete: 'Delete watch',
        textDeleteAll: 'Delete all',
        closeButtonText: 'Close',
        textBook: 'Book',
        textSheet: 'Sheet',
        textName: 'Name',
        textCell: 'Cell',
        textValue: 'Value',
        textFormula: 'Formula'

    }, SSE.Views.WatchDialog || {}));
});