Help gets bounds from help map file
[jalview.git] / src / jalview / gui / Desktop.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer
3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
18  */
19 package jalview.gui;
20
21 import jalview.io.*;
22
23 import java.awt.*;
24 import java.awt.datatransfer.*;
25 import java.awt.dnd.*;
26 import java.awt.event.*;
27
28 import javax.swing.*;
29
30
31 /**
32  * DOCUMENT ME!
33  *
34  * @author $author$
35  * @version $Revision$
36  */
37 public class Desktop extends jalview.jbgui.GDesktop
38     implements DropTargetListener
39 {
40     /** DOCUMENT ME!! */
41     public static JDesktopPane desktop;
42     static int openFrameCount = 0;
43     static final int xOffset = 30;
44     static final int yOffset = 30;
45     public static jalview.ws.Discoverer discoverer;
46     /**
47      * Creates a new Desktop object.
48      */
49     public Desktop()
50     {
51         Image image = null;
52
53         try
54         {
55             java.net.URL url = getClass().getResource("/images/logo.gif");
56
57             if (url != null)
58             {
59                 image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
60
61                 MediaTracker mt = new MediaTracker(this);
62                 mt.addImage(image, 0);
63                 mt.waitForID(0);
64                 setIconImage(image);
65             }
66         }
67         catch (Exception ex)
68         {
69         }
70
71         setTitle("Jalview 2005");
72         setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
73         desktop = new JDesktopPane();
74         desktop.setBackground(Color.white);
75         setContentPane(desktop);
76         desktop.setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
77
78         // This line prevents Windows Look&Feel resizing all new windows to maximum
79         // if previous window was maximised
80         desktop.setDesktopManager(new DefaultDesktopManager());
81
82         Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
83         String x = jalview.bin.Cache.getProperty("SCREEN_X");
84         String y = jalview.bin.Cache.getProperty("SCREEN_Y");
85         String width = jalview.bin.Cache.getProperty("SCREEN_WIDTH");
86         String height = jalview.bin.Cache.getProperty("SCREEN_HEIGHT");
87
88         if ((x != null) && (y != null) && (width != null) && (height != null))
89         {
90             setBounds(Integer.parseInt(x), Integer.parseInt(y),
91                 Integer.parseInt(width), Integer.parseInt(height));
92         }
93         else
94         {
95             setBounds((int) (screenSize.width - 900) / 2,
96                 (int) (screenSize.height - 650) / 2, 900, 650);
97         }
98
99         this.addWindowListener(new WindowAdapter()
100             {
101                 public void windowClosing(WindowEvent evt)
102                 {
103                     quit();
104                 }
105             });
106
107         this.setDropTarget(new java.awt.dnd.DropTarget(desktop, this));
108
109         /////////Add a splashscreen on startup
110         /////////Add a splashscreen on startup
111         JInternalFrame frame = new JInternalFrame();
112
113         SplashScreen splash = new SplashScreen(frame, image);
114         frame.setContentPane(splash);
115         frame.setLayer(JLayeredPane.PALETTE_LAYER);
116         frame.setLocation((int) ((getWidth() - 750) / 2),
117             (int) ((getHeight() - 160) / 2));
118
119         addInternalFrame(frame, "", 750, 160, false);
120
121         discoverer=new jalview.ws.Discoverer(); // Only gets started if gui is displayed.
122
123     }
124
125     /**
126      * DOCUMENT ME!
127      *
128      * @param frame DOCUMENT ME!
129      * @param title DOCUMENT ME!
130      * @param w DOCUMENT ME!
131      * @param h DOCUMENT ME!
132      */
133     public static synchronized void addInternalFrame(final JInternalFrame frame,
134         String title, int w, int h)
135     {
136         addInternalFrame(frame, title, w, h, true);
137     }
138
139     /**
140      * DOCUMENT ME!
141      *
142      * @param frame DOCUMENT ME!
143      * @param title DOCUMENT ME!
144      * @param w DOCUMENT ME!
145      * @param h DOCUMENT ME!
146      * @param resizable DOCUMENT ME!
147      */
148     public static synchronized void addInternalFrame(final JInternalFrame frame,
149         String title, int w, int h, boolean resizable)
150     {
151
152       frame.setTitle(title);
153       if(frame.getWidth()<1 || frame.getHeight()<1)
154       {
155         frame.setSize(w, h);
156       }
157       // THIS IS A PUBLIC STATIC METHOD, SO IT MAY BE CALLED EVEN IN
158       // A HEADLESS STATE WHEN NO DESKTOP EXISTS. MUST RETURN
159       // IF JALVIEW IS RUNNING HEADLESS
160       /////////////////////////////////////////////////
161       if (System.getProperty("java.awt.headless") != null
162           && System.getProperty("java.awt.headless").equals("true"))
163       {
164         return;
165       }
166
167
168         openFrameCount++;
169
170         frame.setVisible(true);
171         frame.setClosable(true);
172         frame.setResizable(resizable);
173         frame.setMaximizable(resizable);
174         frame.setIconifiable(resizable);
175         frame.setFrameIcon(null);
176
177         if (frame.getX()<1 && frame.getY()<1)
178        {
179          frame.setLocation(xOffset * openFrameCount, yOffset * ((openFrameCount-1)%10)+yOffset);
180        }
181
182         final JMenuItem menuItem = new JMenuItem(title);
183         frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
184             {
185                 public void internalFrameClosed(
186                     javax.swing.event.InternalFrameEvent evt)
187                 {
188                     openFrameCount--;
189                     windowMenu.remove(menuItem);
190                 }
191                 ;
192             });
193
194         menuItem.addActionListener(new ActionListener()
195             {
196                 public void actionPerformed(ActionEvent e)
197                 {
198                     try
199                     {
200                         frame.setSelected(true);
201                         frame.setIcon(false);
202                     }
203                     catch (java.beans.PropertyVetoException ex)
204                     {
205
206                     }
207                 }
208             });
209
210         windowMenu.add(menuItem);
211
212         desktop.add(frame);
213         frame.toFront();
214         try{
215           frame.setSelected(true);
216         }catch(java.beans.PropertyVetoException ve)
217         {}
218     }
219
220     /**
221      * DOCUMENT ME!
222      *
223      * @param evt DOCUMENT ME!
224      */
225     public void dragEnter(DropTargetDragEvent evt)
226     {
227     }
228
229     /**
230      * DOCUMENT ME!
231      *
232      * @param evt DOCUMENT ME!
233      */
234     public void dragExit(DropTargetEvent evt)
235     {
236     }
237
238     /**
239      * DOCUMENT ME!
240      *
241      * @param evt DOCUMENT ME!
242      */
243     public void dragOver(DropTargetDragEvent evt)
244     {
245     }
246
247     /**
248      * DOCUMENT ME!
249      *
250      * @param evt DOCUMENT ME!
251      */
252     public void dropActionChanged(DropTargetDragEvent evt)
253     {
254     }
255
256     /**
257      * DOCUMENT ME!
258      *
259      * @param evt DOCUMENT ME!
260      */
261     public void drop(DropTargetDropEvent evt)
262     {
263         Transferable t = evt.getTransferable();
264
265         if (!t.isDataFlavorSupported(DataFlavor.javaFileListFlavor))
266         {
267             return;
268         }
269
270         evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
271
272         try
273         {
274             java.util.List files = (java.util.List) t.getTransferData(DataFlavor.javaFileListFlavor);
275
276             for (int i = 0; i < files.size(); i++)
277             {
278                 String file = files.get(i).toString();
279                 String protocol = "File";
280                 String format = null;
281
282                 if (file.endsWith(".jar"))
283                 {
284                   format = "Jalview";
285
286                 }
287                 else
288                 {
289                     format = jalview.io.IdentifyFile.Identify(file,
290                             protocol);
291                 }
292                 LoadFile(file, protocol, format);
293             }
294         }
295         catch (Exception ex)
296         {
297             ex.printStackTrace();
298         }
299     }
300
301     /**
302      * DOCUMENT ME!
303      *
304      * @param e DOCUMENT ME!
305      */
306     public void inputLocalFileMenuItem_actionPerformed(ActionEvent e)
307     {
308         JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.getProperty(
309                     "LAST_DIRECTORY"),
310                 new String[]
311                 {
312                     "fa, fasta, fastq", "aln", "pfam", "msf", "pir", "blc",
313                     "jar"
314                 },
315                 new String[]
316                 {
317                     "Fasta", "Clustal", "PFAM", "MSF", "PIR", "BLC", "Jalview"
318                 }, jalview.bin.Cache.getProperty("DEFAULT_FILE_FORMAT"));
319
320         chooser.setFileView(new JalviewFileView());
321         chooser.setDialogTitle("Open local file");
322         chooser.setToolTipText("Open");
323
324         int value = chooser.showOpenDialog(this);
325
326         if (value == JalviewFileChooser.APPROVE_OPTION)
327         {
328             String choice = chooser.getSelectedFile().getPath();
329             jalview.bin.Cache.setProperty("LAST_DIRECTORY",
330                 chooser.getSelectedFile().getParent());
331
332             String format = null;
333             if (chooser.getSelectedFormat().equals("Jalview"))
334             {
335               format = "Jalview";
336             }
337             else
338             {
339                 format = IdentifyFile.Identify(choice, "File");
340             }
341
342             jalview.bin.Cache.setProperty("DEFAULT_FILE_FORMAT", format);
343             LoadFile(choice, "File", format);
344         }
345     }
346
347     /**
348      * DOCUMENT ME!
349      *
350      * @param file DOCUMENT ME!
351      * @param protocol DOCUMENT ME!
352      * @param format DOCUMENT ME!
353      */
354     public void LoadFile(String file, String protocol, String format)
355     {
356       FileLoader fileLoader = new FileLoader();
357       fileLoader.LoadFile(file, protocol, format);
358     }
359
360     /**
361      * DOCUMENT ME!
362      *
363      * @param e DOCUMENT ME!
364      */
365     public void inputURLMenuItem_actionPerformed(ActionEvent e)
366     {
367         String url = JOptionPane.showInternalInputDialog(Desktop.desktop,
368                 "Enter url of input file", "Input alignment from URL",
369                 JOptionPane.QUESTION_MESSAGE, null, null, "http://www.")
370                                 .toString();
371
372         if (url == null)
373         {
374             return;
375         }
376
377         if (url.trim().toLowerCase().endsWith(".jar"))
378         {
379                jalview.bin.Cache.setProperty("DEFAULT_FILE_FORMAT", "Jalview");
380                Jalview2XML.LoadJalviewAlign(url);
381         }
382         else
383         {
384
385           String format = IdentifyFile.Identify(url, "URL");
386
387           if (format.equals("URL NOT FOUND"))
388           {
389             JOptionPane.showInternalMessageDialog(Desktop.desktop,
390                                                   "Couldn't locate " + url,
391                                                   "URL not found",
392                                                   JOptionPane.WARNING_MESSAGE);
393
394             return;
395           }
396
397           LoadFile(url, "URL", format);
398         }
399     }
400
401     /**
402      * DOCUMENT ME!
403      *
404      * @param e DOCUMENT ME!
405      */
406     public void inputTextboxMenuItem_actionPerformed(ActionEvent e)
407     {
408         CutAndPasteTransfer cap = new CutAndPasteTransfer();
409         cap.setForInput();
410         Desktop.addInternalFrame(cap, "Cut & Paste Alignment File", 600, 500);
411     }
412
413     /*
414      * Exit the program
415      */
416     public void quit()
417     {
418         jalview.bin.Cache.setProperty("SCREEN_X", getBounds().x + "");
419         jalview.bin.Cache.setProperty("SCREEN_Y", getBounds().y + "");
420         jalview.bin.Cache.setProperty("SCREEN_WIDTH", getWidth() + "");
421         jalview.bin.Cache.setProperty("SCREEN_HEIGHT", getHeight() + "");
422         System.exit(0);
423     }
424
425     /**
426      * DOCUMENT ME!
427      *
428      * @param e DOCUMENT ME!
429      */
430     public void aboutMenuItem_actionPerformed(ActionEvent e)
431     {
432       StringBuffer message = new StringBuffer("JalView 2005 version " +
433                                               jalview.bin.Cache.getProperty(
434           "VERSION") +
435                                               "; last updated: " +
436                                               jalview.bin.
437                                               Cache.getDefault("BUILD_DATE", "unknown"));
438
439       if (!jalview.bin.Cache.getProperty("LATEST_VERSION").equals(
440           jalview.bin.Cache.getProperty("VERSION")))
441       {
442         message.append("\n\n!! Jalview version "
443                        + jalview.bin.Cache.getProperty("LATEST_VERSION")
444                        + " is available for download from http://www.jalview.org !!\n");
445
446       }
447
448       message.append( "\nAuthors:  Michele Clamp, James Cuff, Steve Searle, Andrew Waterhouse, Jim Procter & Geoff Barton." +
449             "\nCurrent development managed by Andrew Waterhouse; Barton Group, University of Dundee." +
450             "\nFor all issues relating to Jalview, email help@jalview.org" +
451             "\n\nIf  you use JalView, please cite:" +
452             "\n\"Clamp, M., Cuff, J., Searle, S. M. and Barton, G. J. (2004), The Jalview Java Alignment Editor\"" +
453             "\nBioinformatics,  2004 12;426-7.");
454
455         JOptionPane.showInternalMessageDialog(Desktop.desktop,
456
457            message.toString(), "About Jalview",
458             JOptionPane.INFORMATION_MESSAGE);
459     }
460
461     /**
462      * DOCUMENT ME!
463      *
464      * @param e DOCUMENT ME!
465      */
466     public void documentationMenuItem_actionPerformed(ActionEvent e)
467     {
468         try
469         {
470             ClassLoader cl = jalview.gui.Desktop.class.getClassLoader();
471             java.net.URL url = javax.help.HelpSet.findHelpSet(cl, "help/help");
472             javax.help.HelpSet hs = new javax.help.HelpSet(cl, url);
473
474             javax.help.HelpBroker hb = hs.createHelpBroker();
475             hb.setCurrentID("home");
476             hb.setDisplayed(true);
477         }
478         catch (Exception ex)
479         {
480             ex.printStackTrace();
481         }
482     }
483
484     /**
485      * DOCUMENT ME!
486      *
487      * @param e DOCUMENT ME!
488      */
489     protected void preferences_actionPerformed(ActionEvent e)
490     {
491         new Preferences();
492     }
493
494     /**
495      * DOCUMENT ME!
496      *
497      * @param e DOCUMENT ME!
498      */
499     public void saveState_actionPerformed(ActionEvent e)
500     {
501         JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.getProperty(
502                     "LAST_DIRECTORY"), new String[] { "jar" },
503                 new String[] { "Jalview Project" }, "Jalview Project");
504
505         chooser.setFileView(new JalviewFileView());
506         chooser.setDialogTitle("Save State");
507
508         int value = chooser.showSaveDialog(this);
509
510         if (value == JalviewFileChooser.APPROVE_OPTION)
511         {
512             java.io.File choice = chooser.getSelectedFile();
513             jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice.getParent());
514             Jalview2XML.SaveState(choice);
515         }
516     }
517
518     /**
519      * DOCUMENT ME!
520      *
521      * @param e DOCUMENT ME!
522      */
523     public void loadState_actionPerformed(ActionEvent e)
524     {
525         JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.getProperty(
526                     "LAST_DIRECTORY"), new String[] { "jar" },
527                 new String[] { "Jalview Project" }, "Jalview Project");
528         chooser.setFileView(new JalviewFileView());
529         chooser.setDialogTitle("Restore state");
530
531         int value = chooser.showOpenDialog(this);
532
533         if (value == JalviewFileChooser.APPROVE_OPTION)
534         {
535             String choice = chooser.getSelectedFile().getAbsolutePath();
536             jalview.bin.Cache.setProperty("LAST_DIRECTORY",
537                 chooser.getSelectedFile().getParent());
538             Jalview2XML.LoadJalviewAlign(choice);
539         }
540     }
541
542 }
543