JAL-2316 Changes following review.
[jalview.git] / src / jalview / gui / Preferences.java
index 550f324..c5bff31 100755 (executable)
@@ -24,15 +24,16 @@ import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
 import jalview.bin.Cache;
 import jalview.gui.Help.HelpId;
 import jalview.gui.StructureViewer.ViewerType;
+import jalview.io.FileFormatI;
 import jalview.io.JalviewFileChooser;
 import jalview.io.JalviewFileView;
 import jalview.jbgui.GPreferences;
 import jalview.jbgui.GSequenceLink;
 import jalview.schemes.ColourSchemeProperty;
-import jalview.urls.DesktopUrlProviderFactory;
 import jalview.urls.UrlLinkTableModel;
-import jalview.urls.UrlProviderFactoryI;
-import jalview.urls.UrlProviderI;
+import jalview.urls.api.UrlProviderFactoryI;
+import jalview.urls.api.UrlProviderI;
+import jalview.urls.desktop.DesktopUrlProviderFactory;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.util.UrlConstants;
@@ -54,7 +55,6 @@ import javax.help.HelpSetException;
 import javax.swing.JColorChooser;
 import javax.swing.JFileChooser;
 import javax.swing.JInternalFrame;
-import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.ListSelectionModel;
 import javax.swing.RowFilter;
