JAL-3141 Reformatted code in eclipse
[jalview.git] / src / jalview / jbgui / GPreferences.java
index 4477620..43b521a 100755 (executable)
@@ -27,6 +27,7 @@ import jalview.gui.JalviewBooleanRadioButtons;
 import jalview.gui.JvSwingUtils;
 import jalview.gui.StructureViewer.ViewerType;
 import jalview.io.BackupFilenameFilter;
+import jalview.io.BackupFiles;
 import jalview.util.MessageManager;
 
 import java.awt.BorderLayout;
@@ -47,6 +48,8 @@ import java.awt.event.KeyEvent;
 import java.awt.event.KeyListener;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
+import java.util.HashMap;
+import java.util.Map;
 
 import javax.swing.AbstractCellEditor;
 import javax.swing.BorderFactory;
@@ -91,6 +94,9 @@ public class GPreferences extends JPanel
   private static final Font LABEL_FONT_ITALIC = JvSwingUtils
           .getLabelFont(false, true);
 
+  private static final Font LABEL_FONT_BOLD = JvSwingUtils
+          .getLabelFont(true, false);
+
   /*
    * Visual tab components
    */
@@ -271,7 +277,6 @@ public class GPreferences extends JPanel
 
   protected JCheckBox sortByTree = new JCheckBox();
 
-
   /*
    * Web Services tab
    */
@@ -285,6 +290,10 @@ public class GPreferences extends JPanel
 
   protected JCheckBox enableBackupFiles = new JCheckBox();
 
+  protected JPanel presetsPanel = new JPanel();
+
+  protected JComboBox<IntKeyStringValueEntry> backupfilesPresetsCombo = new JComboBox<>();
+
   protected JPanel suffixPanel = new JPanel();
 
   protected JPanel keepfilesPanel = new JPanel();
@@ -303,14 +312,12 @@ public class GPreferences extends JPanel
 
   protected JalviewBooleanRadioButtons backupfilesKeepAll = new JalviewBooleanRadioButtons();
 
-  protected JSpinner backupfilesRollMaxSpinner = new JSpinner();
+  public JSpinner backupfilesRollMaxSpinner = new JSpinner();
 
   protected JLabel oldBackupFilesLabel = new JLabel();
 
   protected JalviewBooleanRadioButtons backupfilesConfirmDelete = new JalviewBooleanRadioButtons();
 
