Merge pull request #1834 from ONLYOFFICE/feature/cell-watches

Feature/cell watches
This commit is contained in:
Julia Radzhabova 2022-07-01 16:17:25 +03:00 committed by GitHub
commit a1be884b34
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 392 additions and 4 deletions

View file

@ -874,6 +874,10 @@
border: @scaled-one-px-value solid @border-regular-control;
.border-radius(@border-radius-small);
&.auto {
width: auto;
}
&.dropdown-toggle {
width: 13px;
}

View file

@ -45,7 +45,8 @@ define([
'spreadsheeteditor/main/app/collection/FormulaGroups',
'spreadsheeteditor/main/app/view/FormulaDialog',
'spreadsheeteditor/main/app/view/FormulaTab',
'spreadsheeteditor/main/app/view/FormulaWizard'
'spreadsheeteditor/main/app/view/FormulaWizard',
'spreadsheeteditor/main/app/view/WatchDialog'
], function () {
'use strict';
@ -80,7 +81,8 @@ define([
},
'FormulaTab': {
'function:apply': this.applyFunction,
'function:calculate': this.onCalculate
'function:calculate': this.onCalculate,
'function:watch': this.onWatch
},
'Toolbar': {
'function:apply': this.applyFunction,
@ -409,6 +411,24 @@ define([
}
},
onWatch: function(state) {
if (state) {
var me = this;
this._watchDlg = new SSE.Views.WatchDialog({
api: this.api,
handler: function(result) {
Common.NotificationCenter.trigger('edit:complete');
}
});
this._watchDlg.on('close', function(win){
me.formulaTab.btnWatch.toggle(false, true);
me._watchDlg = null;
}).show();
} else if (this._watchDlg)
this._watchDlg.close();
},
sCategoryAll: 'All',
sCategoryLast10: '10 last used',
sCategoryLogical: 'Logical',

View file

@ -2344,6 +2344,18 @@ define([
}
});
win.show();
} else if (id == Asc.c_oAscConfirm.ConfirmAddCellWatches) {
Common.UI.warning({
title: this.notcriticalErrorTitle,
msg: (data>Asc.c_nAscMaxAddCellWatchesCount) ? Common.Utils.String.format(this.confirmAddCellWatchesMax, Asc.c_nAscMaxAddCellWatchesCount) : Common.Utils.String.format(this.confirmAddCellWatches, data),
buttons: ['yes', 'no'],
primary: 'yes',
callback: _.bind(function(btn) {
if (apiCallback) {
apiCallback(btn === 'yes');
}
}, this)
});
}
},
@ -3598,7 +3610,10 @@ define([
textReconnect: 'Connection is restored',
errorCannotUseCommandProtectedSheet: 'You cannot use this command on a protected sheet. To use this command, unprotect the sheet.<br>You might be requested to enter a password.',
textRequestMacros: 'A macro makes a request to URL. Do you want to allow the request to the %1?',
textRememberMacros: 'Remember my choice for all macros'
textRememberMacros: 'Remember my choice for all macros',
confirmAddCellWatches: 'This action will add {0} cell watches.<br>Do you want to continue?',
confirmAddCellWatchesMax: 'This action will add only {0} cell watches by memory save reason.<br>Do you want to continue?'
}
})(), SSE.Controllers.Main || {}))
});

View file

@ -203,6 +203,10 @@
<span class="btn-slot text x-huge" id="slot-btn-named-range-huge"></span>
</div>
<div class="separator long"></div>
<div class="group">
<span class="btn-slot text x-huge" id="slot-btn-watch-window"></span>
</div>
<div class="separator long"></div>
<div class="group">
<span class="btn-slot text x-huge" id="slot-btn-calculate"></span>
</div>

View file

@ -0,0 +1,27 @@
<div class="settings-panel active">
<div class="inner-content">
<table cols="1" style="width: 100%;">
<tr>
<td class="padding-large">
<button type="button" class="btn btn-text-default auto sort-dialog-btn-text" id="watch-dialog-btn-add"><%= scope.textAdd %></button>
<div id="watch-dialog-btn-delete" style="display: inline-block;"></div>
</td>
</tr>
<tr>
<td>
<label class="header" style="width: 76px;overflow: hidden;text-overflow: ellipsis;vertical-align: middle;"><%= scope.textBook %></label><!--
--><label class="header" style="width: 70px;overflow: hidden;text-overflow: ellipsis;vertical-align: middle;"><%= scope.textSheet %></label><!--
--><label class="header" style="width: 70px;overflow: hidden;text-overflow: ellipsis;vertical-align: middle;"><%= scope.textName %></label><!--
--><label class="header" style="width: 70px;overflow: hidden;text-overflow: ellipsis;vertical-align: middle;"><%= scope.textCell %></label><!--
--><label class="header" style="width: 110px;overflow: hidden;text-overflow: ellipsis;vertical-align: middle;"><%= scope.textValue %></label><!--
--><label class="header" style="width: 140px;overflow: hidden;text-overflow: ellipsis;vertical-align: middle;"><%= scope.textFormula %></label>
</td>
</tr>
<tr>
<td class="padding-small">
<div id="watch-dialog-list" class="range-tableview" style="width:100%; height: 143px;"></div>
</td>
</tr>
</table>
</div>
</div>

View file

