2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import java.awt.Color;
24 import java.awt.event.ActionEvent;
25 import java.awt.event.ActionListener;
26 import java.util.ArrayList;
27 import java.util.Arrays;
28 import java.util.BitSet;
29 import java.util.Collection;
30 import java.util.Collections;
31 import java.util.Hashtable;
32 import java.util.LinkedHashMap;
33 import java.util.List;
35 import java.util.Objects;
36 import java.util.SortedMap;
37 import java.util.TreeMap;
38 import java.util.Vector;
40 import javax.swing.ButtonGroup;
41 import javax.swing.JCheckBoxMenuItem;
42 import javax.swing.JColorChooser;
43 import javax.swing.JMenu;
44 import javax.swing.JMenuItem;
45 import javax.swing.JPopupMenu;
46 import javax.swing.JRadioButtonMenuItem;
48 import jalview.analysis.AAFrequency;
49 import jalview.analysis.AlignmentAnnotationUtils;
50 import jalview.analysis.AlignmentUtils;
51 import jalview.analysis.Conservation;
52 import jalview.api.AlignViewportI;
53 import jalview.bin.Cache;
54 import jalview.commands.ChangeCaseCommand;
55 import jalview.commands.EditCommand;
56 import jalview.commands.EditCommand.Action;
57 import jalview.datamodel.AlignmentAnnotation;
58 import jalview.datamodel.AlignmentI;
59 import jalview.datamodel.DBRefEntry;
60 import jalview.datamodel.HiddenColumns;
61 import jalview.datamodel.MappedFeatures;
62 import jalview.datamodel.PDBEntry;
63 import jalview.datamodel.SequenceFeature;
64 import jalview.datamodel.SequenceGroup;
65 import jalview.datamodel.SequenceI;
66 import jalview.gui.ColourMenuHelper.ColourChangeListener;
67 import jalview.io.FileFormatI;
68 import jalview.io.FileFormats;
69 import jalview.io.FormatAdapter;
70 import jalview.io.SequenceAnnotationReport;
71 import jalview.schemes.Blosum62ColourScheme;
72 import jalview.schemes.ColourSchemeI;
73 import jalview.schemes.ColourSchemes;
74 import jalview.schemes.PIDColourScheme;
75 import jalview.schemes.ResidueColourScheme;
76 import jalview.util.Comparison;
77 import jalview.util.GroupUrlLink;
78 import jalview.util.GroupUrlLink.UrlStringTooLongException;
79 import jalview.util.MessageManager;
80 import jalview.util.StringUtils;
81 import jalview.util.UrlLink;
82 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
85 * The popup menu that is displayed on right-click on a sequence id, or in the
88 public class PopupMenu extends JPopupMenu implements ColourChangeListener
91 * maximum length of feature description to include in popup menu item text
93 private static final int FEATURE_DESC_MAX = 40;
96 * true for ID Panel menu, false for alignment panel menu
98 private final boolean forIdPanel;
100 private final AlignmentPanel ap;
103 * the sequence under the cursor when clicked
104 * (additional sequences may be selected)
106 private final SequenceI sequence;
108 JMenu groupMenu = new JMenu();
110 JMenuItem groupName = new JMenuItem();
112 protected JCheckBoxMenuItem abovePIDColour = new JCheckBoxMenuItem();
114 protected JMenuItem modifyPID = new JMenuItem();
116 protected JCheckBoxMenuItem conservationMenuItem = new JCheckBoxMenuItem();
118 protected JRadioButtonMenuItem annotationColour;
120 protected JMenuItem modifyConservation = new JMenuItem();
122 JMenu sequenceMenu = new JMenu();
124 JMenuItem makeReferenceSeq = new JMenuItem();
126 JMenuItem createGroupMenuItem = new JMenuItem();
128 JMenuItem unGroupMenuItem = new JMenuItem();
130 JMenu colourMenu = new JMenu();
132 JCheckBoxMenuItem showBoxes = new JCheckBoxMenuItem();
134 JCheckBoxMenuItem showText = new JCheckBoxMenuItem();
136 JCheckBoxMenuItem showColourText = new JCheckBoxMenuItem();
138 JCheckBoxMenuItem displayNonconserved = new JCheckBoxMenuItem();
140 JMenu editMenu = new JMenu();
142 JMenuItem upperCase = new JMenuItem();
144 JMenuItem lowerCase = new JMenuItem();
146 JMenuItem toggle = new JMenuItem();
148 JMenu outputMenu = new JMenu();
150 JMenu seqShowAnnotationsMenu = new JMenu();
152 JMenu seqHideAnnotationsMenu = new JMenu();
154 JMenuItem seqAddReferenceAnnotations = new JMenuItem(
155 MessageManager.getString("label.add_reference_annotations"));
157 JMenu groupShowAnnotationsMenu = new JMenu();
159 JMenu groupHideAnnotationsMenu = new JMenu();
161 JMenuItem groupAddReferenceAnnotations = new JMenuItem(
162 MessageManager.getString("label.add_reference_annotations"));
164 JMenuItem textColour = new JMenuItem();
166 JMenu editGroupMenu = new JMenu();
168 JMenuItem chooseStructure = new JMenuItem();
170 JMenu rnaStructureMenu = new JMenu();
173 * Constructs a menu with sub-menu items for any hyperlinks for the sequence
174 * and/or features provided. Hyperlinks may include a lookup by sequence id,
175 * or database cross-references, depending on which links are enabled in user
182 protected static JMenu buildLinkMenu(final SequenceI seq,
183 List<SequenceFeature> features)
185 JMenu linkMenu = new JMenu(MessageManager.getString("action.link"));
187 List<String> nlinks = null;
190 nlinks = Preferences.sequenceUrlLinks.getLinksForMenu();
191 UrlLink.sort(nlinks);
195 nlinks = new ArrayList<>();
198 if (features != null)
200 for (SequenceFeature sf : features)
202 if (sf.links != null)
204 for (String link : sf.links)
213 * instantiate the hyperlinklink templates from sequence data;
214 * note the order of the templates is preserved in the map
216 Map<String, List<String>> linkset = new LinkedHashMap<>();
217 for (String link : nlinks)
219 UrlLink urlLink = null;
222 urlLink = new UrlLink(link);
223 } catch (Exception foo)
225 Cache.log.error("Exception for URLLink '" + link + "'", foo);
229 if (!urlLink.isValid())
231 Cache.log.error(urlLink.getInvalidMessage());
235 urlLink.createLinksFromSeq(seq, linkset);
239 * construct menu items for the hyperlinks (still preserving
240 * the order of the sorted templates)
242 addUrlLinks(linkMenu, linkset.values());
248 * A helper method that builds menu items from the given links, with action
249 * handlers to open the link URL, and adds them to the linkMenu. Each provided
250 * link should be a list whose second item is the menu text, and whose fourth
251 * item is the URL to open when the menu item is selected.
256 static private void addUrlLinks(JMenu linkMenu,
257 Collection<List<String>> linkset)
259 for (List<String> linkstrset : linkset)
261 final String url = linkstrset.get(3);
262 JMenuItem item = new JMenuItem(linkstrset.get(1));
263 item.setToolTipText(MessageManager
264 .formatMessage("label.open_url_param", new Object[]
266 item.addActionListener(new ActionListener()
269 public void actionPerformed(ActionEvent e)
271 new Thread(new Runnable()
286 * Opens the provided url in the default web browser, or shows an error
287 * message if this fails
291 static void showLink(String url)
295 jalview.util.BrowserLauncher.openURL(url);
296 } catch (Exception ex)
298 JvOptionPane.showInternalMessageDialog(Desktop.desktop,
299 MessageManager.getString("label.web_browser_not_found_unix"),
300 MessageManager.getString("label.web_browser_not_found"),
301 JvOptionPane.WARNING_MESSAGE);
303 ex.printStackTrace();
308 * add a late bound groupURL item to the given linkMenu
312 * - menu label string
313 * @param urlgenerator
314 * GroupURLLink used to generate URL
316 * Object array returned from the makeUrlStubs function.
318 static void addshowLink(JMenu linkMenu, String label,
319 final GroupUrlLink urlgenerator, final Object[] urlstub)
321 JMenuItem item = new JMenuItem(label);
322 item.setToolTipText(MessageManager
323 .formatMessage("label.open_url_seqs_param", new Object[]
324 { urlgenerator.getUrl_prefix(),
325 urlgenerator.getNumberInvolved(urlstub) }));
326 // TODO: put in info about what is being sent.
327 item.addActionListener(new ActionListener()
330 public void actionPerformed(ActionEvent e)
332 new Thread(new Runnable()
340 showLink(urlgenerator.constructFrom(urlstub));
341 } catch (UrlStringTooLongException e2)
354 * Constructor for a PopupMenu for a click in the alignment panel (on a residue)
357 * the panel in which the mouse is clicked
359 * the sequence under the mouse
360 * @throws NullPointerException
363 public PopupMenu(final AlignmentPanel ap, SequenceI seq, int column)
365 this(false, ap, seq, column, null);
369 * Constructor for a PopupMenu for a click in the sequence id panel
372 * the panel in which the mouse is clicked
374 * the sequence under the mouse click
376 * templates for sequence external links
377 * @throws NullPointerException
380 public PopupMenu(final AlignmentPanel alignPanel, final SequenceI seq,
381 List<String> groupLinks)
383 this(true, alignPanel, seq, -1, groupLinks);
387 * Private constructor that constructs a popup menu for either sequence ID
388 * Panel, or alignment context
394 * aligned column position (0...)
397 private PopupMenu(boolean fromIdPanel,
398 final AlignmentPanel alignPanel,
399 final SequenceI seq, final int column, List<String> groupLinks)
401 Objects.requireNonNull(seq);
402 this.forIdPanel = fromIdPanel;
403 this.ap = alignPanel;
406 for (String ff : FileFormats.getInstance().getWritableFormats(true))
408 JMenuItem item = new JMenuItem(ff);
410 item.addActionListener(new ActionListener()
413 public void actionPerformed(ActionEvent e)
415 outputText_actionPerformed(e);
419 outputMenu.add(item);
423 * Build menus for annotation types that may be shown or hidden, and for
424 * 'reference annotations' that may be added to the alignment. First for the
425 * currently selected sequence (if there is one):
427 final List<SequenceI> selectedSequence = (forIdPanel && seq != null
429 : Collections.<SequenceI> emptyList());
430 buildAnnotationTypesMenus(seqShowAnnotationsMenu,
431 seqHideAnnotationsMenu, selectedSequence);
432 configureReferenceAnnotationsMenu(seqAddReferenceAnnotations,
436 * And repeat for the current selection group (if there is one):
438 final List<SequenceI> selectedGroup = (alignPanel.av.getSelectionGroup() == null
439 ? Collections.<SequenceI> emptyList()
440 : alignPanel.av.getSelectionGroup().getSequences());
441 buildAnnotationTypesMenus(groupShowAnnotationsMenu,
442 groupHideAnnotationsMenu, selectedGroup);
443 configureReferenceAnnotationsMenu(groupAddReferenceAnnotations,
449 } catch (Exception e)
457 sequenceMenu.setText(sequence.getName());
458 if (seq == alignPanel.av.getAlignment().getSeqrep())
460 makeReferenceSeq.setText(
461 MessageManager.getString("action.unmark_as_reference"));
465 makeReferenceSeq.setText(
466 MessageManager.getString("action.set_as_reference"));
469 if (!alignPanel.av.getAlignment().isNucleotide())
471 remove(rnaStructureMenu);
475 int origCount = rnaStructureMenu.getItemCount();
477 * add menu items to 2D-render any alignment or sequence secondary
478 * structure annotation
480 AlignmentAnnotation[] aas = alignPanel.av.getAlignment()
481 .getAlignmentAnnotation();
484 for (final AlignmentAnnotation aa : aas)
486 if (aa.isValidStruc() && aa.sequenceRef == null)
489 * valid alignment RNA secondary structure annotation
491 menuItem = new JMenuItem();
492 menuItem.setText(MessageManager.formatMessage(
493 "label.2d_rna_structure_line", new Object[]
495 menuItem.addActionListener(new ActionListener()
498 public void actionPerformed(ActionEvent e)
500 new AppVarna(seq, aa, alignPanel);
503 rnaStructureMenu.add(menuItem);
508 if (seq.getAnnotation() != null)
510 AlignmentAnnotation seqAnns[] = seq.getAnnotation();
511 for (final AlignmentAnnotation aa : seqAnns)
513 if (aa.isValidStruc())
516 * valid sequence RNA secondary structure annotation
518 // TODO: make rnastrucF a bit more nice
519 menuItem = new JMenuItem();
520 menuItem.setText(MessageManager.formatMessage(
521 "label.2d_rna_sequence_name", new Object[]
523 menuItem.addActionListener(new ActionListener()
526 public void actionPerformed(ActionEvent e)
528 // TODO: VARNA does'nt print gaps in the sequence
529 new AppVarna(seq, aa, alignPanel);
532 rnaStructureMenu.add(menuItem);
536 if (rnaStructureMenu.getItemCount() == origCount)
538 remove(rnaStructureMenu);
542 menuItem = new JMenuItem(
543 MessageManager.getString("action.hide_sequences"));
544 menuItem.addActionListener(new ActionListener()
547 public void actionPerformed(ActionEvent e)
549 hideSequences(false);
554 if (alignPanel.av.getSelectionGroup() != null
555 && alignPanel.av.getSelectionGroup().getSize() > 1)
557 menuItem = new JMenuItem(MessageManager
558 .formatMessage("label.represent_group_with", new Object[]
560 menuItem.addActionListener(new ActionListener()
563 public void actionPerformed(ActionEvent e)
568 sequenceMenu.add(menuItem);
571 if (alignPanel.av.hasHiddenRows())
573 final int index = alignPanel.av.getAlignment().findIndex(seq);
575 if (alignPanel.av.adjustForHiddenSeqs(index)
576 - alignPanel.av.adjustForHiddenSeqs(index - 1) > 1)
578 menuItem = new JMenuItem(
579 MessageManager.getString("action.reveal_sequences"));
580 menuItem.addActionListener(new ActionListener()
583 public void actionPerformed(ActionEvent e)
585 alignPanel.av.showSequence(index);
586 if (alignPanel.overviewPanel != null)
588 alignPanel.overviewPanel.updateOverviewImage();
599 * - in the IdPanel (seq not null) if any sequence is hidden
600 * - in the IdPanel or SeqPanel if all sequences are hidden (seq is null)
602 if (alignPanel.av.hasHiddenRows())
604 boolean addOption = seq != null;
605 if (!addOption && alignPanel.av.getAlignment().getHeight() == 0)
611 JMenuItem menuItem = new JMenuItem(
612 MessageManager.getString("action.reveal_all"));
613 menuItem.addActionListener(new ActionListener()
616 public void actionPerformed(ActionEvent e)
618 alignPanel.av.showAllHiddenSeqs();
619 if (alignPanel.overviewPanel != null)
621 alignPanel.overviewPanel.updateOverviewImage();
629 SequenceGroup sg = alignPanel.av.getSelectionGroup();
630 boolean isDefinedGroup = (sg != null)
631 ? alignPanel.av.getAlignment().getGroups().contains(sg)
634 if (sg != null && sg.getSize() > 0)
636 groupName.setText(MessageManager
637 .getString("label.edit_name_and_description_current_group"));
639 ColourMenuHelper.setColourSelected(colourMenu, sg.getColourScheme());
641 conservationMenuItem.setEnabled(!sg.isNucleotide());
645 if (sg.cs.conservationApplied())
647 conservationMenuItem.setSelected(true);
649 if (sg.cs.getThreshold() > 0)
651 abovePIDColour.setSelected(true);
654 modifyConservation.setEnabled(conservationMenuItem.isSelected());
655 modifyPID.setEnabled(abovePIDColour.isSelected());
656 displayNonconserved.setSelected(sg.getShowNonconserved());
657 showText.setSelected(sg.getDisplayText());
658 showColourText.setSelected(sg.getColourText());
659 showBoxes.setSelected(sg.getDisplayBoxes());
660 // add any groupURLs to the groupURL submenu and make it visible
661 if (groupLinks != null && groupLinks.size() > 0)
663 buildGroupURLMenu(sg, groupLinks);
665 // Add a 'show all structures' for the current selection
666 Hashtable<String, PDBEntry> pdbe = new Hashtable<>(), reppdb = new Hashtable<>();
668 SequenceI sqass = null;
669 for (SequenceI sq : alignPanel.av.getSequenceSelection())
671 Vector<PDBEntry> pes = sq.getDatasetSequence().getAllPDBEntries();
672 if (pes != null && pes.size() > 0)
674 reppdb.put(pes.get(0).getId(), pes.get(0));
675 for (PDBEntry pe : pes)
677 pdbe.put(pe.getId(), pe);
687 final PDBEntry[] pe = pdbe.values()
688 .toArray(new PDBEntry[pdbe.size()]),
689 pr = reppdb.values().toArray(new PDBEntry[reppdb.size()]);
690 final JMenuItem gpdbview, rpdbview;
695 groupMenu.setVisible(false);
696 editMenu.setVisible(false);
701 createGroupMenuItem.setVisible(true);
702 unGroupMenuItem.setVisible(false);
703 editGroupMenu.setText(MessageManager.getString("action.edit_new_group"));
707 createGroupMenuItem.setVisible(false);
708 unGroupMenuItem.setVisible(true);
709 editGroupMenu.setText(MessageManager.getString("action.edit_group"));
714 sequenceMenu.setVisible(false);
715 chooseStructure.setVisible(false);
716 rnaStructureMenu.setVisible(false);
719 addLinksAndFeatures(seq, column);
725 * <li>configured sequence database links (ID panel popup menu)</li>
726 * <li>non-positional feature links (ID panel popup menu)</li>
727 * <li>positional feature links (alignment panel popup menu)</li>
728 * <li>feature details links (alignment panel popup menu)</li>
730 * If this panel is also showed complementary (CDS/protein) features, then links
731 * to their feature details are also added.
736 void addLinksAndFeatures(final SequenceI seq, final int column)
738 List<SequenceFeature> features = null;
741 features = sequence.getFeatures().getNonPositionalFeatures();
745 features = ap.getFeatureRenderer().findFeaturesAtColumn(sequence,
749 addLinks(seq, features);
753 addFeatureDetails(features, seq, column);
758 * Add a menu item to show feature details for each sequence feature. Any
759 * linked 'virtual' features (CDS/protein) are also optionally found and
766 protected void addFeatureDetails(List<SequenceFeature> features,
767 final SequenceI seq, final int column)
770 * add features in CDS/protein complement at the corresponding
771 * position if configured to do so
773 MappedFeatures mf = null;
774 if (ap.av.isShowComplementFeatures())
776 if (!Comparison.isGap(sequence.getCharAt(column)))
778 AlignViewportI complement = ap.getAlignViewport()
779 .getCodingComplement();
780 AlignFrame af = Desktop.getAlignFrameFor(complement);
781 FeatureRendererModel fr2 = af.getFeatureRenderer();
782 int seqPos = sequence.findPosition(column);
783 mf = fr2.findComplementFeaturesAtResidue(sequence, seqPos);
787 if (features.isEmpty() && mf == null)
790 * no features to show at this position
795 JMenu details = new JMenu(
796 MessageManager.getString("label.feature_details"));
799 String name = seq.getName();
800 for (final SequenceFeature sf : features)
802 addFeatureDetailsMenuItem(details, name, sf, null);
807 for (final SequenceFeature sf : mf.features)
809 addFeatureDetailsMenuItem(details, name, sf, mf);
815 * A helper method to add one menu item whose action is to show details for
816 * one feature. The menu text includes feature description, but this may be
824 void addFeatureDetailsMenuItem(JMenu details, final String seqName,
825 final SequenceFeature sf, MappedFeatures mf)
827 int start = sf.getBegin();
828 int end = sf.getEnd();
832 * show local rather than linked feature coordinates
834 int[] beginRange = mf.getMappedPositions(start, start);
835 int[] endRange = mf.getMappedPositions(end, end);
836 if (beginRange == null || endRange == null)
838 // e.g. variant extending to stop codon so not mappable
841 start = beginRange[0];
842 end = endRange[endRange.length - 1];
844 StringBuilder desc = new StringBuilder();
845 desc.append(sf.getType()).append(" ").append(String.valueOf(start));
848 desc.append(sf.isContactFeature() ? ":" : "-");
849 desc.append(String.valueOf(end));
851 String description = sf.getDescription();
852 if (description != null)
855 description = StringUtils.stripHtmlTags(description);
858 * truncate overlong descriptions unless they contain an href
859 * (as truncation could leave corrupted html)
861 boolean hasLink = description.indexOf("a href") > -1;
862 if (description.length() > FEATURE_DESC_MAX && !hasLink)
864 description = description.substring(0, FEATURE_DESC_MAX) + "...";
866 desc.append(description);
868 String featureGroup = sf.getFeatureGroup();
869 if (featureGroup != null)
871 desc.append(" (").append(featureGroup).append(")");
873 String htmlText = JvSwingUtils.wrapTooltip(true, desc.toString());
874 JMenuItem item = new JMenuItem(htmlText);
875 item.addActionListener(new ActionListener()
878 public void actionPerformed(ActionEvent e)
880 showFeatureDetails(sf, seqName, mf);
887 * Opens a panel showing a text report of feature details
893 protected void showFeatureDetails(SequenceFeature sf, String seqName,
896 CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
897 // it appears Java's CSS does not support border-collapse :-(
898 cap.addStylesheetRule("table { border-collapse: collapse;}");
899 cap.addStylesheetRule("table, td, th {border: 1px solid black;}");
900 cap.setText(sf.getDetailsReport(seqName, mf));
902 Desktop.addInternalFrame(cap,
903 MessageManager.getString("label.feature_details"), 500, 500);
907 * Adds a 'Link' menu item with a sub-menu item for each hyperlink provided.
908 * When seq is not null, these are links for the sequence id, which may be to
909 * external web sites for the sequence accession, and/or links embedded in
910 * non-positional features. When seq is null, only links embedded in the
911 * provided features are added. If no links are found, the menu is not added.
916 void addLinks(final SequenceI seq, List<SequenceFeature> features)
918 JMenu linkMenu = buildLinkMenu(forIdPanel ? seq : null, features);
920 // only add link menu if it has entries
921 if (linkMenu.getItemCount() > 0)
925 sequenceMenu.add(linkMenu);
935 * Add annotation types to 'Show annotations' and/or 'Hide annotations' menus.
936 * "All" is added first, followed by a separator. Then add any annotation
937 * types associated with the current selection. Separate menus are built for
938 * the selected sequence group (if any), and the selected sequence.
940 * Some annotation rows are always rendered together - these can be identified
941 * by a common graphGroup property > -1. Only one of each group will be marked
942 * as visible (to avoid duplication of the display). For such groups we add a
943 * composite type name, e.g.
945 * IUPredWS (Long), IUPredWS (Short)
949 protected void buildAnnotationTypesMenus(JMenu showMenu, JMenu hideMenu,
950 List<SequenceI> forSequences)
952 showMenu.removeAll();
953 hideMenu.removeAll();
955 final List<String> all = Arrays
957 { MessageManager.getString("label.all") });
958 addAnnotationTypeToShowHide(showMenu, forSequences, "", all, true,
960 addAnnotationTypeToShowHide(hideMenu, forSequences, "", all, true,
962 showMenu.addSeparator();
963 hideMenu.addSeparator();
965 final AlignmentAnnotation[] annotations = ap.getAlignment()
966 .getAlignmentAnnotation();
969 * Find shown/hidden annotations types, distinguished by source (calcId),
970 * and grouped by graphGroup. Using LinkedHashMap means we will retrieve in
971 * the insertion order, which is the order of the annotations on the
974 Map<String, List<List<String>>> shownTypes = new LinkedHashMap<>();
975 Map<String, List<List<String>>> hiddenTypes = new LinkedHashMap<>();
976 AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes, hiddenTypes,
977 AlignmentAnnotationUtils.asList(annotations), forSequences);
979 for (String calcId : hiddenTypes.keySet())
981 for (List<String> type : hiddenTypes.get(calcId))
983 addAnnotationTypeToShowHide(showMenu, forSequences, calcId, type,
987 // grey out 'show annotations' if none are hidden
988 showMenu.setEnabled(!hiddenTypes.isEmpty());
990 for (String calcId : shownTypes.keySet())
992 for (List<String> type : shownTypes.get(calcId))
994 addAnnotationTypeToShowHide(hideMenu, forSequences, calcId, type,
998 // grey out 'hide annotations' if none are shown
999 hideMenu.setEnabled(!shownTypes.isEmpty());
1003 * Returns a list of sequences - either the current selection group (if there
1004 * is one), else the specified single sequence.
1009 protected List<SequenceI> getSequenceScope(SequenceI seq)
1011 List<SequenceI> forSequences = null;
1012 final SequenceGroup selectionGroup = ap.av.getSelectionGroup();
1013 if (selectionGroup != null && selectionGroup.getSize() > 0)
1015 forSequences = selectionGroup.getSequences();
1019 forSequences = seq == null ? Collections.<SequenceI> emptyList()
1020 : Arrays.asList(seq);
1022 return forSequences;
1026 * Add one annotation type to the 'Show Annotations' or 'Hide Annotations'
1029 * @param showOrHideMenu
1030 * the menu to add to
1031 * @param forSequences
1032 * the sequences whose annotations may be shown or hidden
1037 * if true this is a special label meaning 'All'
1038 * @param actionIsShow
1039 * if true, the select menu item action is to show the annotation
1042 protected void addAnnotationTypeToShowHide(JMenu showOrHideMenu,
1043 final List<SequenceI> forSequences, String calcId,
1044 final List<String> types, final boolean allTypes,
1045 final boolean actionIsShow)
1047 String label = types.toString(); // [a, b, c]
1048 label = label.substring(1, label.length() - 1); // a, b, c
1049 final JMenuItem item = new JMenuItem(label);
1050 item.setToolTipText(calcId);
1051 item.addActionListener(new ActionListener()
1054 public void actionPerformed(ActionEvent e)
1056 AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(),
1057 types, forSequences, allTypes, actionIsShow);
1061 showOrHideMenu.add(item);
1064 private void buildGroupURLMenu(SequenceGroup sg, List<String> groupLinks)
1067 // TODO: usability: thread off the generation of group url content so root
1068 // menu appears asap
1069 // sequence only URLs
1070 // ID/regex match URLs
1071 JMenu groupLinksMenu = new JMenu(
1072 MessageManager.getString("action.group_link"));
1073 // three types of url that might be created.
1074 JMenu[] linkMenus = new JMenu[] { null,
1075 new JMenu(MessageManager.getString("action.ids")),
1076 new JMenu(MessageManager.getString("action.sequences")),
1077 new JMenu(MessageManager.getString("action.ids_sequences")) };
1079 SequenceI[] seqs = ap.av.getSelectionAsNewSequence();
1080 String[][] idandseqs = GroupUrlLink.formStrings(seqs);
1081 Hashtable<String, Object[]> commonDbrefs = new Hashtable<>();
1082 for (int sq = 0; sq < seqs.length; sq++)
1085 int start = seqs[sq].findPosition(sg.getStartRes()),
1086 end = seqs[sq].findPosition(sg.getEndRes());
1087 // just collect ids from dataset sequence
1088 // TODO: check if IDs collected from selecton group intersects with the
1089 // current selection, too
1090 SequenceI sqi = seqs[sq];
1091 while (sqi.getDatasetSequence() != null)
1093 sqi = sqi.getDatasetSequence();
1095 DBRefEntry[] dbr = sqi.getDBRefs();
1096 if (dbr != null && dbr.length > 0)
1098 for (int d = 0; d < dbr.length; d++)
1100 String src = dbr[d].getSource(); // jalview.util.DBRefUtils.getCanonicalName(dbr[d].getSource()).toUpperCase();
1101 Object[] sarray = commonDbrefs.get(src);
1104 sarray = new Object[2];
1105 sarray[0] = new int[] { 0 };
1106 sarray[1] = new String[seqs.length];
1108 commonDbrefs.put(src, sarray);
1111 if (((String[]) sarray[1])[sq] == null)
1113 if (!dbr[d].hasMap() || (dbr[d].getMap()
1114 .locateMappedRange(start, end) != null))
1116 ((String[]) sarray[1])[sq] = dbr[d].getAccessionId();
1117 ((int[]) sarray[0])[0]++;
1123 // now create group links for all distinct ID/sequence sets.
1124 boolean addMenu = false; // indicates if there are any group links to give
1126 for (String link : groupLinks)
1128 GroupUrlLink urlLink = null;
1131 urlLink = new GroupUrlLink(link);
1132 } catch (Exception foo)
1134 Cache.log.error("Exception for GroupURLLink '" + link + "'", foo);
1138 if (!urlLink.isValid())
1140 Cache.log.error(urlLink.getInvalidMessage());
1143 final String label = urlLink.getLabel();
1144 boolean usingNames = false;
1145 // Now see which parts of the group apply for this URL
1146 String ltarget = urlLink.getTarget(); // jalview.util.DBRefUtils.getCanonicalName(urlLink.getTarget());
1147 Object[] idset = commonDbrefs.get(ltarget.toUpperCase());
1148 String[] seqstr, ids; // input to makeUrl
1151 int numinput = ((int[]) idset[0])[0];
1152 String[] allids = ((String[]) idset[1]);
1153 seqstr = new String[numinput];
1154 ids = new String[numinput];
1155 for (int sq = 0, idcount = 0; sq < seqs.length; sq++)
1157 if (allids[sq] != null)
1159 ids[idcount] = allids[sq];
1160 seqstr[idcount++] = idandseqs[1][sq];
1166 // just use the id/seq set
1167 seqstr = idandseqs[1];
1171 // and try and make the groupURL!
1173 Object[] urlset = null;
1176 urlset = urlLink.makeUrlStubs(ids, seqstr,
1177 "FromJalview" + System.currentTimeMillis(), false);
1178 } catch (UrlStringTooLongException e)
1183 int type = urlLink.getGroupURLType() & 3;
1184 // first two bits ofurlLink type bitfield are sequenceids and sequences
1185 // TODO: FUTURE: ensure the groupURL menu structure can be generalised
1186 addshowLink(linkMenus[type],
1187 label + (((type & 1) == 1)
1188 ? ("(" + (usingNames ? "Names" : ltarget) + ")")
1196 groupLinksMenu = new JMenu(
1197 MessageManager.getString("action.group_link"));
1198 for (int m = 0; m < linkMenus.length; m++)
1200 if (linkMenus[m] != null
1201 && linkMenus[m].getMenuComponentCount() > 0)
1203 groupLinksMenu.add(linkMenus[m]);
1207 groupMenu.add(groupLinksMenu);
1217 private void jbInit() throws Exception
1219 groupMenu.setText(MessageManager.getString("label.selection"));
1220 groupName.setText(MessageManager.getString("label.name"));
1221 groupName.addActionListener(new ActionListener()
1224 public void actionPerformed(ActionEvent e)
1226 groupName_actionPerformed();
1229 sequenceMenu.setText(MessageManager.getString("label.sequence"));
1231 JMenuItem sequenceName = new JMenuItem(
1232 MessageManager.getString("label.edit_name_description"));
1233 sequenceName.addActionListener(new ActionListener()
1236 public void actionPerformed(ActionEvent e)
1238 sequenceName_actionPerformed();
1241 JMenuItem chooseAnnotations = new JMenuItem(
1242 MessageManager.getString("action.choose_annotations"));
1243 chooseAnnotations.addActionListener(new ActionListener()
1246 public void actionPerformed(ActionEvent e)
1248 chooseAnnotations_actionPerformed(e);
1251 JMenuItem sequenceDetails = new JMenuItem(
1252 MessageManager.getString("label.sequence_details"));
1253 sequenceDetails.addActionListener(new ActionListener()
1256 public void actionPerformed(ActionEvent e)
1258 createSequenceDetailsReport(new SequenceI[] { sequence });
1261 JMenuItem sequenceSelDetails = new JMenuItem(
1262 MessageManager.getString("label.sequence_details"));
1263 sequenceSelDetails.addActionListener(new ActionListener()
1266 public void actionPerformed(ActionEvent e)
1268 createSequenceDetailsReport(ap.av.getSequenceSelection());
1273 .setText(MessageManager.getString("action.remove_group"));
1274 unGroupMenuItem.addActionListener(new ActionListener()
1277 public void actionPerformed(ActionEvent e)
1279 unGroupMenuItem_actionPerformed();
1283 .setText(MessageManager.getString("action.create_group"));
1284 createGroupMenuItem.addActionListener(new ActionListener()
1287 public void actionPerformed(ActionEvent e)
1289 createGroupMenuItem_actionPerformed();
1293 JMenuItem outline = new JMenuItem(
1294 MessageManager.getString("action.border_colour"));
1295 outline.addActionListener(new ActionListener()
1298 public void actionPerformed(ActionEvent e)
1300 outline_actionPerformed();
1303 showBoxes.setText(MessageManager.getString("action.boxes"));
1304 showBoxes.setState(true);
1305 showBoxes.addActionListener(new ActionListener()
1308 public void actionPerformed(ActionEvent e)
1310 showBoxes_actionPerformed();
1313 showText.setText(MessageManager.getString("action.text"));
1314 showText.setState(true);
1315 showText.addActionListener(new ActionListener()
1318 public void actionPerformed(ActionEvent e)
1320 showText_actionPerformed();
1323 showColourText.setText(MessageManager.getString("label.colour_text"));
1324 showColourText.addActionListener(new ActionListener()
1327 public void actionPerformed(ActionEvent e)
1329 showColourText_actionPerformed();
1333 .setText(MessageManager.getString("label.show_non_conserved"));
1334 displayNonconserved.setState(true);
1335 displayNonconserved.addActionListener(new ActionListener()
1338 public void actionPerformed(ActionEvent e)
1340 showNonconserved_actionPerformed();
1343 editMenu.setText(MessageManager.getString("action.edit"));
1344 JMenuItem cut = new JMenuItem(MessageManager.getString("action.cut"));
1345 cut.addActionListener(new ActionListener()
1348 public void actionPerformed(ActionEvent e)
1350 cut_actionPerformed();
1353 upperCase.setText(MessageManager.getString("label.to_upper_case"));
1354 upperCase.addActionListener(new ActionListener()
1357 public void actionPerformed(ActionEvent e)
1362 JMenuItem copy = new JMenuItem(MessageManager.getString("action.copy"));
1363 copy.addActionListener(new ActionListener()
1366 public void actionPerformed(ActionEvent e)
1368 copy_actionPerformed();
1371 lowerCase.setText(MessageManager.getString("label.to_lower_case"));
1372 lowerCase.addActionListener(new ActionListener()
1375 public void actionPerformed(ActionEvent e)
1380 toggle.setText(MessageManager.getString("label.toggle_case"));
1381 toggle.addActionListener(new ActionListener()
1384 public void actionPerformed(ActionEvent e)
1390 MessageManager.getString("label.out_to_textbox") + "...");
1391 seqShowAnnotationsMenu
1392 .setText(MessageManager.getString("label.show_annotations"));
1393 seqHideAnnotationsMenu
1394 .setText(MessageManager.getString("label.hide_annotations"));
1395 groupShowAnnotationsMenu
1396 .setText(MessageManager.getString("label.show_annotations"));
1397 groupHideAnnotationsMenu
1398 .setText(MessageManager.getString("label.hide_annotations"));
1399 JMenuItem sequenceFeature = new JMenuItem(
1400 MessageManager.getString("label.create_sequence_feature"));
1401 sequenceFeature.addActionListener(new ActionListener()
1404 public void actionPerformed(ActionEvent e)
1406 sequenceFeature_actionPerformed();
1409 editGroupMenu.setText(MessageManager.getString("label.group"));
1410 chooseStructure.setText(
1411 MessageManager.getString("label.show_pdbstruct_dialog"));
1412 chooseStructure.addActionListener(new ActionListener()
1415 public void actionPerformed(ActionEvent actionEvent)
1417 SequenceI[] selectedSeqs = new SequenceI[] { sequence };
1418 if (ap.av.getSelectionGroup() != null)
1420 selectedSeqs = ap.av.getSequenceSelection();
1422 new StructureChooser(selectedSeqs, sequence, ap);
1427 .setText(MessageManager.getString("label.view_rna_structure"));
1429 // colStructureMenu.setText("Colour By Structure");
1430 JMenuItem editSequence = new JMenuItem(
1431 MessageManager.getString("label.edit_sequence") + "...");
1432 editSequence.addActionListener(new ActionListener()
1435 public void actionPerformed(ActionEvent actionEvent)
1437 editSequence_actionPerformed(actionEvent);
1440 makeReferenceSeq.setText(
1441 MessageManager.getString("label.mark_as_representative"));
1442 makeReferenceSeq.addActionListener(new ActionListener()
1446 public void actionPerformed(ActionEvent actionEvent)
1448 makeReferenceSeq_actionPerformed(actionEvent);
1453 groupMenu.add(sequenceSelDetails);
1456 add(rnaStructureMenu);
1457 add(chooseStructure);
1460 JMenuItem hideInsertions = new JMenuItem(
1461 MessageManager.getString("label.hide_insertions"));
1462 hideInsertions.addActionListener(new ActionListener()
1466 public void actionPerformed(ActionEvent e)
1468 hideInsertions_actionPerformed(e);
1471 add(hideInsertions);
1473 // annotations configuration panel suppressed for now
1474 // groupMenu.add(chooseAnnotations);
1477 * Add show/hide annotations to the Sequence menu, and to the Selection menu
1478 * (if a selection group is in force).
1480 sequenceMenu.add(seqShowAnnotationsMenu);
1481 sequenceMenu.add(seqHideAnnotationsMenu);
1482 sequenceMenu.add(seqAddReferenceAnnotations);
1483 groupMenu.add(groupShowAnnotationsMenu);
1484 groupMenu.add(groupHideAnnotationsMenu);
1485 groupMenu.add(groupAddReferenceAnnotations);
1486 groupMenu.add(editMenu);
1487 groupMenu.add(outputMenu);
1488 groupMenu.add(sequenceFeature);
1489 groupMenu.add(createGroupMenuItem);
1490 groupMenu.add(unGroupMenuItem);
1491 groupMenu.add(editGroupMenu);
1492 sequenceMenu.add(sequenceName);
1493 sequenceMenu.add(sequenceDetails);
1494 sequenceMenu.add(makeReferenceSeq);
1501 editMenu.add(editSequence);
1502 editMenu.add(upperCase);
1503 editMenu.add(lowerCase);
1504 editMenu.add(toggle);
1505 editGroupMenu.add(groupName);
1506 editGroupMenu.add(colourMenu);
1507 editGroupMenu.add(showBoxes);
1508 editGroupMenu.add(showText);
1509 editGroupMenu.add(showColourText);
1510 editGroupMenu.add(outline);
1511 editGroupMenu.add(displayNonconserved);
1515 * Constructs the entries for the colour menu
1517 protected void initColourMenu()
1519 colourMenu.setText(MessageManager.getString("label.group_colour"));
1520 textColour.setText(MessageManager.getString("label.text_colour"));
1521 textColour.addActionListener(new ActionListener()
1524 public void actionPerformed(ActionEvent e)
1526 textColour_actionPerformed();
1530 abovePIDColour.setText(
1531 MessageManager.getString("label.above_identity_threshold"));
1532 abovePIDColour.addActionListener(new ActionListener()
1535 public void actionPerformed(ActionEvent e)
1537 abovePIDColour_actionPerformed(abovePIDColour.isSelected());
1542 MessageManager.getString("label.modify_identity_threshold"));
1543 modifyPID.addActionListener(new ActionListener()
1546 public void actionPerformed(ActionEvent e)
1548 modifyPID_actionPerformed();
1552 conservationMenuItem
1553 .setText(MessageManager.getString("action.by_conservation"));
1554 conservationMenuItem.addActionListener(new ActionListener()
1557 public void actionPerformed(ActionEvent e)
1559 conservationMenuItem_actionPerformed(
1560 conservationMenuItem.isSelected());
1564 annotationColour = new JRadioButtonMenuItem(
1565 MessageManager.getString("action.by_annotation"));
1566 annotationColour.setName(ResidueColourScheme.ANNOTATION_COLOUR);
1567 annotationColour.setEnabled(false);
1568 annotationColour.setToolTipText(
1569 MessageManager.getString("label.by_annotation_tooltip"));
1571 modifyConservation.setText(MessageManager
1572 .getString("label.modify_conservation_threshold"));
1573 modifyConservation.addActionListener(new ActionListener()
1576 public void actionPerformed(ActionEvent e)
1578 modifyConservation_actionPerformed();
1584 * Builds the group colour sub-menu, including any user-defined colours which
1585 * were loaded at startup or during the Jalview session
1587 protected void buildColourMenu()
1589 SequenceGroup sg = ap.av.getSelectionGroup();
1593 * popup menu with no sequence group scope
1597 colourMenu.removeAll();
1598 colourMenu.add(textColour);
1599 colourMenu.addSeparator();
1601 ButtonGroup bg = ColourMenuHelper.addMenuItems(colourMenu, this, sg,
1603 bg.add(annotationColour);
1604 colourMenu.add(annotationColour);
1606 colourMenu.addSeparator();
1607 colourMenu.add(conservationMenuItem);
1608 colourMenu.add(modifyConservation);
1609 colourMenu.add(abovePIDColour);
1610 colourMenu.add(modifyPID);
1613 protected void modifyConservation_actionPerformed()
1615 SequenceGroup sg = getGroup();
1618 SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
1619 SliderPanel.showConservationSlider();
1623 protected void modifyPID_actionPerformed()
1625 SequenceGroup sg = getGroup();
1628 // int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
1630 // sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1631 SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup().getName());
1632 SliderPanel.showPIDSlider();
1637 * Check for any annotations on the underlying dataset sequences (for the
1638 * current selection group) which are not 'on the alignment'.If any are found,
1639 * enable the option to add them to the alignment. The criteria for 'on the
1640 * alignment' is finding an alignment annotation on the alignment, matched on
1641 * calcId, label and sequenceRef.
1643 * A tooltip is also constructed that displays the source (calcId) and type
1644 * (label) of the annotations that can be added.
1647 * @param forSequences
1649 protected void configureReferenceAnnotationsMenu(JMenuItem menuItem,
1650 List<SequenceI> forSequences)
1652 menuItem.setEnabled(false);
1655 * Temporary store to hold distinct calcId / type pairs for the tooltip.
1656 * Using TreeMap means calcIds are shown in alphabetical order.
1658 SortedMap<String, String> tipEntries = new TreeMap<>();
1659 final Map<SequenceI, List<AlignmentAnnotation>> candidates = new LinkedHashMap<>();
1660 AlignmentI al = this.ap.av.getAlignment();
1661 AlignmentUtils.findAddableReferenceAnnotations(forSequences, tipEntries,
1663 if (!candidates.isEmpty())
1665 StringBuilder tooltip = new StringBuilder(64);
1666 tooltip.append(MessageManager.getString("label.add_annotations_for"));
1669 * Found annotations that could be added. Enable the menu item, and
1670 * configure its tooltip and action.
1672 menuItem.setEnabled(true);
1673 for (String calcId : tipEntries.keySet())
1675 tooltip.append("<br/>" + calcId + "/" + tipEntries.get(calcId));
1677 String tooltipText = JvSwingUtils.wrapTooltip(true,
1678 tooltip.toString());
1679 menuItem.setToolTipText(tooltipText);
1681 menuItem.addActionListener(new ActionListener()
1684 public void actionPerformed(ActionEvent e)
1686 addReferenceAnnotations_actionPerformed(candidates);
1693 * Add annotations to the sequences and to the alignment.
1696 * a map whose keys are sequences on the alignment, and values a list
1697 * of annotations to add to each sequence
1699 protected void addReferenceAnnotations_actionPerformed(
1700 Map<SequenceI, List<AlignmentAnnotation>> candidates)
1702 final SequenceGroup selectionGroup = this.ap.av.getSelectionGroup();
1703 final AlignmentI alignment = this.ap.getAlignment();
1704 AlignmentUtils.addReferenceAnnotations(candidates, alignment,
1709 protected void makeReferenceSeq_actionPerformed(ActionEvent actionEvent)
1711 if (!ap.av.getAlignment().hasSeqrep())
1713 // initialise the display flags so the user sees something happen
1714 ap.av.setDisplayReferenceSeq(true);
1715 ap.av.setColourByReferenceSeq(true);
1716 ap.av.getAlignment().setSeqrep(sequence);
1720 if (ap.av.getAlignment().getSeqrep() == sequence)
1722 ap.av.getAlignment().setSeqrep(null);
1726 ap.av.getAlignment().setSeqrep(sequence);
1732 protected void hideInsertions_actionPerformed(ActionEvent actionEvent)
1734 HiddenColumns hidden = ap.av.getAlignment().getHiddenColumns();
1735 BitSet inserts = new BitSet();
1737 boolean markedPopup = false;
1738 // mark inserts in current selection
1739 if (ap.av.getSelectionGroup() != null)
1741 // mark just the columns in the selection group to be hidden
1742 inserts.set(ap.av.getSelectionGroup().getStartRes(),
1743 ap.av.getSelectionGroup().getEndRes() + 1); // TODO why +1?
1745 // now clear columns without gaps
1746 for (SequenceI sq : ap.av.getSelectionGroup().getSequences())
1752 inserts.and(sq.getInsertionsAsBits());
1754 hidden.clearAndHideColumns(inserts, ap.av.getSelectionGroup().getStartRes(),
1755 ap.av.getSelectionGroup().getEndRes());
1758 // now mark for sequence under popup if we haven't already done it
1759 else if (!markedPopup && sequence != null)
1761 inserts.or(sequence.getInsertionsAsBits());
1763 // and set hidden columns accordingly
1764 hidden.hideColumns(inserts);
1769 protected void sequenceSelectionDetails_actionPerformed()
1771 createSequenceDetailsReport(ap.av.getSequenceSelection());
1774 public void createSequenceDetailsReport(SequenceI[] sequences)
1776 CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
1777 StringBuilder contents = new StringBuilder(128);
1778 for (SequenceI seq : sequences)
1780 contents.append("<p><h2>" + MessageManager.formatMessage(
1781 "label.create_sequence_details_report_annotation_for",
1783 { seq.getDisplayId(true) }) + "</h2></p><p>");
1784 new SequenceAnnotationReport(false).createSequenceAnnotationReport(
1785 contents, seq, true, true, ap.getSeqPanel().seqCanvas.fr);
1786 contents.append("</p>");
1788 cap.setText("<html>" + contents.toString() + "</html>");
1790 Desktop.addInternalFrame(cap,
1791 MessageManager.formatMessage("label.sequence_details_for",
1792 (sequences.length == 1 ? new Object[]
1793 { sequences[0].getDisplayId(true) }
1796 .getString("label.selection") })),
1801 protected void showNonconserved_actionPerformed()
1803 getGroup().setShowNonconserved(displayNonconserved.isSelected());
1808 * call to refresh view after settings change
1812 ap.updateAnnotation();
1813 // removed paintAlignment(true) here:
1814 // updateAnnotation calls paintAlignment already, so don't need to call
1817 PaintRefresher.Refresh(this, ap.av.getSequenceSetId());
1821 * protected void covariationColour_actionPerformed() { getGroup().cs = new
1822 * CovariationColourScheme(sequence.getAnnotation()[0]); refresh(); }
1832 public void abovePIDColour_actionPerformed(boolean selected)
1834 SequenceGroup sg = getGroup();
1842 sg.cs.setConsensus(AAFrequency.calculate(
1843 sg.getSequences(ap.av.getHiddenRepSequences()),
1844 sg.getStartRes(), sg.getEndRes() + 1));
1846 int threshold = SliderPanel.setPIDSliderSource(ap,
1847 sg.getGroupColourScheme(), getGroup().getName());
1849 sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1851 SliderPanel.showPIDSlider();
1854 // remove PIDColouring
1856 sg.cs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
1857 SliderPanel.hidePIDSlider();
1859 modifyPID.setEnabled(selected);
1865 * Open a panel where the user can choose which types of sequence annotation
1870 protected void chooseAnnotations_actionPerformed(ActionEvent e)
1872 // todo correct way to guard against opening a duplicate panel?
1873 new AnnotationChooser(ap);
1882 public void conservationMenuItem_actionPerformed(boolean selected)
1884 SequenceGroup sg = getGroup();
1892 // JBPNote: Conservation name shouldn't be i18n translated
1893 Conservation c = new Conservation("Group",
1894 sg.getSequences(ap.av.getHiddenRepSequences()),
1895 sg.getStartRes(), sg.getEndRes() + 1);
1898 c.verdict(false, ap.av.getConsPercGaps());
1899 sg.cs.setConservation(c);
1901 SliderPanel.setConservationSlider(ap, sg.getGroupColourScheme(),
1903 SliderPanel.showConservationSlider();
1906 // remove ConservationColouring
1908 sg.cs.setConservation(null);
1909 SliderPanel.hideConservationSlider();
1911 modifyConservation.setEnabled(selected);
1922 protected void groupName_actionPerformed()
1925 SequenceGroup sg = getGroup();
1926 EditNameDialog dialog = new EditNameDialog(sg.getName(),
1927 sg.getDescription(),
1928 " " + MessageManager.getString("label.group_name") + " ",
1929 MessageManager.getString("label.group_description") + " ",
1930 MessageManager.getString("label.edit_group_name_description"),
1938 sg.setName(dialog.getName());
1939 sg.setDescription(dialog.getDescription());
1944 * Get selection group - adding it to the alignment if necessary.
1946 * @return sequence group to operate on
1948 SequenceGroup getGroup()
1950 SequenceGroup sg = ap.av.getSelectionGroup();
1951 // this method won't add a new group if it already exists
1954 ap.av.getAlignment().addGroup(sg);
1961 * Shows a dialog where the sequence name and description may be edited. If a
1962 * name containing spaces is entered, these are converted to underscores, with a
1965 void sequenceName_actionPerformed()
1967 EditNameDialog dialog = new EditNameDialog(sequence.getName(),
1968 sequence.getDescription(),
1969 " " + MessageManager.getString("label.sequence_name")
1971 MessageManager.getString("label.sequence_description") + " ",
1972 MessageManager.getString(
1973 "label.edit_sequence_name_description"),
1981 String name = dialog.getName();
1984 if (name.indexOf(" ") > -1)
1986 JvOptionPane.showMessageDialog(ap,
1988 .getString("label.spaces_converted_to_backslashes"),
1990 .getString("label.no_spaces_allowed_sequence_name"),
1991 JvOptionPane.WARNING_MESSAGE);
1992 name = name.replace(' ', '_');
1995 sequence.setName(name);
1996 ap.paintAlignment(false, false);
1999 sequence.setDescription(dialog.getDescription());
2001 ap.av.firePropertyChange("alignment", null,
2002 ap.av.getAlignment().getSequences());
2012 void unGroupMenuItem_actionPerformed()
2014 SequenceGroup sg = ap.av.getSelectionGroup();
2015 ap.av.getAlignment().deleteGroup(sg);
2016 ap.av.setSelectionGroup(null);
2020 void createGroupMenuItem_actionPerformed()
2022 getGroup(); // implicitly creates group - note - should apply defaults / use
2023 // standard alignment window logic for this
2033 protected void outline_actionPerformed()
2035 SequenceGroup sg = getGroup();
2036 Color col = JColorChooser.showDialog(this,
2037 MessageManager.getString("label.select_outline_colour"),
2042 sg.setOutlineColour(col);
2054 public void showBoxes_actionPerformed()
2056 getGroup().setDisplayBoxes(showBoxes.isSelected());
2066 public void showText_actionPerformed()
2068 getGroup().setDisplayText(showText.isSelected());
2078 public void showColourText_actionPerformed()
2080 getGroup().setColourText(showColourText.isSelected());
2084 void hideSequences(boolean representGroup)
2086 ap.av.hideSequences(sequence, representGroup);
2089 public void copy_actionPerformed()
2091 ap.alignFrame.copy_actionPerformed(null);
2094 public void cut_actionPerformed()
2096 ap.alignFrame.cut_actionPerformed(null);
2099 void changeCase(ActionEvent e)
2101 Object source = e.getSource();
2102 SequenceGroup sg = ap.av.getSelectionGroup();
2106 List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
2107 sg.getStartRes(), sg.getEndRes() + 1);
2112 if (source == toggle)
2114 description = MessageManager.getString("label.toggle_case");
2115 caseChange = ChangeCaseCommand.TOGGLE_CASE;
2117 else if (source == upperCase)
2119 description = MessageManager.getString("label.to_upper_case");
2120 caseChange = ChangeCaseCommand.TO_UPPER;
2124 description = MessageManager.getString("label.to_lower_case");
2125 caseChange = ChangeCaseCommand.TO_LOWER;
2128 ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
2129 sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
2130 startEnd, caseChange);
2132 ap.alignFrame.addHistoryItem(caseCommand);
2134 ap.av.firePropertyChange("alignment", null,
2135 ap.av.getAlignment().getSequences());
2140 public void outputText_actionPerformed(ActionEvent e)
2142 CutAndPasteTransfer cap = new CutAndPasteTransfer();
2143 cap.setForInput(null);
2144 Desktop.addInternalFrame(cap, MessageManager
2145 .formatMessage("label.alignment_output_command", new Object[]
2146 { e.getActionCommand() }), 600, 500);
2148 String[] omitHidden = null;
2150 System.out.println("PROMPT USER HERE"); // TODO: decide if a prompt happens
2151 // or we simply trust the user wants
2152 // wysiwig behaviour
2154 FileFormatI fileFormat = FileFormats.getInstance()
2155 .forName(e.getActionCommand());
2157 new FormatAdapter(ap).formatSequences(fileFormat, ap, true));
2160 public void sequenceFeature_actionPerformed()
2162 SequenceGroup sg = ap.av.getSelectionGroup();
2168 List<SequenceI> seqs = new ArrayList<>();
2169 List<SequenceFeature> features = new ArrayList<>();
2172 * assemble dataset sequences, and template new sequence features,
2173 * for the amend features dialog
2175 int gSize = sg.getSize();
2176 for (int i = 0; i < gSize; i++)
2178 int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
2179 int end = sg.findEndRes(sg.getSequenceAt(i));
2182 seqs.add(sg.getSequenceAt(i).getDatasetSequence());
2183 features.add(new SequenceFeature(null, null, start, end, null));
2188 * an entirely gapped region will generate empty lists of sequence / features
2190 if (!seqs.isEmpty())
2192 if (ap.getSeqPanel().seqCanvas.getFeatureRenderer()
2193 .amendFeatures(seqs, features, true, ap))
2195 ap.alignFrame.setShowSeqFeatures(true);
2196 ap.av.setSearchResults(null); // clear highlighting
2197 ap.repaint(); // draw new/amended features
2202 public void textColour_actionPerformed()
2204 SequenceGroup sg = getGroup();
2207 new TextColourChooser().chooseColour(ap, sg);
2211 public void editSequence_actionPerformed(ActionEvent actionEvent)
2213 SequenceGroup sg = ap.av.getSelectionGroup();
2215 SequenceI seq = sequence;
2220 seq = sg.getSequenceAt(0);
2223 EditNameDialog dialog = new EditNameDialog(
2224 seq.getSequenceAsString(sg.getStartRes(),
2225 sg.getEndRes() + 1),
2226 null, MessageManager.getString("label.edit_sequence"), null,
2227 MessageManager.getString("label.edit_sequence"),
2232 EditCommand editCommand = new EditCommand(
2233 MessageManager.getString("label.edit_sequences"),
2235 dialog.getName().replace(' ', ap.av.getGapCharacter()),
2236 sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
2237 sg.getStartRes(), sg.getEndRes() + 1, ap.av.getAlignment());
2239 ap.alignFrame.addHistoryItem(editCommand);
2241 ap.av.firePropertyChange("alignment", null,
2242 ap.av.getAlignment().getSequences());
2248 * Action on user selecting an item from the colour menu (that does not have
2249 * its bespoke action handler)
2254 public void changeColour_actionPerformed(String colourSchemeName)
2256 SequenceGroup sg = getGroup();
2258 * switch to the chosen colour scheme (or null for None)
2260 ColourSchemeI colourScheme = ColourSchemes.getInstance()
2261 .getColourScheme(colourSchemeName, ap.av, sg,
2262 ap.av.getHiddenRepSequences());
2263 sg.setColourScheme(colourScheme);
2264 if (colourScheme instanceof Blosum62ColourScheme
2265 || colourScheme instanceof PIDColourScheme)
2267 sg.cs.setConsensus(AAFrequency.calculate(
2268 sg.getSequences(ap.av.getHiddenRepSequences()),
2269 sg.getStartRes(), sg.getEndRes() + 1));