Files
openmct/src/plugins/flexibleLayout/flexibleLayoutViewProvider.js
Jesse Mazzella 02f1013770 fix: DisplayLayout and FlexibleLayout toolbar actions only apply to selected layout (#7184)
* refactor: convert to ES6 function

* fix: include `keyString` in event name

- This negates the need for complicated logic in determining which objectView the action was intended for

* fix: handle the case of currentView being null

* fix: add keyString to flexibleLayout toolbar events

* fix: properly unregister listeners

* fix: remove unused imports

* fix: revert parameter reorder

* refactor: replace usage of `arguments` with `...args`

* fix: add a11y to display layout + toolbar

* test: add first cut of layout toolbar suite

* test: cleanup a bit and add Image test

* test: add stubs

* fix: remove unused variable

* refactor(DisplayLayoutToolbar): convert to ES6 class

* test: generate localStorage data for display layout tests

* fix: clarify "Add" button label

* test: cleanup and don't parameterize tests

* test: fix path for recycled_local_storage.json

* fix: path to local storage file

* docs: add documentation for
utilizing localStorage in e2e

* fix: path to recycled_local_storage.json

* docs: add note hyperlink
2023-11-02 20:42:37 +00:00

104 lines
3.1 KiB
JavaScript

/*****************************************************************************
* Open MCT, Copyright (c) 2014-2023, 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.
*****************************************************************************/
import mount from 'utils/mount';
import FlexibleLayoutComponent from './components/FlexibleLayout.vue';
const FLEXIBLE_LAYOUT_KEY = 'flexible-layout';
export default class FlexibleLayoutViewProvider {
constructor(openmct) {
this.openmct = openmct;
this.key = FLEXIBLE_LAYOUT_KEY;
this.name = 'Flexible Layout';
this.cssClass = 'icon-layout-view';
this.destroy = null;
}
canView(domainObject) {
return domainObject.type === FLEXIBLE_LAYOUT_KEY;
}
canEdit(domainObject) {
return domainObject.type === FLEXIBLE_LAYOUT_KEY;
}
view(domainObject, objectPath) {
let openmct = this.openmct;
let _destroy = null;
let component = null;
return {
show(element, isEditing) {
const { vNode, destroy } = mount(
{
components: {
FlexibleLayoutComponent
},
provide: {
openmct,
objectPath,
domainObject
},
data() {
return {
isEditing: isEditing
};
},
template:
'<flexible-layout-component ref="flexibleLayout" :isEditing="isEditing"></flexible-layout-component>'
},
{
app: openmct.app,
element
}
);
component = vNode.componentInstance;
_destroy = destroy;
},
getSelectionContext() {
return {
item: domainObject,
type: 'flexible-layout'
};
},
contextAction(action, ...args) {
if (component?.$refs?.flexibleLayout?.[action]) {
component.$refs.flexibleLayout[action](...args);
}
},
onEditModeChange(isEditing) {
component.isEditing = isEditing;
},
destroy() {
if (_destroy) {
_destroy();
component = null;
}
}
};
}
priority() {
return 1;
}
}