@ -69,6 +69,9 @@ define([
me.btnNamedRange.menu.on('item:click', function (menu, item, e) {
me.fireEvent('function:namedrange', [menu, item, e]);
});
me.btnWatch.on('click', function(b, e){
me.fireEvent('function:watch', [b.pressed]);
});
}
return {
options: {},
@ -318,6 +321,21 @@ define([
});
this.lockedControls.push(this.btnNamedRange);
this.btnWatch = new Common.UI.Button({
parentEl: $host.find('#slot-btn-watch-window'),
cls: 'btn-toolbar x-huge icon-top',
iconCls: 'toolbar__icon btn-lookup',
caption: this.txtWatch,
hint: this.tipWatch,
disabled: true,
enableToggle: true,
lock: [_set.editCell, _set.lostConnect, _set.coAuth],
dataHint: '1',
dataHintDirection: 'bottom',
dataHintOffset: 'small'
});
this.lockedControls.push(this.btnWatch);
Common.NotificationCenter.on('app:ready', this.onAppReady.bind(this));
},
@ -577,7 +595,9 @@ define([
textCalculateCurrentSheet: 'Calculate current sheet',
textAutomatic: 'Automatic',
textManual: 'Manual',
tipCalculateTheEntireWorkbook: 'Calculate the entire workbook'
tipCalculateTheEntireWorkbook: 'Calculate the entire workbook',
txtWatch: 'Watch Window',
tipWatch: 'Add cells to the Watch Window list'
}
}()), SSE.Views.FormulaTab || {}));
});

View file

@ -0,0 +1,280 @@
/*
*
* (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
*
*/
/**
*
* WatchDialogDialog.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),
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);
this.watchList.scrollToRecord(this.watchList.getSelectedRec());
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 rec = this.watchList.getSelectedRec();
if (rec) {
this._deletedIndex = this.watchList.store.indexOf(rec);
this.api.asc_deleteCellWatches([rec.get('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() {
this.btnDelete.setDisabled(this.watchList.store.length<1 || !this.watchList.getSelectedRec());
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 || {}));
});

View file

@ -1105,6 +1105,8 @@
"SSE.Controllers.Main.warnNoLicense": "You've reached the limit for simultaneous connections to %1 editors. This document will be opened for viewing only.<br>Contact %1 sales team for personal upgrade terms.",
"SSE.Controllers.Main.warnNoLicenseUsers": "You've reached the user limit for %1 editors. Contact %1 sales team for personal upgrade terms.",
"SSE.Controllers.Main.warnProcessRightsChange": "You have been denied the right to edit the file.",
"SSE.Controllers.Main.confirmAddCellWatches": "This action will add {0} cell watches.<br>Do you want to continue?",
"SSE.Controllers.Main.confirmAddCellWatchesMax": "This action will add only {0} cell watches by memory save reason.<br>Do you want to continue?",
"SSE.Controllers.Print.strAllSheets": "All Sheets",
"SSE.Controllers.Print.textFirstCol": "First column",
"SSE.Controllers.Print.textFirstRow": "First row",
@ -2415,6 +2417,8 @@
"SSE.Views.FormulaTab.txtFormulaTip": "Insert function",
"SSE.Views.FormulaTab.txtMore": "More functions",
"SSE.Views.FormulaTab.txtRecent": "Recently used",
"SSE.Views.FormulaTab.txtWatch": "Watch Window",
"SSE.Views.FormulaTab.tipWatch": "Add cells to the Watch Window list",
"SSE.Views.FormulaWizard.textAny": "any",
"SSE.Views.FormulaWizard.textArgument": "Argument",
"SSE.Views.FormulaWizard.textFunction": "Function",
@ -3668,6 +3672,17 @@
"SSE.Views.ViewTab.tipCreate": "Create sheet view",
"SSE.Views.ViewTab.tipFreeze": "Freeze panes",
"SSE.Views.ViewTab.tipSheetView": "Sheet view",
"SSE.Views.WatchDialog.txtTitle": "Watch Window",
"SSE.Views.WatchDialog.textAdd": "Add watch",
"SSE.Views.WatchDialog.textDelete": "Delete watch",
"SSE.Views.WatchDialog.textDeleteAll": "Delete all",
"SSE.Views.WatchDialog.closeButtonText": "Close",
"SSE.Views.WatchDialog.textBook": "Book",
"SSE.Views.WatchDialog.textSheet": "Sheet",
"SSE.Views.WatchDialog.textName": "Name",
"SSE.Views.WatchDialog.textCell": "Cell",
"SSE.Views.WatchDialog.textValue": "Value",
"SSE.Views.WatchDialog.textFormula": "Formula",
"SSE.Views.WBProtection.hintAllowRanges": "Allow edit ranges",
"SSE.Views.WBProtection.hintProtectSheet": "Protect sheet",
"SSE.Views.WBProtection.hintProtectWB": "Protect workbook",

View file

@ -3664,6 +3664,9 @@
"SSE.Views.ViewTab.tipCreate": "Создать представление листа",
"SSE.Views.ViewTab.tipFreeze": "Закрепить области",
"SSE.Views.ViewTab.tipSheetView": "Представление листа",
"SSE.Views.WatchDialog.textAdd": "Добавить контрольное значение",
"SSE.Views.WatchDialog.textDelete": "Удалить контрольное значение",
"SSE.Views.WatchDialog.textDeleteAll": "Удалить все",
"SSE.Views.WBProtection.hintAllowRanges": "Разрешить редактировать диапазоны",
"SSE.Views.WBProtection.hintProtectSheet": "Защитить лист",
"SSE.Views.WBProtection.hintProtectWB": "Защитить книгу",