9292749809d1b4f4336ed4d7b7b9d9f15e987268
[jalviewjs.git] / unused / appletgui / IdPanel.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)\r
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors\r
4  * \r
5  * This file is part of Jalview.\r
6  * \r
7  * Jalview is free software: you can redistribute it and/or\r
8  * modify it under the terms of the GNU General Public License \r
9  * as published by the Free Software Foundation, either version 3\r
10  * of the License, or (at your option) any later version.\r
11  *  \r
12  * Jalview is distributed in the hope that it will be useful, but \r
13  * WITHOUT ANY WARRANTY; without even the implied warranty \r
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
15  * PURPOSE.  See the GNU General Public License for more details.\r
16  * \r
17  * You should have received a copy of the GNU General Public License\r
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
19  * The Jalview Authors are detailed in the 'AUTHORS' file.\r
20  */\r
21 package jalview.appletgui;\r
22 \r
23 import jalview.datamodel.Sequence;\r
24 import jalview.datamodel.SequenceFeature;\r
25 import jalview.datamodel.SequenceGroup;\r
26 import jalview.datamodel.SequenceI;\r
27 import jalview.util.UrlLink;\r
28 import jalview.viewmodel.AlignmentViewport;\r
29 \r
30 import java.awt.BorderLayout;\r
31 import java.awt.Panel;\r
32 import java.awt.event.InputEvent;\r
33 import java.awt.event.MouseEvent;\r
34 import java.awt.event.MouseListener;\r
35 import java.awt.event.MouseMotionListener;\r
36 import java.util.List;\r
37 import java.util.Vector;\r
38 \r
39 public class IdPanel extends Panel implements MouseListener,\r
40         MouseMotionListener\r
41 {\r
42 \r
43   protected IdCanvas idCanvas;\r
44 \r
45   protected AlignmentViewport av;\r
46 \r
47   protected AlignmentPanel alignPanel;\r
48 \r
49   ScrollThread scrollThread = null;\r
50 \r
51   int lastid = -1;\r
52 \r
53   boolean mouseDragging = false;\r
54 \r
55   java.util.Vector links = new java.util.Vector();\r
56 \r
57   public IdPanel(AlignViewport av, AlignmentPanel parent)\r
58   {\r
59     this.av = av;\r
60     alignPanel = parent;\r
61     idCanvas = new IdCanvas(av);\r
62     setLayout(new BorderLayout());\r
63     add(idCanvas, BorderLayout.CENTER);\r
64     idCanvas.addMouseListener(this);\r
65     idCanvas.addMouseMotionListener(this);\r
66 \r
67     String label, url;\r
68     // TODO: add in group link parameter\r
69     if (av.applet != null)\r
70     {\r
71       for (int i = 1; i < 10; i++)\r
72       {\r
73         label = av.applet.getParameter("linkLabel_" + i);\r
74         url = av.applet.getParameter("linkURL_" + i);\r
75 \r
76         if (label != null && url != null)\r
77         {\r
78           links.addElement(label + "|" + url);\r
79         }\r
80 \r
81       }\r
82     }\r
83     {\r
84       // upgrade old SRS link\r
85       int srsPos = links\r
86               .indexOf("SRS|http://srs.ebi.ac.uk/srsbin/cgi-bin/wgetz?-newId+(([uniprot-all:$SEQUENCE_ID$]))+-view+SwissEntry");\r
87       if (srsPos > -1)\r
88       {\r
89         links.setElementAt(\r
90                 "EMBL-EBI Search|http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$",\r
91                 srsPos);\r
92       }\r
93     }\r
94     if (links.size() < 1)\r
95     {\r
96       links = new java.util.Vector();\r
97       links.addElement("EMBL-EBI Search|http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$");\r
98     }\r
99   }\r
100 \r
101   Tooltip tooltip;\r
102 \r
103   public void mouseMoved(MouseEvent e)\r
104   {\r
105     int seq = alignPanel.seqPanel.findSeq(e);\r
106 \r
107     SequenceI sequence = av.getAlignment().getSequenceAt(seq);\r
108 \r
109     // look for non-pos features\r
110     StringBuffer tooltiptext = new StringBuffer();\r
111     if (sequence != null)\r
112     {\r
113       if (sequence.getDescription() != null)\r
114       {\r
115         tooltiptext.append(sequence.getDescription());\r
116         tooltiptext.append("\n");\r
117       }\r
118 \r
119       SequenceFeature sf[] = sequence.getSequenceFeatures();\r
120       for (int sl = 0; sf != null && sl < sf.length; sl++)\r
121       {\r
122         if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0)\r
123         {\r
124           boolean nl = false;\r
125           if (sf[sl].getFeatureGroup() != null)\r
126           {\r
127             tooltiptext.append(sf[sl].getFeatureGroup());\r
128             nl = true;\r
129           }\r
130           ;\r
131           if (sf[sl].getType() != null)\r
132           {\r
133             tooltiptext.append(" ");\r
134             tooltiptext.append(sf[sl].getType());\r
135             nl = true;\r
136           }\r
137           ;\r
138           if (sf[sl].getDescription() != null)\r
139           {\r
140             tooltiptext.append(" ");\r
141             tooltiptext.append(sf[sl].getDescription());\r
142             nl = true;\r
143           }\r
144           ;\r
145           if (sf[sl].getScore() != Float.NaN && sf[sl].getScore() != 0f)\r
146           {\r
147             tooltiptext.append(" Score = ");\r
148             tooltiptext.append(sf[sl].getScore());\r
149             nl = true;\r
150           }\r
151           ;\r
152           if (sf[sl].getStatus() != null && sf[sl].getStatus().length() > 0)\r
153           {\r
154             tooltiptext.append(" (");\r
155             tooltiptext.append(sf[sl].getStatus());\r
156             tooltiptext.append(")");\r
157             nl = true;\r
158           }\r
159           ;\r
160           if (nl)\r
161           {\r
162             tooltiptext.append("\n");\r
163           }\r
164         }\r
165       }\r
166     }\r
167     if (tooltiptext.length() == 0)\r
168     {\r
169       // nothing to display - so clear tooltip if one is visible\r
170       if (tooltip != null)\r
171       {\r
172         tooltip.setVisible(false);\r
173       }\r
174       tooltip = null;\r
175       tooltiptext = null;\r
176       return;\r
177     }\r
178     if (tooltip == null)\r
179     {\r
180       tooltip = new Tooltip(sequence.getDisplayId(true) + "\n"\r
181               + tooltiptext.toString(), idCanvas);\r
182     }\r
183     else\r
184     {\r
185       tooltip.setTip(sequence.getDisplayId(true) + "\n"\r
186               + tooltiptext.toString());\r
187     }\r
188     tooltiptext = null;\r
189   }\r
190 \r
191   public void mouseDragged(MouseEvent e)\r
192   {\r
193     mouseDragging = true;\r
194 \r
195     int seq = Math.max(0, alignPanel.seqPanel.findSeq(e));\r
196 \r
197     if (seq < lastid)\r
198     {\r
199       selectSeqs(lastid - 1, seq);\r
200     }\r
201     else if (seq > lastid)\r
202     {\r
203       selectSeqs(lastid + 1, seq);\r
204     }\r
205 \r
206     lastid = seq;\r
207     alignPanel.paintAlignment(false);\r
208   }\r
209 \r
210   public void mouseClicked(MouseEvent e)\r
211   {\r
212     if (e.getClickCount() < 2)\r
213     {\r
214       return;\r
215     }\r
216 \r
217     // DEFAULT LINK IS FIRST IN THE LINK LIST\r
218     int seq = alignPanel.seqPanel.findSeq(e);\r
219     SequenceI sq = av.getAlignment().getSequenceAt(seq);\r
220     if (sq == null)\r
221     {\r
222       return;\r
223     }\r
224     String id = sq.getName();\r
225 \r
226     String target = null;\r
227     String url = null;\r
228     int i = 0;\r
229     while (url == null && i < links.size())\r
230     {\r
231       // DEFAULT LINK IS FIRST IN THE LINK LIST\r
232       // BUT IF ITS A REGEX AND DOES NOT MATCH THE NEXT ONE WILL BE TRIED\r
233       url = links.elementAt(i++).toString();\r
234       UrlLink urlLink = null;\r
235       try\r
236       {\r
237         urlLink = new UrlLink(url);\r
238         target = urlLink.getTarget();\r
239       } catch (Exception foo)\r
240       {\r
241         System.err.println("Exception for URLLink '" + url + "'");\r
242         foo.printStackTrace();\r
243         url = null;\r
244         continue;\r
245       }\r
246       ;\r
247       if (!urlLink.isValid())\r
248       {\r
249         System.err.println(urlLink.getInvalidMessage());\r
250         url = null;\r
251         continue;\r
252       }\r
253 \r
254       String urls[] = urlLink.makeUrls(id, true);\r
255       if (urls == null || urls[0] == null || urls[0].length() < 1)\r
256       {\r
257         url = null;\r
258         continue;\r
259       }\r
260       // just take first URL made from regex\r
261       url = urls[1];\r
262     }\r
263     try\r
264     {\r
265 \r
266       alignPanel.alignFrame.showURL(url, target);\r
267     } catch (Exception ex)\r
268     {\r
269       ex.printStackTrace();\r
270     }\r
271   }\r
272 \r
273   public void mouseEntered(MouseEvent e)\r
274   {\r
275     if (scrollThread != null)\r
276     {\r
277       scrollThread.running = false;\r
278     }\r
279   }\r
280 \r
281   public void mouseExited(MouseEvent e)\r
282   {\r
283     if (av.getWrapAlignment())\r
284     {\r
285       return;\r
286     }\r
287 \r
288     if (mouseDragging && e.getY() < 0 && av.getStartSeq() > 0)\r
289     {\r
290       scrollThread = new ScrollThread(true);\r
291     }\r
292 \r
293     if (mouseDragging && e.getY() >= getSize().height\r
294             && av.getAlignment().getHeight() > av.getEndSeq())\r
295     {\r
296       scrollThread = new ScrollThread(false);\r
297     }\r
298   }\r
299 \r
300   public void mousePressed(MouseEvent e)\r
301   {\r
302     if (e.getClickCount() > 1)\r
303     {\r
304       return;\r
305     }\r
306 \r
307     int y = e.getY();\r
308     if (av.getWrapAlignment())\r
309     {\r
310       y -= 2 * av.getCharHeight();\r
311     }\r
312 \r
313     int seq = alignPanel.seqPanel.findSeq(e);\r
314 \r
315     if ((e.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)\r
316     {\r
317       Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq);\r
318 \r
319       // build a new links menu based on the current links + any non-positional\r
320       // features\r
321       Vector nlinks = new Vector();\r
322       for (int l = 0, lSize = links.size(); l < lSize; l++)\r
323       {\r
324         nlinks.addElement(links.elementAt(l));\r
325       }\r
326       SequenceFeature sf[] = sq == null ? null : sq.getSequenceFeatures();\r
327       for (int sl = 0; sf != null && sl < sf.length; sl++)\r
328       {\r
329         if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0)\r
330         {\r
331           if (sf[sl].links != null && sf[sl].links.size() > 0)\r
332           {\r
333             for (int l = 0, lSize = sf[sl].links.size(); l < lSize; l++)\r
334             {\r
335               nlinks.addElement(sf[sl].links.elementAt(l));\r
336             }\r
337           }\r
338         }\r
339       }\r
340 \r
341       APopupMenu popup = new APopupMenu(alignPanel, sq, nlinks);\r
342       this.add(popup);\r
343       popup.show(this, e.getX(), e.getY());\r
344       return;\r
345     }\r
346 \r
347     if ((av.getSelectionGroup() == null)\r
348             || ((!e.isControlDown() && !e.isShiftDown()) && av\r
349                     .getSelectionGroup() != null))\r
350     {\r
351       av.setSelectionGroup(new SequenceGroup());\r
352       av.getSelectionGroup().setStartRes(0);\r
353       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);\r
354     }\r
355 \r
356     if (e.isShiftDown() && lastid != -1)\r
357     {\r
358       selectSeqs(lastid, seq);\r
359     }\r
360     else\r
361     {\r
362       selectSeq(seq);\r
363     }\r
364 \r
365     alignPanel.paintAlignment(false);\r
366   }\r
367 \r
368   void selectSeq(int seq)\r
369   {\r
370     lastid = seq;\r
371     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);\r
372     av.getSelectionGroup().addOrRemove(pickedSeq, true);\r
373   }\r
374 \r
375   void selectSeqs(int start, int end)\r
376   {\r
377 \r
378     lastid = start;\r
379 \r
380     if (end >= av.getAlignment().getHeight())\r
381     {\r
382       end = av.getAlignment().getHeight() - 1;\r
383     }\r
384 \r
385     if (end < start)\r
386     {\r
387       int tmp = start;\r
388       start = end;\r
389       end = tmp;\r
390       lastid = end;\r
391     }\r
392     if (av.getSelectionGroup() == null)\r
393     {\r
394       av.setSelectionGroup(new SequenceGroup());\r
395     }\r
396     for (int i = start; i <= end; i++)\r
397     {\r
398       av.getSelectionGroup().addSequence(\r
399               av.getAlignment().getSequenceAt(i), i == end);\r
400     }\r
401 \r
402   }\r
403 \r
404   public void mouseReleased(MouseEvent e)\r
405   {\r
406     if (scrollThread != null)\r
407     {\r
408       scrollThread.running = false;\r
409     }\r
410 \r
411     if (av.getSelectionGroup() != null)\r
412     {\r
413       av.getSelectionGroup().recalcConservation();\r
414     }\r
415 \r
416     mouseDragging = false;\r
417     PaintRefresher.Refresh(this, av.getSequenceSetId());\r
418     // always send selection message when mouse is released\r
419     av.sendSelection();\r
420   }\r
421 \r
422   public void highlightSearchResults(List<SequenceI> list)\r
423   {\r
424     idCanvas.setHighlighted(list);\r
425 \r
426     if (list == null)\r
427     {\r
428       return;\r
429     }\r
430 \r
431     int index = av.getAlignment().findIndex(list.get(0));\r
432 \r
433     // do we need to scroll the panel?\r
434     if (av.getStartSeq() > index || av.getEndSeq() < index)\r
435     {\r
436       alignPanel.setScrollValues(av.getStartRes(), index);\r
437     }\r
438   }\r
439 \r
440   // this class allows scrolling off the bottom of the visible alignment\r
441   class ScrollThread extends Thread\r
442   {\r
443     boolean running = false;\r
444 \r
445     boolean up = true;\r
446 \r
447     public ScrollThread(boolean up)\r
448     {\r
449       this.up = up;\r
450       start();\r
451     }\r
452 \r
453     public void stopScrolling()\r
454     {\r
455       running = false;\r
456     }\r
457 \r
458     public void run()\r
459     {\r
460       running = true;\r
461       while (running)\r
462       {\r
463         if (alignPanel.scrollUp(up))\r
464         {\r
465           // scroll was ok, so add new sequence to selection\r
466           int seq = av.getStartSeq();\r
467           if (!up)\r
468           {\r
469             seq = av.getEndSeq();\r
470           }\r
471 \r
472           if (seq < lastid)\r
473           {\r
474             selectSeqs(lastid - 1, seq);\r
475           }\r
476           else if (seq > lastid && seq < av.getAlignment().getHeight())\r
477           {\r
478             selectSeqs(lastid + 1, seq);\r
479           }\r
480 \r
481           lastid = seq;\r
482         }\r
483         else\r
484         {\r
485           running = false;\r
486         }\r
487 \r
488         alignPanel.paintAlignment(true);\r
489         try\r
490         {\r
491           Thread.sleep(100);\r
492         } catch (Exception ex)\r
493         {\r
494         }\r
495       }\r
496     }\r
497   }\r
498 }\r