@@ -128,10 +128,21 @@ public class Preferences extends GPreferences
   public static List<String> groupURLLinks;
   static
   {
-    String string = Cache.getDefault("SEQUENCE_LINKS",
-            UrlConstants.DEFAULT_STRING);
-    UrlProviderFactoryI factory = new DesktopUrlProviderFactory(
-            UrlConstants.DEFAULT_LABEL, string);
+    // get links selected to be in the menu (SEQUENCE_LINKS)
+    // and links entered by the user but not selected (STORED_LINKS)
+    String inMenuString = Cache.getDefault("SEQUENCE_LINKS", "");
+    String notInMenuString = Cache.getDefault("STORED_LINKS", "");
+    String defaultUrl = Cache.getDefault("DEFAULT_URL",
+            UrlConstants.DEFAULT_LABEL);
+
+    // if both links lists are empty, add the DEFAULT_URL link
+    // otherwise we assume the default link is in one of the lists
+    if (inMenuString.isEmpty() && notInMenuString.isEmpty())
+    {
+      inMenuString = UrlConstants.DEFAULT_STRING;
+    }
+    UrlProviderFactoryI factory = new DesktopUrlProviderFactory(defaultUrl,
+            inMenuString, notInMenuString);
     sequenceUrlLinks = factory.createUrlProvider();
     dataModel = new UrlLinkTableModel(sequenceUrlLinks);
 
@@ -334,10 +345,13 @@ public class Preferences extends GPreferences
     linkUrlTable.setRowSorter(sorter);
     List<RowSorter.SortKey> sortKeys = new ArrayList<>();
 
-    sortKeys.add(new RowSorter.SortKey(3,
+    UrlLinkTableModel m = (UrlLinkTableModel) linkUrlTable.getModel();
+    sortKeys.add(new RowSorter.SortKey(m.getPrimaryColumn(),
             SortOrder.DESCENDING));
-    sortKeys.add(new RowSorter.SortKey(2, SortOrder.DESCENDING));
-    sortKeys.add(new RowSorter.SortKey(0, SortOrder.ASCENDING));
+    sortKeys.add(new RowSorter.SortKey(m.getSelectedColumn(),
+            SortOrder.DESCENDING));
+    sortKeys.add(new RowSorter.SortKey(m.getNameColumn(),
+            SortOrder.ASCENDING));
 
     sorter.setSortKeys(sortKeys);
     sorter.sort();
@@ -363,8 +377,7 @@ public class Preferences extends GPreferences
       public boolean include(
               Entry<? extends TableModel, ? extends Object> entry)
       {
-        String id = entry.getStringValue(4);
-        return sequenceUrlLinks.isUserEntry(id);
+        return ((UrlLinkTableModel) entry.getModel()).isUserEntry(entry);
       }
     };
 
@@ -386,24 +399,26 @@ public class Preferences extends GPreferences
 
     filterTB.getDocument().addDocumentListener(new DocumentListener()
     {
+      String caseInsensitiveFlag = "(?i)";
+
       @Override
       public void changedUpdate(DocumentEvent e)
       {
-        sorter.setRowFilter(RowFilter.regexFilter("(?i)"
+        sorter.setRowFilter(RowFilter.regexFilter(caseInsensitiveFlag
                 + filterTB.getText()));
       }
 
       @Override
       public void removeUpdate(DocumentEvent e)
       {
-        sorter.setRowFilter(RowFilter.regexFilter("(?i)"
+        sorter.setRowFilter(RowFilter.regexFilter(caseInsensitiveFlag
                 + filterTB.getText()));
       }
 
       @Override
       public void insertUpdate(DocumentEvent e)
       {
-        sorter.setRowFilter(RowFilter.regexFilter("(?i)"
+        sorter.setRowFilter(RowFilter.regexFilter(caseInsensitiveFlag
                 + filterTB.getText()));
       }
     });
@@ -413,9 +428,12 @@ public class Preferences extends GPreferences
             new UrlListSelectionHandler());
 
     // set up radio buttons
-    linkUrlTable.getColumn("Default").setCellRenderer(
-            new RadioButtonRenderer());
-    linkUrlTable.getColumn("Default")
+    int onClickCol = ((UrlLinkTableModel) linkUrlTable.getModel())
+            .getPrimaryColumn();
+    String onClickName = linkUrlTable.getColumnName(onClickCol);
+    linkUrlTable.getColumn(onClickName).setCellRenderer(
+               new RadioButtonRenderer());
+    linkUrlTable.getColumn(onClickName)
             .setCellEditor(new RadioButtonEditor());
 
     // get boolean columns and resize those to min possible
@@ -635,17 +653,31 @@ public class Preferences extends GPreferences
     jalview.util.BrowserLauncher.resetBrowser();
 
     // save user-defined and selected links
-    String links = linkUrlTable.getModel().toString();
-    if (links.isEmpty())
+    String menuLinks = sequenceUrlLinks.writeUrlsAsString(true);
+    if (menuLinks.isEmpty())
     {
       Cache.applicationProperties.remove("SEQUENCE_LINKS");
     }
     else
     {
       Cache.applicationProperties.setProperty("SEQUENCE_LINKS",
-              links.toString());
+              menuLinks.toString());
     }
 
+    String nonMenuLinks = sequenceUrlLinks.writeUrlsAsString(false);
+    if (nonMenuLinks.isEmpty())
+    {
+      Cache.applicationProperties.remove("STORED_LINKS");
+    }
+    else
+    {
+      Cache.applicationProperties.setProperty("STORED_LINKS",
+              nonMenuLinks.toString());
+    }
+
+    Cache.applicationProperties.setProperty("DEFAULT_URL",
+            sequenceUrlLinks.getPrimaryUrlId());
+
     Cache.applicationProperties.setProperty("USE_PROXY",
             Boolean.toString(useProxy.isSelected()));
 
@@ -762,12 +794,9 @@ public class Preferences extends GPreferences
   @Override
   public void startupFileTextfield_mouseClicked()
   {
-    JalviewFileChooser chooser = new JalviewFileChooser(
-            jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[] {
-                "fa, fasta, fastq", "aln", "pfam", "msf", "pir", "blc",
-                "jar" }, new String[] { "Fasta", "Clustal", "PFAM", "MSF",
-                "PIR", "BLC", "Jalview" },
-            jalview.bin.Cache.getProperty("DEFAULT_FILE_FORMAT"));
+    String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
+    JalviewFileChooser chooser = JalviewFileChooser.forRead(
+            Cache.getProperty("LAST_DIRECTORY"), fileFormat);
     chooser.setFileView(new JalviewFileView());
     chooser.setDialogTitle(MessageManager
             .getString("label.select_startup_file"));
@@ -776,8 +805,12 @@ public class Preferences extends GPreferences
 
     if (value == JalviewFileChooser.APPROVE_OPTION)
     {
-      jalview.bin.Cache.applicationProperties.setProperty(
-              "DEFAULT_FILE_FORMAT", chooser.getSelectedFormat());
+      FileFormatI format = chooser.getSelectedFormat();
+      if (format != null)
+      {
+        Cache.applicationProperties.setProperty("DEFAULT_FILE_FORMAT",
+                format.toString());
+      }
       startupFileTextfield.setText(chooser.getSelectedFile()
               .getAbsolutePath());
     }
@@ -829,15 +862,24 @@ public class Preferences extends GPreferences
     boolean valid = false;
     while (!valid)
     {
-      if (JOptionPane.showInternalConfirmDialog(Desktop.desktop, link,
+      if (JvOptionPane.showInternalConfirmDialog(Desktop.desktop, link,
               MessageManager.getString("label.new_sequence_url_link"),
-              JOptionPane.OK_CANCEL_OPTION, -1, null) == JOptionPane.OK_OPTION)
+              JvOptionPane.OK_CANCEL_OPTION, -1, null) == JvOptionPane.OK_OPTION)
       {
         if (link.checkValid())
         {
-          ((UrlLinkTableModel) linkUrlTable.getModel()).insertRow(
-                  link.getName(), link.getURL());
-          valid = true;
+          if (((UrlLinkTableModel) linkUrlTable.getModel())
+                  .isUniqueName(link.getName()))
+          {
+            ((UrlLinkTableModel) linkUrlTable.getModel()).insertRow(
+                    link.getName(), link.getURL());
+            valid = true;
+          }
+          else
+          {
+            link.notifyDuplicate();
+            continue;
+          }
         }
       }
       else
@@ -855,11 +897,8 @@ public class Preferences extends GPreferences
     int index = linkUrlTable.getSelectedRow();
     if (index == -1)
     {
-      // no row was selected
-      JOptionPane.showInternalMessageDialog(Desktop.desktop,
-              MessageManager.getString("label.no_link_selected"),
-              MessageManager.getString("label.no_link_selected"),
-              JOptionPane.WARNING_MESSAGE);
+      // button no longer enabled if row is not selected
+      Cache.log.debug("Edit with no row selected in linkUrlTable");
       return;
     }
 
@@ -869,15 +908,24 @@ public class Preferences extends GPreferences
     boolean valid = false;
     while (!valid)
     {
-      if (JOptionPane.showInternalConfirmDialog(Desktop.desktop, link,
-              MessageManager.getString("label.new_sequence_url_link"),
-              JOptionPane.OK_CANCEL_OPTION, -1, null) == JOptionPane.OK_OPTION)
+      if (JvOptionPane.showInternalConfirmDialog(Desktop.desktop, link,
+              MessageManager.getString("label.edit_sequence_url_link"),
+              JvOptionPane.OK_CANCEL_OPTION, -1, null) == JvOptionPane.OK_OPTION)
       {
         if (link.checkValid())
         {
-          linkUrlTable.setValueAt(link.getName(), index, 0);
-          linkUrlTable.setValueAt(link.getURL(), index, 1);
-          valid = true;
+          if (((UrlLinkTableModel) linkUrlTable.getModel())
+                  .isUniqueName(link.getName()))
+          {
+            linkUrlTable.setValueAt(link.getName(), index, 0);
+            linkUrlTable.setValueAt(link.getURL(), index, 1);
+            valid = true;
+          }
+          else
+          {
+            link.notifyDuplicate();
+            continue;
+          }
         }
       }
       else
@@ -894,11 +942,8 @@ public class Preferences extends GPreferences
     int modelIndex = -1;
     if (index == -1)
     {
-      // no row is selected
-      JOptionPane.showInternalMessageDialog(Desktop.desktop,
-              MessageManager.getString("label.no_link_selected"),
-              MessageManager.getString("label.no_link_selected"),
-              JOptionPane.WARNING_MESSAGE);
+      // button no longer enabled if row is not selected
+      Cache.log.debug("Delete with no row selected in linkUrlTable");
       return;
     }
     else
@@ -989,10 +1034,10 @@ public class Preferences extends GPreferences
       }
     } catch (NumberFormatException x)
     {
-      JOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
+      JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
               .getString("warn.user_defined_width_requirements"),
               MessageManager.getString("label.invalid_id_column_width"),
-              JOptionPane.WARNING_MESSAGE);
+              JvOptionPane.WARNING_MESSAGE);
       userIdWidth.setText("");
     }
   }
@@ -1015,10 +1060,10 @@ public class Preferences extends GPreferences
       File f = new File(chimeraPath.getText());
       if (!f.canExecute())
       {
-        JOptionPane.showInternalMessageDialog(Desktop.desktop,
+        JvOptionPane.showInternalMessageDialog(Desktop.desktop,
                 MessageManager.getString("label.invalid_chimera_path"),
                 MessageManager.getString("label.invalid_name"),
-                JOptionPane.ERROR_MESSAGE);
+                JvOptionPane.ERROR_MESSAGE);
         return false;
       }
     }
@@ -1054,13 +1099,13 @@ public class Preferences extends GPreferences
     if (!found)
     {
       String[] options = { "OK", "Help" };
-      int showHelp = JOptionPane.showInternalOptionDialog(
+      int showHelp = JvOptionPane.showInternalOptionDialog(
               Desktop.desktop,
               JvSwingUtils.wrapTooltip(true,
                       MessageManager.getString("label.chimera_missing")),
-              "", JOptionPane.YES_NO_OPTION, JOptionPane.WARNING_MESSAGE,
+              "", JvOptionPane.YES_NO_OPTION, JvOptionPane.WARNING_MESSAGE,
               null, options, options[0]);
-      if (showHelp == JOptionPane.NO_OPTION)
+      if (showHelp == JvOptionPane.NO_OPTION)
       {
         try
         {
@@ -1146,26 +1191,25 @@ public class Preferences extends GPreferences
       }
       int modelIndex = linkUrlTable.convertRowIndexToModel(index);
 
-      // determine if the new selection is a custom url or not
-      if (!sequenceUrlLinks.isUserEntry((String) linkUrlTable
-.getModel()
-              .getValueAt(modelIndex, 4))) // KM TODO do this better
+      // enable/disable edit and delete link buttons
+      if (((UrlLinkTableModel) linkUrlTable.getModel())
+              .isRowDeletable(modelIndex))
       {
-        // entry is not a user-defined url and so should not be edited
-        // disable edit and delete buttons
-        deleteLink.setEnabled(false);
-        editLink.setEnabled(false);
+        deleteLink.setEnabled(true);
       }
       else
       {
-        deleteLink.setEnabled(true);
-        editLink.setEnabled(true);
+        deleteLink.setEnabled(false);
       }
 
-      // BUT it's the default url, don't allow deletion
-      if ((boolean) linkUrlTable.getValueAt(index, 3))
+      if (((UrlLinkTableModel) linkUrlTable.getModel())
+              .isRowEditable(modelIndex))
       {
-        deleteLink.setEnabled(false);
+        editLink.setEnabled(true);
+      }
+      else
+      {
+        editLink.setEnabled(false);
       }
     }
 }