a09da30768
* no-implicit-coercion and no-unneeded-ternary * End every line with a semicolon * Spacing and formatting * Enabled semi-spacing * Applies npm run lint:fix to code after master merge * Fix merge issues * Switched operator-linebreak to 'before' Co-authored-by: Joshi <simplyrender@gmail.com>
114 lines
4.2 KiB
JavaScript
114 lines
4.2 KiB
JavaScript
/*****************************************************************************
|
|
* Open MCT, Copyright (c) 2014-2018, United States Government
|
|
* as represented by the Administrator of the National Aeronautics and Space
|
|
* Administration. All rights reserved.
|
|
*
|
|
* Open MCT is licensed under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
* http://www.apache.org/licenses/LICENSE-2.0.
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
* Open MCT includes source code licensed under additional open source
|
|
* licenses. See the Open Source Licenses file (LICENSES.md) included with
|
|
* this source code distribution or the Licensing information page available
|
|
* at runtime from the About dialog for additional information.
|
|
*****************************************************************************/
|
|
|
|
define(
|
|
[],
|
|
function () {
|
|
|
|
/**
|
|
* A capability that implements an editing 'session' for a domain
|
|
* object. An editing session is initiated via a call to .edit().
|
|
* Once initiated, any persist operations will be queued pending a
|
|
* subsequent call to [.save()](@link #save) or [.finish()](@link
|
|
* #finish).
|
|
* @param transactionService
|
|
* @param domainObject
|
|
* @constructor
|
|
*/
|
|
function EditorCapability(
|
|
transactionService,
|
|
openmct,
|
|
domainObject
|
|
) {
|
|
this.transactionService = transactionService;
|
|
this.openmct = openmct;
|
|
this.domainObject = domainObject;
|
|
}
|
|
|
|
/**
|
|
* Initiate an editing session. This will start a transaction during
|
|
* which any persist operations will be deferred until either save()
|
|
* or finish() are called.
|
|
*/
|
|
EditorCapability.prototype.edit = function () {
|
|
console.warn('DEPRECATED: cannot edit via edit capability, use openmct.editor instead.');
|
|
|
|
if (!this.openmct.editor.isEditing()) {
|
|
this.openmct.editor.edit();
|
|
this.domainObject.getCapability('status').set('editing', true);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Determines whether this object, or any of its ancestors are
|
|
* currently being edited.
|
|
* @returns boolean
|
|
*/
|
|
EditorCapability.prototype.inEditContext = function () {
|
|
return this.openmct.editor.isEditing();
|
|
};
|
|
|
|
/**
|
|
* Is this the root editing object (ie. the object that the user
|
|
* clicked 'edit' on)?
|
|
* @returns {*}
|
|
*/
|
|
EditorCapability.prototype.isEditContextRoot = function () {
|
|
return this.openmct.editor.isEditing();
|
|
};
|
|
|
|
/**
|
|
* Save any unsaved changes from this editing session. This will
|
|
* end the current transaction and continue with a new one.
|
|
* @returns {*}
|
|
*/
|
|
EditorCapability.prototype.save = function () {
|
|
console.warn('DEPRECATED: cannot save via edit capability, use openmct.editor instead.');
|
|
|
|
return Promise.resolve();
|
|
};
|
|
|
|
EditorCapability.prototype.invoke = EditorCapability.prototype.edit;
|
|
|
|
/**
|
|
* Finish the current editing session. This will discard any pending
|
|
* persist operations
|
|
* @returns {*}
|
|
*/
|
|
EditorCapability.prototype.finish = function () {
|
|
console.warn('DEPRECATED: cannot finish via edit capability, use openmct.editor instead.');
|
|
|
|
return Promise.resolve();
|
|
};
|
|
|
|
/**
|
|
* @returns {boolean} true if there have been any domain model
|
|
* modifications since the last persist, false otherwise.
|
|
*/
|
|
EditorCapability.prototype.dirty = function () {
|
|
return this.transactionService.size() > 0;
|
|
};
|
|
|
|
return EditorCapability;
|
|
}
|
|
);
|