src/jalview/io/JalviewFileChooser.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 //////////////////////////////////////////////////////////////////
  22 package jalview.io;
  23
  24 import jalview.gui.JvOptionPane;
  25 import jalview.util.MessageManager;
  26 import jalview.util.Platform;
  27
  28 import java.awt.Component;
  29 import java.awt.Dimension;
  30 import java.awt.EventQueue;
  31 import java.awt.HeadlessException;
  32 import java.awt.event.MouseAdapter;
  33 import java.awt.event.MouseEvent;
  34 import java.io.File;
  35 import java.util.ArrayList;
  36 import java.util.Collections;
  37 import java.util.List;
  38 import java.util.StringTokenizer;
  39 import java.util.Vector;
  40
  41 import javax.swing.DefaultListCellRenderer;
  42 import javax.swing.JFileChooser;
  43 import javax.swing.JList;
  44 import javax.swing.JPanel;
  45 import javax.swing.JScrollPane;
  46 import javax.swing.SpringLayout;
  47 import javax.swing.filechooser.FileView;
  48 import javax.swing.plaf.basic.BasicFileChooserUI;
  49
  50 /**
  51  * Enhanced file chooser dialog box.
  52  *
  53  * NOTE: bug on Windows systems when filechooser opened on directory to view
  54  * files with colons in title.
  55  *
  56  * @author AMW
  57  *
  58  */
  59 public class JalviewFileChooser extends JFileChooser
  60 {
  61   /**
  62    * Factory method to return a file chooser that offers readable alignment file
  63    * formats
  64    *
  65    * @param directory
  66    * @param selected
  67    * @param selectAll
  68    * @return
  69    */
  70   public static JalviewFileChooser forRead(String directory,
  71           String selected, boolean selectAll)
  72   {
  73     List<String> extensions = new ArrayList<String>();
  74     List<String> descs = new ArrayList<String>();
  75     for (FileFormatI format : FileFormat.values())
  76     {
  77       if (format.isReadable())
  78       {
  79         extensions.add(format.getExtensions());
  80         descs.add(format.toString());
  81       }
  82     }
  83     return new JalviewFileChooser(directory,
  84             extensions.toArray(new String[extensions.size()]),
  85             descs.toArray(new String[descs.size()]),
  86             selected);
  87   }
  88
  89   /**
  90    * Factory method to return a file chooser that offers writable alignment file
  91    * formats
  92    *
  93    * @param directory
  94    * @param selected
  95    * @param selectAll
  96    * @return
  97    */
  98   public static JalviewFileChooser forWrite(String directory,
  99           String selected, boolean selectAll)
 100   {
 101     // TODO in Java 8, forRead and forWrite can be a single method
 102     // with a lambda expression parameter for isReadable/isWritable
 103     List<String> extensions = new ArrayList<String>();
 104     List<String> descs = new ArrayList<String>();
 105     for (FileFormatI format : FileFormat.values())
 106     {
 107       if (format.isWritable())
 108       {
 109         extensions.add(format.getExtensions());
 110         descs.add(format.toString());
 111       }
 112     }
 113     return new JalviewFileChooser(directory,
 114             extensions.toArray(new String[extensions.size()]),
 115             descs.toArray(new String[descs.size()]), selected);
 116   }
 117
 118   public JalviewFileChooser(String dir)
 119   {
 120     super(safePath(dir));
 121     setAccessory(new RecentlyOpened());
 122   }
 123
 124   public JalviewFileChooser(String dir, String extension, String desc,
 125           String selected)
 126   {
 127     super(safePath(dir));
 128     init(Collections.singletonList(new String[] { extension, desc }),
 129             selected);
 130   }
 131
 132   public JalviewFileChooser(String dir, String[] extensions, String[] descs,
 133           String selected)
 134   {
 135     super(safePath(dir));
 136     if (extensions.length == descs.length)
 137     {
 138       List<String[]> formats = new ArrayList<String[]>();
 139       for (int i = 0; i < extensions.length; i++)
 140       {
 141         formats.add(new String[] { extensions[i], descs[i] });
 142       }
 143       init(formats, selected);
 144     }
 145     else
 146     {
 147       System.err.println("JalviewFileChooser arguments mismatch: "
 148               + extensions + ", " + descs);
 149     }
 150   }
 151
 152   private static File safePath(String dir)
 153   {
 154     if (dir == null)
 155     {
 156       return null;
 157     }
 158
 159     File f = new File(dir);
 160     if (f.getName().indexOf(':') > -1)
 161     {
 162       return null;
 163     }
 164     return f;
 165   }
 166
 167   /**
 168    *
 169    * @param formats
 170    *          a list of {extensions, description} for each file format
 171    * @param selected
 172    */
 173   void init(List<String[]> formats, String selected)
 174   {
 175
 176     JalviewFileFilter chosen = null;
 177
 178     // SelectAllFilter needs to be set first before adding further
 179     // file filters to fix bug on Mac OSX
 180     setAcceptAllFileFilterUsed(true);
 181
 182     for (String[] format : formats)
 183     {
 184       JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
 185       addChoosableFileFilter(jvf);
 186       if ((selected != null) && selected.equalsIgnoreCase(format[1]))
 187       {
 188         chosen = jvf;
 189       }
 190     }
 191
 192     if (chosen != null)
 193     {
 194       setFileFilter(chosen);
 195     }
 196
 197     setAccessory(new RecentlyOpened());
 198   }
 199
 200   @Override
 201   public void setFileFilter(javax.swing.filechooser.FileFilter filter)
 202   {
 203     super.setFileFilter(filter);
 204
 205     try
 206     {
 207       if (getUI() instanceof BasicFileChooserUI)
 208       {
 209         final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
 210         final String name = fcui.getFileName().trim();
 211
 212         if ((name == null) || (name.length() == 0))
 213         {
 214           return;
 215         }
 216
 217         EventQueue.invokeLater(new Thread()
 218         {
 219           @Override
 220           public void run()
 221           {
 222             String currentName = fcui.getFileName();
 223             if ((currentName == null) || (currentName.length() == 0))
 224             {
 225               fcui.setFileName(name);
 226             }
 227           }
 228         });
 229       }
 230     } catch (Exception ex)
 231     {
 232       ex.printStackTrace();
 233       // Some platforms do not have BasicFileChooserUI
 234     }
 235   }
 236
 237   /**
 238    * Returns the selected file format, or null if none selected
 239    *
 240    * @return
 241    */
 242   public FileFormatI getSelectedFormat()
 243   {
 244     if (getFileFilter() == null)
 245     {
 246       return null;
 247     }
 248
 249     /*
 250      * logic here depends on option description being formatted as
 251      * formatName (extension, extension...)
 252      * or the 'no option selected' value
 253      * All Files
 254      * @see JalviewFileFilter.getDescription
 255      */
 256     String format = getFileFilter().getDescription();
 257     int parenPos = format.indexOf("(");
 258     if (parenPos > 0)
 259     {
 260       format = format.substring(0, parenPos).trim();
 261       try
 262       {
 263         return FileFormat.valueOf(format);
 264       } catch (IllegalArgumentException e)
 265       {
 266         System.err.println("Unexpected format: " + format);
 267       }
 268     }
 269     return null;
 270   }
 271
 272   @Override
 273   public int showSaveDialog(Component parent) throws HeadlessException
 274   {
 275     this.setAccessory(null);
 276
 277     setDialogType(SAVE_DIALOG);
 278
 279     int ret = showDialog(parent, MessageManager.getString("action.save"));
 280
 281     if (getFileFilter() instanceof JalviewFileFilter)
 282     {
 283       JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
 284
 285       if (!jvf.accept(getSelectedFile()))
 286       {
 287         String withExtension = getSelectedFile() + "."
 288                 + jvf.getAcceptableExtension();
 289         setSelectedFile(new File(withExtension));
 290       }
 291     }
 292     // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
 293     // USER PROMPTED FOR A NEW FILENAME
 294     if ((ret == JalviewFileChooser.APPROVE_OPTION)
 295             && getSelectedFile().exists())
 296     {
 297       int confirm = JvOptionPane.showConfirmDialog(parent,
 298               MessageManager.getString("label.overwrite_existing_file"),
 299               MessageManager.getString("label.file_already_exists"),
 300               JvOptionPane.YES_NO_OPTION);
 301
 302       if (confirm != JvOptionPane.YES_OPTION)
 303       {
 304         ret = JalviewFileChooser.CANCEL_OPTION;
 305       }
 306     }
 307
 308     return ret;
 309   }
 310
 311   void recentListSelectionChanged(Object selection)
 312   {
 313     setSelectedFile(null);
 314     if (selection != null)
 315     {
 316       File file = new File((String) selection);
 317       if (getFileFilter() instanceof JalviewFileFilter)
 318       {
 319         JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
 320
 321         if (!jvf.accept(file))
 322         {
 323           setFileFilter(getChoosableFileFilters()[0]);
 324         }
 325       }
 326
 327       setSelectedFile(file);
 328     }
 329   }
 330
 331   class RecentlyOpened extends JPanel
 332   {
 333     JList list;
 334
 335     public RecentlyOpened()
 336     {
 337
 338       String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
 339       StringTokenizer st;
 340       Vector recent = new Vector();
 341
 342       if (historyItems != null)
 343       {
 344         st = new StringTokenizer(historyItems, "\t");
 345
 346         while (st.hasMoreTokens())
 347         {
 348           recent.addElement(st.nextElement());
 349         }
 350       }
 351
 352       list = new JList(recent);
 353
 354       DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
 355       dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
 356       list.setCellRenderer(dlcr);
 357
 358       list.addMouseListener(new MouseAdapter()
 359       {
 360         @Override
 361         public void mousePressed(MouseEvent evt)
 362         {
 363           recentListSelectionChanged(list.getSelectedValue());
 364         }
 365       });
 366
 367       this.setBorder(new javax.swing.border.TitledBorder(MessageManager
 368               .getString("label.recently_opened")));
 369
 370       final JScrollPane scroller = new JScrollPane(list);
 371
 372       SpringLayout layout = new SpringLayout();
 373       layout.putConstraint(SpringLayout.WEST, scroller, 5,
 374               SpringLayout.WEST, this);
 375       layout.putConstraint(SpringLayout.NORTH, scroller, 5,
 376               SpringLayout.NORTH, this);
 377
 378       if (new Platform().isAMac())
 379       {
 380         scroller.setPreferredSize(new Dimension(500, 100));
 381       }
 382       else
 383       {
 384         scroller.setPreferredSize(new Dimension(130, 200));
 385       }
 386
 387       this.add(scroller);
 388
 389       javax.swing.SwingUtilities.invokeLater(new Runnable()
 390       {
 391         @Override
 392         public void run()
 393         {
 394           scroller.getHorizontalScrollBar().setValue(
 395                   scroller.getHorizontalScrollBar().getMaximum());
 396         }
 397       });
 398
 399     }
 400
 401   }
 402 }