-  protected JLabel exampleLabel = new JLabel();
-
   protected JTextArea backupfilesExampleLabel = new JTextArea();
 
   /**
@@ -523,11 +530,8 @@ public class GPreferences extends JPanel
     embbedBioJSON.setText(MessageManager.getString("label.embbed_biojson"));
     embbedBioJSON.setBounds(new Rectangle(228, 200, 250, 23));
 
-
     TitledBorder backupFilesBorder = new TitledBorder(
-            MessageManager
-                    .getString("label.backup_files"));
-
+            MessageManager.getString("label.backup_files"));
 
     jPanel11.add(jLabel1);
     jPanel11.add(blcjv);
@@ -1060,14 +1064,13 @@ public class GPreferences extends JPanel
         hiddenColour_actionPerformed(hiddenColour);
       }
     });
-    
+
     useLegacyGap = new JCheckBox(
             MessageManager.getString("label.ov_legacy_gap"));
     useLegacyGap.setFont(LABEL_FONT);
     useLegacyGap.setHorizontalAlignment(SwingConstants.LEFT);
     useLegacyGap.setVerticalTextPosition(SwingConstants.TOP);
-    gapLabel = new JLabel(
-            MessageManager.getString("label.gap_colour"));
+    gapLabel = new JLabel(MessageManager.getString("label.gap_colour"));
     gapLabel.setFont(LABEL_FONT);
     gapLabel.setHorizontalAlignment(SwingConstants.LEFT);
     gapLabel.setVerticalTextPosition(SwingConstants.TOP);
@@ -1690,13 +1693,25 @@ public class GPreferences extends JPanel
   private JPanel initBackupsTab()
   {
     JPanel backupsTab = new JPanel();
-    // backupsTab.setBorder(new TitledBorder(MessageManager
-    // .getString("label.backup_files")));
+    backupsTab.setBorder(new TitledBorder(
+            MessageManager.getString("label.backup_files")));
     backupsTab.setLayout(new GridBagLayout());
 
-    enableBackupFiles.setFont(LABEL_FONT);
-    enableBackupFiles.setText(
-            MessageManager.getString("label.enable_backupfiles"));
+    GridBagConstraints gbc = new GridBagConstraints();
+    gbc.weightx = 1.0;
+    gbc.weighty = 0.0;
+    gbc.anchor = GridBagConstraints.NORTHWEST;
+    gbc.fill = GridBagConstraints.NONE;
+
+    initBackupsTabPresetsPanel();
+    initBackupsTabSuffixPanel();
+    initBackupsTabKeepFilesPanel();
+    initBackupsTabFilenameExamplesPanel();
+
+    gbc.weightx = 0.5;
+    enableBackupFiles.setFont(LABEL_FONT_BOLD);
+    enableBackupFiles
+            .setText(MessageManager.getString("label.enable_backupfiles"));
     enableBackupFiles.addActionListener(new ActionListener()
     {
       @Override
@@ -1708,60 +1723,154 @@ public class GPreferences extends JPanel
       }
     });
 
-    GridBagConstraints gbc = new GridBagConstraints();
-    gbc.weightx = 1.0;
-    gbc.weighty = 0.0;
-    gbc.anchor = GridBagConstraints.NORTHWEST;
-    gbc.fill = GridBagConstraints.NONE;
-
     // enable checkbox 1 row
     gbc.gridwidth = 1;
+    gbc.gridx = 0;
     gbc.gridy = 0;
     backupsTab.add(enableBackupFiles, gbc);
 
-    initBackupsTabSuffixPanel();
-    initBackupsTabKeepFilesPanel();
-    initBackupsTabFilenameExamplesPanel();
+    gbc.gridx = 1;
+    gbc.weightx = 1.0;
+    gbc.gridheight = 2;
+    // gbc.anchor = GridBagConstraints.NORTHEAST;
+    // gbc.fill = GridBagConstraints.HORIZONTAL;
+    backupsTab.add(exampleFilesPanel, gbc);
 
-    /*
-    // set widths of the panels to the max one
-    int maxw = suffixPanel.getWidth();
-    if (maxw < keepfilesPanel.getWidth())
-    {
-      maxw = keepfilesPanel.getWidth();
-    }
-    if (maxw < exampleFilesPanel.getWidth())
-    {
-      maxw = exampleFilesPanel.getWidth();
-    }
-    suffixPanel.setSize(suffixPanel.getHeight(), maxw);
-    keepfilesPanel.setSize(keepfilesPanel.getHeight(), maxw);
-    exampleFilesPanel.setSize(exampleFilesPanel.getHeight(), maxw);
-    */
+    gbc.gridx = 0;
+    gbc.gridy = 1;
+    backupsTab.add(presetsPanel, gbc);
 
+    gbc.anchor = GridBagConstraints.NORTHWEST;
+    gbc.fill = GridBagConstraints.NONE;
+    gbc.gridwidth = 2;
+    gbc.gridheight = 1;
     // whole suffix panel next row
-    gbc.gridy = 1;
+    gbc.gridx = 0;
+    gbc.gridy = 2;
     backupsTab.add(suffixPanel, gbc);
 
     // keep files panel
-    gbc.gridy = 2;
+    gbc.gridy = 3;
     backupsTab.add(keepfilesPanel, gbc);
 
+    /*
     // whole examples panel next row
     gbc.gridy = 3;
     backupsTab.add(exampleFilesPanel, gbc);
-
+    
     // fill empty space
     gbc.gridy = 4;
     gbc.weighty = 1.0;
     backupsTab.add(new JPanel(), gbc);
+    */
 
     backupsOptionsSetEnabled(enableBackupFiles.isSelected());
     return backupsTab;
   }
 
