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.util.Locale;
25 import java.awt.BorderLayout;
26 import java.awt.Color;
27 import java.awt.event.ActionEvent;
28 import java.awt.event.ActionListener;
29 import java.util.ArrayList;
30 import java.util.Arrays;
31 import java.util.BitSet;
32 import java.util.Collection;
33 import java.util.Collections;
34 import java.util.Hashtable;
35 import java.util.LinkedHashMap;
36 import java.util.List;
38 import java.util.Objects;
39 import java.util.SortedMap;
40 import java.util.TreeMap;
41 import java.util.Vector;
43 import javax.swing.ButtonGroup;
44 import javax.swing.JCheckBoxMenuItem;
45 import javax.swing.JInternalFrame;
46 import javax.swing.JLabel;
47 import javax.swing.JMenu;
48 import javax.swing.JMenuItem;
49 import javax.swing.JPanel;
50 import javax.swing.JPopupMenu;
51 import javax.swing.JRadioButtonMenuItem;
52 import javax.swing.JScrollPane;
54 import jalview.analysis.AAFrequency;
55 import jalview.analysis.AlignmentAnnotationUtils;
56 import jalview.analysis.AlignmentUtils;
57 import jalview.analysis.Conservation;
58 import jalview.api.AlignViewportI;
59 import jalview.bin.Console;
60 import jalview.commands.ChangeCaseCommand;
61 import jalview.commands.EditCommand;
62 import jalview.commands.EditCommand.Action;
63 import jalview.datamodel.AlignmentAnnotation;
64 import jalview.datamodel.AlignmentI;
65 import jalview.datamodel.DBRefEntry;
66 import jalview.datamodel.HiddenColumns;
67 import jalview.datamodel.MappedFeatures;
68 import jalview.datamodel.PDBEntry;
69 import jalview.datamodel.ResidueCount;
70 import jalview.datamodel.SequenceFeature;
71 import jalview.datamodel.SequenceGroup;
72 import jalview.datamodel.SequenceI;
73 import jalview.gui.ColourMenuHelper.ColourChangeListener;
74 import jalview.gui.JalviewColourChooser.ColourChooserListener;
75 import jalview.io.CountReader;
76 import jalview.io.FileFormatI;
77 import jalview.io.FileFormats;
78 import jalview.io.FormatAdapter;
79 import jalview.io.SequenceAnnotationReport;
80 import jalview.schemes.Blosum62ColourScheme;
81 import jalview.schemes.ColourSchemeI;
82 import jalview.schemes.ColourSchemes;
83 import jalview.schemes.PIDColourScheme;
84 import jalview.schemes.ResidueColourScheme;
85 import jalview.util.Comparison;
86 import jalview.util.GroupUrlLink;
87 import jalview.util.GroupUrlLink.UrlStringTooLongException;
88 import jalview.util.MessageManager;
89 import jalview.util.Platform;
90 import jalview.util.StringUtils;
91 import jalview.util.UrlLink;
92 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
94 import java.io.IOException;
95 import java.net.MalformedURLException;
97 * The popup menu that is displayed on right-click on a sequence id, or in the
100 public class PopupMenu extends JPopupMenu implements ColourChangeListener
103 * maximum length of feature description to include in popup menu item text
105 private static final int FEATURE_DESC_MAX = 40;
108 * true for ID Panel menu, false for alignment panel menu
110 private final boolean forIdPanel;
112 private final AlignmentPanel ap;
115 * the sequence under the cursor when clicked
116 * (additional sequences may be selected)
118 private final SequenceI sequence;
120 JMenu groupMenu = new JMenu();
122 JMenuItem groupName = new JMenuItem();
124 protected JCheckBoxMenuItem abovePIDColour = new JCheckBoxMenuItem();
126 protected JMenuItem modifyPID = new JMenuItem();
128 protected JCheckBoxMenuItem conservationMenuItem = new JCheckBoxMenuItem();
130 protected JRadioButtonMenuItem annotationColour;
132 protected JMenuItem modifyConservation = new JMenuItem();
134 JMenu sequenceMenu = new JMenu();
136 JMenuItem makeReferenceSeq = new JMenuItem();
138 JMenuItem createGroupMenuItem = new JMenuItem();
140 JMenuItem unGroupMenuItem = new JMenuItem();
142 JMenu colourMenu = new JMenu();
144 JCheckBoxMenuItem showBoxes = new JCheckBoxMenuItem();
146 JCheckBoxMenuItem showText = new JCheckBoxMenuItem();
148 JCheckBoxMenuItem showColourText = new JCheckBoxMenuItem();
150 JCheckBoxMenuItem displayNonconserved = new JCheckBoxMenuItem();
152 JMenu editMenu = new JMenu();
154 JMenuItem upperCase = new JMenuItem();
156 JMenuItem lowerCase = new JMenuItem();
158 JMenuItem toggle = new JMenuItem();
160 JMenu outputMenu = new JMenu();
162 JMenu seqShowAnnotationsMenu = new JMenu();
164 JMenu seqHideAnnotationsMenu = new JMenu();
166 JMenuItem seqAddReferenceAnnotations = new JMenuItem(
167 MessageManager.getString("label.add_reference_annotations"));
169 JMenu groupShowAnnotationsMenu = new JMenu();
171 JMenu groupHideAnnotationsMenu = new JMenu();
173 JMenuItem groupAddReferenceAnnotations = new JMenuItem(
174 MessageManager.getString("label.add_reference_annotations"));
176 JMenuItem textColour = new JMenuItem();
178 JMenu editGroupMenu = new JMenu();
180 JMenuItem chooseStructure = new JMenuItem();
182 JMenu rnaStructureMenu = new JMenu();
185 * Constructs a menu with sub-menu items for any hyperlinks for the sequence
186 * and/or features provided. Hyperlinks may include a lookup by sequence id,
187 * or database cross-references, depending on which links are enabled in user
194 protected static JMenu buildLinkMenu(final SequenceI seq,
195 List<SequenceFeature> features)
197 JMenu linkMenu = new JMenu(MessageManager.getString("action.link"));
199 List<String> nlinks = null;
202 nlinks = Preferences.sequenceUrlLinks.getLinksForMenu();
203 UrlLink.sort(nlinks);
207 nlinks = new ArrayList<>();
210 if (features != null)
212 for (SequenceFeature sf : features)
214 if (sf.links != null)
216 for (String link : sf.links)
225 * instantiate the hyperlinklink templates from sequence data;
226 * note the order of the templates is preserved in the map
228 Map<String, List<String>> linkset = new LinkedHashMap<>();
229 for (String link : nlinks)
231 UrlLink urlLink = null;
234 urlLink = new UrlLink(link);
235 } catch (Exception foo)
237 Console.error("Exception for URLLink '" + link + "'", foo);
241 if (!urlLink.isValid())
243 Console.error(urlLink.getInvalidMessage());
247 urlLink.createLinksFromSeq(seq, linkset);
251 * construct menu items for the hyperlinks (still preserving
252 * the order of the sorted templates)
254 addUrlLinks(linkMenu, linkset.values());
260 * A helper method that builds menu items from the given links, with action
261 * handlers to open the link URL, and adds them to the linkMenu. Each provided
262 * link should be a list whose second item is the menu text, and whose fourth
263 * item is the URL to open when the menu item is selected.
268 static private void addUrlLinks(JMenu linkMenu,
269 Collection<List<String>> linkset)
271 for (List<String> linkstrset : linkset)
273 final String url = linkstrset.get(3);
274 JMenuItem item = new JMenuItem(linkstrset.get(1));
275 item.setToolTipText(MessageManager
276 .formatMessage("label.open_url_param", new Object[]
278 item.addActionListener(new ActionListener()
281 public void actionPerformed(ActionEvent e)
283 new Thread(new Runnable()
298 * Opens the provided url in the default web browser, or shows an error
299 * message if this fails
303 static void showLink(String url)
307 jalview.util.BrowserLauncher.openURL(url);
308 } catch (Exception ex)
310 JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
311 MessageManager.getString("label.web_browser_not_found_unix"),
312 MessageManager.getString("label.web_browser_not_found"),
313 JvOptionPane.WARNING_MESSAGE);
315 ex.printStackTrace();
320 * add a late bound groupURL item to the given linkMenu
324 * - menu label string
325 * @param urlgenerator
326 * GroupURLLink used to generate URL
328 * Object array returned from the makeUrlStubs function.
330 static void addshowLink(JMenu linkMenu, String label,
331 final GroupUrlLink urlgenerator, final Object[] urlstub)
333 JMenuItem item = new JMenuItem(label);
334 item.setToolTipText(MessageManager
335 .formatMessage("label.open_url_seqs_param", new Object[]
336 { urlgenerator.getUrl_prefix(),
337 urlgenerator.getNumberInvolved(urlstub) }));
338 // TODO: put in info about what is being sent.
339 item.addActionListener(new ActionListener()
342 public void actionPerformed(ActionEvent e)
344 new Thread(new Runnable()
352 showLink(urlgenerator.constructFrom(urlstub));
353 } catch (UrlStringTooLongException e2)
366 * Constructor for a PopupMenu for a click in the alignment panel (on a residue)
369 * the panel in which the mouse is clicked
371 * the sequence under the mouse
372 * @throws NullPointerException
375 public PopupMenu(final AlignmentPanel ap, SequenceI seq, int column)
377 this(false, ap, seq, column, null);
381 * Constructor for a PopupMenu for a click in the sequence id panel
384 * the panel in which the mouse is clicked
386 * the sequence under the mouse click
388 * templates for sequence external links
389 * @throws NullPointerException
392 public PopupMenu(final AlignmentPanel alignPanel, final SequenceI seq,
393 List<String> groupLinks)
395 this(true, alignPanel, seq, -1, groupLinks);
399 * Private constructor that constructs a popup menu for either sequence ID
400 * Panel, or alignment context
406 * aligned column position (0...)
409 private PopupMenu(boolean fromIdPanel,
410 final AlignmentPanel alignPanel,
411 final SequenceI seq, final int column, List<String> groupLinks)
413 Objects.requireNonNull(seq);
414 this.forIdPanel = fromIdPanel;
415 this.ap = alignPanel;
418 for (String ff : FileFormats.getInstance().getWritableFormats(true))
420 JMenuItem item = new JMenuItem(ff);
422 item.addActionListener(new ActionListener()
425 public void actionPerformed(ActionEvent e)
427 outputText_actionPerformed(e);
431 outputMenu.add(item);
435 * Build menus for annotation types that may be shown or hidden, and for
436 * 'reference annotations' that may be added to the alignment. First for the
437 * currently selected sequence (if there is one):
439 final List<SequenceI> selectedSequence = (forIdPanel && seq != null
441 : Collections.<SequenceI> emptyList());
442 buildAnnotationTypesMenus(seqShowAnnotationsMenu,
443 seqHideAnnotationsMenu, selectedSequence);
444 configureReferenceAnnotationsMenu(seqAddReferenceAnnotations,
448 * And repeat for the current selection group (if there is one):
450 final List<SequenceI> selectedGroup = (alignPanel.av.getSelectionGroup() == null
451 ? Collections.<SequenceI> emptyList()
452 : alignPanel.av.getSelectionGroup().getSequences());
453 buildAnnotationTypesMenus(groupShowAnnotationsMenu,
454 groupHideAnnotationsMenu, selectedGroup);
455 configureReferenceAnnotationsMenu(groupAddReferenceAnnotations,
461 } catch (Exception e)
469 sequenceMenu.setText(sequence.getName());
470 if (seq == alignPanel.av.getAlignment().getSeqrep())
472 makeReferenceSeq.setText(
473 MessageManager.getString("action.unmark_as_reference"));
477 makeReferenceSeq.setText(
478 MessageManager.getString("action.set_as_reference"));
481 if (!alignPanel.av.getAlignment().isNucleotide())
483 remove(rnaStructureMenu);
487 int origCount = rnaStructureMenu.getItemCount();
489 * add menu items to 2D-render any alignment or sequence secondary
490 * structure annotation
492 AlignmentAnnotation[] aas = alignPanel.av.getAlignment()
493 .getAlignmentAnnotation();
496 for (final AlignmentAnnotation aa : aas)
498 if (aa.isValidStruc() && aa.sequenceRef == null)
501 * valid alignment RNA secondary structure annotation
503 menuItem = new JMenuItem();
504 menuItem.setText(MessageManager.formatMessage(
505 "label.2d_rna_structure_line", new Object[]
507 menuItem.addActionListener(new ActionListener()
510 public void actionPerformed(ActionEvent e)
512 new AppVarna(seq, aa, alignPanel);
515 rnaStructureMenu.add(menuItem);
520 if (seq.getAnnotation() != null)
522 AlignmentAnnotation seqAnns[] = seq.getAnnotation();
523 for (final AlignmentAnnotation aa : seqAnns)
525 if (aa.isValidStruc())
528 * valid sequence RNA secondary structure annotation
530 // TODO: make rnastrucF a bit more nice
531 menuItem = new JMenuItem();
532 menuItem.setText(MessageManager.formatMessage(
533 "label.2d_rna_sequence_name", new Object[]
535 menuItem.addActionListener(new ActionListener()
538 public void actionPerformed(ActionEvent e)
540 // TODO: VARNA does'nt print gaps in the sequence
541 new AppVarna(seq, aa, alignPanel);
544 rnaStructureMenu.add(menuItem);
548 if (rnaStructureMenu.getItemCount() == origCount)
550 remove(rnaStructureMenu);
554 if (seq.hasHMMProfile())
556 menuItem = new JMenuItem(MessageManager
557 .getString("action.add_background_frequencies"));
558 menuItem.addActionListener(new ActionListener()
561 public void actionPerformed(ActionEvent e)
565 ResidueCount counts = CountReader.getBackgroundFrequencies(ap,
569 seq.getHMM().setBackgroundFrequencies(counts);
570 ap.alignFrame.buildColourMenu();
572 } catch (MalformedURLException e1)
574 e1.printStackTrace();
575 } catch (IOException e1)
577 e1.printStackTrace();
583 menuItem = new JMenuItem(
584 MessageManager.getString("action.hide_sequences"));
585 menuItem.addActionListener(new ActionListener()
588 public void actionPerformed(ActionEvent e)
590 hideSequences(false);
595 if (alignPanel.av.getSelectionGroup() != null
596 && alignPanel.av.getSelectionGroup().getSize() > 1)
598 menuItem = new JMenuItem(MessageManager
599 .formatMessage("label.represent_group_with", new Object[]
601 menuItem.addActionListener(new ActionListener()
604 public void actionPerformed(ActionEvent e)
609 sequenceMenu.add(menuItem);
612 if (alignPanel.av.hasHiddenRows())
614 final int index = alignPanel.av.getAlignment().findIndex(seq);
616 if (alignPanel.av.adjustForHiddenSeqs(index)
617 - alignPanel.av.adjustForHiddenSeqs(index - 1) > 1)
619 menuItem = new JMenuItem(
620 MessageManager.getString("action.reveal_sequences"));
621 menuItem.addActionListener(new ActionListener()
624 public void actionPerformed(ActionEvent e)
626 alignPanel.av.showSequence(index);
627 if (alignPanel.overviewPanel != null)
629 alignPanel.overviewPanel.updateOverviewImage();
640 * - in the IdPanel (seq not null) if any sequence is hidden
641 * - in the IdPanel or SeqPanel if all sequences are hidden (seq is null)
643 if (alignPanel.av.hasHiddenRows())
645 boolean addOption = seq != null;
646 if (!addOption && alignPanel.av.getAlignment().getHeight() == 0)
652 JMenuItem menuItem = new JMenuItem(
653 MessageManager.getString("action.reveal_all"));
654 menuItem.addActionListener(new ActionListener()
657 public void actionPerformed(ActionEvent e)
659 alignPanel.av.showAllHiddenSeqs();
660 if (alignPanel.overviewPanel != null)
662 alignPanel.overviewPanel.updateOverviewImage();
670 SequenceGroup sg = alignPanel.av.getSelectionGroup();
671 boolean isDefinedGroup = (sg != null)
672 ? alignPanel.av.getAlignment().getGroups().contains(sg)
675 if (sg != null && sg.getSize() > 0)
677 groupName.setText(MessageManager
678 .getString("label.edit_name_and_description_current_group"));
680 ColourMenuHelper.setColourSelected(colourMenu, sg.getColourScheme());
682 conservationMenuItem.setEnabled(!sg.isNucleotide());
686 if (sg.cs.conservationApplied())
688 conservationMenuItem.setSelected(true);
690 if (sg.cs.getThreshold() > 0)
692 abovePIDColour.setSelected(true);
695 modifyConservation.setEnabled(conservationMenuItem.isSelected());
696 modifyPID.setEnabled(abovePIDColour.isSelected());
697 displayNonconserved.setSelected(sg.getShowNonconserved());
698 showText.setSelected(sg.getDisplayText());
699 showColourText.setSelected(sg.getColourText());
700 showBoxes.setSelected(sg.getDisplayBoxes());
701 // add any groupURLs to the groupURL submenu and make it visible
702 if (groupLinks != null && groupLinks.size() > 0)
704 buildGroupURLMenu(sg, groupLinks);
706 // TODO REMOVE FOR 2.12 ?
707 // Add a 'show all structures' for the current selection
708 Hashtable<String, PDBEntry> pdbe = new Hashtable<>();
709 Hashtable<String, PDBEntry> reppdb = new Hashtable<>();
711 SequenceI sqass = null;
712 for (SequenceI sq : alignPanel.av.getSequenceSelection())
714 Vector<PDBEntry> pes = sq.getDatasetSequence().getAllPDBEntries();
715 if (pes != null && pes.size() > 0)
717 reppdb.put(pes.get(0).getId(), pes.get(0));
718 for (PDBEntry pe : pes)
720 pdbe.put(pe.getId(), pe);
730 final PDBEntry[] pe = pdbe.values()
731 .toArray(new PDBEntry[pdbe.size()]),
732 pr = reppdb.values().toArray(new PDBEntry[reppdb.size()]);
733 final JMenuItem gpdbview, rpdbview;
738 groupMenu.setVisible(false);
739 editMenu.setVisible(false);
744 createGroupMenuItem.setVisible(true);
745 unGroupMenuItem.setVisible(false);
746 editGroupMenu.setText(MessageManager.getString("action.edit_new_group"));
750 createGroupMenuItem.setVisible(false);
751 unGroupMenuItem.setVisible(true);
752 editGroupMenu.setText(MessageManager.getString("action.edit_group"));
757 sequenceMenu.setVisible(false);
758 chooseStructure.setVisible(false);
759 rnaStructureMenu.setVisible(false);
762 addLinksAndFeatures(seq, column);
768 * <li>configured sequence database links (ID panel popup menu)</li>
769 * <li>non-positional feature links (ID panel popup menu)</li>
770 * <li>positional feature links (alignment panel popup menu)</li>
771 * <li>feature details links (alignment panel popup menu)</li>
773 * If this panel is also showed complementary (CDS/protein) features, then links
774 * to their feature details are also added.
779 void addLinksAndFeatures(final SequenceI seq, final int column)
781 List<SequenceFeature> features = null;
784 features = sequence.getFeatures().getNonPositionalFeatures();
788 features = ap.getFeatureRenderer().findFeaturesAtColumn(sequence,
792 addLinks(seq, features);
796 addFeatureDetails(features, seq, column);
801 * Add a menu item to show feature details for each sequence feature. Any
802 * linked 'virtual' features (CDS/protein) are also optionally found and
809 protected void addFeatureDetails(List<SequenceFeature> features,
810 final SequenceI seq, final int column)
813 * add features in CDS/protein complement at the corresponding
814 * position if configured to do so
816 MappedFeatures mf = null;
817 if (ap.av.isShowComplementFeatures())
819 if (!Comparison.isGap(sequence.getCharAt(column)))
821 AlignViewportI complement = ap.getAlignViewport()
822 .getCodingComplement();
823 AlignFrame af = Desktop.getAlignFrameFor(complement);
824 FeatureRendererModel fr2 = af.getFeatureRenderer();
825 int seqPos = sequence.findPosition(column);
826 mf = fr2.findComplementFeaturesAtResidue(sequence, seqPos);
830 if (features.isEmpty() && mf == null)
833 * no features to show at this position
838 JMenu details = new JMenu(
839 MessageManager.getString("label.feature_details"));
842 String name = seq.getName();
843 for (final SequenceFeature sf : features)
845 addFeatureDetailsMenuItem(details, name, sf, null);
850 for (final SequenceFeature sf : mf.features)
852 addFeatureDetailsMenuItem(details, name, sf, mf);
858 * A helper method to add one menu item whose action is to show details for
859 * one feature. The menu text includes feature description, but this may be
867 void addFeatureDetailsMenuItem(JMenu details, final String seqName,
868 final SequenceFeature sf, MappedFeatures mf)
870 int start = sf.getBegin();
871 int end = sf.getEnd();
875 * show local rather than linked feature coordinates
877 int[] localRange = mf.getMappedPositions(start, end);
878 if (localRange == null)
880 // e.g. variant extending to stop codon so not mappable
883 start = localRange[0];
884 end = localRange[localRange.length - 1];
886 StringBuilder desc = new StringBuilder();
887 desc.append(sf.getType()).append(" ").append(String.valueOf(start));
890 desc.append(sf.isContactFeature() ? ":" : "-");
891 desc.append(String.valueOf(end));
893 String description = sf.getDescription();
894 if (description != null)
897 description = StringUtils.stripHtmlTags(description);
900 * truncate overlong descriptions unless they contain an href
901 * (as truncation could leave corrupted html)
903 boolean hasLink = description.indexOf("a href") > -1;
904 if (description.length() > FEATURE_DESC_MAX && !hasLink)
906 description = description.substring(0, FEATURE_DESC_MAX) + "...";
908 desc.append(description);
910 String featureGroup = sf.getFeatureGroup();
911 if (featureGroup != null)
913 desc.append(" (").append(featureGroup).append(")");
915 String htmlText = JvSwingUtils.wrapTooltip(true, desc.toString());
916 JMenuItem item = new JMenuItem(htmlText);
917 item.addActionListener(new ActionListener()
920 public void actionPerformed(ActionEvent e)
922 showFeatureDetails(sf, seqName, mf);
929 * Opens a panel showing a text report of feature details
935 protected void showFeatureDetails(SequenceFeature sf, String seqName,
938 JInternalFrame details;
941 details = new JInternalFrame();
942 JPanel panel = new JPanel(new BorderLayout());
943 panel.setOpaque(true);
944 panel.setBackground(Color.white);
945 // TODO JAL-3026 set style of table correctly for feature details
946 JLabel reprt = new JLabel(MessageManager
947 .formatMessage("label.html_content", new Object[]
948 { sf.getDetailsReport(seqName, mf) }));
949 reprt.setBackground(Color.WHITE);
950 reprt.setOpaque(true);
951 panel.add(reprt, BorderLayout.CENTER);
952 details.setContentPane(panel);
962 CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
963 // it appears Java's CSS does not support border-collapse :-(
964 cap.addStylesheetRule("table { border-collapse: collapse;}");
965 cap.addStylesheetRule("table, td, th {border: 1px solid black;}");
966 cap.setText(sf.getDetailsReport(seqName, mf));
969 Desktop.addInternalFrame(details,
970 MessageManager.getString("label.feature_details"), 500, 500);
974 * Adds a 'Link' menu item with a sub-menu item for each hyperlink provided.
975 * When seq is not null, these are links for the sequence id, which may be to
976 * external web sites for the sequence accession, and/or links embedded in
977 * non-positional features. When seq is null, only links embedded in the
978 * provided features are added. If no links are found, the menu is not added.
983 void addLinks(final SequenceI seq, List<SequenceFeature> features)
985 JMenu linkMenu = buildLinkMenu(forIdPanel ? seq : null, features);
987 // only add link menu if it has entries
988 if (linkMenu.getItemCount() > 0)
992 sequenceMenu.add(linkMenu);
1002 * Add annotation types to 'Show annotations' and/or 'Hide annotations' menus.
1003 * "All" is added first, followed by a separator. Then add any annotation
1004 * types associated with the current selection. Separate menus are built for
1005 * the selected sequence group (if any), and the selected sequence.
1007 * Some annotation rows are always rendered together - these can be identified
1008 * by a common graphGroup property > -1. Only one of each group will be marked
1009 * as visible (to avoid duplication of the display). For such groups we add a
1010 * composite type name, e.g.
1012 * IUPredWS (Long), IUPredWS (Short)
1016 protected void buildAnnotationTypesMenus(JMenu showMenu, JMenu hideMenu,
1017 List<SequenceI> forSequences)
1019 showMenu.removeAll();
1020 hideMenu.removeAll();
1022 final List<String> all = Arrays
1023 .asList(new String[]
1024 { MessageManager.getString("label.all") });
1025 addAnnotationTypeToShowHide(showMenu, forSequences, "", all, true,
1027 addAnnotationTypeToShowHide(hideMenu, forSequences, "", all, true,
1029 showMenu.addSeparator();
1030 hideMenu.addSeparator();
1032 final AlignmentAnnotation[] annotations = ap.getAlignment()
1033 .getAlignmentAnnotation();
1036 * Find shown/hidden annotations types, distinguished by source (calcId),
1037 * and grouped by graphGroup. Using LinkedHashMap means we will retrieve in
1038 * the insertion order, which is the order of the annotations on the
1041 Map<String, List<List<String>>> shownTypes = new LinkedHashMap<>();
1042 Map<String, List<List<String>>> hiddenTypes = new LinkedHashMap<>();
1043 AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes, hiddenTypes,
1044 AlignmentAnnotationUtils.asList(annotations), forSequences);
1046 for (String calcId : hiddenTypes.keySet())
1048 for (List<String> type : hiddenTypes.get(calcId))
1050 addAnnotationTypeToShowHide(showMenu, forSequences, calcId, type,
1054 // grey out 'show annotations' if none are hidden
1055 showMenu.setEnabled(!hiddenTypes.isEmpty());
1057 for (String calcId : shownTypes.keySet())
1059 for (List<String> type : shownTypes.get(calcId))
1061 addAnnotationTypeToShowHide(hideMenu, forSequences, calcId, type,
1065 // grey out 'hide annotations' if none are shown
1066 hideMenu.setEnabled(!shownTypes.isEmpty());
1070 * Returns a list of sequences - either the current selection group (if there
1071 * is one), else the specified single sequence.
1076 protected List<SequenceI> getSequenceScope(SequenceI seq)
1078 List<SequenceI> forSequences = null;
1079 final SequenceGroup selectionGroup = ap.av.getSelectionGroup();
1080 if (selectionGroup != null && selectionGroup.getSize() > 0)
1082 forSequences = selectionGroup.getSequences();
1086 forSequences = seq == null ? Collections.<SequenceI> emptyList()
1087 : Arrays.asList(seq);
1089 return forSequences;
1093 * Add one annotation type to the 'Show Annotations' or 'Hide Annotations'
1096 * @param showOrHideMenu
1097 * the menu to add to
1098 * @param forSequences
1099 * the sequences whose annotations may be shown or hidden
1104 * if true this is a special label meaning 'All'
1105 * @param actionIsShow
1106 * if true, the select menu item action is to show the annotation
1109 protected void addAnnotationTypeToShowHide(JMenu showOrHideMenu,
1110 final List<SequenceI> forSequences, String calcId,
1111 final List<String> types, final boolean allTypes,
1112 final boolean actionIsShow)
1114 String label = types.toString(); // [a, b, c]
1115 label = label.substring(1, label.length() - 1); // a, b, c
1116 final JMenuItem item = new JMenuItem(label);
1117 item.setToolTipText(calcId);
1118 item.addActionListener(new ActionListener()
1121 public void actionPerformed(ActionEvent e)
1123 AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(),
1124 types, forSequences, allTypes, actionIsShow);
1128 showOrHideMenu.add(item);
1131 private void buildGroupURLMenu(SequenceGroup sg, List<String> groupLinks)
1134 // TODO: usability: thread off the generation of group url content so root
1135 // menu appears asap
1136 // sequence only URLs
1137 // ID/regex match URLs
1138 JMenu groupLinksMenu = new JMenu(
1139 MessageManager.getString("action.group_link"));
1140 // three types of url that might be created.
1141 JMenu[] linkMenus = new JMenu[] { null,
1142 new JMenu(MessageManager.getString("action.ids")),
1143 new JMenu(MessageManager.getString("action.sequences")),
1144 new JMenu(MessageManager.getString("action.ids_sequences")) };
1146 SequenceI[] seqs = ap.av.getSelectionAsNewSequence();
1147 String[][] idandseqs = GroupUrlLink.formStrings(seqs);
1148 Hashtable<String, Object[]> commonDbrefs = new Hashtable<>();
1149 for (int sq = 0; sq < seqs.length; sq++)
1152 int start = seqs[sq].findPosition(sg.getStartRes()),
1153 end = seqs[sq].findPosition(sg.getEndRes());
1154 // just collect ids from dataset sequence
1155 // TODO: check if IDs collected from selecton group intersects with the
1156 // current selection, too
1157 SequenceI sqi = seqs[sq];
1158 while (sqi.getDatasetSequence() != null)
1160 sqi = sqi.getDatasetSequence();
1162 List<DBRefEntry> dbr = sqi.getDBRefs();
1164 if (dbr != null && (nd = dbr.size()) > 0)
1166 for (int d = 0; d < nd; d++)
1168 DBRefEntry e = dbr.get(d);
1169 String src = e.getSource(); // jalview.util.DBRefUtils.getCanonicalName(dbr[d].getSource()).toUpperCase(Locale.ROOT);
1170 Object[] sarray = commonDbrefs.get(src);
1173 sarray = new Object[2];
1174 sarray[0] = new int[] { 0 };
1175 sarray[1] = new String[seqs.length];
1177 commonDbrefs.put(src, sarray);
1180 if (((String[]) sarray[1])[sq] == null)
1182 if (!e.hasMap() || (e.getMap()
1183 .locateMappedRange(start, end) != null))
1185 ((String[]) sarray[1])[sq] = e.getAccessionId();
1186 ((int[]) sarray[0])[0]++;
1192 // now create group links for all distinct ID/sequence sets.
1193 boolean addMenu = false; // indicates if there are any group links to give
1195 for (String link : groupLinks)
1197 GroupUrlLink urlLink = null;
1200 urlLink = new GroupUrlLink(link);
1201 } catch (Exception foo)
1203 Console.error("Exception for GroupURLLink '" + link + "'", foo);
1206 if (!urlLink.isValid())
1208 Console.error(urlLink.getInvalidMessage());
1211 final String label = urlLink.getLabel();
1212 boolean usingNames = false;
1213 // Now see which parts of the group apply for this URL
1214 String ltarget = urlLink.getTarget(); // jalview.util.DBRefUtils.getCanonicalName(urlLink.getTarget());
1215 Object[] idset = commonDbrefs.get(ltarget.toUpperCase(Locale.ROOT));
1216 String[] seqstr, ids; // input to makeUrl
1219 int numinput = ((int[]) idset[0])[0];
1220 String[] allids = ((String[]) idset[1]);
1221 seqstr = new String[numinput];
1222 ids = new String[numinput];
1223 for (int sq = 0, idcount = 0; sq < seqs.length; sq++)
1225 if (allids[sq] != null)
1227 ids[idcount] = allids[sq];
1228 seqstr[idcount++] = idandseqs[1][sq];
1234 // just use the id/seq set
1235 seqstr = idandseqs[1];
1239 // and try and make the groupURL!
1241 Object[] urlset = null;
1244 urlset = urlLink.makeUrlStubs(ids, seqstr,
1245 "FromJalview" + System.currentTimeMillis(), false);
1246 } catch (UrlStringTooLongException e)
1251 int type = urlLink.getGroupURLType() & 3;
1252 // first two bits ofurlLink type bitfield are sequenceids and sequences
1253 // TODO: FUTURE: ensure the groupURL menu structure can be generalised
1254 addshowLink(linkMenus[type],
1255 label + (((type & 1) == 1)
1256 ? ("(" + (usingNames ? "Names" : ltarget) + ")")
1264 groupLinksMenu = new JMenu(
1265 MessageManager.getString("action.group_link"));
1266 for (int m = 0; m < linkMenus.length; m++)
1268 if (linkMenus[m] != null
1269 && linkMenus[m].getMenuComponentCount() > 0)
1271 groupLinksMenu.add(linkMenus[m]);
1275 groupMenu.add(groupLinksMenu);
1285 private void jbInit() throws Exception
1287 groupMenu.setText(MessageManager.getString("label.selection"));
1288 groupName.setText(MessageManager.getString("label.name"));
1289 groupName.addActionListener(new ActionListener()
1292 public void actionPerformed(ActionEvent e)
1294 groupName_actionPerformed();
1297 sequenceMenu.setText(MessageManager.getString("label.sequence"));
1299 JMenuItem sequenceName = new JMenuItem(
1300 MessageManager.getString("label.edit_name_description"));
1301 sequenceName.addActionListener(new ActionListener()
1304 public void actionPerformed(ActionEvent e)
1306 sequenceName_actionPerformed();
1309 JMenuItem chooseAnnotations = new JMenuItem(
1310 MessageManager.getString("action.choose_annotations"));
1311 chooseAnnotations.addActionListener(new ActionListener()
1314 public void actionPerformed(ActionEvent e)
1316 chooseAnnotations_actionPerformed(e);
1319 JMenuItem sequenceDetails = new JMenuItem(
1320 MessageManager.getString("label.sequence_details"));
1321 sequenceDetails.addActionListener(new ActionListener()
1324 public void actionPerformed(ActionEvent e)
1326 createSequenceDetailsReport(new SequenceI[] { sequence });
1329 JMenuItem sequenceSelDetails = new JMenuItem(
1330 MessageManager.getString("label.sequence_details"));
1331 sequenceSelDetails.addActionListener(new ActionListener()
1334 public void actionPerformed(ActionEvent e)
1336 createSequenceDetailsReport(ap.av.getSequenceSelection());
1341 .setText(MessageManager.getString("action.remove_group"));
1342 unGroupMenuItem.addActionListener(new ActionListener()
1345 public void actionPerformed(ActionEvent e)
1347 unGroupMenuItem_actionPerformed();
1351 .setText(MessageManager.getString("action.create_group"));
1352 createGroupMenuItem.addActionListener(new ActionListener()
1355 public void actionPerformed(ActionEvent e)
1357 createGroupMenuItem_actionPerformed();
1361 JMenuItem outline = new JMenuItem(
1362 MessageManager.getString("action.border_colour"));
1363 outline.addActionListener(new ActionListener()
1366 public void actionPerformed(ActionEvent e)
1368 outline_actionPerformed();
1371 showBoxes.setText(MessageManager.getString("action.boxes"));
1372 showBoxes.setState(true);
1373 showBoxes.addActionListener(new ActionListener()
1376 public void actionPerformed(ActionEvent e)
1378 showBoxes_actionPerformed();
1381 showText.setText(MessageManager.getString("action.text"));
1382 showText.setState(true);
1383 showText.addActionListener(new ActionListener()
1386 public void actionPerformed(ActionEvent e)
1388 showText_actionPerformed();
1391 showColourText.setText(MessageManager.getString("label.colour_text"));
1392 showColourText.addActionListener(new ActionListener()
1395 public void actionPerformed(ActionEvent e)
1397 showColourText_actionPerformed();
1401 .setText(MessageManager.getString("label.show_non_conserved"));
1402 displayNonconserved.setState(true);
1403 displayNonconserved.addActionListener(new ActionListener()
1406 public void actionPerformed(ActionEvent e)
1408 showNonconserved_actionPerformed();
1411 editMenu.setText(MessageManager.getString("action.edit"));
1412 JMenuItem cut = new JMenuItem(MessageManager.getString("action.cut"));
1413 cut.addActionListener(new ActionListener()
1416 public void actionPerformed(ActionEvent e)
1418 cut_actionPerformed();
1421 upperCase.setText(MessageManager.getString("label.to_upper_case"));
1422 upperCase.addActionListener(new ActionListener()
1425 public void actionPerformed(ActionEvent e)
1430 JMenuItem copy = new JMenuItem(MessageManager.getString("action.copy"));
1431 copy.addActionListener(new ActionListener()
1434 public void actionPerformed(ActionEvent e)
1436 copy_actionPerformed();
1439 lowerCase.setText(MessageManager.getString("label.to_lower_case"));
1440 lowerCase.addActionListener(new ActionListener()
1443 public void actionPerformed(ActionEvent e)
1448 toggle.setText(MessageManager.getString("label.toggle_case"));
1449 toggle.addActionListener(new ActionListener()
1452 public void actionPerformed(ActionEvent e)
1458 MessageManager.getString("label.out_to_textbox") + "...");
1459 seqShowAnnotationsMenu
1460 .setText(MessageManager.getString("label.show_annotations"));
1461 seqHideAnnotationsMenu
1462 .setText(MessageManager.getString("label.hide_annotations"));
1463 groupShowAnnotationsMenu
1464 .setText(MessageManager.getString("label.show_annotations"));
1465 groupHideAnnotationsMenu
1466 .setText(MessageManager.getString("label.hide_annotations"));
1467 JMenuItem sequenceFeature = new JMenuItem(
1468 MessageManager.getString("label.create_sequence_feature"));
1469 sequenceFeature.addActionListener(new ActionListener()
1472 public void actionPerformed(ActionEvent e)
1474 sequenceFeature_actionPerformed();
1477 editGroupMenu.setText(MessageManager.getString("label.group"));
1478 chooseStructure.setText(
1479 MessageManager.getString("label.show_pdbstruct_dialog"));
1480 chooseStructure.addActionListener(new ActionListener()
1483 public void actionPerformed(ActionEvent actionEvent)
1485 SequenceI[] selectedSeqs = new SequenceI[] { sequence };
1486 if (ap.av.getSelectionGroup() != null)
1488 selectedSeqs = ap.av.getSequenceSelection();
1490 new StructureChooser(selectedSeqs, sequence, ap);
1495 .setText(MessageManager.getString("label.view_rna_structure"));
1497 // colStructureMenu.setText("Colour By Structure");
1498 JMenuItem editSequence = new JMenuItem(
1499 MessageManager.getString("label.edit_sequence") + "...");
1500 editSequence.addActionListener(new ActionListener()
1503 public void actionPerformed(ActionEvent actionEvent)
1505 editSequence_actionPerformed();
1508 makeReferenceSeq.setText(
1509 MessageManager.getString("label.mark_as_representative"));
1510 makeReferenceSeq.addActionListener(new ActionListener()
1514 public void actionPerformed(ActionEvent actionEvent)
1516 makeReferenceSeq_actionPerformed(actionEvent);
1521 groupMenu.add(sequenceSelDetails);
1524 add(rnaStructureMenu);
1525 add(chooseStructure);
1528 JMenuItem hideInsertions = new JMenuItem(
1529 MessageManager.getString("label.hide_insertions"));
1530 hideInsertions.addActionListener(new ActionListener()
1534 public void actionPerformed(ActionEvent e)
1536 hideInsertions_actionPerformed(e);
1539 add(hideInsertions);
1541 // annotations configuration panel suppressed for now
1542 // groupMenu.add(chooseAnnotations);
1545 * Add show/hide annotations to the Sequence menu, and to the Selection menu
1546 * (if a selection group is in force).
1548 sequenceMenu.add(seqShowAnnotationsMenu);
1549 sequenceMenu.add(seqHideAnnotationsMenu);
1550 sequenceMenu.add(seqAddReferenceAnnotations);
1551 groupMenu.add(groupShowAnnotationsMenu);
1552 groupMenu.add(groupHideAnnotationsMenu);
1553 groupMenu.add(groupAddReferenceAnnotations);
1554 groupMenu.add(editMenu);
1555 groupMenu.add(outputMenu);
1556 groupMenu.add(sequenceFeature);
1557 groupMenu.add(createGroupMenuItem);
1558 groupMenu.add(unGroupMenuItem);
1559 groupMenu.add(editGroupMenu);
1560 sequenceMenu.add(sequenceName);
1561 sequenceMenu.add(sequenceDetails);
1562 sequenceMenu.add(makeReferenceSeq);
1569 editMenu.add(editSequence);
1570 editMenu.add(upperCase);
1571 editMenu.add(lowerCase);
1572 editMenu.add(toggle);
1573 editGroupMenu.add(groupName);
1574 editGroupMenu.add(colourMenu);
1575 editGroupMenu.add(showBoxes);
1576 editGroupMenu.add(showText);
1577 editGroupMenu.add(showColourText);
1578 editGroupMenu.add(outline);
1579 editGroupMenu.add(displayNonconserved);
1583 * Constructs the entries for the colour menu
1585 protected void initColourMenu()
1587 colourMenu.setText(MessageManager.getString("label.group_colour"));
1588 textColour.setText(MessageManager.getString("label.text_colour"));
1589 textColour.addActionListener(new ActionListener()
1592 public void actionPerformed(ActionEvent e)
1594 textColour_actionPerformed();
1598 abovePIDColour.setText(
1599 MessageManager.getString("label.above_identity_threshold"));
1600 abovePIDColour.addActionListener(new ActionListener()
1603 public void actionPerformed(ActionEvent e)
1605 abovePIDColour_actionPerformed(abovePIDColour.isSelected());
1610 MessageManager.getString("label.modify_identity_threshold"));
1611 modifyPID.addActionListener(new ActionListener()
1614 public void actionPerformed(ActionEvent e)
1616 modifyPID_actionPerformed();
1620 conservationMenuItem
1621 .setText(MessageManager.getString("action.by_conservation"));
1622 conservationMenuItem.addActionListener(new ActionListener()
1625 public void actionPerformed(ActionEvent e)
1627 conservationMenuItem_actionPerformed(
1628 conservationMenuItem.isSelected());
1632 annotationColour = new JRadioButtonMenuItem(
1633 MessageManager.getString("action.by_annotation"));
1634 annotationColour.setName(ResidueColourScheme.ANNOTATION_COLOUR);
1635 annotationColour.setEnabled(false);
1636 annotationColour.setToolTipText(
1637 MessageManager.getString("label.by_annotation_tooltip"));
1639 modifyConservation.setText(MessageManager
1640 .getString("label.modify_conservation_threshold"));
1641 modifyConservation.addActionListener(new ActionListener()
1644 public void actionPerformed(ActionEvent e)
1646 modifyConservation_actionPerformed();
1652 * Builds the group colour sub-menu, including any user-defined colours which
1653 * were loaded at startup or during the Jalview session
1655 protected void buildColourMenu()
1657 SequenceGroup sg = ap.av.getSelectionGroup();
1661 * popup menu with no sequence group scope
1665 colourMenu.removeAll();
1666 colourMenu.add(textColour);
1667 colourMenu.addSeparator();
1669 ButtonGroup bg = ColourMenuHelper.addMenuItems(colourMenu, this, sg,
1671 bg.add(annotationColour);
1672 colourMenu.add(annotationColour);
1674 colourMenu.addSeparator();
1675 colourMenu.add(conservationMenuItem);
1676 colourMenu.add(modifyConservation);
1677 colourMenu.add(abovePIDColour);
1678 colourMenu.add(modifyPID);
1681 protected void modifyConservation_actionPerformed()
1683 SequenceGroup sg = getGroup();
1686 SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
1687 SliderPanel.showConservationSlider();
1691 protected void modifyPID_actionPerformed()
1693 SequenceGroup sg = getGroup();
1696 // int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
1698 // sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1699 SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup().getName());
1700 SliderPanel.showPIDSlider();
1705 * Check for any annotations on the underlying dataset sequences (for the
1706 * current selection group) which are not 'on the alignment'.If any are found,
1707 * enable the option to add them to the alignment. The criteria for 'on the
1708 * alignment' is finding an alignment annotation on the alignment, matched on
1709 * calcId, label and sequenceRef.
1711 * A tooltip is also constructed that displays the source (calcId) and type
1712 * (label) of the annotations that can be added.
1715 * @param forSequences
1717 protected void configureReferenceAnnotationsMenu(JMenuItem menuItem,
1718 List<SequenceI> forSequences)
1720 menuItem.setEnabled(false);
1723 * Temporary store to hold distinct calcId / type pairs for the tooltip.
1724 * Using TreeMap means calcIds are shown in alphabetical order.
1726 SortedMap<String, String> tipEntries = new TreeMap<>();
1727 final Map<SequenceI, List<AlignmentAnnotation>> candidates = new LinkedHashMap<>();
1728 AlignmentI al = this.ap.av.getAlignment();
1729 AlignmentUtils.findAddableReferenceAnnotations(forSequences, tipEntries,
1731 if (!candidates.isEmpty())
1733 StringBuilder tooltip = new StringBuilder(64);
1734 tooltip.append(MessageManager.getString("label.add_annotations_for"));
1737 * Found annotations that could be added. Enable the menu item, and
1738 * configure its tooltip and action.
1740 menuItem.setEnabled(true);
1741 for (String calcId : tipEntries.keySet())
1743 tooltip.append("<br/>" + calcId + "/" + tipEntries.get(calcId));
1745 String tooltipText = JvSwingUtils.wrapTooltip(true,
1746 tooltip.toString());
1747 menuItem.setToolTipText(tooltipText);
1749 menuItem.addActionListener(new ActionListener()
1752 public void actionPerformed(ActionEvent e)
1754 addReferenceAnnotations_actionPerformed(candidates);
1761 * Add annotations to the sequences and to the alignment.
1764 * a map whose keys are sequences on the alignment, and values a list
1765 * of annotations to add to each sequence
1767 protected void addReferenceAnnotations_actionPerformed(
1768 Map<SequenceI, List<AlignmentAnnotation>> candidates)
1770 final SequenceGroup selectionGroup = this.ap.av.getSelectionGroup();
1771 final AlignmentI alignment = this.ap.getAlignment();
1772 AlignmentUtils.addReferenceAnnotations(candidates, alignment,
1777 protected void makeReferenceSeq_actionPerformed(ActionEvent actionEvent)
1779 if (!ap.av.getAlignment().hasSeqrep())
1781 // initialise the display flags so the user sees something happen
1782 ap.av.setDisplayReferenceSeq(true);
1783 ap.av.setColourByReferenceSeq(true);
1784 ap.av.getAlignment().setSeqrep(sequence);
1788 if (ap.av.getAlignment().getSeqrep() == sequence)
1790 ap.av.getAlignment().setSeqrep(null);
1794 ap.av.getAlignment().setSeqrep(sequence);
1800 protected void hideInsertions_actionPerformed(ActionEvent actionEvent)
1802 HiddenColumns hidden = ap.av.getAlignment().getHiddenColumns();
1803 BitSet inserts = new BitSet();
1805 boolean markedPopup = false;
1806 // mark inserts in current selection
1807 if (ap.av.getSelectionGroup() != null)
1809 // mark just the columns in the selection group to be hidden
1810 inserts.set(ap.av.getSelectionGroup().getStartRes(),
1811 ap.av.getSelectionGroup().getEndRes() + 1); // TODO why +1?
1813 // now clear columns without gaps
1814 for (SequenceI sq : ap.av.getSelectionGroup().getSequences())
1820 inserts.and(sq.getInsertionsAsBits());
1822 hidden.clearAndHideColumns(inserts, ap.av.getSelectionGroup().getStartRes(),
1823 ap.av.getSelectionGroup().getEndRes());
1826 // now mark for sequence under popup if we haven't already done it
1827 else if (!markedPopup && sequence != null)
1829 inserts.or(sequence.getInsertionsAsBits());
1831 // and set hidden columns accordingly
1832 hidden.hideColumns(inserts);
1837 protected void sequenceSelectionDetails_actionPerformed()
1839 createSequenceDetailsReport(ap.av.getSequenceSelection());
1842 public void createSequenceDetailsReport(SequenceI[] sequences)
1844 StringBuilder contents = new StringBuilder(128);
1845 contents.append("<html><body>");
1846 for (SequenceI seq : sequences)
1848 contents.append("<p><h2>" + MessageManager.formatMessage(
1849 "label.create_sequence_details_report_annotation_for",
1851 { seq.getDisplayId(true) }) + "</h2></p>\n<p>");
1852 new SequenceAnnotationReport(false).createSequenceAnnotationReport(
1853 contents, seq, true, true, ap.getSeqPanel().seqCanvas.fr);
1854 contents.append("</p>");
1856 contents.append("</body></html>");
1857 String report = contents.toString();
1859 JInternalFrame frame;
1860 if (Platform.isJS())
1862 JLabel textLabel = new JLabel();
1863 textLabel.setText(report);
1864 textLabel.setBackground(Color.WHITE);
1865 JPanel pane = new JPanel(new BorderLayout());
1866 pane.setOpaque(true);
1867 pane.setBackground(Color.WHITE);
1868 pane.add(textLabel, BorderLayout.NORTH);
1869 frame = new JInternalFrame();
1870 frame.getContentPane().add(new JScrollPane(pane));
1879 CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
1880 cap.setText(report);
1884 Desktop.addInternalFrame(frame,
1885 MessageManager.formatMessage("label.sequence_details_for",
1886 (sequences.length == 1 ? new Object[]
1887 { sequences[0].getDisplayId(true) }
1890 .getString("label.selection") })),
1894 protected void showNonconserved_actionPerformed()
1896 getGroup().setShowNonconserved(displayNonconserved.isSelected());
1901 * call to refresh view after settings change
1905 ap.updateAnnotation();
1906 // removed paintAlignment(true) here:
1907 // updateAnnotation calls paintAlignment already, so don't need to call
1910 PaintRefresher.Refresh(this, ap.av.getSequenceSetId());
1914 * protected void covariationColour_actionPerformed() { getGroup().cs = new
1915 * CovariationColourScheme(sequence.getAnnotation()[0]); refresh(); }
1925 public void abovePIDColour_actionPerformed(boolean selected)
1927 SequenceGroup sg = getGroup();
1935 sg.cs.setConsensus(AAFrequency.calculate(
1936 sg.getSequences(ap.av.getHiddenRepSequences()),
1937 sg.getStartRes(), sg.getEndRes() + 1));
1939 int threshold = SliderPanel.setPIDSliderSource(ap,
1940 sg.getGroupColourScheme(), getGroup().getName());
1942 sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1944 SliderPanel.showPIDSlider();
1947 // remove PIDColouring
1949 sg.cs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
1950 SliderPanel.hidePIDSlider();
1952 modifyPID.setEnabled(selected);
1958 * Open a panel where the user can choose which types of sequence annotation
1963 protected void chooseAnnotations_actionPerformed(ActionEvent e)
1965 // todo correct way to guard against opening a duplicate panel?
1966 new AnnotationChooser(ap);
1975 public void conservationMenuItem_actionPerformed(boolean selected)
1977 SequenceGroup sg = getGroup();
1985 // JBPNote: Conservation name shouldn't be i18n translated
1986 Conservation c = new Conservation("Group",
1987 sg.getSequences(ap.av.getHiddenRepSequences()),
1988 sg.getStartRes(), sg.getEndRes() + 1);
1991 c.verdict(false, ap.av.getConsPercGaps());
1992 sg.cs.setConservation(c);
1994 SliderPanel.setConservationSlider(ap, sg.getGroupColourScheme(),
1996 SliderPanel.showConservationSlider();
1999 // remove ConservationColouring
2001 sg.cs.setConservation(null);
2002 SliderPanel.hideConservationSlider();
2004 modifyConservation.setEnabled(selected);
2010 * Shows a dialog where group name and description may be edited
2012 protected void groupName_actionPerformed()
2014 SequenceGroup sg = getGroup();
2015 EditNameDialog dialog = new EditNameDialog(sg.getName(),
2016 sg.getDescription(),
2017 MessageManager.getString("label.group_name"),
2018 MessageManager.getString("label.group_description"));
2019 dialog.showDialog(ap.alignFrame,
2020 MessageManager.getString("label.edit_group_name_description"),
2026 sg.setName(dialog.getName());
2027 sg.setDescription(dialog.getDescription());
2034 * Get selection group - adding it to the alignment if necessary.
2036 * @return sequence group to operate on
2038 SequenceGroup getGroup()
2040 SequenceGroup sg = ap.av.getSelectionGroup();
2041 // this method won't add a new group if it already exists
2044 ap.av.getAlignment().addGroup(sg);
2051 * Shows a dialog where the sequence name and description may be edited. If a
2052 * name containing spaces is entered, these are converted to underscores, with a
2055 void sequenceName_actionPerformed()
2057 EditNameDialog dialog = new EditNameDialog(sequence.getName(),
2058 sequence.getDescription(),
2059 MessageManager.getString("label.sequence_name"),
2060 MessageManager.getString("label.sequence_description"));
2061 dialog.showDialog(ap.alignFrame,
2062 MessageManager.getString(
2063 "label.edit_sequence_name_description"),
2069 if (dialog.getName() != null)
2071 if (dialog.getName().indexOf(" ") > -1)
2073 JvOptionPane.showMessageDialog(ap,
2074 MessageManager.getString(
2075 "label.spaces_converted_to_underscores"),
2076 MessageManager.getString(
2077 "label.no_spaces_allowed_sequence_name"),
2078 JvOptionPane.WARNING_MESSAGE);
2080 sequence.setName(dialog.getName().replace(' ', '_'));
2081 ap.paintAlignment(false, false);
2083 sequence.setDescription(dialog.getDescription());
2084 ap.av.notifyAlignment();
2095 void unGroupMenuItem_actionPerformed()
2097 SequenceGroup sg = ap.av.getSelectionGroup();
2098 ap.av.getAlignment().deleteGroup(sg);
2099 ap.av.setSelectionGroup(null);
2103 void createGroupMenuItem_actionPerformed()
2105 getGroup(); // implicitly creates group - note - should apply defaults / use
2106 // standard alignment window logic for this
2111 * Offers a colour chooser and sets the selected colour as the group outline
2113 protected void outline_actionPerformed()
2115 String title = MessageManager
2116 .getString("label.select_outline_colour");
2117 ColourChooserListener listener = new ColourChooserListener()
2120 public void colourSelected(Color c)
2122 getGroup().setOutlineColour(c);
2126 JalviewColourChooser.showColourChooser(Desktop.getDesktopPane(),
2127 title, Color.BLUE, listener);
2136 public void showBoxes_actionPerformed()
2138 getGroup().setDisplayBoxes(showBoxes.isSelected());
2148 public void showText_actionPerformed()
2150 getGroup().setDisplayText(showText.isSelected());
2160 public void showColourText_actionPerformed()
2162 getGroup().setColourText(showColourText.isSelected());
2166 void hideSequences(boolean representGroup)
2168 ap.av.hideSequences(sequence, representGroup);
2171 public void copy_actionPerformed()
2173 ap.alignFrame.copy_actionPerformed();
2176 public void cut_actionPerformed()
2178 ap.alignFrame.cut_actionPerformed();
2181 void changeCase(ActionEvent e)
2183 Object source = e.getSource();
2184 SequenceGroup sg = ap.av.getSelectionGroup();
2188 List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
2189 sg.getStartRes(), sg.getEndRes() + 1);
2194 if (source == toggle)
2196 description = MessageManager.getString("label.toggle_case");
2197 caseChange = ChangeCaseCommand.TOGGLE_CASE;
2199 else if (source == upperCase)
2201 description = MessageManager.getString("label.to_upper_case");
2202 caseChange = ChangeCaseCommand.TO_UPPER;
2206 description = MessageManager.getString("label.to_lower_case");
2207 caseChange = ChangeCaseCommand.TO_LOWER;
2210 ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
2211 sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
2212 startEnd, caseChange);
2214 ap.alignFrame.addHistoryItem(caseCommand);
2215 ap.av.notifyAlignment();
2221 public void outputText_actionPerformed(ActionEvent e)
2223 CutAndPasteTransfer cap = new CutAndPasteTransfer();
2224 cap.setForInput(null);
2225 Desktop.addInternalFrame(cap, MessageManager
2226 .formatMessage("label.alignment_output_command", new Object[]
2227 { e.getActionCommand() }), 600, 500);
2229 String[] omitHidden = null;
2231 System.out.println("PROMPT USER HERE"); // TODO: decide if a prompt happens
2232 // or we simply trust the user wants
2233 // wysiwig behaviour
2235 FileFormatI fileFormat = FileFormats.getInstance()
2236 .forName(e.getActionCommand());
2238 new FormatAdapter(ap).formatSequences(fileFormat, ap, true));
2241 public void sequenceFeature_actionPerformed()
2243 SequenceGroup sg = ap.av.getSelectionGroup();
2249 List<SequenceI> seqs = new ArrayList<>();
2250 List<SequenceFeature> features = new ArrayList<>();
2253 * assemble dataset sequences, and template new sequence features,
2254 * for the amend features dialog
2256 int gSize = sg.getSize();
2257 for (int i = 0; i < gSize; i++)
2259 int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
2260 int end = sg.findEndRes(sg.getSequenceAt(i));
2263 seqs.add(sg.getSequenceAt(i).getDatasetSequence());
2264 features.add(new SequenceFeature(null, null, start, end, null));
2269 * an entirely gapped region will generate empty lists of sequence / features
2271 if (!seqs.isEmpty())
2273 new FeatureEditor(ap, seqs, features, true).showDialog();
2277 public void textColour_actionPerformed()
2279 SequenceGroup sg = getGroup();
2282 new TextColourChooser().chooseColour(ap, sg);
2287 * Shows a dialog where sequence characters may be edited. Any changes are
2288 * applied, and added as an available 'Undo' item in the edit commands
2291 public void editSequence_actionPerformed()
2293 SequenceGroup sg = ap.av.getSelectionGroup();
2295 SequenceI seq = sequence;
2300 seq = sg.getSequenceAt(0);
2303 EditNameDialog dialog = new EditNameDialog(
2304 seq.getSequenceAsString(sg.getStartRes(), sg.getEndRes() + 1),
2305 null, MessageManager.getString("label.edit_sequence"), null);
2306 dialog.showDialog(ap.alignFrame,
2307 MessageManager.getString("label.edit_sequence"),
2313 EditCommand editCommand = new EditCommand(
2314 MessageManager.getString("label.edit_sequences"),
2316 dialog.getName().replace(' ',
2317 ap.av.getGapCharacter()),
2318 sg.getSequencesAsArray(
2319 ap.av.getHiddenRepSequences()),
2320 sg.getStartRes(), sg.getEndRes() + 1,
2321 ap.av.getAlignment());
2322 ap.alignFrame.addHistoryItem(editCommand);
2323 ap.av.notifyAlignment();
2330 * Action on user selecting an item from the colour menu (that does not have
2331 * its bespoke action handler)
2336 public void changeColour_actionPerformed(String colourSchemeName)
2338 SequenceGroup sg = getGroup();
2340 * switch to the chosen colour scheme (or null for None)
2342 ColourSchemeI colourScheme = ColourSchemes.getInstance()
2343 .getColourScheme(colourSchemeName, ap.av, sg,
2344 ap.av.getHiddenRepSequences());
2345 sg.setColourScheme(colourScheme);
2346 if (colourScheme instanceof Blosum62ColourScheme
2347 || colourScheme instanceof PIDColourScheme)
2349 sg.cs.setConsensus(AAFrequency.calculate(
2350 sg.getSequences(ap.av.getHiddenRepSequences()),
2351 sg.getStartRes(), sg.getEndRes() + 1));