JAL-2416 order score models by order of addition rather than name
[jalview.git] / src / jalview / gui / IdPanel.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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.
11  *  
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.
16  * 
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.
20  */
21 package jalview.gui;
22
23 import jalview.datamodel.Sequence;
24 import jalview.datamodel.SequenceFeature;
25 import jalview.datamodel.SequenceGroup;
26 import jalview.datamodel.SequenceI;
27 import jalview.io.SequenceAnnotationReport;
28 import jalview.util.MessageManager;
29 import jalview.util.Platform;
30 import jalview.viewmodel.AlignmentViewport;
31
32 import java.awt.BorderLayout;
33 import java.awt.event.MouseEvent;
34 import java.awt.event.MouseListener;
35 import java.awt.event.MouseMotionListener;
36 import java.awt.event.MouseWheelEvent;
37 import java.awt.event.MouseWheelListener;
38 import java.util.List;
39
40 import javax.swing.JPanel;
41 import javax.swing.SwingUtilities;
42 import javax.swing.ToolTipManager;
43
44 /**
45  * This panel hosts alignment sequence ids and responds to mouse clicks on them,
46  * as well as highlighting ids matched by a search from the Find menu.
47  * 
48  * @author $author$
49  * @version $Revision$
50  */
51 public class IdPanel extends JPanel implements MouseListener,
52         MouseMotionListener, MouseWheelListener
53 {
54   private IdCanvas idCanvas;
55
56   protected AlignmentViewport av;
57
58   protected AlignmentPanel alignPanel;
59
60   ScrollThread scrollThread = null;
61
62   String linkImageURL;
63
64   int offy;
65
66   // int width;
67   int lastid = -1;
68
69   boolean mouseDragging = false;
70
71   private final SequenceAnnotationReport seqAnnotReport;
72
73   /**
74    * Creates a new IdPanel object.
75    * 
76    * @param av
77    * @param parent
78    */
79   public IdPanel(AlignViewport av, AlignmentPanel parent)
80   {
81     this.av = av;
82     alignPanel = parent;
83     setIdCanvas(new IdCanvas(av));
84     linkImageURL = getClass().getResource("/images/link.gif").toString();
85     seqAnnotReport = new SequenceAnnotationReport(linkImageURL);
86     setLayout(new BorderLayout());
87     add(getIdCanvas(), BorderLayout.CENTER);
88     addMouseListener(this);
89     addMouseMotionListener(this);
90     addMouseWheelListener(this);
91     ToolTipManager.sharedInstance().registerComponent(this);
92   }
93
94   /**
95    * Respond to mouse movement by constructing tooltip text for the sequence id
96    * under the mouse.
97    * 
98    * @param e
99    *          DOCUMENT ME!
100    */
101   @Override
102   public void mouseMoved(MouseEvent e)
103   {
104     SeqPanel sp = alignPanel.getSeqPanel();
105     int seq = Math.max(0, sp.findSeq(e));
106     if (seq > -1 && seq < av.getAlignment().getHeight())
107     {
108       SequenceI sequence = av.getAlignment().getSequenceAt(seq);
109       StringBuilder tip = new StringBuilder(64);
110       seqAnnotReport.createTooltipAnnotationReport(tip, sequence,
111               av.isShowDBRefs(), av.isShowNPFeats(),
112               sp.seqCanvas.fr.getMinMax());
113       setToolTipText(JvSwingUtils.wrapTooltip(true,
114               sequence.getDisplayId(true) + " " + tip.toString()));
115     }
116   }
117
118   /**
119    * Responds to a mouse drag by selecting the sequences under the dragged
120    * region.
121    * 
122    * @param e
123    */
124   @Override
125   public void mouseDragged(MouseEvent e)
126   {
127     mouseDragging = true;
128
129     int seq = Math.max(0, alignPanel.getSeqPanel().findSeq(e));
130
131     if (seq < lastid)
132     {
133       selectSeqs(lastid - 1, seq);
134     }
135     else if (seq > lastid)
136     {
137       selectSeqs(lastid + 1, seq);
138     }
139
140     lastid = seq;
141     alignPanel.paintAlignment(true);
142   }
143
144   /**
145    * Response to the mouse wheel by scrolling the alignment panel.
146    */
147   @Override
148   public void mouseWheelMoved(MouseWheelEvent e)
149   {
150     e.consume();
151     if (e.getWheelRotation() > 0)
152     {
153       if (e.isShiftDown())
154       {
155         alignPanel.scrollRight(true);
156       }
157       else
158       {
159         alignPanel.scrollUp(false);
160       }
161     }
162     else
163     {
164       if (e.isShiftDown())
165       {
166         alignPanel.scrollRight(false);
167       }
168       else
169       {
170         alignPanel.scrollUp(true);
171       }
172     }
173   }
174
175   /**
176    * Handle a mouse click event. Currently only responds to a double-click. The
177    * action is to try to open a browser window at a URL that searches for the
178    * selected sequence id. The search URL is configured in Preferences |
179    * Connections | URL link from Sequence ID. For example:
180    * 
181    * http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$
182    * 
183    * @param e
184    */
185   @Override
186   public void mouseClicked(MouseEvent e)
187   {
188     /*
189      * Ignore single click. Ignore 'left' click followed by 'right' click (user
190      * selects a row then its pop-up menu).
191      */
192     if (e.getClickCount() < 2 || SwingUtilities.isRightMouseButton(e))
193     {
194       // reinstate isRightMouseButton check to ignore mouse-related popup events
195       // note - this does nothing on default MacBookPro force-trackpad config!
196       return;
197     }
198
199     int seq = alignPanel.getSeqPanel().findSeq(e);
200     String id = av.getAlignment().getSequenceAt(seq).getName();
201     String url = Preferences.sequenceUrlLinks.getPrimaryUrl(id);
202
203     try
204     {
205       jalview.util.BrowserLauncher.openURL(url);
206     } catch (Exception ex)
207     {
208       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
209               MessageManager.getString("label.web_browser_not_found_unix"),
210               MessageManager.getString("label.web_browser_not_found"),
211               JvOptionPane.WARNING_MESSAGE);
212       ex.printStackTrace();
213     }
214   }
215
216   /**
217    * DOCUMENT ME!
218    * 
219    * @param e
220    *          DOCUMENT ME!
221    */
222   @Override
223   public void mouseEntered(MouseEvent e)
224   {
225     if (scrollThread != null)
226     {
227       scrollThread.running = false;
228     }
229   }
230
231   /**
232    * DOCUMENT ME!
233    * 
234    * @param e
235    *          DOCUMENT ME!
236    */
237   @Override
238   public void mouseExited(MouseEvent e)
239   {
240     if (av.getWrapAlignment())
241     {
242       return;
243     }
244
245     if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))
246     {
247       scrollThread = new ScrollThread(true);
248     }
249
250     if (mouseDragging && (e.getY() >= getHeight())
251             && (av.getAlignment().getHeight() > av.getEndSeq()))
252     {
253       scrollThread = new ScrollThread(false);
254     }
255   }
256
257   /**
258    * Respond to a mouse press. Does nothing for (left) double-click as this is
259    * handled by mouseClicked().
260    * 
261    * Right mouse down - construct and show context menu.
262    * 
263    * Ctrl-down or Shift-down - add to or expand current selection group if there
264    * is one.
265    * 
266    * Mouse down - select this sequence.
267    * 
268    * @param e
269    */
270   @Override
271   public void mousePressed(MouseEvent e)
272   {
273     if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e))
274     {
275       return;
276     }
277
278     if (e.isPopupTrigger()) // Mac reports this in mousePressed
279     {
280       showPopupMenu(e);
281       return;
282     }
283
284     /*
285      * defer right-mouse click handling to mouseReleased on Windows
286      * (where isPopupTrigger() will answer true)
287      * NB isRightMouseButton is also true for Cmd-click on Mac
288      */
289     if (SwingUtilities.isRightMouseButton(e) && !Platform.isAMac())
290     {
291       return;
292     }
293
294     if ((av.getSelectionGroup() == null)
295             || (!jalview.util.Platform.isControlDown(e) && !e.isShiftDown() && av
296                     .getSelectionGroup() != null))
297     {
298       av.setSelectionGroup(new SequenceGroup());
299       av.getSelectionGroup().setStartRes(0);
300       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
301     }
302
303     int seq = alignPanel.getSeqPanel().findSeq(e);
304     if (e.isShiftDown() && (lastid != -1))
305     {
306       selectSeqs(lastid, seq);
307     }
308     else
309     {
310       selectSeq(seq);
311     }
312
313     av.isSelectionGroupChanged(true);
314
315     alignPanel.paintAlignment(true);
316   }
317
318   /**
319    * Build and show the popup-menu at the right-click mouse position
320    * 
321    * @param e
322    */
323   void showPopupMenu(MouseEvent e)
324   {
325     int seq2 = alignPanel.getSeqPanel().findSeq(e);
326     Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq2);
327     // build a new links menu based on the current links + any non-positional
328     // features
329     List<String> nlinks = Preferences.sequenceUrlLinks.getLinksForMenu();
330     SequenceFeature sfs[] = sq == null ? null : sq.getSequenceFeatures();
331     if (sfs != null)
332     {
333       for (SequenceFeature sf : sfs)
334       {
335         if (sf.begin == sf.end && sf.begin == 0)
336         {
337           if (sf.links != null && sf.links.size() > 0)
338           {
339             for (int l = 0, lSize = sf.links.size(); l < lSize; l++)
340             {
341               nlinks.add(sf.links.elementAt(l));
342             }
343           }
344         }
345       }
346     }
347
348     PopupMenu pop = new PopupMenu(alignPanel, sq, nlinks,
349             Preferences.getGroupURLLinks());
350     pop.show(this, e.getX(), e.getY());
351   }
352
353   /**
354    * Toggle whether the sequence is part of the current selection group.
355    * 
356    * @param seq
357    */
358   void selectSeq(int seq)
359   {
360     lastid = seq;
361
362     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
363     av.getSelectionGroup().addOrRemove(pickedSeq, true);
364   }
365
366   /**
367    * Add contiguous rows of the alignment to the current selection group. Does
368    * nothing if there is no selection group.
369    * 
370    * @param start
371    * @param end
372    */
373   void selectSeqs(int start, int end)
374   {
375     if (av.getSelectionGroup() == null)
376     {
377       return;
378     }
379
380     if (end >= av.getAlignment().getHeight())
381     {
382       end = av.getAlignment().getHeight() - 1;
383     }
384
385     lastid = start;
386
387     if (end < start)
388     {
389       int tmp = start;
390       start = end;
391       end = tmp;
392       lastid = end;
393     }
394
395     for (int i = start; i <= end; i++)
396     {
397       av.getSelectionGroup().addSequence(
398               av.getAlignment().getSequenceAt(i), i == end);
399     }
400   }
401
402   /**
403    * Respond to mouse released. Refreshes the display and triggers broadcast of
404    * the new selection group to any listeners.
405    * 
406    * @param e
407    */
408   @Override
409   public void mouseReleased(MouseEvent e)
410   {
411     if (scrollThread != null)
412     {
413       scrollThread.running = false;
414     }
415
416     mouseDragging = false;
417     PaintRefresher.Refresh(this, av.getSequenceSetId());
418     // always send selection message when mouse is released
419     av.sendSelection();
420
421     if (e.isPopupTrigger()) // Windows reports this in mouseReleased
422     {
423       showPopupMenu(e);
424     }
425   }
426
427   /**
428    * Highlight sequence ids that match the given list, and if necessary scroll
429    * to the start sequence of the list.
430    * 
431    * @param list
432    */
433   public void highlightSearchResults(List<SequenceI> list)
434   {
435     getIdCanvas().setHighlighted(list);
436
437     if (list == null)
438     {
439       return;
440     }
441
442     int index = av.getAlignment().findIndex(list.get(0));
443
444     // do we need to scroll the panel?
445     if ((av.getStartSeq() > index) || (av.getEndSeq() < index))
446     {
447       alignPanel.setScrollValues(av.getStartRes(), index);
448     }
449   }
450
451   public IdCanvas getIdCanvas()
452   {
453     return idCanvas;
454   }
455
456   public void setIdCanvas(IdCanvas idCanvas)
457   {
458     this.idCanvas = idCanvas;
459   }
460
461   // this class allows scrolling off the bottom of the visible alignment
462   class ScrollThread extends Thread
463   {
464     boolean running = false;
465
466     boolean up = true;
467
468     public ScrollThread(boolean up)
469     {
470       this.up = up;
471       start();
472     }
473
474     public void stopScrolling()
475     {
476       running = false;
477     }
478
479     @Override
480     public void run()
481     {
482       running = true;
483
484       while (running)
485       {
486         if (alignPanel.scrollUp(up))
487         {
488           // scroll was ok, so add new sequence to selection
489           int seq = av.getStartSeq();
490
491           if (!up)
492           {
493             seq = av.getEndSeq();
494           }
495
496           if (seq < lastid)
497           {
498             selectSeqs(lastid - 1, seq);
499           }
500           else if (seq > lastid)
501           {
502             selectSeqs(lastid + 1, seq);
503           }
504
505           lastid = seq;
506         }
507         else
508         {
509           running = false;
510         }
511
512         alignPanel.paintAlignment(false);
513
514         try
515         {
516           Thread.sleep(100);
517         } catch (Exception ex)
518         {
519         }
520       }
521     }
522   }
523 }