+  private final IntKeyStringValueEntry[] backupfilesPresetEntries = {
+      new IntKeyStringValueEntry(1,
+              MessageManager.getString("label.default")),
+      new IntKeyStringValueEntry(2,
+              MessageManager.getString("label.single_file")),
+      new IntKeyStringValueEntry(3,
+              MessageManager.getString("label.keep_everything")),
+      new IntKeyStringValueEntry(4,
+              MessageManager.getString("label.rolled_backups")),
+      // ...
+      // IMPORTANT, keep "Custom" entry with key 0 (even though it appears last)
+      new IntKeyStringValueEntry(0,
+              MessageManager.getString("label.custom")) };
+
+  private final Map<Integer, BackupFilesPresetEntry> backupfilesPresetEntriesValues = new HashMap<Integer, BackupFilesPresetEntry>()
+  {
+    {
+      put(1, new BackupFilesPresetEntry(".v" + BackupFiles.NUM_PLACEHOLDER,
+              3, false, false, 4, false));
+      put(2, new BackupFilesPresetEntry("~", 1, false, false, 1, false));
+      put(3, new BackupFilesPresetEntry(".v" + BackupFiles.NUM_PLACEHOLDER,
+              3, false, true, 10, true));
+      put(4, new BackupFilesPresetEntry(
+              "_bak." + BackupFiles.NUM_PLACEHOLDER, 1, true, false, 9,
+              false));
+    }
+  };
+
+  private JPanel initBackupsTabPresetsPanel()
+  {
+    presetsPanel.setBorder(
+            new TitledBorder(MessageManager.getString("label.presets")));
+
+    for (int i = 0; i < backupfilesPresetEntries.length; i++)
+    {
+      backupfilesPresetsCombo.addItem(backupfilesPresetEntries[i]);
+    }
+
+    backupfilesPresetsCombo.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        backupsTabUpdatePresets();
+      }
+    });
+
+    presetsPanel.add(backupfilesPresetsCombo);
+    return presetsPanel;
+  }
+
+  private void backupsTabUpdatePresets()
+  {
+    IntKeyStringValueEntry entry = (IntKeyStringValueEntry) backupfilesPresetsCombo
+            .getSelectedItem();
+    int key = entry.getKey();
+    String value = entry.getValue();
+    boolean custom = key == 0;
 
-  public JPanel initBackupsTabSuffixPanel()
+    if (custom)
+    {
+      // backupsSetCustomOptions();
+    }
+    else
+    {
+      if (backupfilesPresetEntriesValues.containsKey(key))
+      {
+        backupsSetOptions(backupfilesPresetEntriesValues.get(key));
+      }
+      else
+      {
+        System.out.println("Preset '" + value + "' not implemented yet");
+      }
+    }
+
+    updateBackupFilesExampleLabel();
+    backupsCustomOptionsSetEnabled(custom);
+  }
+
+  protected int getComboIntStringKey(JComboBox c)
+  {
+    IntKeyStringValueEntry e = (IntKeyStringValueEntry) c.getSelectedItem();
+    return e != null ? e.getKey() : 0;
+  }
+
+  protected void setComboIntStringKey(JComboBox<IntKeyStringValueEntry> c,
+          int key)
+  {
+    for (int i = 0; i < c.getItemCount(); i++)
+    {
+      IntKeyStringValueEntry e = c.getItemAt(i);
+      int k = e.getKey();
+      String v = e.getValue();
+      if (e.getKey() == key)
+      {
+        c.setSelectedIndex(i);
+        break;
+      }
+    }
+    backupsTabUpdatePresets();
+  }
+
+  private JPanel initBackupsTabSuffixPanel()
   {
     suffixPanel.setBorder(new TitledBorder(
             MessageManager.getString("label.suffix_format")));
@@ -1772,8 +1881,8 @@ public class GPreferences extends JPanel
     suffixTemplateLabel.setHorizontalAlignment(SwingConstants.LEFT);
     suffixTemplateLabel.setFont(LABEL_FONT);
 
-    final String tooltip = JvSwingUtils.wrapTooltip(true, MessageManager
-            .getString("label.suffix_template_tooltip"));
+    final String tooltip = JvSwingUtils.wrapTooltip(true,
+            MessageManager.getString("label.suffix_template_tooltip"));
     suffixTemplate.setToolTipText(tooltip);
     suffixTemplate.addActionListener(new ActionListener()
     {
@@ -1830,8 +1939,7 @@ public class GPreferences extends JPanel
     };
     setIntegerSpinner(suffixDigitsSpinner, defaultmin, defaultmax, 3, c);
 
-    suffixReverse.setLabels(
-            MessageManager.getString("label.reverse_roll"),
+    suffixReverse.setLabels(MessageManager.getString("label.reverse_roll"),
             MessageManager.getString("label.increment_index"));
     suffixReverse.addActionListener(new ActionListener()
     {
@@ -1853,15 +1961,15 @@ public class GPreferences extends JPanel
     sgbc.weightx = 1.0;
     sgbc.weighty = 0.0;
     sgbc.fill = GridBagConstraints.NONE;
-    suffixPanel.add(suffixTemplateLabel,sgbc);
-    
+    suffixPanel.add(suffixTemplateLabel, sgbc);
+
     sgbc.gridx = 1;
     sgbc.fill = GridBagConstraints.HORIZONTAL;
     suffixPanel.add(suffixTemplate, sgbc);
-    
+
     // second row (number of digits spinner)
     sgbc.gridy = 1;
-    
+
     sgbc.gridx = 0;
     sgbc.fill = GridBagConstraints.NONE;
     suffixPanel.add(suffixDigitsLabel, sgbc);
@@ -1883,6 +1991,12 @@ public class GPreferences extends JPanel
     return suffixPanel;
   }
 
+  private void backupfilesKeepAllEnabled(boolean enabled)
+  {
+    backupfilesKeepAll.setEnabled(enabled);
+    keepRollMaxOptionsEnabled();
+  }
+
   private JPanel initBackupsTabKeepFilesPanel()
   {
     keepfilesPanel.setBorder(
@@ -1907,7 +2021,7 @@ public class GPreferences extends JPanel
       public void actionPerformed(ActionEvent e)
       {
         boolean selected = backupfilesKeepAll.isSelected();
-        keepRollMaxOptionsEnabled(!selected);
+        keepRollMaxOptionsEnabled();
         updateBackupFilesExampleLabel();
       }
     });
@@ -1927,7 +2041,7 @@ public class GPreferences extends JPanel
             MessageManager.getString("label.confirm_delete"),
             MessageManager.getString("label.auto_delete"));
     // update the enabled section
-    keepRollMaxOptionsEnabled(!backupfilesKeepAll.isSelected());
+    keepRollMaxOptionsEnabled();
 
     GridBagConstraints kgbc = new GridBagConstraints();
 
@@ -1979,42 +2093,37 @@ public class GPreferences extends JPanel
     jp.add(backupfilesConfirmDelete.getTrueButton());
     jp.add(backupfilesConfirmDelete.getFalseButton());
     keepfilesPanel.add(jp, kgbc);
-    
+
     return keepfilesPanel;
   }
 
   private JPanel initBackupsTabFilenameExamplesPanel()
   {
-    exampleFilesPanel.setBorder(new TitledBorder(
-            MessageManager.getString("label.example_filenames")));
+    String title = MessageManager.getString("label.example_filenames");
+    TitledBorder tb = new TitledBorder(title);
+    // tb.setTitleFont(LABEL_FONT);
+    exampleFilesPanel.setBorder(tb);
     exampleFilesPanel.setLayout(new GridBagLayout());
 
-    /*
-    exampleLabel.setText(
-            MessageManager.getString("label.suffix_example_filenames"));
-    exampleLabel.setFont(LABEL_FONT);
-    exampleLabel.setHorizontalAlignment(SwingConstants.LEFT);
-    */
+    // inordinately difficult to get this titledborder the right size for the
+    // title
 
     backupfilesExampleLabel.setEditable(false);
-    backupfilesExampleLabel.setPreferredSize(new Dimension(400, 85));
+    backupfilesExampleLabel.setPreferredSize(new Dimension(280, 85));
     backupfilesExampleLabel.setAlignmentX(LEFT_ALIGNMENT);
     backupfilesExampleLabel.setAlignmentY(TOP_ALIGNMENT);
-    
+
     backupfilesExampleLabel.setFont(LABEL_FONT_ITALIC);
-    backupfilesExampleLabel.setBackground(exampleLabel.getBackground());
+    backupfilesExampleLabel
+            .setBackground(exampleFilesPanel.getBackground());
 
     updateBackupFilesExampleLabel();
+    exampleFilesPanel.setMinimumSize(new Dimension(280, 85));
 
     GridBagConstraints gbc = new GridBagConstraints();
-    gbc.anchor = GridBagConstraints.WEST;
-    gbc.fill = GridBagConstraints.NONE;
+    gbc.anchor = GridBagConstraints.EAST;
 
     gbc.gridy = 0;
-    /*
-    exampleFilesPanel.add(exampleLabel, gbc);
-    gbc.gridy = 1;
-    */
     exampleFilesPanel.add(backupfilesExampleLabel, gbc);
     return exampleFilesPanel;
   }
@@ -2025,19 +2134,20 @@ public class GPreferences extends JPanel
     String base = MessageManager.getString("label.filename");
     if (base == null || base.length() > 0)
     {
-      base = "filename";
+      base = "filename.fa";
     }
-    String extension = ".fa";
 
     String suffix = suffixTemplate.getText();
     int digits = 3;
-    try {
+    try
+    {
       suffixDigitsSpinner.commitEdit();
       digits = (Integer) suffixDigitsSpinner.getValue();
       digits = digits < 1 ? 1 : digits;
     } catch (Exception e)
     {
-      System.out.println("Failed casting (Integer) suffixTemplateSpinner.getValue()");
+      System.out.println(
+              "Failed casting (Integer) suffixTemplateSpinner.getValue()");
     }
     boolean reverse = suffixReverse.isSelected();
     boolean keepAll = backupfilesKeepAll.isSelected();
@@ -2083,7 +2193,7 @@ public class GPreferences extends JPanel
             exampleSB.append("\n");
           }
           exampleSB.append(BackupFilenameFilter.getBackupFilename(index,
-                  base, suffix, digits, extension));
+                  base, suffix, digits));
           if (min == max)
           {
             // no extra text needed
@@ -2093,7 +2203,7 @@ public class GPreferences extends JPanel
             String newest = MessageManager.getString("label.braced_newest");
             if (newest != null && newest.length() > 0)
             {
-              exampleSB.append(" "+newest);
+              exampleSB.append(" " + newest);
             }
           }
           else if (index == max)
