2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
3 * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 package jalview.appletgui;
24 import java.awt.event.*;
26 import jalview.analysis.*;
27 import jalview.commands.*;
28 import jalview.datamodel.*;
29 import jalview.schemes.*;
30 import jalview.util.UrlLink;
31 import jalview.io.AppletFormatAdapter;
33 public class APopupMenu extends java.awt.PopupMenu implements
34 ActionListener, ItemListener
36 Menu groupMenu = new Menu();
38 MenuItem editGroupName = new MenuItem();
40 protected MenuItem clustalColour = new MenuItem();
42 protected MenuItem zappoColour = new MenuItem();
44 protected MenuItem taylorColour = new MenuItem();
46 protected MenuItem hydrophobicityColour = new MenuItem();
48 protected MenuItem helixColour = new MenuItem();
50 protected MenuItem strandColour = new MenuItem();
52 protected MenuItem turnColour = new MenuItem();
54 protected MenuItem buriedColour = new MenuItem();
56 protected CheckboxMenuItem abovePIDColour = new CheckboxMenuItem();
58 protected MenuItem userDefinedColour = new MenuItem();
60 protected MenuItem PIDColour = new MenuItem();
62 protected MenuItem BLOSUM62Colour = new MenuItem();
64 MenuItem noColourmenuItem = new MenuItem();
66 protected CheckboxMenuItem conservationMenuItem = new CheckboxMenuItem();
68 final AlignmentPanel ap;
70 MenuItem unGroupMenuItem = new MenuItem();
72 MenuItem nucleotideMenuItem = new MenuItem();
74 Menu colourMenu = new Menu();
76 CheckboxMenuItem showBoxes = new CheckboxMenuItem();
78 CheckboxMenuItem showText = new CheckboxMenuItem();
80 CheckboxMenuItem showColourText = new CheckboxMenuItem();
82 Menu editMenu = new Menu("Edit");
84 MenuItem copy = new MenuItem("Copy (Jalview Only)");
86 MenuItem cut = new MenuItem("Cut (Jalview Only)");
88 MenuItem toUpper = new MenuItem("To Upper Case");
90 MenuItem toLower = new MenuItem("To Lower Case");
92 MenuItem toggleCase = new MenuItem("Toggle Case");
94 Menu outputmenu = new Menu();
96 Menu seqMenu = new Menu();
98 MenuItem pdb = new MenuItem();
100 MenuItem hideSeqs = new MenuItem();
102 MenuItem repGroup = new MenuItem();
104 MenuItem sequenceName = new MenuItem("Edit Name/Description");
106 MenuItem sequenceFeature = new MenuItem("Create Sequence Feature");
108 MenuItem editSequence = new MenuItem("Edit Sequence");
112 MenuItem revealAll = new MenuItem();
114 Menu menu1 = new Menu();
116 public APopupMenu(AlignmentPanel apanel, final Sequence seq, Vector links)
118 // /////////////////////////////////////////////////////////
119 // If this is activated from the sequence panel, the user may want to
120 // edit or annotate a particular residue. Therefore display the residue menu
122 // If from the IDPanel, we must display the sequence menu
123 // ////////////////////////////////////////////////////////
131 } catch (Exception e)
136 for (int i = 0; i < jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS.length; i++)
138 MenuItem item = new MenuItem(
139 jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS[i]);
141 item.addActionListener(this);
142 outputmenu.add(item);
145 SequenceGroup sg = ap.av.getSelectionGroup();
147 if (sg != null && sg.getSize() > 0)
149 editGroupName.setLabel(sg.getName());
150 showText.setState(sg.getDisplayText());
151 showColourText.setState(sg.getColourText());
152 showBoxes.setState(sg.getDisplayBoxes());
153 if (!ap.av.alignment.getGroups().contains(sg))
155 groupMenu.remove(unGroupMenuItem);
165 if (links != null && links.size() > 0)
167 Menu linkMenu = new Menu("Link");
169 for (int i = 0; i < links.size(); i++)
171 link = links.elementAt(i).toString();
172 UrlLink urlLink = new UrlLink(link);
173 if (!urlLink.isValid())
175 System.err.println(urlLink.getInvalidMessage());
178 final String target = urlLink.getTarget(); // link.substring(0,
179 // link.indexOf("|"));
180 final String label = urlLink.getLabel();
181 if (urlLink.isDynamic())
184 // collect matching db-refs
185 DBRefEntry[] dbr = jalview.util.DBRefUtils.selectRefs(seq
186 .getDBRef(), new String[]
188 // collect id string too
189 String id = seq.getName();
192 for (int r = 0; r < dbr.length; r++)
194 if (id != null && dbr[r].getAccessionId().equals(id))
196 // suppress duplicate link creation for the bare sequence ID
197 // string with this link
200 // create Bare ID link for this RUL
201 String[] urls = urlLink.makeUrls(dbr[r].getAccessionId(),
205 for (int u = 0; u < urls.length; u += 2)
207 addshowLink(linkMenu, label + "|" + urls[u], urls[u + 1]);
214 // create Bare ID link for this RUL
215 String[] urls = urlLink.makeUrls(id, true);
218 for (int u = 0; u < urls.length; u += 2)
220 addshowLink(linkMenu, label, urls[u + 1]);
223 // addshowLink(linkMenu, target, url_pref + id + url_suff);
228 addshowLink(linkMenu, target, urlLink.getUrl_prefix()); // link.substring(link.lastIndexOf("|")+1));
233 * if (link.indexOf("$SEQUENCE_ID$") > -1) { // Substitute SEQUENCE_ID
234 * string and any matching database reference accessions String url_pref =
235 * link.substring(link.indexOf("|") + 1, link.indexOf("$SEQUENCE_ID$"));
237 * String url_suff = link.substring(link.indexOf("$SEQUENCE_ID$") + 13);
238 * // collect matching db-refs DBRefEntry[] dbr =
239 * jalview.util.DBRefUtils.selectRefs(seq.getDBRef(), new
240 * String[]{target}); // collect id string too String id =
241 * seq.getName(); if (id.indexOf("|") > -1) { id =
242 * id.substring(id.lastIndexOf("|") + 1); } if (dbr!=null) { for (int
243 * r=0;r<dbr.length; r++) { if (dbr[r].getAccessionId().equals(id)) { //
244 * suppress duplicate link creation for the bare sequence ID string with
245 * this link id = null; } addshowLink(linkMenu,
246 * dbr[r].getSource()+"|"+dbr[r].getAccessionId(), target,
247 * url_pref+dbr[r].getAccessionId()+url_suff); } } if (id!=null) { //
248 * create Bare ID link for this RUL addshowLink(linkMenu, target,
249 * url_pref + id + url_suff); } } else { addshowLink(linkMenu, target,
250 * link.substring(link.lastIndexOf("|")+1)); }
256 seqMenu.add(linkMenu);
265 seqMenu.setLabel(seq.getName());
266 repGroup.setLabel("Represent Group with " + seq.getName());
273 if (!ap.av.hasHiddenRows)
280 * add a show URL menu item to the given linkMenu
288 private void addshowLink(Menu linkMenu, final String target,
291 addshowLink(linkMenu, target, target, url);
295 * add a show URL menu item to the given linkMenu
305 private void addshowLink(Menu linkMenu, final String target,
306 final String label, final String url)
308 MenuItem item = new MenuItem(label);
309 item.addActionListener(new java.awt.event.ActionListener()
311 public void actionPerformed(ActionEvent e)
313 ap.alignFrame.showURL(url, target);
319 public void itemStateChanged(ItemEvent evt)
321 if (evt.getSource() == abovePIDColour)
323 abovePIDColour_itemStateChanged();
325 else if (evt.getSource() == showColourText)
327 showColourText_itemStateChanged();
329 else if (evt.getSource() == showText)
331 showText_itemStateChanged();
333 else if (evt.getSource() == showBoxes)
335 showBoxes_itemStateChanged();
339 public void actionPerformed(ActionEvent evt)
341 Object source = evt.getSource();
342 if (source == clustalColour)
344 clustalColour_actionPerformed();
346 else if (source == zappoColour)
348 zappoColour_actionPerformed();
350 else if (source == taylorColour)
352 taylorColour_actionPerformed();
354 else if (source == hydrophobicityColour)
356 hydrophobicityColour_actionPerformed();
358 else if (source == helixColour)
360 helixColour_actionPerformed();
362 else if (source == strandColour)
364 strandColour_actionPerformed();
366 else if (source == turnColour)
368 turnColour_actionPerformed();
370 else if (source == buriedColour)
372 buriedColour_actionPerformed();
374 else if (source == nucleotideMenuItem)
376 nucleotideMenuItem_actionPerformed();
379 else if (source == userDefinedColour)
381 userDefinedColour_actionPerformed();
383 else if (source == PIDColour)
385 PIDColour_actionPerformed();
387 else if (source == BLOSUM62Colour)
389 BLOSUM62Colour_actionPerformed();
391 else if (source == noColourmenuItem)
393 noColourmenuItem_actionPerformed();
395 else if (source == conservationMenuItem)
397 conservationMenuItem_itemStateChanged();
399 else if (source == unGroupMenuItem)
401 unGroupMenuItem_actionPerformed();
404 else if (source == sequenceName)
408 else if (source == pdb)
412 else if (source == hideSeqs)
414 hideSequences(false);
416 else if (source == repGroup)
420 else if (source == revealAll)
422 ap.av.showAllHiddenSeqs();
425 else if (source == editGroupName)
427 EditNameDialog dialog = new EditNameDialog(getGroup().getName(),
428 getGroup().getDescription(), " Group Name",
429 "Group Description", ap.alignFrame,
430 "Edit Group Name / Description", 500, 100, true);
434 getGroup().setName(dialog.getName().replace(' ', '_'));
435 getGroup().setDescription(dialog.getDescription());
439 else if (source == copy)
441 ap.alignFrame.copy_actionPerformed();
443 else if (source == cut)
445 ap.alignFrame.cut_actionPerformed();
447 else if (source == editSequence)
449 SequenceGroup sg = ap.av.getSelectionGroup();
454 seq = (Sequence) sg.getSequenceAt(0);
456 EditNameDialog dialog = new EditNameDialog(seq.getSequenceAsString(
457 sg.getStartRes(), sg.getEndRes() + 1), null,
458 "Edit Sequence ", null,
460 ap.alignFrame, "Edit Sequence", 500, 100, true);
464 EditCommand editCommand = new EditCommand("Edit Sequences",
465 EditCommand.REPLACE, dialog.getName().replace(' ',
466 ap.av.getGapCharacter()), sg
467 .getSequencesAsArray(ap.av.hiddenRepSequences),
468 sg.getStartRes(), sg.getEndRes() + 1, ap.av.alignment);
470 ap.alignFrame.addHistoryItem(editCommand);
472 ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
477 else if (source == toUpper || source == toLower || source == toggleCase)
479 SequenceGroup sg = ap.av.getSelectionGroup();
480 Vector regions = new Vector();
483 int start = sg.getStartRes();
484 int end = sg.getEndRes() + 1;
488 if (ap.av.hasHiddenColumns)
492 start = ap.av.colSel.adjustForHiddenColumns(start);
495 end = ap.av.colSel.getHiddenBoundaryRight(start);
498 end = sg.getEndRes() + 1;
500 if (end > sg.getEndRes())
502 end = sg.getEndRes() + 1;
506 regions.addElement(new int[]
509 if (ap.av.hasHiddenColumns)
511 start = ap.av.colSel.adjustForHiddenColumns(end);
512 start = ap.av.colSel.getHiddenBoundaryLeft(start) + 1;
514 } while (end < sg.getEndRes());
516 int[][] startEnd = new int[regions.size()][2];
517 for (int i = 0; i < regions.size(); i++)
519 startEnd[i] = (int[]) regions.elementAt(i);
525 if (source == toggleCase)
527 description = "Toggle Case";
528 caseChange = ChangeCaseCommand.TOGGLE_CASE;
530 else if (source == toUpper)
532 description = "To Upper Case";
533 caseChange = ChangeCaseCommand.TO_UPPER;
537 description = "To Lower Case";
538 caseChange = ChangeCaseCommand.TO_LOWER;
541 ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
542 sg.getSequencesAsArray(ap.av.hiddenRepSequences), startEnd,
545 ap.alignFrame.addHistoryItem(caseCommand);
547 ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
552 else if (source == sequenceFeature)
554 SequenceGroup sg = ap.av.getSelectionGroup();
560 int gSize = sg.getSize();
561 SequenceI[] seqs = new SequenceI[gSize];
562 SequenceFeature[] features = new SequenceFeature[gSize];
564 for (int i = 0; i < gSize; i++)
566 seqs[i] = sg.getSequenceAt(i);
567 int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
568 int end = sg.findEndRes(sg.getSequenceAt(i));
569 features[i] = new SequenceFeature(null, null, null, start, end,
573 if (ap.seqPanel.seqCanvas.getFeatureRenderer().amendFeatures(seqs,
576 ap.alignFrame.sequenceFeatures.setState(true);
577 ap.av.showSequenceFeatures(true);
578 ap.highlightSearchResults(null);
588 void outputText(ActionEvent e)
590 CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
592 Frame frame = new Frame();
594 jalview.bin.JalviewLite.addFrame(frame, "Selection output - "
595 + e.getActionCommand(), 600, 500);
597 cap.setText(new jalview.io.AppletFormatAdapter().formatSequences(e
598 .getActionCommand(), new Alignment(ap.av
599 .getSelectionAsNewSequence()), ap.av.showJVSuffix));
605 EditNameDialog dialog = new EditNameDialog(seq.getName(), seq
606 .getDescription(), " Sequence Name",
607 "Sequence Description", ap.alignFrame,
608 "Edit Sequence Name / Description", 500, 100, true);
612 seq.setName(dialog.getName());
613 seq.setDescription(dialog.getDescription());
614 ap.paintAlignment(false);
620 if (seq.getPDBId() != null)
622 PDBEntry entry = (PDBEntry) seq.getPDBId().firstElement();
624 if (ap.av.applet.jmolAvailable)
625 new jalview.appletgui.AppletJmol(entry, new Sequence[]
626 { seq }, null, ap, AppletFormatAdapter.URL);
628 new MCview.AppletPDBViewer(entry, new Sequence[]
629 { seq }, null, ap, AppletFormatAdapter.URL);
634 CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
635 cap.setText("Paste your PDB file here.");
636 cap.setPDBImport(seq);
637 Frame frame = new Frame();
639 jalview.bin.JalviewLite.addFrame(frame, "Paste PDB file ", 400, 300);
643 private void jbInit() throws Exception
645 groupMenu.setLabel("Group");
646 groupMenu.setLabel("Selection");
647 sequenceFeature.addActionListener(this);
649 editGroupName.addActionListener(this);
650 unGroupMenuItem.setLabel("Remove Group");
651 unGroupMenuItem.addActionListener(this);
653 nucleotideMenuItem.setLabel("Nucleotide");
654 nucleotideMenuItem.addActionListener(this);
655 conservationMenuItem.addItemListener(this);
656 abovePIDColour.addItemListener(this);
657 colourMenu.setLabel("Group Colour");
658 showBoxes.setLabel("Boxes");
659 showBoxes.setState(true);
660 showBoxes.addItemListener(this);
661 sequenceName.addActionListener(this);
663 showText.setLabel("Text");
664 showText.addItemListener(this);
665 showColourText.setLabel("Colour Text");
666 showColourText.addItemListener(this);
667 outputmenu.setLabel("Output to Textbox...");
668 seqMenu.setLabel("Sequence");
669 pdb.setLabel("View PDB Structure");
670 hideSeqs.setLabel("Hide Sequences");
671 repGroup.setLabel("Represent Group with");
672 revealAll.setLabel("Reveal All");
673 menu1.setLabel("Group");
678 groupMenu.add(editGroupName);
679 groupMenu.add(editMenu);
680 groupMenu.add(outputmenu);
681 groupMenu.add(sequenceFeature);
682 groupMenu.add(menu1);
684 colourMenu.add(noColourmenuItem);
685 colourMenu.add(clustalColour);
686 colourMenu.add(BLOSUM62Colour);
687 colourMenu.add(PIDColour);
688 colourMenu.add(zappoColour);
689 colourMenu.add(taylorColour);
690 colourMenu.add(hydrophobicityColour);
691 colourMenu.add(helixColour);
692 colourMenu.add(strandColour);
693 colourMenu.add(turnColour);
694 colourMenu.add(buriedColour);
695 colourMenu.add(nucleotideMenuItem);
696 colourMenu.add(userDefinedColour);
697 colourMenu.addSeparator();
698 colourMenu.add(abovePIDColour);
699 colourMenu.add(conservationMenuItem);
701 noColourmenuItem.setLabel("None");
702 noColourmenuItem.addActionListener(this);
704 clustalColour.setLabel("Clustalx colours");
705 clustalColour.addActionListener(this);
706 zappoColour.setLabel("Zappo");
707 zappoColour.addActionListener(this);
708 taylorColour.setLabel("Taylor");
709 taylorColour.addActionListener(this);
710 hydrophobicityColour.setLabel("Hydrophobicity");
711 hydrophobicityColour.addActionListener(this);
712 helixColour.setLabel("Helix propensity");
713 helixColour.addActionListener(this);
714 strandColour.setLabel("Strand propensity");
715 strandColour.addActionListener(this);
716 turnColour.setLabel("Turn propensity");
717 turnColour.addActionListener(this);
718 buriedColour.setLabel("Buried Index");
719 buriedColour.addActionListener(this);
720 abovePIDColour.setLabel("Above % Identity");
722 userDefinedColour.setLabel("User Defined");
723 userDefinedColour.addActionListener(this);
724 PIDColour.setLabel("Percentage Identity");
725 PIDColour.addActionListener(this);
726 BLOSUM62Colour.setLabel("BLOSUM62");
727 BLOSUM62Colour.addActionListener(this);
728 conservationMenuItem.setLabel("Conservation");
731 copy.addActionListener(this);
733 cut.addActionListener(this);
735 editMenu.add(editSequence);
736 editSequence.addActionListener(this);
738 editMenu.add(toUpper);
739 toUpper.addActionListener(this);
740 editMenu.add(toLower);
741 toLower.addActionListener(this);
742 editMenu.add(toggleCase);
743 seqMenu.add(sequenceName);
745 seqMenu.add(repGroup);
746 menu1.add(unGroupMenuItem);
747 menu1.add(colourMenu);
748 menu1.add(showBoxes);
750 menu1.add(showColourText);
751 toggleCase.addActionListener(this);
752 pdb.addActionListener(this);
753 hideSeqs.addActionListener(this);
754 repGroup.addActionListener(this);
755 revealAll.addActionListener(this);
760 ap.paintAlignment(true);
763 protected void clustalColour_actionPerformed()
765 SequenceGroup sg = getGroup();
766 sg.cs = new ClustalxColourScheme(sg
767 .getSequences(ap.av.hiddenRepSequences), ap.av.alignment
772 protected void zappoColour_actionPerformed()
774 getGroup().cs = new ZappoColourScheme();
778 protected void taylorColour_actionPerformed()
780 getGroup().cs = new TaylorColourScheme();
784 protected void hydrophobicityColour_actionPerformed()
786 getGroup().cs = new HydrophobicColourScheme();
790 protected void helixColour_actionPerformed()
792 getGroup().cs = new HelixColourScheme();
796 protected void strandColour_actionPerformed()
798 getGroup().cs = new StrandColourScheme();
802 protected void turnColour_actionPerformed()
804 getGroup().cs = new TurnColourScheme();
808 protected void buriedColour_actionPerformed()
810 getGroup().cs = new BuriedColourScheme();
814 public void nucleotideMenuItem_actionPerformed()
816 getGroup().cs = new NucleotideColourScheme();
820 protected void abovePIDColour_itemStateChanged()
822 SequenceGroup sg = getGroup();
828 if (abovePIDColour.getState())
830 sg.cs.setConsensus(AAFrequency.calculate(sg
831 .getSequences(ap.av.hiddenRepSequences), 0, ap.av.alignment
833 int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
836 sg.cs.setThreshold(threshold, ap.av.getIgnoreGapsConsensus());
838 SliderPanel.showPIDSlider();
842 // remove PIDColouring
844 sg.cs.setThreshold(0, ap.av.getIgnoreGapsConsensus());
851 protected void userDefinedColour_actionPerformed()
853 new UserDefinedColours(ap, getGroup());
856 protected void PIDColour_actionPerformed()
858 SequenceGroup sg = getGroup();
859 sg.cs = new PIDColourScheme();
860 sg.cs.setConsensus(AAFrequency.calculate(sg
861 .getSequences(ap.av.hiddenRepSequences), 0, ap.av.alignment
866 protected void BLOSUM62Colour_actionPerformed()
868 SequenceGroup sg = getGroup();
870 sg.cs = new Blosum62ColourScheme();
872 sg.cs.setConsensus(AAFrequency.calculate(sg
873 .getSequences(ap.av.hiddenRepSequences), 0, ap.av.alignment
879 protected void noColourmenuItem_actionPerformed()
881 getGroup().cs = null;
885 protected void conservationMenuItem_itemStateChanged()
887 SequenceGroup sg = getGroup();
893 if (conservationMenuItem.getState())
896 Conservation c = new Conservation("Group",
897 ResidueProperties.propHash, 3, sg
898 .getSequences(ap.av.hiddenRepSequences), 0,
899 ap.av.alignment.getWidth());
902 c.verdict(false, ap.av.ConsPercGaps);
904 sg.cs.setConservation(c);
906 SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
907 SliderPanel.showConservationSlider();
910 // remove ConservationColouring
912 sg.cs.setConservation(null);
918 SequenceGroup getGroup()
920 SequenceGroup sg = ap.av.getSelectionGroup();
922 // this method won't add a new group if it already exists
925 ap.av.alignment.addGroup(sg);
931 void unGroupMenuItem_actionPerformed()
933 SequenceGroup sg = ap.av.getSelectionGroup();
934 ap.av.alignment.deleteGroup(sg);
935 ap.av.setSelectionGroup(null);
936 ap.paintAlignment(true);
939 public void showColourText_itemStateChanged()
941 getGroup().setColourText(showColourText.getState());
945 public void showText_itemStateChanged()
947 getGroup().setDisplayText(showText.getState());
951 public void showBoxes_itemStateChanged()
953 getGroup().setDisplayBoxes(showBoxes.getState());
957 void hideSequences(boolean representGroup)
959 SequenceGroup sg = ap.av.getSelectionGroup();
960 if (sg == null || sg.getSize() < 1)
962 ap.av.hideSequence(new SequenceI[]
967 ap.av.setSelectionGroup(null);
971 ap.av.hideRepSequences(seq, sg);
976 int gsize = sg.getSize();
979 hseqs = new SequenceI[gsize];
982 for (int i = 0; i < gsize; i++)
984 hseqs[index++] = sg.getSequenceAt(i);
987 ap.av.hideSequence(hseqs);