File size: 3,169 Bytes
71174bc | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | <template>
<PluginComponent v-model="open" :infoPayload="infoPayload" @onUserArgChanged="onUserArgChanged"
@onMolCountsChanged="onMolCountsChanged"></PluginComponent>
</template>
<script lang="ts">
/* eslint-disable @typescript-eslint/ban-ts-comment */
import { Options } from "vue-class-component";
import {
IContributorCredit,
ISoftwareCredit,
} from "@/Plugins/PluginInterfaces";
import PluginComponent from "@/Plugins/Parents/PluginComponent/PluginComponent.vue";
import { PluginParentClass } from "@/Plugins/Parents/PluginParentClass/PluginParentClass";
import { UserArg } from "@/UI/Forms/FormFull/FormFullInterfaces";
import { ITest } from "@/Testing/TestInterfaces";
import { TestCmdList } from "@/Testing/TestCmdList";
import { getUpDownTreeNavMoleculesToActOn, toggleUpDownTreeNav } from "./UpDownTreeNavUtils";
import { checkAnyMolLoaded } from "../../CheckUseAllowedUtils";
import { Tag } from "@/Plugins/Core/ActivityFocus/ActivityFocusUtils";
/** UpTreeNavPlugin */
@Options({
components: {
PluginComponent,
},
})
export default class UpTreeNavPlugin extends PluginParentClass {
menuPath = ["View", "Toggles", "[7] Toggle Up"];
title = "Toggle Up";
softwareCredits: ISoftwareCredit[] = [];
contributorCredits: IContributorCredit[] = [];
pluginId = "uptreenav";
noPopup = true;
userArgDefaults: UserArg[] = [];
logJob = false;
logAnalytics = false;
intro = "Toggle visibility and focus with the molecule above the selected one.";
details = "This plugin provides a keyboard-friendly way to navigate through molecules in the 3D viewer.";
hotkey = "[";
tags = [Tag.All];
/**
* Every plugin runs some job. This is the function that does the job
* running.
*
* @returns {Promise<void>} Resolves when the job is done.
*/
runJobInBrowser(): Promise<void> {
const molsToActOn = getUpDownTreeNavMoleculesToActOn();
if (
molsToActOn.molBefore === null ||
molsToActOn.molToConsider === null
) {
return Promise.resolve();
}
toggleUpDownTreeNav(molsToActOn.molBefore, molsToActOn.molToConsider);
return Promise.resolve();
}
/**
* Check if this plugin can currently be used.
*
* @returns {string | null} If it returns a string, show that as an error
* message. If null, proceed to run the plugin.
*/
checkPluginAllowed(): string | null {
return checkAnyMolLoaded();
}
/**
* Gets the test commands for the plugin. For advanced use.
*
* @gooddefault
* @document
* @returns {ITest} The selenium test commands.
*/
async getTests(): Promise{
return {
beforePluginOpens: () => new TestCmdList()
.loadExampleMolecule(true)
.selectMoleculeInTree("Compounds"),
afterPluginCloses: () => new TestCmdList().waitUntilRegex(
"#navigator",
'class=.title selected.[^>]+?data-label=.Protein.'
),
};
}
}
</script>
<style scoped lang="scss"></style>
|