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;
88 * last column position for mouseMoved event
90 private int lastMouseColumn;
93 * last sequence offset for mouseMoved event
95 private int lastMouseSeq;
97 protected int lastres;
99 protected int startseq;
101 protected AlignViewport av;
103 ScrollThread scrollThread = null;
105 boolean mouseDragging = false;
107 boolean editingSeqs = false;
109 boolean groupEditing = false;
111 // ////////////////////////////////////////
112 // ///Everything below this is for defining the boundary of the rubberband
113 // ////////////////////////////////////////
116 boolean changeEndSeq = false;
118 boolean changeStartSeq = false;
120 boolean changeEndRes = false;
122 boolean changeStartRes = false;
124 SequenceGroup stretchGroup = null;
126 boolean remove = false;
128 Point lastMousePress;
130 boolean mouseWheelPressed = false;
132 StringBuffer keyboardNo1;
134 StringBuffer keyboardNo2;
136 java.net.URL linkImageURL;
138 private final SequenceAnnotationReport seqARep;
140 StringBuilder tooltipText = new StringBuilder();
144 EditCommand editCommand;
146 StructureSelectionManager ssm;
148 SearchResultsI lastSearchResults;
151 * Creates a new SeqPanel object.
158 public SeqPanel(AlignViewport av, AlignmentPanel ap)
160 linkImageURL = getClass().getResource("/images/link.gif");
161 seqARep = new SequenceAnnotationReport(linkImageURL.toString());
162 ToolTipManager.sharedInstance().registerComponent(this);
163 ToolTipManager.sharedInstance().setInitialDelay(0);
164 ToolTipManager.sharedInstance().setDismissDelay(10000);
166 setBackground(Color.white);
168 seqCanvas = new SeqCanvas(ap);
169 setLayout(new BorderLayout());
170 add(seqCanvas, BorderLayout.CENTER);
176 addMouseMotionListener(this);
177 addMouseListener(this);
178 addMouseWheelListener(this);
179 ssm = av.getStructureSelectionManager();
180 ssm.addStructureViewerListener(this);
181 ssm.addSelectionListener(this);
184 lastMouseColumn = -1;
188 int startWrapBlock = -1;
190 int wrappedBlock = -1;
193 * Returns the aligned sequence position (base 0) at the mouse position, or
194 * the closest visible one
199 int findColumn(MouseEvent evt)
204 if (av.getWrapAlignment())
207 int hgap = av.getCharHeight();
208 if (av.getScaleAboveWrapped())
210 hgap += av.getCharHeight();
213 int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
214 + hgap + seqCanvas.getAnnotationHeight();
218 x -= seqCanvas.LABEL_WEST;
220 int cwidth = seqCanvas.getWrappedCanvasWidth(this.getWidth());
226 wrappedBlock = y / cHeight;
227 wrappedBlock += av.getRanges().getStartRes() / cwidth;
229 res = wrappedBlock * cwidth + x / av.getCharWidth();
234 if (x > seqCanvas.getX() + seqCanvas.getWidth())
236 // make sure we calculate relative to visible alignment, rather than
238 x = seqCanvas.getX() + seqCanvas.getWidth();
240 res = (x / av.getCharWidth()) + av.getRanges().getStartRes();
241 if (res > av.getRanges().getEndRes())
244 res = av.getRanges().getEndRes();
248 if (av.hasHiddenColumns())
250 res = av.getAlignment().getHiddenColumns()
251 .adjustForHiddenColumns(res);
258 int findSeq(MouseEvent evt)
263 if (av.getWrapAlignment())
265 int hgap = av.getCharHeight();
266 if (av.getScaleAboveWrapped())
268 hgap += av.getCharHeight();
271 int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
272 + hgap + seqCanvas.getAnnotationHeight();
276 seq = Math.min((y % cHeight) / av.getCharHeight(), av.getAlignment()
281 seq = Math.min((y / av.getCharHeight())
282 + av.getRanges().getStartSeq(),
284 .getAlignment().getHeight() - 1);
291 * When all of a sequence of edits are complete, put the resulting edit list
292 * on the history stack (undo list), and reset flags for editing in progress.
298 if (editCommand != null && editCommand.getSize() > 0)
300 ap.alignFrame.addHistoryItem(editCommand);
301 av.firePropertyChange("alignment", null, av.getAlignment()
307 * Tidy up come what may...
312 groupEditing = false;
321 seqCanvas.cursorY = getKeyboardNo1() - 1;
325 void setCursorColumn()
327 seqCanvas.cursorX = getKeyboardNo1() - 1;
331 void setCursorRowAndColumn()
333 if (keyboardNo2 == null)
335 keyboardNo2 = new StringBuffer();
339 seqCanvas.cursorX = getKeyboardNo1() - 1;
340 seqCanvas.cursorY = getKeyboardNo2() - 1;
345 void setCursorPosition()
347 SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
349 seqCanvas.cursorX = sequence.findIndex(getKeyboardNo1()) - 1;
353 void moveCursor(int dx, int dy)
355 seqCanvas.cursorX += dx;
356 seqCanvas.cursorY += dy;
358 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
360 if (av.hasHiddenColumns()
361 && !hidden.isVisible(seqCanvas.cursorX))
363 int original = seqCanvas.cursorX - dx;
364 int maxWidth = av.getAlignment().getWidth();
366 while (!hidden.isVisible(seqCanvas.cursorX)
367 && seqCanvas.cursorX < maxWidth && seqCanvas.cursorX > 0)
369 seqCanvas.cursorX += dx;
372 if (seqCanvas.cursorX >= maxWidth
373 || !hidden.isVisible(seqCanvas.cursorX))
375 seqCanvas.cursorX = original;
382 void scrollToVisible()
384 if (seqCanvas.cursorX < 0)
386 seqCanvas.cursorX = 0;
388 else if (seqCanvas.cursorX > av.getAlignment().getWidth() - 1)
390 seqCanvas.cursorX = av.getAlignment().getWidth() - 1;
393 if (seqCanvas.cursorY < 0)
395 seqCanvas.cursorY = 0;
397 else if (seqCanvas.cursorY > av.getAlignment().getHeight() - 1)
399 seqCanvas.cursorY = av.getAlignment().getHeight() - 1;
403 if (av.getWrapAlignment())
405 av.getRanges().scrollToWrappedVisible(seqCanvas.cursorX);
409 av.getRanges().scrollToVisible(seqCanvas.cursorX, seqCanvas.cursorY,
412 setStatusMessage(av.getAlignment().getSequenceAt(seqCanvas.cursorY),
413 seqCanvas.cursorX, seqCanvas.cursorY);
418 void setSelectionAreaAtCursor(boolean topLeft)
420 SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
422 if (av.getSelectionGroup() != null)
424 SequenceGroup sg = av.getSelectionGroup();
425 // Find the top and bottom of this group
426 int min = av.getAlignment().getHeight(), max = 0;
427 for (int i = 0; i < sg.getSize(); i++)
429 int index = av.getAlignment().findIndex(sg.getSequenceAt(i));
444 sg.setStartRes(seqCanvas.cursorX);
445 if (sg.getEndRes() < seqCanvas.cursorX)
447 sg.setEndRes(seqCanvas.cursorX);
450 min = seqCanvas.cursorY;
454 sg.setEndRes(seqCanvas.cursorX);
455 if (sg.getStartRes() > seqCanvas.cursorX)
457 sg.setStartRes(seqCanvas.cursorX);
460 max = seqCanvas.cursorY + 1;
465 // Only the user can do this
466 av.setSelectionGroup(null);
470 // Now add any sequences between min and max
471 sg.getSequences(null).clear();
472 for (int i = min; i < max; i++)
474 sg.addSequence(av.getAlignment().getSequenceAt(i), false);
479 if (av.getSelectionGroup() == null)
481 SequenceGroup sg = new SequenceGroup();
482 sg.setStartRes(seqCanvas.cursorX);
483 sg.setEndRes(seqCanvas.cursorX);
484 sg.addSequence(sequence, false);
485 av.setSelectionGroup(sg);
488 ap.paintAlignment(false);
492 void insertGapAtCursor(boolean group)
494 groupEditing = group;
495 startseq = seqCanvas.cursorY;
496 lastres = seqCanvas.cursorX;
497 editSequence(true, false, seqCanvas.cursorX + getKeyboardNo1());
501 void deleteGapAtCursor(boolean group)
503 groupEditing = group;
504 startseq = seqCanvas.cursorY;
505 lastres = seqCanvas.cursorX + getKeyboardNo1();
506 editSequence(false, false, seqCanvas.cursorX);
510 void insertNucAtCursor(boolean group, String nuc)
512 // TODO not called - delete?
513 groupEditing = group;
514 startseq = seqCanvas.cursorY;
515 lastres = seqCanvas.cursorX;
516 editSequence(false, true, seqCanvas.cursorX + getKeyboardNo1());
520 void numberPressed(char value)
522 if (keyboardNo1 == null)
524 keyboardNo1 = new StringBuffer();
527 if (keyboardNo2 != null)
529 keyboardNo2.append(value);
533 keyboardNo1.append(value);
541 if (keyboardNo1 != null)
543 int value = Integer.parseInt(keyboardNo1.toString());
547 } catch (Exception x)
558 if (keyboardNo2 != null)
560 int value = Integer.parseInt(keyboardNo2.toString());
564 } catch (Exception x)
578 public void mouseReleased(MouseEvent evt)
580 mouseDragging = false;
581 mouseWheelPressed = false;
583 if (evt.isPopupTrigger()) // Windows: mouseReleased
592 doMouseReleasedDefineMode(evt);
606 public void mousePressed(MouseEvent evt)
608 lastMousePress = evt.getPoint();
610 if (SwingUtilities.isMiddleMouseButton(evt))
612 mouseWheelPressed = true;
616 boolean isControlDown = Platform.isControlDown(evt);
617 if (evt.isShiftDown() || isControlDown)
627 doMousePressedDefineMode(evt);
631 int seq = findSeq(evt);
632 int res = findColumn(evt);
634 if (seq < 0 || res < 0)
639 if ((seq < av.getAlignment().getHeight())
640 && (res < av.getAlignment().getSequenceAt(seq).getLength()))
657 public void mouseOverSequence(SequenceI sequence, int index, int pos)
659 String tmp = sequence.hashCode() + " " + index + " " + pos;
661 if (lastMessage == null || !lastMessage.equals(tmp))
663 // System.err.println("mouseOver Sequence: "+tmp);
664 ssm.mouseOverSequence(sequence, index, pos, av);
670 * Highlight the mapped region described by the search results object (unless
671 * unchanged). This supports highlight of protein while mousing over linked
672 * cDNA and vice versa. The status bar is also updated to show the location of
673 * the start of the highlighted region.
676 public void highlightSequence(SearchResultsI results)
678 if (results == null || results.equals(lastSearchResults))
682 lastSearchResults = results;
684 if (av.isFollowHighlight())
686 // don't allow highlight of protein/cDNA to also scroll a complementary
687 // panel,as this sets up a feedback loop (scrolling panel 1 causes moused
688 // over residue to change abruptly, causing highlighted residue in panel 2
689 // to change, causing a scroll in panel 1 etc)
690 ap.setToScrollComplementPanel(false);
691 if (ap.scrollToPosition(results, false))
693 seqCanvas.revalidate();
695 ap.setToScrollComplementPanel(true);
697 setStatusMessage(results);
698 seqCanvas.highlightSearchResults(results);
702 public VamsasSource getVamsasSource()
704 return this.ap == null ? null : this.ap.av;
708 public void updateColours(SequenceI seq, int index)
710 System.out.println("update the seqPanel colours");
721 public void mouseMoved(MouseEvent evt)
725 // This is because MacOSX creates a mouseMoved
726 // If control is down, other platforms will not.
730 final int column = findColumn(evt);
731 int seq = findSeq(evt);
732 if (column < 0 || seq < 0 || seq >= av.getAlignment().getHeight())
736 if (column == lastMouseColumn && seq == lastMouseSeq)
739 * just a pixel move without change of residue
743 lastMouseColumn = column;
746 SequenceI sequence = av.getAlignment().getSequenceAt(seq);
748 if (column >= sequence.getLength())
754 * set status bar message, returning residue position in sequence
756 final int pos = setStatusMessage(sequence, column, seq);
757 if (ssm != null && pos > -1)
759 mouseOverSequence(sequence, column, pos);
762 tooltipText.setLength(6); // Cuts the buffer back to <html>
764 SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
767 for (int g = 0; g < groups.length; g++)
769 if (groups[g].getStartRes() <= column
770 && groups[g].getEndRes() >= column)
772 if (!groups[g].getName().startsWith("JTreeGroup")
773 && !groups[g].getName().startsWith("JGroup"))
775 tooltipText.append(groups[g].getName());
778 if (groups[g].getDescription() != null)
780 tooltipText.append(": " + groups[g].getDescription());
786 if (av.isShowSequenceFeatures() && pos != -1)
788 List<SequenceFeature> features = ap.getFeatureRenderer()
789 .findFeaturesAtRes(sequence.getDatasetSequence(), pos);
790 seqARep.appendFeatures(tooltipText, pos, features,
791 this.ap.getSeqPanel().seqCanvas.fr.getMinMax());
793 if (tooltipText.length() == 6) // <html>
795 setToolTipText(null);
800 String textString = tooltipText.toString();
801 if (lastTooltip == null || !lastTooltip.equals(textString))
803 String formatedTooltipText = JvSwingUtils.wrapTooltip(true,
805 setToolTipText(formatedTooltipText);
806 lastTooltip = textString;
811 private Point lastp = null;
816 * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
819 public Point getToolTipLocation(MouseEvent event)
821 int x = event.getX(), w = getWidth();
822 int wdth = (w - x < 200) ? -(w / 2) : 5; // switch sides when tooltip is too
825 if (!event.isShiftDown() || p == null)
827 p = (tooltipText != null && tooltipText.length() > 6) ? new Point(
828 event.getX() + wdth, event.getY() - 20) : null;
831 * TODO: try to modify position region is not obcured by tooltip
839 * set when the current UI interaction has resulted in a change that requires
840 * overview shading to be recalculated. this could be changed to something
841 * more expressive that indicates what actually has changed, so selective
842 * redraws can be applied
844 private boolean needOverviewUpdate = false; // TODO: refactor to avcontroller
847 * set if av.getSelectionGroup() refers to a group that is defined on the
848 * alignment view, rather than a transient selection
850 // private boolean editingDefinedGroup = false; // TODO: refactor to
851 // avcontroller or viewModel
854 * Sets the status message in alignment panel, showing the sequence number
855 * (index) and id, residue and residue position for the given sequence and
856 * column position. Returns the calculated residue position in the sequence,
857 * or -1 for a gapped column position.
860 * aligned sequence object
864 * index of sequence in alignment
865 * @return position of column in sequence or -1 if at a gap
867 int setStatusMessage(SequenceI sequence, final int column, int seq)
869 StringBuilder text = new StringBuilder(32);
872 * Sequence number (if known), and sequence name.
874 String seqno = seq == -1 ? "" : " " + (seq + 1);
875 text.append("Sequence").append(seqno).append(" ID: ")
876 .append(sequence.getName());
878 String residue = null;
880 * Try to translate the display character to residue name (null for gap).
882 final String displayChar = String.valueOf(sequence.getCharAt(column));
883 if (av.getAlignment().isNucleotide())
885 residue = ResidueProperties.nucleotideName.get(displayChar);
888 text.append(" Nucleotide: ").append(residue);
893 residue = "X".equalsIgnoreCase(displayChar) ? "X" : ("*"
894 .equals(displayChar) ? "STOP" : ResidueProperties.aa2Triplet
898 text.append(" Residue: ").append(residue);
905 pos = sequence.findPosition(column);
906 text.append(" (").append(Integer.toString(pos)).append(")");
908 ap.alignFrame.statusBar.setText(text.toString());
913 * Set the status bar message to highlight the first matched position in
918 private void setStatusMessage(SearchResultsI results)
920 AlignmentI al = this.av.getAlignment();
921 int sequenceIndex = al.findIndex(results);
922 if (sequenceIndex == -1)
926 SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
927 for (SearchResultMatchI m : results.getResults())
929 SequenceI seq = m.getSequence();
930 if (seq.getDatasetSequence() != null)
932 seq = seq.getDatasetSequence();
938 * Convert position in sequence (base 1) to sequence character array
941 int start = m.getStart() - m.getSequence().getStart();
942 setStatusMessage(seq, start, sequenceIndex);
952 public void mouseDragged(MouseEvent evt)
954 if (mouseWheelPressed)
956 boolean inSplitFrame = ap.av.getCodingComplement() != null;
957 boolean copyChanges = inSplitFrame && av.isProteinFontAsCdna();
959 int oldWidth = av.getCharWidth();
961 // Which is bigger, left-right or up-down?
962 if (Math.abs(evt.getY() - lastMousePress.getY()) > Math.abs(evt
963 .getX() - lastMousePress.getX()))
966 * on drag up or down, decrement or increment font size
968 int fontSize = av.font.getSize();
969 boolean fontChanged = false;
971 if (evt.getY() < lastMousePress.getY())
976 else if (evt.getY() > lastMousePress.getY())
989 Font newFont = new Font(av.font.getName(), av.font.getStyle(),
991 av.setFont(newFont, true);
992 av.setCharWidth(oldWidth);
996 ap.av.getCodingComplement().setFont(newFont, true);
997 SplitFrame splitFrame = (SplitFrame) ap.alignFrame
998 .getSplitViewContainer();
999 splitFrame.adjustLayout();
1000 splitFrame.repaint();
1007 * on drag left or right, decrement or increment character width
1010 if (evt.getX() < lastMousePress.getX() && av.getCharWidth() > 1)
1012 newWidth = av.getCharWidth() - 1;
1013 av.setCharWidth(newWidth);
1015 else if (evt.getX() > lastMousePress.getX())
1017 newWidth = av.getCharWidth() + 1;
1018 av.setCharWidth(newWidth);
1022 ap.paintAlignment(false);
1026 * need to ensure newWidth is set on cdna, regardless of which
1027 * panel the mouse drag happened in; protein will compute its
1028 * character width as 1:1 or 3:1
1030 av.getCodingComplement().setCharWidth(newWidth);
1031 SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1032 .getSplitViewContainer();
1033 splitFrame.adjustLayout();
1034 splitFrame.repaint();
1039 FontMetrics fm = getFontMetrics(av.getFont());
1040 av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
1042 lastMousePress = evt.getPoint();
1049 doMouseDraggedDefineMode(evt);
1053 int res = findColumn(evt);
1060 if ((lastres == -1) || (lastres == res))
1065 if ((res < av.getAlignment().getWidth()) && (res < lastres))
1067 // dragLeft, delete gap
1068 editSequence(false, false, res);
1072 editSequence(true, false, res);
1075 mouseDragging = true;
1076 if (scrollThread != null)
1078 scrollThread.setEvent(evt);
1082 // TODO: Make it more clever than many booleans
1083 synchronized void editSequence(boolean insertGap, boolean editSeq,
1087 int fixedRight = -1;
1088 boolean fixedColumns = false;
1089 SequenceGroup sg = av.getSelectionGroup();
1091 SequenceI seq = av.getAlignment().getSequenceAt(startseq);
1093 // No group, but the sequence may represent a group
1094 if (!groupEditing && av.hasHiddenRows())
1096 if (av.isHiddenRepSequence(seq))
1098 sg = av.getRepresentedSequences(seq);
1099 groupEditing = true;
1103 StringBuilder message = new StringBuilder(64);
1106 message.append("Edit group:");
1107 if (editCommand == null)
1109 editCommand = new EditCommand(
1110 MessageManager.getString("action.edit_group"));
1115 message.append("Edit sequence: " + seq.getName());
1116 String label = seq.getName();
1117 if (label.length() > 10)
1119 label = label.substring(0, 10);
1121 if (editCommand == null)
1123 editCommand = new EditCommand(MessageManager.formatMessage(
1124 "label.edit_params", new String[] { label }));
1130 message.append(" insert ");
1134 message.append(" delete ");
1137 message.append(Math.abs(startres - lastres) + " gaps.");
1138 ap.alignFrame.statusBar.setText(message.toString());
1140 // Are we editing within a selection group?
1142 || (sg != null && sg.getSequences(av.getHiddenRepSequences())
1145 fixedColumns = true;
1147 // sg might be null as the user may only see 1 sequence,
1148 // but the sequence represents a group
1151 if (!av.isHiddenRepSequence(seq))
1156 sg = av.getRepresentedSequences(seq);
1159 fixedLeft = sg.getStartRes();
1160 fixedRight = sg.getEndRes();
1162 if ((startres < fixedLeft && lastres >= fixedLeft)
1163 || (startres >= fixedLeft && lastres < fixedLeft)
1164 || (startres > fixedRight && lastres <= fixedRight)
1165 || (startres <= fixedRight && lastres > fixedRight))
1171 if (fixedLeft > startres)
1173 fixedRight = fixedLeft - 1;
1176 else if (fixedRight < startres)
1178 fixedLeft = fixedRight;
1183 if (av.hasHiddenColumns())
1185 fixedColumns = true;
1186 int y1 = av.getAlignment().getHiddenColumns()
1187 .getHiddenBoundaryLeft(startres);
1188 int y2 = av.getAlignment().getHiddenColumns()
1189 .getHiddenBoundaryRight(startres);
1191 if ((insertGap && startres > y1 && lastres < y1)
1192 || (!insertGap && startres < y2 && lastres > y2))
1198 // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1199 // Selection spans a hidden region
1200 if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1208 fixedRight = y2 - 1;
1215 List<SequenceI> vseqs = sg.getSequences(av.getHiddenRepSequences());
1216 int g, groupSize = vseqs.size();
1217 SequenceI[] groupSeqs = new SequenceI[groupSize];
1218 for (g = 0; g < groupSeqs.length; g++)
1220 groupSeqs[g] = vseqs.get(g);
1226 // If the user has selected the whole sequence, and is dragging to
1227 // the right, we can still extend the alignment and selectionGroup
1228 if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1229 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1231 sg.setEndRes(av.getAlignment().getWidth() + startres - lastres);
1232 fixedRight = sg.getEndRes();
1235 // Is it valid with fixed columns??
1236 // Find the next gap before the end
1237 // of the visible region boundary
1238 boolean blank = false;
1239 for (fixedRight = fixedRight; fixedRight > lastres; fixedRight--)
1243 for (g = 0; g < groupSize; g++)
1245 for (int j = 0; j < startres - lastres; j++)
1247 if (!Comparison.isGap(groupSeqs[g].getCharAt(fixedRight - j)))
1262 if (sg.getSize() == av.getAlignment().getHeight())
1264 if ((av.hasHiddenColumns() && startres < av.getAlignment()
1265 .getHiddenColumns().getHiddenBoundaryRight(startres)))
1271 int alWidth = av.getAlignment().getWidth();
1272 if (av.hasHiddenRows())
1274 int hwidth = av.getAlignment().getHiddenSequences()
1276 if (hwidth > alWidth)
1281 // We can still insert gaps if the selectionGroup
1282 // contains all the sequences
1283 sg.setEndRes(sg.getEndRes() + startres - lastres);
1284 fixedRight = alWidth + startres - lastres;
1295 else if (!insertGap)
1297 // / Are we able to delete?
1298 // ie are all columns blank?
1300 for (g = 0; g < groupSize; g++)
1302 for (int j = startres; j < lastres; j++)
1304 if (groupSeqs[g].getLength() <= j)
1309 if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
1311 // Not a gap, block edit not valid
1321 // dragging to the right
1322 if (fixedColumns && fixedRight != -1)
1324 for (int j = lastres; j < startres; j++)
1326 insertChar(j, groupSeqs, fixedRight);
1331 appendEdit(Action.INSERT_GAP, groupSeqs, startres, startres
1337 // dragging to the left
1338 if (fixedColumns && fixedRight != -1)
1340 for (int j = lastres; j > startres; j--)
1342 deleteChar(startres, groupSeqs, fixedRight);
1347 appendEdit(Action.DELETE_GAP, groupSeqs, startres, lastres
1354 // ///Editing a single sequence///////////
1358 // dragging to the right
1359 if (fixedColumns && fixedRight != -1)
1361 for (int j = lastres; j < startres; j++)
1363 insertChar(j, new SequenceI[] { seq }, fixedRight);
1368 appendEdit(Action.INSERT_GAP, new SequenceI[] { seq }, lastres,
1369 startres - lastres);
1376 // dragging to the left
1377 if (fixedColumns && fixedRight != -1)
1379 for (int j = lastres; j > startres; j--)
1381 if (!Comparison.isGap(seq.getCharAt(startres)))
1386 deleteChar(startres, new SequenceI[] { seq }, fixedRight);
1391 // could be a keyboard edit trying to delete none gaps
1393 for (int m = startres; m < lastres; m++)
1395 if (!Comparison.isGap(seq.getCharAt(m)))
1404 appendEdit(Action.DELETE_GAP, new SequenceI[] { seq },
1410 {// insertGap==false AND editSeq==TRUE;
1411 if (fixedColumns && fixedRight != -1)
1413 for (int j = lastres; j < startres; j++)
1415 insertChar(j, new SequenceI[] { seq }, fixedRight);
1420 appendEdit(Action.INSERT_NUC, new SequenceI[] { seq }, lastres,
1421 startres - lastres);
1428 seqCanvas.repaint();
1431 void insertChar(int j, SequenceI[] seq, int fixedColumn)
1433 int blankColumn = fixedColumn;
1434 for (int s = 0; s < seq.length; s++)
1436 // Find the next gap before the end of the visible region boundary
1437 // If lastCol > j, theres a boundary after the gap insertion
1439 for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1441 if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
1443 // Theres a space, so break and insert the gap
1448 if (blankColumn <= j)
1450 blankColumn = fixedColumn;
1456 appendEdit(Action.DELETE_GAP, seq, blankColumn, 1);
1458 appendEdit(Action.INSERT_GAP, seq, j, 1);
1463 * Helper method to add and perform one edit action.
1470 protected void appendEdit(Action action, SequenceI[] seq, int pos,
1474 final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
1475 av.getAlignment().getGapCharacter());
1477 editCommand.appendEdit(edit, av.getAlignment(), true, null);
1480 void deleteChar(int j, SequenceI[] seq, int fixedColumn)
1483 appendEdit(Action.DELETE_GAP, seq, j, 1);
1485 appendEdit(Action.INSERT_GAP, seq, fixedColumn, 1);
1495 public void mouseEntered(MouseEvent e)
1502 if (scrollThread != null)
1504 scrollThread.running = false;
1505 scrollThread = null;
1516 public void mouseExited(MouseEvent e)
1518 if (av.getWrapAlignment())
1525 scrollThread = new ScrollThread();
1530 * Handler for double-click on a position with one or more sequence features.
1531 * Opens the Amend Features dialog to allow feature details to be amended, or
1532 * the feature deleted.
1535 public void mouseClicked(MouseEvent evt)
1537 SequenceGroup sg = null;
1538 SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
1539 if (evt.getClickCount() > 1)
1541 sg = av.getSelectionGroup();
1542 if (sg != null && sg.getSize() == 1
1543 && sg.getEndRes() - sg.getStartRes() < 2)
1545 av.setSelectionGroup(null);
1548 List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
1549 .findFeaturesAtRes(sequence.getDatasetSequence(),
1550 sequence.findPosition(findColumn(evt)));
1552 if (!features.isEmpty())
1555 * highlight the first feature at the position on the alignment
1557 SearchResultsI highlight = new SearchResults();
1558 highlight.addResult(sequence, features.get(0).getBegin(), features
1560 seqCanvas.highlightSearchResults(highlight);
1563 * open the Amend Features dialog; clear highlighting afterwards,
1564 * whether changes were made or not
1566 List<SequenceI> seqs = Collections.singletonList(sequence);
1567 seqCanvas.getFeatureRenderer().amendFeatures(seqs, features, false,
1569 seqCanvas.highlightSearchResults(null);
1575 public void mouseWheelMoved(MouseWheelEvent e)
1578 if (e.getWheelRotation() > 0)
1580 if (e.isShiftDown())
1582 av.getRanges().scrollRight(true);
1587 av.getRanges().scrollUp(false);
1592 if (e.isShiftDown())
1594 av.getRanges().scrollRight(false);
1598 av.getRanges().scrollUp(true);
1601 // TODO Update tooltip for new position.
1610 public void doMousePressedDefineMode(MouseEvent evt)
1612 final int res = findColumn(evt);
1613 final int seq = findSeq(evt);
1615 needOverviewUpdate = false;
1617 startWrapBlock = wrappedBlock;
1619 if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1621 JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
1622 .getString("label.cannot_edit_annotations_in_wrapped_view"),
1623 MessageManager.getString("label.wrapped_view_no_edit"),
1624 JvOptionPane.WARNING_MESSAGE);
1628 if (seq < 0 || res < 0)
1633 SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1635 if ((sequence == null) || (res > sequence.getLength()))
1640 stretchGroup = av.getSelectionGroup();
1642 if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1644 stretchGroup = av.getAlignment().findGroup(sequence, res);
1645 if (stretchGroup != null)
1647 // only update the current selection if the popup menu has a group to
1649 av.setSelectionGroup(stretchGroup);
1653 if (evt.isPopupTrigger()) // Mac: mousePressed
1660 * defer right-mouse click handling to mouseReleased on Windows
1661 * (where isPopupTrigger() will answer true)
1662 * NB isRightMouseButton is also true for Cmd-click on Mac
1664 if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1671 seqCanvas.cursorX = findColumn(evt);
1672 seqCanvas.cursorY = findSeq(evt);
1673 seqCanvas.repaint();
1677 if (stretchGroup == null)
1679 // Only if left mouse button do we want to change group sizes
1681 // define a new group here
1682 SequenceGroup sg = new SequenceGroup();
1683 sg.setStartRes(res);
1685 sg.addSequence(sequence, false);
1686 av.setSelectionGroup(sg);
1689 if (av.getConservationSelected())
1691 SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1695 if (av.getAbovePIDThreshold())
1697 SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1700 // TODO: stretchGroup will always be not null. Is this a merge error ?
1701 if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1703 // Edit end res position of selected group
1704 changeEndRes = true;
1706 else if ((stretchGroup != null)
1707 && (stretchGroup.getStartRes() == res))
1709 // Edit end res position of selected group
1710 changeStartRes = true;
1712 stretchGroup.getWidth();
1715 seqCanvas.repaint();
1719 * Build and show a pop-up menu at the right-click mouse position
1725 void showPopupMenu(MouseEvent evt)
1727 final int res = findColumn(evt);
1728 final int seq = findSeq(evt);
1729 SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1730 List<SequenceFeature> allFeatures = ap.getFeatureRenderer()
1731 .findFeaturesAtRes(sequence.getDatasetSequence(),
1732 sequence.findPosition(res));
1733 List<String> links = new ArrayList<String>();
1734 for (SequenceFeature sf : allFeatures)
1736 if (sf.links != null)
1738 for (String link : sf.links)
1745 PopupMenu pop = new PopupMenu(ap, null, links);
1746 pop.show(this, evt.getX(), evt.getY());
1755 public void doMouseReleasedDefineMode(MouseEvent evt)
1757 if (stretchGroup == null)
1761 // always do this - annotation has own state
1762 // but defer colourscheme update until hidden sequences are passed in
1763 boolean vischange = stretchGroup.recalcConservation(true);
1764 needOverviewUpdate |= vischange && av.isSelectionDefinedGroup();
1765 if (stretchGroup.cs != null)
1767 stretchGroup.cs.alignmentChanged(stretchGroup,
1768 av.getHiddenRepSequences());
1770 ResidueShaderI groupColourScheme = stretchGroup.getGroupColourScheme();
1771 String name = stretchGroup.getName();
1772 if (stretchGroup.cs.conservationApplied())
1774 SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1776 if (stretchGroup.cs.getThreshold() > 0)
1778 SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1781 PaintRefresher.Refresh(this, av.getSequenceSetId());
1782 ap.paintAlignment(needOverviewUpdate);
1783 needOverviewUpdate = false;
1784 changeEndRes = false;
1785 changeStartRes = false;
1786 stretchGroup = null;
1796 public void doMouseDraggedDefineMode(MouseEvent evt)
1798 int res = findColumn(evt);
1799 int y = findSeq(evt);
1801 if (wrappedBlock != startWrapBlock)
1806 if (stretchGroup == null)
1811 if (res >= av.getAlignment().getWidth())
1813 res = av.getAlignment().getWidth() - 1;
1816 if (stretchGroup.getEndRes() == res)
1818 // Edit end res position of selected group
1819 changeEndRes = true;
1821 else if (stretchGroup.getStartRes() == res)
1823 // Edit start res position of selected group
1824 changeStartRes = true;
1827 if (res < av.getRanges().getStartRes())
1829 res = av.getRanges().getStartRes();
1834 if (res > (stretchGroup.getStartRes() - 1))
1836 stretchGroup.setEndRes(res);
1837 needOverviewUpdate |= av.isSelectionDefinedGroup();
1840 else if (changeStartRes)
1842 if (res < (stretchGroup.getEndRes() + 1))
1844 stretchGroup.setStartRes(res);
1845 needOverviewUpdate |= av.isSelectionDefinedGroup();
1849 int dragDirection = 0;
1855 else if (y < oldSeq)
1860 while ((y != oldSeq) && (oldSeq > -1)
1861 && (y < av.getAlignment().getHeight()))
1863 // This routine ensures we don't skip any sequences, as the
1864 // selection is quite slow.
1865 Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1867 oldSeq += dragDirection;
1874 Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1876 if (stretchGroup.getSequences(null).contains(nextSeq))
1878 stretchGroup.deleteSequence(seq, false);
1879 needOverviewUpdate |= av.isSelectionDefinedGroup();
1885 stretchGroup.addSequence(seq, false);
1888 stretchGroup.addSequence(nextSeq, false);
1889 needOverviewUpdate |= av.isSelectionDefinedGroup();
1898 mouseDragging = true;
1900 if (scrollThread != null)
1902 scrollThread.setEvent(evt);
1905 seqCanvas.repaint();
1908 void scrollCanvas(MouseEvent evt)
1912 if (scrollThread != null)
1914 scrollThread.running = false;
1915 scrollThread = null;
1917 mouseDragging = false;
1921 if (scrollThread == null)
1923 scrollThread = new ScrollThread();
1926 mouseDragging = true;
1927 scrollThread.setEvent(evt);
1932 // this class allows scrolling off the bottom of the visible alignment
1933 class ScrollThread extends Thread
1937 boolean running = false;
1939 public ScrollThread()
1944 public void setEvent(MouseEvent e)
1949 public void stopScrolling()
1963 if (mouseDragging && (evt.getY() < 0)
1964 && (av.getRanges().getStartSeq() > 0))
1966 running = av.getRanges().scrollUp(true);
1969 if (mouseDragging && (evt.getY() >= getHeight())
1970 && (av.getAlignment().getHeight() > av.getRanges()
1973 running = av.getRanges().scrollUp(false);
1976 if (mouseDragging && (evt.getX() < 0))
1978 running = av.getRanges().scrollRight(false);
1980 else if (mouseDragging && (evt.getX() >= getWidth()))
1982 running = av.getRanges().scrollRight(true);
1989 } catch (Exception ex)
1997 * modify current selection according to a received message.
2000 public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2001 HiddenColumns hidden, SelectionSource source)
2003 // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2004 // handles selection messages...
2005 // TODO: extend config options to allow user to control if selections may be
2006 // shared between viewports.
2007 boolean iSentTheSelection = (av == source || (source instanceof AlignViewport && ((AlignmentViewport) source)
2008 .getSequenceSetId().equals(av.getSequenceSetId())));
2010 if (iSentTheSelection)
2012 // respond to our own event by updating dependent dialogs
2013 if (ap.getCalculationDialog() != null)
2015 ap.getCalculationDialog().validateCalcTypes();
2018 // process further ?
2019 if (!av.followSelection)
2026 * Ignore the selection if there is one of our own pending.
2028 if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2034 * Check for selection in a view of which this one is a dna/protein
2037 if (selectionFromTranslation(seqsel, colsel, hidden, source))
2042 // do we want to thread this ? (contention with seqsel and colsel locks, I
2045 * only copy colsel if there is a real intersection between
2046 * sequence selection and this panel's alignment
2048 boolean repaint = false;
2049 boolean copycolsel = false;
2051 SequenceGroup sgroup = null;
2052 if (seqsel != null && seqsel.getSize() > 0)
2054 if (av.getAlignment() == null)
2056 Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2057 + " ViewId=" + av.getViewId()
2058 + " 's alignment is NULL! returning immediately.");
2061 sgroup = seqsel.intersect(av.getAlignment(),
2062 (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2063 if ((sgroup != null && sgroup.getSize() > 0))
2068 if (sgroup != null && sgroup.getSize() > 0)
2070 av.setSelectionGroup(sgroup);
2074 av.setSelectionGroup(null);
2076 av.isSelectionGroupChanged(true);
2081 // the current selection is unset or from a previous message
2082 // so import the new colsel.
2083 if (colsel == null || colsel.isEmpty())
2085 if (av.getColumnSelection() != null)
2087 av.getColumnSelection().clear();
2093 // TODO: shift colSel according to the intersecting sequences
2094 if (av.getColumnSelection() == null)
2096 av.setColumnSelection(new ColumnSelection(colsel));
2100 av.getColumnSelection().setElementsFrom(colsel,
2101 av.getAlignment().getHiddenColumns());
2104 av.isColSelChanged(true);
2109 && av.hasHiddenColumns()
2110 && (av.getAlignment().getHiddenColumns() == null || av
2111 .getAlignment().getHiddenColumns().getHiddenRegions() == null))
2113 System.err.println("Bad things");
2115 if (repaint) // always true!
2117 // probably finessing with multiple redraws here
2118 PaintRefresher.Refresh(this, av.getSequenceSetId());
2119 // ap.paintAlignment(false);
2122 // lastly, update dependent dialogs
2123 if (ap.getCalculationDialog() != null)
2125 ap.getCalculationDialog().validateCalcTypes();
2131 * If this panel is a cdna/protein translation view of the selection source,
2132 * tries to map the source selection to a local one, and returns true. Else
2139 protected boolean selectionFromTranslation(SequenceGroup seqsel,
2140 ColumnSelection colsel, HiddenColumns hidden,
2141 SelectionSource source)
2143 if (!(source instanceof AlignViewportI))
2147 final AlignViewportI sourceAv = (AlignViewportI) source;
2148 if (sourceAv.getCodingComplement() != av
2149 && av.getCodingComplement() != sourceAv)
2155 * Map sequence selection
2157 SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2158 av.setSelectionGroup(sg);
2159 av.isSelectionGroupChanged(true);
2162 * Map column selection
2164 // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2166 ColumnSelection cs = new ColumnSelection();
2167 HiddenColumns hs = new HiddenColumns();
2168 MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2169 av.setColumnSelection(cs);
2170 av.getAlignment().setHiddenColumns(hs);
2172 // lastly, update any dependent dialogs
2173 if (ap.getCalculationDialog() != null)
2175 ap.getCalculationDialog().validateCalcTypes();
2178 PaintRefresher.Refresh(this, av.getSequenceSetId());