@@ -2101,7 +2211,7 @@ public class GPreferences extends JPanel
             String oldest = MessageManager.getString("label.braced_oldest");
             if (oldest != null && oldest.length() > 0)
             {
-              exampleSB.append(" "+oldest);
+              exampleSB.append(" " + oldest);
             }
           }
         }
@@ -2136,7 +2246,7 @@ public class GPreferences extends JPanel
             exampleSB.append("\n");
           }
           exampleSB.append(BackupFilenameFilter.getBackupFilename(index,
-                  base, suffix, digits, extension));
+                  base, suffix, digits));
           if (min == max)
           {
             // no extra text needed
@@ -2146,7 +2256,7 @@ public class GPreferences extends JPanel
             String oldest = MessageManager.getString("label.braced_oldest");
             if (oldest != null && oldest.length() > 0)
             {
-              exampleSB.append(" "+oldest);
+              exampleSB.append(" " + oldest);
             }
           }
           else if (index == max)
@@ -2154,7 +2264,7 @@ public class GPreferences extends JPanel
             String newest = MessageManager.getString("label.braced_newest");
             if (newest != null && newest.length() > 0)
             {
-              exampleSB.append(" "+newest);
+              exampleSB.append(" " + newest);
             }
           }
         }
@@ -2199,7 +2309,7 @@ public class GPreferences extends JPanel
 
   }
 
