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 jalview.api.AlignViewportI;
24 import jalview.bin.Cache;
25 import jalview.commands.EditCommand;
26 import jalview.commands.EditCommand.Action;
27 import jalview.commands.EditCommand.Edit;
28 import jalview.datamodel.AlignmentI;
29 import jalview.datamodel.ColumnSelection;
30 import jalview.datamodel.HiddenColumns;
31 import jalview.datamodel.SearchResultMatchI;
32 import jalview.datamodel.SearchResults;
33 import jalview.datamodel.SearchResultsI;
34 import jalview.datamodel.Sequence;
35 import jalview.datamodel.SequenceFeature;
36 import jalview.datamodel.SequenceGroup;
37 import jalview.datamodel.SequenceI;
38 import jalview.io.SequenceAnnotationReport;
39 import jalview.renderer.ResidueShaderI;
40 import jalview.schemes.ResidueProperties;
41 import jalview.structure.SelectionListener;
42 import jalview.structure.SelectionSource;
43 import jalview.structure.SequenceListener;
44 import jalview.structure.StructureSelectionManager;
45 import jalview.structure.VamsasSource;
46 import jalview.util.Comparison;
47 import jalview.util.MappingUtils;
48 import jalview.util.MessageManager;
49 import jalview.util.Platform;
50 import jalview.viewmodel.AlignmentViewport;
52 import java.awt.BorderLayout;
53 import java.awt.Color;
55 import java.awt.FontMetrics;
56 import java.awt.Point;
57 import java.awt.event.MouseEvent;
58 import java.awt.event.MouseListener;
59 import java.awt.event.MouseMotionListener;
60 import java.awt.event.MouseWheelEvent;
61 import java.awt.event.MouseWheelListener;
62 import java.util.ArrayList;
63 import java.util.Collections;
64 import java.util.List;
66 import javax.swing.JPanel;
67 import javax.swing.SwingUtilities;
68 import javax.swing.ToolTipManager;
74 * @version $Revision: 1.130 $
76 public class SeqPanel extends JPanel implements MouseListener,
77 MouseMotionListener, MouseWheelListener, SequenceListener,
82 public SeqCanvas seqCanvas;
85 public AlignmentPanel ap;
87 protected int lastres;
89 protected int startseq;
91 protected AlignViewport av;
93 ScrollThread scrollThread = null;
95 boolean mouseDragging = false;
97 boolean editingSeqs = false;
99 boolean groupEditing = false;
101 // ////////////////////////////////////////
102 // ///Everything below this is for defining the boundary of the rubberband
103 // ////////////////////////////////////////
106 boolean changeEndSeq = false;
108 boolean changeStartSeq = false;
110 boolean changeEndRes = false;
112 boolean changeStartRes = false;
114 SequenceGroup stretchGroup = null;
116 boolean remove = false;
118 Point lastMousePress;
120 boolean mouseWheelPressed = false;
122 StringBuffer keyboardNo1;
124 StringBuffer keyboardNo2;
126 java.net.URL linkImageURL;
128 private final SequenceAnnotationReport seqARep;
130 StringBuilder tooltipText = new StringBuilder();
134 EditCommand editCommand;
136 StructureSelectionManager ssm;
138 SearchResultsI lastSearchResults;
141 * Creates a new SeqPanel object.
148 public SeqPanel(AlignViewport av, AlignmentPanel ap)
150 linkImageURL = getClass().getResource("/images/link.gif");
151 seqARep = new SequenceAnnotationReport(linkImageURL.toString());
152 ToolTipManager.sharedInstance().registerComponent(this);
153 ToolTipManager.sharedInstance().setInitialDelay(0);
154 ToolTipManager.sharedInstance().setDismissDelay(10000);
156 setBackground(Color.white);
158 seqCanvas = new SeqCanvas(ap);
159 setLayout(new BorderLayout());
160 add(seqCanvas, BorderLayout.CENTER);
166 addMouseMotionListener(this);
167 addMouseListener(this);
168 addMouseWheelListener(this);
169 ssm = av.getStructureSelectionManager();
170 ssm.addStructureViewerListener(this);
171 ssm.addSelectionListener(this);
175 int startWrapBlock = -1;
177 int wrappedBlock = -1;
180 * Returns the aligned sequence position (base 0) at the mouse position, or
181 * the closest visible one
186 int findRes(MouseEvent evt)
191 if (av.getWrapAlignment())
194 int hgap = av.getCharHeight();
195 if (av.getScaleAboveWrapped())
197 hgap += av.getCharHeight();
200 int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
201 + hgap + seqCanvas.getAnnotationHeight();
205 x -= seqCanvas.LABEL_WEST;
207 int cwidth = seqCanvas.getWrappedCanvasWidth(this.getWidth());
213 wrappedBlock = y / cHeight;
214 wrappedBlock += av.getRanges().getStartRes() / cwidth;
216 res = wrappedBlock * cwidth + x / av.getCharWidth();
221 if (x > seqCanvas.getX() + seqCanvas.getWidth())
223 // make sure we calculate relative to visible alignment, rather than
225 x = seqCanvas.getX() + seqCanvas.getWidth();
227 res = (x / av.getCharWidth()) + av.getRanges().getStartRes();
228 if (res > av.getRanges().getEndRes())
231 res = av.getRanges().getEndRes();
235 if (av.hasHiddenColumns())
237 res = av.getAlignment().getHiddenColumns()
238 .adjustForHiddenColumns(res);
245 int findSeq(MouseEvent evt)
250 if (av.getWrapAlignment())
252 int hgap = av.getCharHeight();
253 if (av.getScaleAboveWrapped())
255 hgap += av.getCharHeight();
258 int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
259 + hgap + seqCanvas.getAnnotationHeight();
263 seq = Math.min((y % cHeight) / av.getCharHeight(), av.getAlignment()
268 seq = Math.min((y / av.getCharHeight())
269 + av.getRanges().getStartSeq(),
271 .getAlignment().getHeight() - 1);
278 * When all of a sequence of edits are complete, put the resulting edit list
279 * on the history stack (undo list), and reset flags for editing in progress.
285 if (editCommand != null && editCommand.getSize() > 0)
287 ap.alignFrame.addHistoryItem(editCommand);
288 av.firePropertyChange("alignment", null, av.getAlignment()
294 * Tidy up come what may...
299 groupEditing = false;
308 seqCanvas.cursorY = getKeyboardNo1() - 1;
312 void setCursorColumn()
314 seqCanvas.cursorX = getKeyboardNo1() - 1;
318 void setCursorRowAndColumn()
320 if (keyboardNo2 == null)
322 keyboardNo2 = new StringBuffer();
326 seqCanvas.cursorX = getKeyboardNo1() - 1;
327 seqCanvas.cursorY = getKeyboardNo2() - 1;
332 void setCursorPosition()
334 SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
336 seqCanvas.cursorX = sequence.findIndex(getKeyboardNo1()) - 1;
340 void moveCursor(int dx, int dy)
342 seqCanvas.cursorX += dx;
343 seqCanvas.cursorY += dy;
345 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
347 if (av.hasHiddenColumns()
348 && !hidden.isVisible(seqCanvas.cursorX))
350 int original = seqCanvas.cursorX - dx;
351 int maxWidth = av.getAlignment().getWidth();
353 while (!hidden.isVisible(seqCanvas.cursorX)
354 && seqCanvas.cursorX < maxWidth && seqCanvas.cursorX > 0)
356 seqCanvas.cursorX += dx;
359 if (seqCanvas.cursorX >= maxWidth
360 || !hidden.isVisible(seqCanvas.cursorX))
362 seqCanvas.cursorX = original;
369 void scrollToVisible()
371 if (seqCanvas.cursorX < 0)
373 seqCanvas.cursorX = 0;
375 else if (seqCanvas.cursorX > av.getAlignment().getWidth() - 1)
377 seqCanvas.cursorX = av.getAlignment().getWidth() - 1;
380 if (seqCanvas.cursorY < 0)
382 seqCanvas.cursorY = 0;
384 else if (seqCanvas.cursorY > av.getAlignment().getHeight() - 1)
386 seqCanvas.cursorY = av.getAlignment().getHeight() - 1;
390 if (av.getWrapAlignment())
392 ap.scrollToWrappedVisible(seqCanvas.cursorX);
396 while (seqCanvas.cursorY < av.getRanges().getStartSeq())
400 while (seqCanvas.cursorY > av.getRanges().getEndSeq())
404 if (!av.getWrapAlignment())
406 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
407 while (seqCanvas.cursorX < hidden.adjustForHiddenColumns(av
408 .getRanges().getStartRes()))
410 if (!ap.scrollRight(false))
415 while (seqCanvas.cursorX > hidden.adjustForHiddenColumns(av
416 .getRanges().getEndRes()))
418 if (!ap.scrollRight(true))
425 setStatusMessage(av.getAlignment().getSequenceAt(seqCanvas.cursorY),
426 seqCanvas.cursorX, seqCanvas.cursorY);
431 void setSelectionAreaAtCursor(boolean topLeft)
433 SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
435 if (av.getSelectionGroup() != null)
437 SequenceGroup sg = av.getSelectionGroup();
438 // Find the top and bottom of this group
439 int min = av.getAlignment().getHeight(), max = 0;
440 for (int i = 0; i < sg.getSize(); i++)
442 int index = av.getAlignment().findIndex(sg.getSequenceAt(i));
457 sg.setStartRes(seqCanvas.cursorX);
458 if (sg.getEndRes() < seqCanvas.cursorX)
460 sg.setEndRes(seqCanvas.cursorX);
463 min = seqCanvas.cursorY;
467 sg.setEndRes(seqCanvas.cursorX);
468 if (sg.getStartRes() > seqCanvas.cursorX)
470 sg.setStartRes(seqCanvas.cursorX);
473 max = seqCanvas.cursorY + 1;
478 // Only the user can do this
479 av.setSelectionGroup(null);
483 // Now add any sequences between min and max
484 sg.getSequences(null).clear();
485 for (int i = min; i < max; i++)
487 sg.addSequence(av.getAlignment().getSequenceAt(i), false);
492 if (av.getSelectionGroup() == null)
494 SequenceGroup sg = new SequenceGroup();
495 sg.setStartRes(seqCanvas.cursorX);
496 sg.setEndRes(seqCanvas.cursorX);
497 sg.addSequence(sequence, false);
498 av.setSelectionGroup(sg);
501 ap.paintAlignment(false);
505 void insertGapAtCursor(boolean group)
507 groupEditing = group;
508 startseq = seqCanvas.cursorY;
509 lastres = seqCanvas.cursorX;
510 editSequence(true, false, seqCanvas.cursorX + getKeyboardNo1());
514 void deleteGapAtCursor(boolean group)
516 groupEditing = group;
517 startseq = seqCanvas.cursorY;
518 lastres = seqCanvas.cursorX + getKeyboardNo1();
519 editSequence(false, false, seqCanvas.cursorX);
523 void insertNucAtCursor(boolean group, String nuc)
525 // TODO not called - delete?
526 groupEditing = group;
527 startseq = seqCanvas.cursorY;
528 lastres = seqCanvas.cursorX;
529 editSequence(false, true, seqCanvas.cursorX + getKeyboardNo1());
533 void numberPressed(char value)
535 if (keyboardNo1 == null)
537 keyboardNo1 = new StringBuffer();
540 if (keyboardNo2 != null)
542 keyboardNo2.append(value);
546 keyboardNo1.append(value);
554 if (keyboardNo1 != null)
556 int value = Integer.parseInt(keyboardNo1.toString());
560 } catch (Exception x)
571 if (keyboardNo2 != null)
573 int value = Integer.parseInt(keyboardNo2.toString());
577 } catch (Exception x)
591 public void mouseReleased(MouseEvent evt)
593 mouseDragging = false;
594 mouseWheelPressed = false;
596 if (evt.isPopupTrigger()) // Windows: mouseReleased
605 doMouseReleasedDefineMode(evt);
619 public void mousePressed(MouseEvent evt)
621 lastMousePress = evt.getPoint();
623 if (SwingUtilities.isMiddleMouseButton(evt))
625 mouseWheelPressed = true;
629 boolean isControlDown = Platform.isControlDown(evt);
630 if (evt.isShiftDown() || isControlDown)
640 doMousePressedDefineMode(evt);
644 int seq = findSeq(evt);
645 int res = findRes(evt);
647 if (seq < 0 || res < 0)
652 if ((seq < av.getAlignment().getHeight())
653 && (res < av.getAlignment().getSequenceAt(seq).getLength()))
670 public void mouseOverSequence(SequenceI sequence, int index, int pos)
672 String tmp = sequence.hashCode() + " " + index + " " + pos;
674 if (lastMessage == null || !lastMessage.equals(tmp))
676 // System.err.println("mouseOver Sequence: "+tmp);
677 ssm.mouseOverSequence(sequence, index, pos, av);
683 * Highlight the mapped region described by the search results object (unless
684 * unchanged). This supports highlight of protein while mousing over linked
685 * cDNA and vice versa. The status bar is also updated to show the location of
686 * the start of the highlighted region.
689 public void highlightSequence(SearchResultsI results)
691 if (results == null || results.equals(lastSearchResults))
695 lastSearchResults = results;
697 if (av.isFollowHighlight())
700 * if scrollToPosition requires a scroll adjustment, this flag prevents
701 * another scroll event being propagated back to the originator
703 * @see AlignmentPanel#adjustmentValueChanged
705 ap.setDontScrollComplement(true);
706 if (ap.scrollToPosition(results, false))
708 seqCanvas.revalidate();
711 setStatusMessage(results);
712 seqCanvas.highlightSearchResults(results);
716 public VamsasSource getVamsasSource()
718 return this.ap == null ? null : this.ap.av;
722 public void updateColours(SequenceI seq, int index)
724 System.out.println("update the seqPanel colours");
735 public void mouseMoved(MouseEvent evt)
739 // This is because MacOSX creates a mouseMoved
740 // If control is down, other platforms will not.
744 int res = findRes(evt);
745 int seq = findSeq(evt);
747 if (res < 0 || seq < 0 || seq >= av.getAlignment().getHeight())
752 SequenceI sequence = av.getAlignment().getSequenceAt(seq);
754 if (res >= sequence.getLength())
759 pos = setStatusMessage(sequence, res, seq);
760 if (ssm != null && pos > -1)
762 mouseOverSequence(sequence, res, pos);
765 tooltipText.setLength(6); // Cuts the buffer back to <html>
767 SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
770 for (int g = 0; g < groups.length; g++)
772 if (groups[g].getStartRes() <= res && groups[g].getEndRes() >= res)
774 if (!groups[g].getName().startsWith("JTreeGroup")
775 && !groups[g].getName().startsWith("JGroup"))
777 tooltipText.append(groups[g].getName());
780 if (groups[g].getDescription() != null)
782 tooltipText.append(": " + groups[g].getDescription());
788 // use aa to see if the mouse pointer is on a
789 if (av.isShowSequenceFeatures())
792 List<SequenceFeature> features = ap.getFeatureRenderer()
793 .findFeaturesAtRes(sequence.getDatasetSequence(),
794 rpos = sequence.findPosition(res));
795 seqARep.appendFeatures(tooltipText, rpos, features,
796 this.ap.getSeqPanel().seqCanvas.fr.getMinMax());
798 if (tooltipText.length() == 6) // <html>
800 setToolTipText(null);
805 if (lastTooltip == null
806 || !lastTooltip.equals(tooltipText.toString()))
808 String formatedTooltipText = JvSwingUtils.wrapTooltip(true,
809 tooltipText.toString());
810 // String formatedTooltipText = tooltipText.toString();
811 setToolTipText(formatedTooltipText);
812 lastTooltip = tooltipText.toString();
819 private Point lastp = null;
824 * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
827 public Point getToolTipLocation(MouseEvent event)
829 int x = event.getX(), w = getWidth();
830 int wdth = (w - x < 200) ? -(w / 2) : 5; // switch sides when tooltip is too
833 if (!event.isShiftDown() || p == null)
835 p = (tooltipText != null && tooltipText.length() > 6) ? new Point(
836 event.getX() + wdth, event.getY() - 20) : null;
839 * TODO: try to modify position region is not obcured by tooltip
847 * set when the current UI interaction has resulted in a change that requires
848 * overview shading to be recalculated. this could be changed to something
849 * more expressive that indicates what actually has changed, so selective
850 * redraws can be applied
852 private boolean needOverviewUpdate = false; // TODO: refactor to avcontroller
855 * set if av.getSelectionGroup() refers to a group that is defined on the
856 * alignment view, rather than a transient selection
858 // private boolean editingDefinedGroup = false; // TODO: refactor to
859 // avcontroller or viewModel
862 * Set status message in alignment panel
865 * aligned sequence object
869 * index of sequence in alignment
870 * @return position of res in sequence
872 int setStatusMessage(SequenceI sequence, int res, int seq)
874 StringBuilder text = new StringBuilder(32);
877 * Sequence number (if known), and sequence name.
879 String seqno = seq == -1 ? "" : " " + (seq + 1);
880 text.append("Sequence").append(seqno).append(" ID: ")
881 .append(sequence.getName());
883 String residue = null;
885 * Try to translate the display character to residue name (null for gap).
887 final String displayChar = String.valueOf(sequence.getCharAt(res));
888 if (av.getAlignment().isNucleotide())
890 residue = ResidueProperties.nucleotideName.get(displayChar);
893 text.append(" Nucleotide: ").append(residue);
898 residue = "X".equalsIgnoreCase(displayChar) ? "X" : ("*"
899 .equals(displayChar) ? "STOP" : ResidueProperties.aa2Triplet
903 text.append(" Residue: ").append(residue);
910 pos = sequence.findPosition(res);
911 text.append(" (").append(Integer.toString(pos)).append(")");
913 ap.alignFrame.statusBar.setText(text.toString());
918 * Set the status bar message to highlight the first matched position in
923 private void setStatusMessage(SearchResultsI results)
925 AlignmentI al = this.av.getAlignment();
926 int sequenceIndex = al.findIndex(results);
927 if (sequenceIndex == -1)
931 SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
932 for (SearchResultMatchI m : results.getResults())
934 SequenceI seq = m.getSequence();
935 if (seq.getDatasetSequence() != null)
937 seq = seq.getDatasetSequence();
943 * Convert position in sequence (base 1) to sequence character array
946 int start = m.getStart() - m.getSequence().getStart();
947 setStatusMessage(seq, start, sequenceIndex);
957 public void mouseDragged(MouseEvent evt)
959 if (mouseWheelPressed)
961 boolean inSplitFrame = ap.av.getCodingComplement() != null;
962 boolean copyChanges = inSplitFrame && av.isProteinFontAsCdna();
964 int oldWidth = av.getCharWidth();
966 // Which is bigger, left-right or up-down?
967 if (Math.abs(evt.getY() - lastMousePress.getY()) > Math.abs(evt
968 .getX() - lastMousePress.getX()))
971 * on drag up or down, decrement or increment font size
973 int fontSize = av.font.getSize();
974 boolean fontChanged = false;
976 if (evt.getY() < lastMousePress.getY())
981 else if (evt.getY() > lastMousePress.getY())
994 Font newFont = new Font(av.font.getName(), av.font.getStyle(),
996 av.setFont(newFont, true);
997 av.setCharWidth(oldWidth);
1001 ap.av.getCodingComplement().setFont(newFont, true);
1002 SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1003 .getSplitViewContainer();
1004 splitFrame.adjustLayout();
1005 splitFrame.repaint();
1012 * on drag left or right, decrement or increment character width
1015 if (evt.getX() < lastMousePress.getX() && av.getCharWidth() > 1)
1017 newWidth = av.getCharWidth() - 1;
1018 av.setCharWidth(newWidth);
1020 else if (evt.getX() > lastMousePress.getX())
1022 newWidth = av.getCharWidth() + 1;
1023 av.setCharWidth(newWidth);
1027 ap.paintAlignment(false);
1031 * need to ensure newWidth is set on cdna, regardless of which
1032 * panel the mouse drag happened in; protein will compute its
1033 * character width as 1:1 or 3:1
1035 av.getCodingComplement().setCharWidth(newWidth);
1036 SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1037 .getSplitViewContainer();
1038 splitFrame.adjustLayout();
1039 splitFrame.repaint();
1044 FontMetrics fm = getFontMetrics(av.getFont());
1045 av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
1047 lastMousePress = evt.getPoint();
1054 doMouseDraggedDefineMode(evt);
1058 int res = findRes(evt);
1065 if ((lastres == -1) || (lastres == res))
1070 if ((res < av.getAlignment().getWidth()) && (res < lastres))
1072 // dragLeft, delete gap
1073 editSequence(false, false, res);
1077 editSequence(true, false, res);
1080 mouseDragging = true;
1081 if (scrollThread != null)
1083 scrollThread.setEvent(evt);
1087 // TODO: Make it more clever than many booleans
1088 synchronized void editSequence(boolean insertGap, boolean editSeq,
1092 int fixedRight = -1;
1093 boolean fixedColumns = false;
1094 SequenceGroup sg = av.getSelectionGroup();
1096 SequenceI seq = av.getAlignment().getSequenceAt(startseq);
1098 // No group, but the sequence may represent a group
1099 if (!groupEditing && av.hasHiddenRows())
1101 if (av.isHiddenRepSequence(seq))
1103 sg = av.getRepresentedSequences(seq);
1104 groupEditing = true;
1108 StringBuilder message = new StringBuilder(64);
1111 message.append("Edit group:");
1112 if (editCommand == null)
1114 editCommand = new EditCommand(
1115 MessageManager.getString("action.edit_group"));
1120 message.append("Edit sequence: " + seq.getName());
1121 String label = seq.getName();
1122 if (label.length() > 10)
1124 label = label.substring(0, 10);
1126 if (editCommand == null)
1128 editCommand = new EditCommand(MessageManager.formatMessage(
1129 "label.edit_params", new String[] { label }));
1135 message.append(" insert ");
1139 message.append(" delete ");
1142 message.append(Math.abs(startres - lastres) + " gaps.");
1143 ap.alignFrame.statusBar.setText(message.toString());
1145 // Are we editing within a selection group?
1147 || (sg != null && sg.getSequences(av.getHiddenRepSequences())
1150 fixedColumns = true;
1152 // sg might be null as the user may only see 1 sequence,
1153 // but the sequence represents a group
1156 if (!av.isHiddenRepSequence(seq))
1161 sg = av.getRepresentedSequences(seq);
1164 fixedLeft = sg.getStartRes();
1165 fixedRight = sg.getEndRes();
1167 if ((startres < fixedLeft && lastres >= fixedLeft)
1168 || (startres >= fixedLeft && lastres < fixedLeft)
1169 || (startres > fixedRight && lastres <= fixedRight)
1170 || (startres <= fixedRight && lastres > fixedRight))
1176 if (fixedLeft > startres)
1178 fixedRight = fixedLeft - 1;
1181 else if (fixedRight < startres)
1183 fixedLeft = fixedRight;
1188 if (av.hasHiddenColumns())
1190 fixedColumns = true;
1191 int y1 = av.getAlignment().getHiddenColumns()
1192 .getHiddenBoundaryLeft(startres);
1193 int y2 = av.getAlignment().getHiddenColumns()
1194 .getHiddenBoundaryRight(startres);
1196 if ((insertGap && startres > y1 && lastres < y1)
1197 || (!insertGap && startres < y2 && lastres > y2))
1203 // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1204 // Selection spans a hidden region
1205 if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1213 fixedRight = y2 - 1;
1220 List<SequenceI> vseqs = sg.getSequences(av.getHiddenRepSequences());
1221 int g, groupSize = vseqs.size();
1222 SequenceI[] groupSeqs = new SequenceI[groupSize];
1223 for (g = 0; g < groupSeqs.length; g++)
1225 groupSeqs[g] = vseqs.get(g);
1231 // If the user has selected the whole sequence, and is dragging to
1232 // the right, we can still extend the alignment and selectionGroup
1233 if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1234 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1236 sg.setEndRes(av.getAlignment().getWidth() + startres - lastres);
1237 fixedRight = sg.getEndRes();
1240 // Is it valid with fixed columns??
1241 // Find the next gap before the end
1242 // of the visible region boundary
1243 boolean blank = false;
1244 for (fixedRight = fixedRight; fixedRight > lastres; fixedRight--)
1248 for (g = 0; g < groupSize; g++)
1250 for (int j = 0; j < startres - lastres; j++)
1252 if (!Comparison.isGap(groupSeqs[g].getCharAt(fixedRight - j)))
1267 if (sg.getSize() == av.getAlignment().getHeight())
1269 if ((av.hasHiddenColumns() && startres < av.getAlignment()
1270 .getHiddenColumns().getHiddenBoundaryRight(startres)))
1276 int alWidth = av.getAlignment().getWidth();
1277 if (av.hasHiddenRows())
1279 int hwidth = av.getAlignment().getHiddenSequences()
1281 if (hwidth > alWidth)
1286 // We can still insert gaps if the selectionGroup
1287 // contains all the sequences
1288 sg.setEndRes(sg.getEndRes() + startres - lastres);
1289 fixedRight = alWidth + startres - lastres;
1300 else if (!insertGap)
1302 // / Are we able to delete?
1303 // ie are all columns blank?
1305 for (g = 0; g < groupSize; g++)
1307 for (int j = startres; j < lastres; j++)
1309 if (groupSeqs[g].getLength() <= j)
1314 if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
1316 // Not a gap, block edit not valid
1326 // dragging to the right
1327 if (fixedColumns && fixedRight != -1)
1329 for (int j = lastres; j < startres; j++)
1331 insertChar(j, groupSeqs, fixedRight);
1336 appendEdit(Action.INSERT_GAP, groupSeqs, startres, startres
1342 // dragging to the left
1343 if (fixedColumns && fixedRight != -1)
1345 for (int j = lastres; j > startres; j--)
1347 deleteChar(startres, groupSeqs, fixedRight);
1352 appendEdit(Action.DELETE_GAP, groupSeqs, startres, lastres
1359 // ///Editing a single sequence///////////
1363 // dragging to the right
1364 if (fixedColumns && fixedRight != -1)
1366 for (int j = lastres; j < startres; j++)
1368 insertChar(j, new SequenceI[] { seq }, fixedRight);
1373 appendEdit(Action.INSERT_GAP, new SequenceI[] { seq }, lastres,
1374 startres - lastres);
1381 // dragging to the left
1382 if (fixedColumns && fixedRight != -1)
1384 for (int j = lastres; j > startres; j--)
1386 if (!Comparison.isGap(seq.getCharAt(startres)))
1391 deleteChar(startres, new SequenceI[] { seq }, fixedRight);
1396 // could be a keyboard edit trying to delete none gaps
1398 for (int m = startres; m < lastres; m++)
1400 if (!Comparison.isGap(seq.getCharAt(m)))
1409 appendEdit(Action.DELETE_GAP, new SequenceI[] { seq },
1415 {// insertGap==false AND editSeq==TRUE;
1416 if (fixedColumns && fixedRight != -1)
1418 for (int j = lastres; j < startres; j++)
1420 insertChar(j, new SequenceI[] { seq }, fixedRight);
1425 appendEdit(Action.INSERT_NUC, new SequenceI[] { seq }, lastres,
1426 startres - lastres);
1433 seqCanvas.repaint();
1436 void insertChar(int j, SequenceI[] seq, int fixedColumn)
1438 int blankColumn = fixedColumn;
1439 for (int s = 0; s < seq.length; s++)
1441 // Find the next gap before the end of the visible region boundary
1442 // If lastCol > j, theres a boundary after the gap insertion
1444 for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1446 if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
1448 // Theres a space, so break and insert the gap
1453 if (blankColumn <= j)
1455 blankColumn = fixedColumn;
1461 appendEdit(Action.DELETE_GAP, seq, blankColumn, 1);
1463 appendEdit(Action.INSERT_GAP, seq, j, 1);
1468 * Helper method to add and perform one edit action.
1475 protected void appendEdit(Action action, SequenceI[] seq, int pos,
1479 final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
1480 av.getAlignment().getGapCharacter());
1482 editCommand.appendEdit(edit, av.getAlignment(), true, null);
1485 void deleteChar(int j, SequenceI[] seq, int fixedColumn)
1488 appendEdit(Action.DELETE_GAP, seq, j, 1);
1490 appendEdit(Action.INSERT_GAP, seq, fixedColumn, 1);
1500 public void mouseEntered(MouseEvent e)
1507 if (scrollThread != null)
1509 scrollThread.running = false;
1510 scrollThread = null;
1521 public void mouseExited(MouseEvent e)
1523 if (av.getWrapAlignment())
1530 scrollThread = new ScrollThread();
1535 * Handler for double-click on a position with one or more sequence features.
1536 * Opens the Amend Features dialog to allow feature details to be amended, or
1537 * the feature deleted.
1540 public void mouseClicked(MouseEvent evt)
1542 SequenceGroup sg = null;
1543 SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
1544 if (evt.getClickCount() > 1)
1546 sg = av.getSelectionGroup();
1547 if (sg != null && sg.getSize() == 1
1548 && sg.getEndRes() - sg.getStartRes() < 2)
1550 av.setSelectionGroup(null);
1553 List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
1554 .findFeaturesAtRes(sequence.getDatasetSequence(),
1555 sequence.findPosition(findRes(evt)));
1557 if (!features.isEmpty())
1560 * highlight the first feature at the position on the alignment
1562 SearchResultsI highlight = new SearchResults();
1563 highlight.addResult(sequence, features.get(0).getBegin(), features
1565 seqCanvas.highlightSearchResults(highlight);
1568 * open the Amend Features dialog; clear highlighting afterwards,
1569 * whether changes were made or not
1571 List<SequenceI> seqs = Collections.singletonList(sequence);
1572 seqCanvas.getFeatureRenderer().amendFeatures(seqs, features, false,
1574 seqCanvas.highlightSearchResults(null);
1580 public void mouseWheelMoved(MouseWheelEvent e)
1583 if (e.getWheelRotation() > 0)
1585 if (e.isShiftDown())
1587 ap.scrollRight(true);
1597 if (e.isShiftDown())
1599 ap.scrollRight(false);
1606 // TODO Update tooltip for new position.
1615 public void doMousePressedDefineMode(MouseEvent evt)
1617 final int res = findRes(evt);
1618 final int seq = findSeq(evt);
1620 needOverviewUpdate = false;
1622 startWrapBlock = wrappedBlock;
1624 if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1626 JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
1627 .getString("label.cannot_edit_annotations_in_wrapped_view"),
1628 MessageManager.getString("label.wrapped_view_no_edit"),
1629 JvOptionPane.WARNING_MESSAGE);
1633 if (seq < 0 || res < 0)
1638 SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1640 if ((sequence == null) || (res > sequence.getLength()))
1645 stretchGroup = av.getSelectionGroup();
1647 if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1649 stretchGroup = av.getAlignment().findGroup(sequence, res);
1650 if (stretchGroup != null)
1652 // only update the current selection if the popup menu has a group to
1654 av.setSelectionGroup(stretchGroup);
1658 if (evt.isPopupTrigger()) // Mac: mousePressed
1665 * defer right-mouse click handling to mouseReleased on Windows
1666 * (where isPopupTrigger() will answer true)
1667 * NB isRightMouseButton is also true for Cmd-click on Mac
1669 if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1676 seqCanvas.cursorX = findRes(evt);
1677 seqCanvas.cursorY = findSeq(evt);
1678 seqCanvas.repaint();
1682 if (stretchGroup == null)
1684 // Only if left mouse button do we want to change group sizes
1686 // define a new group here
1687 SequenceGroup sg = new SequenceGroup();
1688 sg.setStartRes(res);
1690 sg.addSequence(sequence, false);
1691 av.setSelectionGroup(sg);
1694 if (av.getConservationSelected())
1696 SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1700 if (av.getAbovePIDThreshold())
1702 SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1705 // TODO: stretchGroup will always be not null. Is this a merge error ?
1706 if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1708 // Edit end res position of selected group
1709 changeEndRes = true;
1711 else if ((stretchGroup != null)
1712 && (stretchGroup.getStartRes() == res))
1714 // Edit end res position of selected group
1715 changeStartRes = true;
1717 stretchGroup.getWidth();
1720 seqCanvas.repaint();
1724 * Build and show a pop-up menu at the right-click mouse position
1730 void showPopupMenu(MouseEvent evt)
1732 final int res = findRes(evt);
1733 final int seq = findSeq(evt);
1734 SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1735 List<SequenceFeature> allFeatures = ap.getFeatureRenderer()
1736 .findFeaturesAtRes(sequence.getDatasetSequence(),
1737 sequence.findPosition(res));
1738 List<String> links = new ArrayList<String>();
1739 for (SequenceFeature sf : allFeatures)
1741 if (sf.links != null)
1743 for (String link : sf.links)
1750 PopupMenu pop = new PopupMenu(ap, null, links);
1751 pop.show(this, evt.getX(), evt.getY());
1760 public void doMouseReleasedDefineMode(MouseEvent evt)
1762 if (stretchGroup == null)
1766 // always do this - annotation has own state
1767 // but defer colourscheme update until hidden sequences are passed in
1768 boolean vischange = stretchGroup.recalcConservation(true);
1769 needOverviewUpdate |= vischange && av.isSelectionDefinedGroup();
1770 if (stretchGroup.cs != null)
1772 stretchGroup.cs.alignmentChanged(stretchGroup,
1773 av.getHiddenRepSequences());
1775 ResidueShaderI groupColourScheme = stretchGroup.getGroupColourScheme();
1776 String name = stretchGroup.getName();
1777 if (stretchGroup.cs.conservationApplied())
1779 SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1781 if (stretchGroup.cs.getThreshold() > 0)
1783 SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1786 PaintRefresher.Refresh(this, av.getSequenceSetId());
1787 ap.paintAlignment(needOverviewUpdate);
1788 needOverviewUpdate = false;
1789 changeEndRes = false;
1790 changeStartRes = false;
1791 stretchGroup = null;
1801 public void doMouseDraggedDefineMode(MouseEvent evt)
1803 int res = findRes(evt);
1804 int y = findSeq(evt);
1806 if (wrappedBlock != startWrapBlock)
1811 if (stretchGroup == null)
1816 if (res >= av.getAlignment().getWidth())
1818 res = av.getAlignment().getWidth() - 1;
1821 if (stretchGroup.getEndRes() == res)
1823 // Edit end res position of selected group
1824 changeEndRes = true;
1826 else if (stretchGroup.getStartRes() == res)
1828 // Edit start res position of selected group
1829 changeStartRes = true;
1832 if (res < av.getRanges().getStartRes())
1834 res = av.getRanges().getStartRes();
1839 if (res > (stretchGroup.getStartRes() - 1))
1841 stretchGroup.setEndRes(res);
1842 needOverviewUpdate |= av.isSelectionDefinedGroup();
1845 else if (changeStartRes)
1847 if (res < (stretchGroup.getEndRes() + 1))
1849 stretchGroup.setStartRes(res);
1850 needOverviewUpdate |= av.isSelectionDefinedGroup();
1854 int dragDirection = 0;
1860 else if (y < oldSeq)
1865 while ((y != oldSeq) && (oldSeq > -1)
1866 && (y < av.getAlignment().getHeight()))
1868 // This routine ensures we don't skip any sequences, as the
1869 // selection is quite slow.
1870 Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1872 oldSeq += dragDirection;
1879 Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1881 if (stretchGroup.getSequences(null).contains(nextSeq))
1883 stretchGroup.deleteSequence(seq, false);
1884 needOverviewUpdate |= av.isSelectionDefinedGroup();
1890 stretchGroup.addSequence(seq, false);
1893 stretchGroup.addSequence(nextSeq, false);
1894 needOverviewUpdate |= av.isSelectionDefinedGroup();
1903 mouseDragging = true;
1905 if (scrollThread != null)
1907 scrollThread.setEvent(evt);
1910 seqCanvas.repaint();
1913 void scrollCanvas(MouseEvent evt)
1917 if (scrollThread != null)
1919 scrollThread.running = false;
1920 scrollThread = null;
1922 mouseDragging = false;
1926 if (scrollThread == null)
1928 scrollThread = new ScrollThread();
1931 mouseDragging = true;
1932 scrollThread.setEvent(evt);
1937 // this class allows scrolling off the bottom of the visible alignment
1938 class ScrollThread extends Thread
1942 boolean running = false;
1944 public ScrollThread()
1949 public void setEvent(MouseEvent e)
1954 public void stopScrolling()
1968 if (mouseDragging && (evt.getY() < 0)
1969 && (av.getRanges().getStartSeq() > 0))
1971 running = ap.scrollUp(true);
1974 if (mouseDragging && (evt.getY() >= getHeight())
1975 && (av.getAlignment().getHeight() > av.getRanges()
1978 running = ap.scrollUp(false);
1981 if (mouseDragging && (evt.getX() < 0))
1983 running = ap.scrollRight(false);
1985 else if (mouseDragging && (evt.getX() >= getWidth()))
1987 running = ap.scrollRight(true);
1994 } catch (Exception ex)
2002 * modify current selection according to a received message.
2005 public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2006 HiddenColumns hidden, SelectionSource source)
2008 // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2009 // handles selection messages...
2010 // TODO: extend config options to allow user to control if selections may be
2011 // shared between viewports.
2012 boolean iSentTheSelection = (av == source || (source instanceof AlignViewport && ((AlignmentViewport) source)
2013 .getSequenceSetId().equals(av.getSequenceSetId())));
2015 if (iSentTheSelection)
2017 // respond to our own event by updating dependent dialogs
2018 if (ap.getCalculationDialog() != null)
2020 ap.getCalculationDialog().validateCalcTypes();
2023 // process further ?
2024 if (!av.followSelection)
2031 * Ignore the selection if there is one of our own pending.
2033 if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2039 * Check for selection in a view of which this one is a dna/protein
2042 if (selectionFromTranslation(seqsel, colsel, hidden, source))
2047 // do we want to thread this ? (contention with seqsel and colsel locks, I
2050 * only copy colsel if there is a real intersection between
2051 * sequence selection and this panel's alignment
2053 boolean repaint = false;
2054 boolean copycolsel = false;
2056 SequenceGroup sgroup = null;
2057 if (seqsel != null && seqsel.getSize() > 0)
2059 if (av.getAlignment() == null)
2061 Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2062 + " ViewId=" + av.getViewId()
2063 + " 's alignment is NULL! returning immediately.");
2066 sgroup = seqsel.intersect(av.getAlignment(),
2067 (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2068 if ((sgroup != null && sgroup.getSize() > 0))
2073 if (sgroup != null && sgroup.getSize() > 0)
2075 av.setSelectionGroup(sgroup);
2079 av.setSelectionGroup(null);
2081 av.isSelectionGroupChanged(true);
2086 // the current selection is unset or from a previous message
2087 // so import the new colsel.
2088 if (colsel == null || colsel.isEmpty())
2090 if (av.getColumnSelection() != null)
2092 av.getColumnSelection().clear();
2098 // TODO: shift colSel according to the intersecting sequences
2099 if (av.getColumnSelection() == null)
2101 av.setColumnSelection(new ColumnSelection(colsel));
2105 av.getColumnSelection().setElementsFrom(colsel,
2106 av.getAlignment().getHiddenColumns());
2109 av.isColSelChanged(true);
2114 && av.hasHiddenColumns()
2115 && (av.getAlignment().getHiddenColumns() == null || av
2116 .getAlignment().getHiddenColumns().getHiddenRegions() == null))
2118 System.err.println("Bad things");
2120 if (repaint) // always true!
2122 // probably finessing with multiple redraws here
2123 PaintRefresher.Refresh(this, av.getSequenceSetId());
2124 // ap.paintAlignment(false);
2127 // lastly, update dependent dialogs
2128 if (ap.getCalculationDialog() != null)
2130 ap.getCalculationDialog().validateCalcTypes();
2136 * If this panel is a cdna/protein translation view of the selection source,
2137 * tries to map the source selection to a local one, and returns true. Else
2144 protected boolean selectionFromTranslation(SequenceGroup seqsel,
2145 ColumnSelection colsel, HiddenColumns hidden,
2146 SelectionSource source)
2148 if (!(source instanceof AlignViewportI))
2152 final AlignViewportI sourceAv = (AlignViewportI) source;
2153 if (sourceAv.getCodingComplement() != av
2154 && av.getCodingComplement() != sourceAv)
2160 * Map sequence selection
2162 SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2163 av.setSelectionGroup(sg);
2164 av.isSelectionGroupChanged(true);
2167 * Map column selection
2169 // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2171 ColumnSelection cs = new ColumnSelection();
2172 HiddenColumns hs = new HiddenColumns();
2173 MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2174 av.setColumnSelection(cs);
2175 av.getAlignment().setHiddenColumns(hs);
2177 // lastly, update any dependent dialogs
2178 if (ap.getCalculationDialog() != null)
2180 ap.getCalculationDialog().validateCalcTypes();
2183 PaintRefresher.Refresh(this, av.getSequenceSetId());