//******************************************************************************************************//  pagedViewModel.js - Gbtc////  Copyright © 2016, Grid Protection Alliance.  All Rights Reserved.////  Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See//  the NOTICE file distributed with this work for additional information regarding copyright ownership.//  The GPA licenses this file to you under the MIT License (MIT), the "License"; you may//  not use this file except in compliance with the License. You may obtain a copy of the License at:////      http://opensource.org/licenses/MIT////  Unless agreed to in writing, the subject software distributed under the License is distributed on an//  "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the//  License for the specific language governing permissions and limitations.////  Code Modification History://  ----------------------------------------------------------------------------------------------------//  01/23/2016 - J. Ritchie Carroll//       Generated original version of source code.////******************************************************************************************************// ReSharper disable UndeclaredGlobalVariableUsing // Paged view model base class scripts"use strict"; if (typeof jQuery === "undefined") {  throw new Error("pageViewModel script requires jQuery - make sure jquery.js is loaded first");} if (typeof Cookies.get === "undefined") {  throw new Error("pageViewModel script requires js.cookie - make sure js.cookie.js is loaded first");} if (typeof ko === "undefined") {  throw new Error("pageViewModel script requires knockout - make sure knockout.js is loaded first");} if (typeof Dictionary === "undefined") {  throw new Error("pageViewModel script requires gsf.web.client - make sure gsf.web.client.js is loaded first");} var RecordMode = {    View: 0,    Edit: 1,    AddNew: 2} // Define paged view model classfunction PagedViewModel() {    const self = this;     // Configuration fields    self.labelField = "{name}";                                     // Field name that best represents row for delete confirmation    self.primaryKeyFields = ["{id}"];                               // Primary key field names array    self.defaultSortField = "{id}";                                 // Default sort field    self.defaultSortAscending = true;                               // Default sort ascending flag    self.initialFocusField = "";                                    // Initial add/edit field with focus    self.modelName = "{name}";                                      // Full class name of source model    self.hubName = "{name}";                                        // Full class name of data hub    self.pageName = "{name}";                                       // Name of page implementing model (helps with unique cookie name)    self.filterText = "";                                           // Search filter text    self.addNewEditDialogVisible = false;                           // Flag that indicates when add new / edit dialog is visible     // Observable fields    self.pageRecords = ko.observableArray();                        // Records queried for current page    self.recordCount = ko.observable(0);                            // Queried record count    self.sortField = ko.observable(self.defaultSortField);          // Current sort field, persisted per model    self.sortAscending = ko.observable(self.defaultSortAscending);  // Current sort ascending flag, persisted per model    self.unassignedFieldCount = ko.observable(0);                   // Number of bound fields with missing data    self.dataHubIsConnected = ko.observable(false);                 // Data hub connected observable flag - externally managed    self.errors = ko.validation.group([ko.observable(0)]);          // Validation errors array    self.canEdit = ko.observable(true);                             // Can edit flag - normally controlled by external roles    self.canAddNew = ko.observable(true);                           // Can add new flag - normally controlled by external roles    self.canDelete = ko.observable(true);                           // Can delete flag - normally controlled by external roles     // Internal fields    self._currentPageSize = ko.observable(1);    self._currentPage = ko.observable(0);    self._currentRecord = ko.observable();    self._currentRecordWatcher = function () { return { dispose: function () { } }; }();    self._recordMode = ko.observable(RecordMode.View);    self._isDirty = ko.observable(false);    self._columnWidths = [];     // Properties     // Gets or sets the number records to display on the page    self.currentPageSize = ko.pureComputed({        read: self._currentPageSize,        write: function(value) {            if (value < 1)                value = 1;             if (value !== self._currentPageSize()) {                self._currentPageSize(value);                 // Validate current page after page size change                if (self.currentPage())                    self.currentPage(self.currentPage());            }        },        owner: self    });     // Gets or sets the current page number    self.currentPage = ko.pureComputed({        read: self._currentPage,        write: function(value) {            if (value < 1)                value = 1;            else if (value > self.totalPages())                value = self.totalPages();             // Requery records for page when current page changes            if (value !== self._currentPage()) {                self._currentPage(value);                self.queryPageRecords();            }        },        owner: self    });     // Gets or sets current record on page    self.currentRecord = ko.pureComputed({        read: self._currentRecord,        write: function (value) {            self._currentRecordWatcher.dispose();            self._currentRecord(value);            self.isDirty(false);            $(self).trigger("currentRecordChanged");            self.applyValidationParameters();             // Watch for changes to fields in current record            self._currentRecordWatcher = ko.watch(self._currentRecord(), function (parents, child, item) {                // Do not trigger field changed operations until dialog is visible                // so that updates will only be for user triggered changed                if (!self.addNewEditDialogVisible)                    return;                 self.isDirty(true);                $(self).trigger("currentRecordUpdated", [child]);                 // Recalculate unassigned field count after bindings may have been updated by field change                setTimeout(self.calculateUnassignedFieldCount, 10);            });        },        owner: self    });     // Gets or sets the record mode, i.e., view, edit or add new    self.recordMode = ko.pureComputed({        read: self._recordMode,        write: function(newMode) {            const oldMode = self._recordMode();             if (newMode !== oldMode) {                self._recordMode(newMode);                 if (oldMode === RecordMode.View && newMode === RecordMode.Edit)                    self.setFocusOnInitialField();                 $(self).trigger("recordModeChanged", [oldMode, newMode]);            }        },        owner: self    });     // Gets or sets current record changed flag    self.isDirty = ko.pureComputed({        read: self._isDirty,        write: function(value) {            if (value === undefined)                value = true;             self._isDirty(value);            self.calculateUnassignedFieldCount();        },        owner: self    });     // Gets total number pages based on total record count and current page size    self.totalPages = ko.pureComputed(function() {        return Math.max(Math.ceil(self.recordCount() / self.currentPageSize()), 1);    });     // Gets flag that determines if current page is first page    self.onFirstPage = ko.pureComputed(function() {        return self.currentPage() <= 1;    });     // Gets flag that determines if current page is last page    self.onLastPage = ko.pureComputed(function() {        return self.currentPage() >= self.totalPages();    });     // Return validation errors, i.e., non-required field errors    self.validationErrors = ko.pureComputed(function() {        return self.errors().length - self.unassignedFieldCount();    }).extend({ notify: "always" });     // Delegates    self.queryRecordCount = function(/* filterText */) { };    self.queryRecords = function(/* sortField, ascending, page, pageSize, filterText */) { };    self.deleteRecord = function(/* keyValues[] */) { };    self.newRecord = function() { };    self.addNewRecord = function(/* record */) { };    self.updateRecord = function(/* record */) { };    self.applyValidationParameters = function() { };     // Setters needed to assign delegate properties, 'cause Javascript    self.setQueryRecordCount = function(queryRecordCountFunction) {        self.queryRecordCount = queryRecordCountFunction;    }     self.setQueryRecords = function(queryRecordsFunction) {        self.queryRecords = queryRecordsFunction;    }     self.setDeleteRecord = function(deleteRecordFunction) {        self.deleteRecord = deleteRecordFunction;    }     self.setNewRecord = function(newRecordFunction) {        self.newRecord = newRecordFunction;    }     self.setAddNewRecord = function(addNewRecordFunction) {        self.addNewRecord = addNewRecordFunction;    }     self.setUpdateRecord = function(updateRecordFunction) {        self.updateRecord = updateRecordFunction;    }     self.setApplyValidationParameters = function(applyValidationParametersFunction) {        self.applyValidationParameters = applyValidationParametersFunction;    }     // Methods    self.initialize = function() {        // Restore any previous sort order        const lastSortField = Cookies.get(self.getCookieName("LastSortField"));        const lastSortAscending = Cookies.get(self.getCookieName("LastSortAscending"));         if (lastSortField === undefined)            self.sortField(self.defaultSortField);        else            self.sortField(lastSortField);         if (lastSortAscending === undefined)            self.sortAscending(self.defaultSortAscending);        else            self.sortAscending(lastSortAscending === "true");         if (self.dataHubIsConnected()) {            // Query total record count            self.queryRecordCount(self.filterText).done(function(count) {                // Update record count observable                self.recordCount(count);                 // Force page refresh when record count has been updated                const currentPage = self.currentPage();                self._currentPage(0);                self.currentPage(currentPage);            });                         // Initialize current record with an empty row            self.newRecord().done(function(emptyRecord) {                self.deriveObservableRecord(emptyRecord).done(function(observableRecord) {                    self.currentRecord(observableRecord);                });            });        }         // Initialize column widths array        self._columnWidths = [];        const columns = $("#recordRow").find("td");         for (let i = 0; i < columns.length; i++) {            self._columnWidths.push($(columns[i]).width());        }    }     self.calculatePageSize = function(forceRefresh) {        // Calculate total number of table rows that will fit within current page height        const remainingHeight = calculateRemainingBodyHeight() -            $("#contentWell").paddingHeight() -            $("#responsiveTableDiv").paddingHeight() -            $("#recordsTable").paddingHeight() -            $("#pageControlsRow").outerHeight(true);         // Estimate page size based on height of first record row        const firstRow = $("#recordRow");        var pageSize = (remainingHeight / firstRow.outerHeight(true)).truncate();         if (!pageSize || isNaN(pageSize) || !isFinite(pageSize) || pageSize < 1)            pageSize = 1;         if (forceRefresh === undefined)            forceRefresh = false;         // Check for dynamic Bootstrap column resizing, in which case we need to refresh data        // for cases where binding may be truncating data lengths, see $.fn.truncateToWidth        const columns = firstRow.find("td");        var columnWidth;         for (let i = 0; i < columns.length; i++) {            columnWidth = $(columns[i]).width();             if (self._columnWidths[i] !== columnWidth) {                self._columnWidths[i] = columnWidth;                forceRefresh = true;            }        }         if (pageSize !== self.currentPageSize() || forceRefresh) {            const currentPage = self.currentPage();             // Updating page size will validate current page number            self.currentPageSize(pageSize);             // Requery data for page unless current page was dynamically changed            // by page size update and has reloaded data already            if (currentPage === self.currentPage())                self.queryPageRecords();        }         $(self).trigger("pageSizeCalculated", [remainingHeight]);    }     // Get a unique cookie name for a value    self.getCookieName = function(suffix) {        if (suffix === undefined)            suffix = "value";         return String.format("_{0}_{1}!{2}", notNull(self.modelName, "model"), notNull(self.pageName, "page"), notNull(suffix, "value"));    }     self.calculateUnassignedFieldCount = function() {        // Derive unassigned field count based on existence of "has-no-value" class        self.unassignedFieldCount($("#addNewEditDialog div.form-group.has-no-value").length);    }     self.refreshValidationErrors = function() {        // Force re-evaluation of validation errors property        self.unassignedFieldCount.valueHasMutated();         // Make sure any initial validation error messages are visible        self.errors.showAllMessages();    }     // Convert observable object to a simple Javascript record    self.deriveJSRecord = function() {        return $.Deferred(function(deferred) {            const observableRecord = self.currentRecord();            const promises = [];             // Allow customization of observable record before conversion            $(self).trigger("beforeSave", [observableRecord, promises]);             $(promises).whenAll().done(function() {                deferred.resolve(ko.mapping.toJS(observableRecord));            });        }).promise();    }     // Convert simple Javascript record to an observable object    self.deriveObservableRecord = function(record) {        return $.Deferred(function(deferred) {            const observableRecord = ko.mapping.fromJS(record);            const promises = [];             // Allow customization of new observable record            $(self).trigger("beforeEdit", [observableRecord, promises]);             $(promises).whenAll().done(function() {                // Apply validation binding to current observable record                self.errors = ko.validation.group(observableRecord);                self.refreshValidationErrors();                deferred.resolve(observableRecord);            });        }).promise();    }     self.setFocusOnInitialField = function() {        if (!isEmpty(self.initialFocusField))            $("#" + self.initialFocusField).focus();    }     self.nextPage = function() {        if (self.currentPage() < self.totalPages())            self.currentPage(self.currentPage() + 1);    }     self.previousPage = function() {        if (self.currentPage() > 1)            self.currentPage(self.currentPage() - 1);    }     self.updateSortOrder = function(fieldName, ascending) {        self.sortField(fieldName);        self.sortAscending(ascending);        self.queryPageRecords();         // Save last sort order        Cookies.set(self.getCookieName("LastSortField"), self.sortField(), { expires: 365 });        Cookies.set(self.getCookieName("LastSortAscending"), self.sortAscending().toString(), { expires: 365 });    }     self.isSortOrder = function(fieldName, ascending) {        return self.sortField().toUpperCase() === fieldName.toUpperCase() && self.sortAscending() === ascending;    }     self.queryPageRecords = function() {        if (self.dataHubIsConnected())        {            self.queryRecords(self.sortField(), self.sortAscending(), self.currentPage(), self.currentPageSize(), self.filterText).done(function(records) {                $(self).trigger("pageRecordsQueried", [records]);                self.pageRecords.removeAll();                self.pageRecords(records);                refreshHubDependentControlState();                $("[id='recordRow']").css("visibility", "visible");                $("#loadingDataLabel").hide();                 // Validate proper page size after any record refresh                setTimeout(self.calculatePageSize, 150);            }).fail(function(error) {                showErrorMessage(error, null, true);            });             self.queryRecordCount(self.filterText).done(function(count) {                self.recordCount(count);            });        }    }     self.removePageRecord = function(record) {        if (!self.canDelete())            return;         if (self.dataHubIsConnected() && confirm("Are you sure you want to delete \"" + record[self.labelField] + "\"?")) {            const keyValues = [];             for (var i = 0; i < self.primaryKeyFields.length; i++) {                keyValues.push(record[self.primaryKeyFields[i]]);            }             self.deleteRecord(keyValues).done(function() {                self.pageRecords.remove(record);                self.initialize();                $(self).trigger("recordDeleted", [record]);                showInfoMessage("Deleted record...");            }).fail(function(error) {                showErrorMessage(error, null, true);            });        }    }     self.savePageRecord = function() {        switch (self.recordMode()) {            case RecordMode.Edit:                self.saveEditedRecord();                break;            case RecordMode.AddNew:                self.saveNewRecord();                break;        }    }     self.saveEditedRecord = function() {        if (!self.canEdit())            return;         if (self.dataHubIsConnected()) {            self.deriveJSRecord().done(function(record) {                self.updateRecord(record).done(function() {                    self.initialize();                    $(self).trigger("recordSaved", [record, false]);                    showInfoMessage("Saved updated record...");                }).fail(function(error) {                    showErrorMessage(error, null, true);                });            });        }    }     self.saveNewRecord = function() {        if (!self.canAddNew())            return;         if (self.dataHubIsConnected()) {            self.deriveJSRecord().done(function(record) {                self.addNewRecord(record).done(function() {                    self.initialize();                    $(self).trigger("recordSaved", [record, true]);                    showInfoMessage("Saved new record...");                }).fail(function(error) {                    showErrorMessage(error, null, true);

Lines 1–500 of 639. Load more