-  public static int getSpinnerInt(JSpinner s, int def)
+  protected static int getSpinnerInt(JSpinner s, int def)
   {
     int i = def;
     try
@@ -2213,33 +2323,73 @@ public class GPreferences extends JPanel
     return i;
   }
 
-  private void keepRollMaxOptionsEnabled(boolean enabled)
+  protected void keepRollMaxOptionsEnabled()
+  {
+    keepRollMaxOptionsEnabled(backupfilesKeepAll.isEnabled());
+  }
+
+  protected void keepRollMaxOptionsEnabled(boolean tryEnabled)
   {
+    boolean enabled = tryEnabled && !backupfilesKeepAll.isSelected();
     oldBackupFilesLabel.setEnabled(enabled);
     backupfilesRollMaxSpinner.setEnabled(enabled);
     backupfilesConfirmDelete.setEnabled(enabled);
+  }
 
+  protected void backupsCustomOptionsSetEnabled(boolean enabled)
+  {
+    backupsOptionsSetEnabled(enabled, false);
   }
 
   protected void backupsOptionsSetEnabled(boolean enabled)
   {
+    backupsOptionsSetEnabled(enabled, true);
+  }
+
+  protected void backupsOptionsSetEnabled(boolean enabled, boolean all)
+  {
+
+    if (all)
+    {
+      presetsPanel.setEnabled(enabled);
+      exampleFilesPanel.setEnabled(enabled);
+
+      backupfilesPresetsCombo.setEnabled(enabled);
+      backupfilesExampleLabel.setEnabled(enabled);
+    }
     suffixPanel.setEnabled(enabled);
     keepfilesPanel.setEnabled(enabled);
-    exampleFilesPanel.setEnabled(enabled);
 
     suffixTemplate.setEnabled(enabled);
     suffixTemplateLabel.setEnabled(enabled);
     suffixDigitsLabel.setEnabled(enabled);
     suffixDigitsSpinner.setEnabled(enabled);
     suffixReverse.setEnabled(enabled);
-    backupfilesKeepAll.setEnabled(enabled);
-    backupfilesRollMaxSpinner.setEnabled(enabled);
     oldBackupFilesLabel.setEnabled(enabled);
-    backupfilesConfirmDelete.setEnabled(enabled);
-    exampleLabel.setEnabled(enabled);
-    backupfilesExampleLabel.setEnabled(enabled);
+    backupfilesKeepAllEnabled(enabled);
 
-    keepRollMaxOptionsEnabled(enabled && !backupfilesKeepAll.isSelected());
+    if (enabled && all)
+    {
+      backupsTabUpdatePresets();
+    }
+  }
+
+  protected void backupsSetOptions(String suffix, int digits,
+          boolean reverse, boolean keepAll, int rollMax,
+          boolean confirmDelete)
+  {
+    suffixTemplate.setText(suffix);
+    suffixDigitsSpinner.setValue(digits);
+    suffixReverse.setSelected(reverse);
+    backupfilesKeepAll.setSelected(keepAll);
+    backupfilesRollMaxSpinner.setValue(rollMax);
+    backupfilesConfirmDelete.setSelected(confirmDelete);
+  }
+
+  protected void backupsSetOptions(BackupFilesPresetEntry p)
+  {
+    backupsSetOptions(p.suffix, p.digits, p.reverse, p.keepAll, p.rollMax,
+            p.confirmDelete);
   }
 
   protected void autoIdWidth_actionPerformed()
@@ -2427,3 +2577,58 @@ public class GPreferences extends JPanel
 
   }
 }
+
+class IntKeyStringValueEntry
+{
+  int k;
+
+  String v;
+
+  public IntKeyStringValueEntry(int k, String v)
+  {
+    this.k = k;
+    this.v = v;
+  }
+
+  @Override
+  public String toString()
+  {
+    return this.getValue();
+  }
+
+  public int getKey()
+  {
+    return k;
+  }
+
+  public String getValue()
+  {
+    return v;
+  }
+}
+
+class BackupFilesPresetEntry
+{
+  String suffix;
+
+  int digits;
+
+  boolean reverse;
+
+  boolean keepAll;
+
+  int rollMax;
+
+  boolean confirmDelete;
+
+  public BackupFilesPresetEntry(String suffix, int digits, boolean reverse,
+          boolean keepAll, int rollMax, boolean confirmDelete)
+  {
+    this.suffix = suffix;
+    this.digits = digits;
+    this.reverse = reverse;
+    this.keepAll = keepAll;
+    this.rollMax = rollMax;
+    this.confirmDelete = confirmDelete;
+  }
+}