Formatted source
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index 5a29ba7..d44275a 100755 (executable)
 * along with this program; if not, write to the Free Software\r
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
 */\r
-\r
-\r
 /*///////////////////////////////////////////////////////////////////\r
 // This file was taken from java forum\r
 // Re: JFileChooser functioning like normal Windows Apps FileChooser\r
 // Author: ddanimal\r
 // http://forum.java.sun.com/thread.jspa?forumID=57&threadID=327712\r
-*///////////////////////////////////////////////////////////////////\r
+*/\r
 \r
+//////////////////////////////////////////////////////////////////\r
 package jalview.io;\r
 \r
 import java.awt.*;\r
 import java.awt.event.*;\r
+\r
 import java.io.*;\r
+\r
 import java.util.*;\r
 \r
 import javax.swing.*;\r
@@ -38,341 +39,367 @@ import javax.swing.plaf.basic.*;
 import javax.swing.plaf.metal.*;\r
 import javax.swing.table.*;\r
 \r
-public class JalviewFileChooser extends JFileChooser\r
-{\r
-\r
-  private static final int COLUMN_FILENAME = 0;\r
-  private static final int COLUMN_FILESIZE = 1;\r
-  private static final int COLUMN_FILETYPE = 2;\r
-  private static final int COLUMN_FILEDATE = 3;\r
-  private static final int COLUMN_FILEATTR = 4;\r
-  private static final int COLUMN_COLCOUNT = 5;\r
-  private static String[] COLUMNS = null;\r
-\r
-\r
-  public JalviewFileChooser(String dir, String [] suffix, String [] desc, String selected)\r
-  {\r
-    super(dir);\r
-\r
-    JalviewFileFilter chosen = null;\r
-    for(int i=0; i<suffix.length; i++)\r
-    {\r
-      JalviewFileFilter jvf = new JalviewFileFilter(suffix[i], desc[i]);\r
-      addChoosableFileFilter(jvf);\r
-      if(selected!=null && selected.equalsIgnoreCase(desc[i]))\r
-        chosen = jvf;\r
+\r
+public class JalviewFileChooser extends JFileChooser {\r
+    private static final int COLUMN_FILENAME = 0;\r
+    private static final int COLUMN_FILESIZE = 1;\r
+    private static final int COLUMN_FILETYPE = 2;\r
+    private static final int COLUMN_FILEDATE = 3;\r
+    private static final int COLUMN_FILEATTR = 4;\r
+    private static final int COLUMN_COLCOUNT = 5;\r
+    private static String[] COLUMNS = null;\r
+\r
+    public JalviewFileChooser(String dir, String[] suffix, String[] desc,\r
+        String selected) {\r
+        super(dir);\r
+\r
+        JalviewFileFilter chosen = null;\r
+\r
+        for (int i = 0; i < suffix.length; i++) {\r
+            JalviewFileFilter jvf = new JalviewFileFilter(suffix[i], desc[i]);\r
+            addChoosableFileFilter(jvf);\r
+\r
+            if ((selected != null) && selected.equalsIgnoreCase(desc[i])) {\r
+                chosen = jvf;\r
+            }\r
+        }\r
+\r
+        if (chosen != null) {\r
+            setFileFilter(chosen);\r
+        }\r
+\r
+        initColumns();\r
     }\r
-    if(chosen!=null)\r
-      setFileFilter(chosen);\r
-    initColumns();\r
-  }\r
-\r
-  public String getSelectedFormat()\r
-  {\r
-\r
-    String format = getFileFilter().getDescription();\r
-\r
-    if (format.toUpperCase().startsWith("JALVIEW"))\r
-      format = "Jalview";\r
-    else if (format.toUpperCase().startsWith("FASTA"))\r
-      format = "FASTA";\r
-    else if (format.toUpperCase().startsWith("MSF"))\r
-      format = "MSF";\r
-    else if (format.toUpperCase().startsWith("CLUSTAL"))\r
-      format = "CLUSTAL";\r
-    else if (format.toUpperCase().startsWith("BLC"))\r
-      format = "BLC";\r
-    else if (format.toUpperCase().startsWith("PIR"))\r
-      format = "PIR";\r
-    else if (format.toUpperCase().startsWith("PFAM"))\r
-      format = "PFAM";\r
-\r
-    return format;\r
-  }\r
-  public JalviewFileChooser(String dir)\r
-  {\r
-    super(dir);\r
-    initColumns();\r
-  }\r
-\r
-  public int showSaveDialog(Component parent) throws HeadlessException {\r
-      setDialogType(SAVE_DIALOG);\r
-      int ret = showDialog(parent, null);\r
-\r
-      if(getFileFilter() instanceof JalviewFileFilter)\r
-      {\r
-        JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();\r
-        if (!jvf.accept(getSelectedFile()))\r
-        {\r
-          String withExtension = getSelectedFile() + "." + jvf.getAcceptableExtension();\r
-          setSelectedFile(new File(withExtension));\r
+\r
+    public JalviewFileChooser(String dir) {\r
+        super(dir);\r
+        initColumns();\r
+    }\r
+\r
+    public String getSelectedFormat() {\r
+        String format = getFileFilter().getDescription();\r
+\r
+        if (format.toUpperCase().startsWith("JALVIEW")) {\r
+            format = "Jalview";\r
+        } else if (format.toUpperCase().startsWith("FASTA")) {\r
+            format = "FASTA";\r
+        } else if (format.toUpperCase().startsWith("MSF")) {\r
+            format = "MSF";\r
+        } else if (format.toUpperCase().startsWith("CLUSTAL")) {\r
+            format = "CLUSTAL";\r
+        } else if (format.toUpperCase().startsWith("BLC")) {\r
+            format = "BLC";\r
+        } else if (format.toUpperCase().startsWith("PIR")) {\r
+            format = "PIR";\r
+        } else if (format.toUpperCase().startsWith("PFAM")) {\r
+            format = "PFAM";\r
         }\r
-      }\r
-\r
-      if(ret == JalviewFileChooser.APPROVE_OPTION  &&  getSelectedFile().exists() )\r
-      {\r
-       int confirm =  JOptionPane.showConfirmDialog(parent,\r
-                                      "Overwrite existing file?",\r
-                                      "File exists",\r
-                                      JOptionPane.YES_NO_OPTION);\r
-       if(confirm!=JOptionPane.YES_OPTION)\r
-         ret = this.CANCEL_OPTION;\r
-      }\r
-      return ret;\r
-  }\r
-\r
-\r
-  void initColumns()\r
-  {\r
-    if (COLUMNS == null)\r
-    {\r
-        Locale l = getLocale();\r
-        COLUMNS = new String[]{\r
-        UIManager.getString("FileChooser.fileNameHeaderText",l),\r
-        UIManager.getString("FileChooser.fileSizeHeaderText",l),\r
-        UIManager.getString("FileChooser.fileTypeHeaderText",l),\r
-        UIManager.getString("FileChooser.fileDateHeaderText",l),\r
-        UIManager.getString("FileChooser.fileAttrHeaderText",l)\r
-      };\r
+\r
+        return format;\r
     }\r
-  }\r
-\r
-  /**************************************************************************\r
-   * Always create the local UI\r
-   * @param comp\r
-   *************************************************************************/\r
-  public final void setUI(ComponentUI comp)\r
-  {\r
-    super.setUI(new UI(this));\r
-  }\r
-\r
-   /**************************************************************************\r
-    * Internal implementation of Metal LookAndFeel to create the table sorting\r
-    * ability.\r
-    *************************************************************************/\r
-   private final static class UI extends MetalFileChooserUI\r
-   {\r
-     private DirectoryModel model;\r
-\r
-     /**************************************************************************\r
-      * Must be overridden to extend\r
-      * @param e\r
-      *************************************************************************/\r
-     public UI(JFileChooser e)\r
-     {\r
-       super(e);\r
-     }\r
-\r
-     /**************************************************************************\r
-      * Overridden to create our own model\r
-      *************************************************************************/\r
-     protected final void createModel()\r
-     {\r
-       model = new DirectoryModel(getFileChooser());\r
-     }\r
-\r
-     /**************************************************************************\r
-      * Overridden to get our own model\r
-      * @return\r
-      *************************************************************************/\r
-     public final BasicDirectoryModel getModel() {       return model;     }\r
-\r
-     /**************************************************************************\r
-      * Calls the default method then adds a MouseListener to the JTable\r
-      * @param chooser\r
-      * @return\r
-      *************************************************************************/\r
-     protected final JPanel createDetailsView(JFileChooser chooser)\r
-     {\r
-       final JPanel panel = super.createDetailsView(chooser);\r
-\r
-       //Since we can't access MetalFileChooserUI's private member detailsTable\r
-       //directly, we have to find it in the JPanel\r
-       final JTable tbl = findJTable(panel.getComponents());\r
-       if (tbl != null)\r
-       {\r
-         //Fix the columns so they can't be rearranged, if we don't do this\r
-         //we would need to keep track when each column is moved\r
-         tbl.getTableHeader().setReorderingAllowed(false);\r
-\r
-         //Add a mouselistener to listen for clicks on column headers\r
-         tbl.getTableHeader().addMouseListener(new MouseAdapter(){\r
-           public void mouseClicked(MouseEvent e)\r
-           {\r
-             //Only process single clicks\r
-             if (e.getClickCount() > 1) return;\r
-             e.consume();\r
-             final int col = tbl.getTableHeader().columnAtPoint(e.getPoint());\r
-             if (col == COLUMN_FILENAME || col == COLUMN_FILESIZE ||\r
-                 col == COLUMN_FILEDATE)\r
-               model.sort(col,tbl);\r
-           }\r
-         });\r
-       }\r
-       return panel;\r
-     }\r
-\r
-     /**************************************************************************\r
-      * Finds the JTable in the panel so we can add MouseListener\r
-      * @param comp\r
-      * @return\r
-      *************************************************************************/\r
-     private final static JTable findJTable(Component[] comp)\r
-     {\r
-       for (int i=0;i<comp.length;i++)\r
-       {\r
-         if (comp[i] instanceof JTable)\r
-         {\r
-           return (JTable)comp[i];\r
-         }\r
-         if (comp[i] instanceof Container)\r
-         {\r
-           JTable tbl = findJTable(((Container)comp[i]).getComponents());\r
-           if (tbl != null) return tbl;\r
-         }\r
-       }\r
-       return null;\r
-     }\r
-   }\r
-\r
-  /***************************************************************************\r
-   * Implementation of BasicDirectoryModel that sorts the Files by column\r
-   **************************************************************************/\r
-  private final static class DirectoryModel extends BasicDirectoryModel\r
-   {\r
-     int col = 0;\r
-     boolean ascending;\r
-\r
-     /**************************************************************************\r
-      * Must be overridden to extend BasicDirectoryModel\r
-      * @param chooser\r
-      *************************************************************************/\r
-     DirectoryModel(JFileChooser chooser)\r
-     {\r
-       super(chooser);\r
-     }\r
-\r
-\r
-     /**************************************************************************\r
-      * Supposedly this is not used anymore, hopefully not.  We implemented\r
-      * some basic attempt at sorting just in case\r
-      * @param a\r
-      * @param b\r
-      * @return\r
-      *************************************************************************/\r
-     protected final boolean lt(File a, File b)\r
-     {\r
-       System.out.println("DEBUG:LT called?");\r
-       boolean less = false;\r
-       switch (col)\r
-       {\r
-         case COLUMN_FILEDATE:\r
-           less = a.lastModified() > b.lastModified();\r
-           break;\r
-         case COLUMN_FILESIZE:\r
-           less = a.length() > b.length();\r
-           break;\r
-         default:\r
-           less = a.getName().compareToIgnoreCase(b.getName()) > 0;\r
-         break;\r
-       }\r
-       if (ascending) return less = !less;\r
-       return less;\r
-     }\r
-\r
-     /**************************************************************************\r
-      * Resorts the JFileChooser table based on new column\r
-      * @param c\r
-      *************************************************************************/\r
-     protected final void sort(int c, JTable tbl)\r
-     {\r
-       //Set column and order\r
-       col = c;\r
-       ascending = !ascending;\r
-       String indicator = " (^)";\r
-       if (ascending)\r
-         indicator = " (v)";\r
-\r
-       final JTableHeader th = tbl.getTableHeader();\r
-       final TableColumnModel tcm = th.getColumnModel();\r
-\r
-       for (int i=0;i<JalviewFileChooser.COLUMN_COLCOUNT;i++)\r
-       {\r
-         final TableColumn tc = tcm.getColumn( i ); // the column to change\r
-         tc.setHeaderValue( COLUMNS[i] );\r
-       }\r
-\r
-       final TableColumn tc = tcm.getColumn( col ); // the column to change\r
-       tc.setHeaderValue( COLUMNS[col] + indicator );\r
-\r
-       th.repaint();\r
-\r
-       //Requery the file listing\r
-       validateFileCache();\r
-     }\r
-\r
-     /**************************************************************************\r
-      * Sorts the data based on current column setting\r
-      * @param data\r
-      *************************************************************************/\r
-     protected final void sort(Vector data)\r
-     {\r
-       switch (col)\r
-       {\r
-         case COLUMN_FILEDATE:\r
-           Collections.sort(data,new Comparator(){\r
-             public int compare(Object o1,Object o2)\r
-             {\r
-               int ret = 1;\r
-               final File a = (File)o1;\r
-               final File b = (File)o2;\r
-               if (a.lastModified() > b.lastModified())\r
-                 ret = -1;\r
-               else if (a.lastModified() == b.lastModified())\r
-                 ret = 0;\r
-\r
-               if (ascending)\r
-                 ret *= -1;\r
-               return ret;\r
-             }\r
-\r
-           });\r
-           break;\r
-         case COLUMN_FILESIZE:\r
-           Collections.sort(data,new Comparator(){\r
-             public int compare(Object o1,Object o2)\r
-             {\r
-               int ret = 1;\r
-               final File a = (File)o1;\r
-               final File b = (File)o2;\r
-               if (a.length() > b.length())\r
-                 ret = -1;\r
-               else if (a.length() == b.length())\r
-                 ret = 0;\r
-\r
-               if (ascending)\r
-                 ret *= -1;\r
-               return ret;\r
-             }\r
-\r
-           });\r
-           break;\r
-         case COLUMN_FILENAME:\r
-           Collections.sort(data,new Comparator(){\r
-             public int compare(Object o1,Object o2)\r
-             {\r
-               final File a = (File)o1;\r
-               final File b = (File)o2;\r
-               if (ascending)\r
-                 return a.getName().compareToIgnoreCase(b.getName());\r
-               else\r
-                 return -1 * a.getName().compareToIgnoreCase(b.getName());\r
-             }\r
-\r
-           });\r
-           break;\r
-       }\r
-     }\r
-  }\r
-}\r
 \r
+    public int showSaveDialog(Component parent) throws HeadlessException {\r
+        setDialogType(SAVE_DIALOG);\r
+\r
+        int ret = showDialog(parent, null);\r
+\r
+        if (getFileFilter() instanceof JalviewFileFilter) {\r
+            JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();\r
+\r
+            if (!jvf.accept(getSelectedFile())) {\r
+                String withExtension = getSelectedFile() + "." +\r
+                    jvf.getAcceptableExtension();\r
+                setSelectedFile(new File(withExtension));\r
+            }\r
+        }\r
+\r
+        if ((ret == JalviewFileChooser.APPROVE_OPTION) &&\r
+                getSelectedFile().exists()) {\r
+            int confirm = JOptionPane.showConfirmDialog(parent,\r
+                    "Overwrite existing file?", "File exists",\r
+                    JOptionPane.YES_NO_OPTION);\r
+\r
+            if (confirm != JOptionPane.YES_OPTION) {\r
+                ret = this.CANCEL_OPTION;\r
+            }\r
+        }\r
+\r
+        return ret;\r
+    }\r
+\r
+    void initColumns() {\r
+        if (COLUMNS == null) {\r
+            Locale l = getLocale();\r
+            COLUMNS = new String[] {\r
+                    UIManager.getString("FileChooser.fileNameHeaderText", l),\r
+                    UIManager.getString("FileChooser.fileSizeHeaderText", l),\r
+                    UIManager.getString("FileChooser.fileTypeHeaderText", l),\r
+                    UIManager.getString("FileChooser.fileDateHeaderText", l),\r
+                    UIManager.getString("FileChooser.fileAttrHeaderText", l)\r
+                };\r
+        }\r
+    }\r
+\r
+    /**************************************************************************\r
+     * Always create the local UI\r
+     * @param comp\r
+     *************************************************************************/\r
+    public final void setUI(ComponentUI comp) {\r
+        super.setUI(new UI(this));\r
+    }\r
+\r
+    /**************************************************************************\r
+     * Internal implementation of Metal LookAndFeel to create the table sorting\r
+     * ability.\r
+     *************************************************************************/\r
+    private final static class UI extends MetalFileChooserUI {\r
+        private DirectoryModel model;\r
+\r
+        /**************************************************************************\r
+         * Must be overridden to extend\r
+         * @param e\r
+         *************************************************************************/\r
+        public UI(JFileChooser e) {\r
+            super(e);\r
+        }\r
+\r
+        /**************************************************************************\r
+         * Overridden to create our own model\r
+         *************************************************************************/\r
+        protected final void createModel() {\r
+            model = new DirectoryModel(getFileChooser());\r
+        }\r
+\r
+        /**************************************************************************\r
+         * Overridden to get our own model\r
+         * @return\r
+         *************************************************************************/\r
+        public final BasicDirectoryModel getModel() {\r
+            return model;\r
+        }\r
+\r
+        /**************************************************************************\r
+         * Calls the default method then adds a MouseListener to the JTable\r
+         * @param chooser\r
+         * @return\r
+         *************************************************************************/\r
+        protected final JPanel createDetailsView(JFileChooser chooser) {\r
+            final JPanel panel = super.createDetailsView(chooser);\r
+\r
+            //Since we can't access MetalFileChooserUI's private member detailsTable\r
+            //directly, we have to find it in the JPanel\r
+            final JTable tbl = findJTable(panel.getComponents());\r
+\r
+            if (tbl != null) {\r
+                //Fix the columns so they can't be rearranged, if we don't do this\r
+                //we would need to keep track when each column is moved\r
+                tbl.getTableHeader().setReorderingAllowed(false);\r
+\r
+                //Add a mouselistener to listen for clicks on column headers\r
+                tbl.getTableHeader().addMouseListener(new MouseAdapter() {\r
+                        public void mouseClicked(MouseEvent e) {\r
+                            //Only process single clicks\r
+                            if (e.getClickCount() > 1) {\r
+                                return;\r
+                            }\r
+\r
+                            e.consume();\r
+\r
+                            final int col = tbl.getTableHeader().columnAtPoint(e.getPoint());\r
+\r
+                            if ((col == COLUMN_FILENAME) ||\r
+                                    (col == COLUMN_FILESIZE) ||\r
+                                    (col == COLUMN_FILEDATE)) {\r
+                                model.sort(col, tbl);\r
+                            }\r
+                        }\r
+                    });\r
+            }\r
+\r
+            return panel;\r
+        }\r
+\r
+        /**************************************************************************\r
+         * Finds the JTable in the panel so we can add MouseListener\r
+         * @param comp\r
+         * @return\r
+         *************************************************************************/\r
+        private final static JTable findJTable(Component[] comp) {\r
+            for (int i = 0; i < comp.length; i++) {\r
+                if (comp[i] instanceof JTable) {\r
+                    return (JTable) comp[i];\r
+                }\r
+\r
+                if (comp[i] instanceof Container) {\r
+                    JTable tbl = findJTable(((Container) comp[i]).getComponents());\r
+\r
+                    if (tbl != null) {\r
+                        return tbl;\r
+                    }\r
+                }\r
+            }\r
+\r
+            return null;\r
+        }\r
+    }\r
+\r
+    /***************************************************************************\r
+     * Implementation of BasicDirectoryModel that sorts the Files by column\r
+     **************************************************************************/\r
+    private final static class DirectoryModel extends BasicDirectoryModel {\r
+        int col = 0;\r
+        boolean ascending;\r
+\r
+        /**************************************************************************\r
+         * Must be overridden to extend BasicDirectoryModel\r
+         * @param chooser\r
+         *************************************************************************/\r
+        DirectoryModel(JFileChooser chooser) {\r
+            super(chooser);\r
+        }\r
+\r
+        /**************************************************************************\r
+         * Supposedly this is not used anymore, hopefully not.  We implemented\r
+         * some basic attempt at sorting just in case\r
+         * @param a\r
+         * @param b\r
+         * @return\r
+         *************************************************************************/\r
+        protected final boolean lt(File a, File b) {\r
+            System.out.println("DEBUG:LT called?");\r
+\r
+            boolean less = false;\r
+\r
+            switch (col) {\r
+            case COLUMN_FILEDATE:\r
+                less = a.lastModified() > b.lastModified();\r
+\r
+                break;\r
+\r
+            case COLUMN_FILESIZE:\r
+                less = a.length() > b.length();\r
+\r
+                break;\r
+\r
+            default:\r
+                less = a.getName().compareToIgnoreCase(b.getName()) > 0;\r
+\r
+                break;\r
+            }\r
+\r
+            if (ascending) {\r
+                return less = !less;\r
+            }\r
+\r
+            return less;\r
+        }\r
+\r
+        /**************************************************************************\r
+         * Resorts the JFileChooser table based on new column\r
+         * @param c\r
+         *************************************************************************/\r
+        protected final void sort(int c, JTable tbl) {\r
+            //Set column and order\r
+            col = c;\r
+            ascending = !ascending;\r
+\r
+            String indicator = " (^)";\r
+\r
+            if (ascending) {\r
+                indicator = " (v)";\r
+            }\r
+\r
+            final JTableHeader th = tbl.getTableHeader();\r
+            final TableColumnModel tcm = th.getColumnModel();\r
+\r
+            for (int i = 0; i < JalviewFileChooser.COLUMN_COLCOUNT; i++) {\r
+                final TableColumn tc = tcm.getColumn(i); // the column to change\r
+                tc.setHeaderValue(COLUMNS[i]);\r
+            }\r
+\r
+            final TableColumn tc = tcm.getColumn(col); // the column to change\r
+            tc.setHeaderValue(COLUMNS[col] + indicator);\r
+\r
+            th.repaint();\r
+\r
+            //Requery the file listing\r
+            validateFileCache();\r
+        }\r
+\r
+        /**************************************************************************\r
+         * Sorts the data based on current column setting\r
+         * @param data\r
+         *************************************************************************/\r
+        protected final void sort(Vector data) {\r
+            switch (col) {\r
+            case COLUMN_FILEDATE:\r
+                Collections.sort(data,\r
+                    new Comparator() {\r
+                        public int compare(Object o1, Object o2) {\r
+                            int ret = 1;\r
+                            final File a = (File) o1;\r
+                            final File b = (File) o2;\r
+\r
+                            if (a.lastModified() > b.lastModified()) {\r
+                                ret = -1;\r
+                            } else if (a.lastModified() == b.lastModified()) {\r
+                                ret = 0;\r
+                            }\r
+\r
+                            if (ascending) {\r
+                                ret *= -1;\r
+                            }\r
+\r
+                            return ret;\r
+                        }\r
+                    });\r
+\r
+\r
+                break;\r
+\r
+            case COLUMN_FILESIZE:\r
+                Collections.sort(data,\r
+                    new Comparator() {\r
+                        public int compare(Object o1, Object o2) {\r
+                            int ret = 1;\r
+                            final File a = (File) o1;\r
+                            final File b = (File) o2;\r
+\r
+                            if (a.length() > b.length()) {\r
+                                ret = -1;\r
+                            } else if (a.length() == b.length()) {\r
+                                ret = 0;\r
+                            }\r
+\r
+                            if (ascending) {\r
+                                ret *= -1;\r
+                            }\r
+\r
+                            return ret;\r
+                        }\r
+                    });\r
+\r
+\r
+                break;\r
+\r
+            case COLUMN_FILENAME:\r
+                Collections.sort(data,\r
+                    new Comparator() {\r
+                        public int compare(Object o1, Object o2) {\r
+                            final File a = (File) o1;\r
+                            final File b = (File) o2;\r
+\r
+                            if (ascending) {\r
+                                return a.getName().compareToIgnoreCase(b.getName());\r
+                            } else {\r
+                                return -1 * a.getName().compareToIgnoreCase(b.getName());\r
+                            }\r
+                        }\r
+                    });\r
+\r
+\r
+                break;\r
+            }\r
+        }\r
+    }\r
+}\r