JAL-3775 JAL-3633 Make java.net.Authenticator code conditional on not being JalviewJS
[jalview.git] / src / jalview / jbgui / GPreferences.java
index bc9584e..5af94e4 100755 (executable)
@@ -69,6 +69,8 @@ import javax.swing.border.EtchedBorder;
 import javax.swing.border.TitledBorder;
 import javax.swing.event.ChangeEvent;
 import javax.swing.event.ChangeListener;
+import javax.swing.event.DocumentEvent;
+import javax.swing.event.DocumentListener;
 import javax.swing.table.TableCellEditor;
 import javax.swing.table.TableCellRenderer;
 
@@ -262,7 +264,7 @@ public class GPreferences extends JPanel
 
   protected JTextField proxyAuthUsernameTB = new JTextField();
 
-  protected JPasswordField proxyAuthPasswordTB = new JPasswordField();
+  protected JPasswordField proxyAuthPasswordPB = new JPasswordField();
 
   protected JTextField defaultBrowser = new JTextField();
 
@@ -274,6 +276,8 @@ public class GPreferences extends JPanel
 
   protected JRadioButton customProxy = new JRadioButton();
 
+  protected JButton applyProxyButton = new JButton();
+
   protected JCheckBox usagestats = new JCheckBox();
 
   protected JCheckBox questionnaire = new JCheckBox();
@@ -373,19 +377,18 @@ public class GPreferences extends JPanel
 
   protected JTextArea backupfilesExampleLabel = new JTextArea();
 
+  private final JTabbedPane tabbedPane = new JTabbedPane();
+
+  private JLabel messageLabel = new JLabel("", JLabel.CENTER);
+
   /**
    * Creates a new GPreferences object.
    */
   public GPreferences()
   {
-    new GPreferences(0);
-  }
-
-  public GPreferences(int selectTab)
-  {
     try
     {
-      jbInit(selectTab);
+      jbInit();
     } catch (Exception ex)
     {
       ex.printStackTrace();
@@ -399,15 +402,12 @@ public class GPreferences extends JPanel
    */
   private void jbInit() throws Exception
   {
-    jbInit(0);
-  }
+    // final JTabbedPane tabbedPane = new JTabbedPane();
+    this.setLayout(new BorderLayout());
 
-  public final static int CONNECTIONS_TAB = 5;
+    // message label at top
+    this.add(messageLabel, BorderLayout.NORTH);
 
-  private void jbInit(int selectTab) throws Exception
-  {
-    final JTabbedPane tabbedPane = new JTabbedPane();
-    this.setLayout(new BorderLayout());
     JPanel okCancelPanel = initOkCancelPanel();
     this.add(tabbedPane, BorderLayout.CENTER);
     this.add(okCancelPanel, BorderLayout.SOUTH);
@@ -427,11 +427,11 @@ public class GPreferences extends JPanel
     tabbedPane.add(initConnectionsTab(),
             MessageManager.getString("label.connections"));
 
-       if (!Platform.isJS()) 
-       {
-         tabbedPane.add(initBackupsTab(), 
-                       MessageManager.getString("label.backups"));
-       }
+    if (!Platform.isJS())
+    {
+      tabbedPane.add(initBackupsTab(),
+              MessageManager.getString("label.backups"));
+    }
 
     tabbedPane.add(initLinksTab(),
             MessageManager.getString("label.urllinks"));
@@ -454,6 +454,7 @@ public class GPreferences extends JPanel
     /*
      * Handler to validate a tab before leaving it - currently only for
      * Structure.
+     * Adding a clearMessage() so messages are cleared when changing tabs.
      */
     tabbedPane.addChangeListener(new ChangeListener()
     {
@@ -472,10 +473,47 @@ public class GPreferences extends JPanel
           }
         }
         lastTab = tabbedPane.getSelectedComponent();
+
+        clearMessage();
       }
 
     });
+  }
+
+  public void setMessage(String message)
+  {
+    if (message != null)
+    {
+      messageLabel.setText(message);
+      messageLabel.setFont(LABEL_FONT_BOLD);
+      messageLabel.setForeground(Color.RED.darker());
+      messageLabel.revalidate();
+      messageLabel.repaint();
+    }
+    // note message not cleared if message is null. call clearMessage()
+    // directly.
+    this.revalidate();
+    this.repaint();
+  }
+
+  public void clearMessage()
+  {
+    // only repaint if message exists
+    if (messageLabel.getText() != null
+            && messageLabel.getText().length() > 0)
+    {
+      messageLabel.setText("");
+      messageLabel.revalidate();
+      messageLabel.repaint();
+      this.revalidate();
+      this.repaint();
+    }
+  }
+
+  public final static int CONNECTIONS_TAB = 5;
 
+  public void selectTab(int selectTab)
+  {
     // select a given tab - currently only for Connections
     switch (selectTab)
     {
@@ -484,7 +522,6 @@ public class GPreferences extends JPanel
       break;
     default:
     }
-
   }
 
   /**
@@ -953,8 +990,60 @@ public class GPreferences extends JPanel
     proxyPortHttpsTB.setColumns(4);
     proxyAuthUsernameTB.setFont(LABEL_FONT);
     proxyAuthUsernameTB.setColumns(30);
-    proxyAuthPasswordTB.setFont(LABEL_FONT);
-    proxyAuthPasswordTB.setColumns(30);
+
+    // check for any change to enable applyProxyButton
+    DocumentListener d = new DocumentListener()
+    {
+      @Override
+      public void changedUpdate(DocumentEvent e)
+      {
+        applyProxyButtonEnabled(true);
+      }
+
+      @Override
+      public void insertUpdate(DocumentEvent e)
+      {
+        applyProxyButtonEnabled(true);
+      }
+
+      @Override
+      public void removeUpdate(DocumentEvent e)
+      {
+        applyProxyButtonEnabled(true);
+      }
+    };
+    proxyServerHttpTB.getDocument().addDocumentListener(d);
+    proxyPortHttpTB.getDocument().addDocumentListener(d);
+    proxyServerHttpsTB.getDocument().addDocumentListener(d);
+    proxyPortHttpsTB.getDocument().addDocumentListener(d);
+    proxyAuthUsernameTB.getDocument().addDocumentListener(d);
+    proxyAuthPasswordPB.setFont(LABEL_FONT);
+    proxyAuthPasswordPB.setColumns(30);
+    proxyAuthPasswordPB.getDocument()
+            .addDocumentListener(new DocumentListener()
+            {
+              @Override
+              public void changedUpdate(DocumentEvent e)
+              {
+                proxyAuthPasswordCheckHighlight(true);
+                applyProxyButtonEnabled(true);
+              }
+
+              @Override
+              public void insertUpdate(DocumentEvent e)
+              {
+                proxyAuthPasswordCheckHighlight(true);
+                applyProxyButtonEnabled(true);
+              }
+
+              @Override
+              public void removeUpdate(DocumentEvent e)
+              {
+                proxyAuthPasswordCheckHighlight(true);
+                applyProxyButtonEnabled(true);
+              }
+
+            });
 
     // Label for Port text box
     portLabel.setFont(LABEL_FONT);
@@ -1116,47 +1205,106 @@ public class GPreferences extends JPanel
     gbc.gridy++;
     proxyPanel.add(hpPanel, gbc);
 
-    // Require authentication checkbox
+    if (!Platform.isJS())
+    /**
+     * java.net.Authenticator is not implemented in SwingJS. Not displaying the
+     * Authentication options in Preferences.
+     * 
+     * @j2sIgnore
+     * 
+     */
+    {
+      // Require authentication checkbox
+      gbc.gridy++;
+      proxyPanel.add(proxyAuth, gbc);
+
+      // username and password
+      JPanel upPanel = new JPanel();
+      upPanel.setLayout(new GridBagLayout());
+      // username row
+      c.gridy = 0;
+      c.gridx = 0;
+      c.gridwidth = 1;
+      c.weightx = 0.4;
+      c.anchor = GridBagConstraints.LINE_END;
+      upPanel.add(proxyAuthUsernameLabel, c);
+
+      c.gridx++;
+      c.weightx = 1.0;
+      c.anchor = GridBagConstraints.LINE_START;
+      upPanel.add(proxyAuthUsernameTB, c);
+
+      // password row
+      c.gridy++;
+      c.gridx = 0;
+      c.weightx = 0.4;
+      c.anchor = GridBagConstraints.LINE_END;
+      upPanel.add(proxyAuthPasswordLabel, c);
+
+      c.gridx++;
+      c.weightx = 1.0;
+      c.anchor = GridBagConstraints.LINE_START;
+      upPanel.add(proxyAuthPasswordPB, c);
+
+      c.gridx++;
+      c.weightx = 0.4;
+      c.anchor = GridBagConstraints.LINE_START;
+      upPanel.add(passwordNotStoredLabel, c);
+
+      gbc.gridy++;
+      proxyPanel.add(upPanel, gbc);
+
+    } // end j2sIgnore
+
+    applyProxyButton.setText(MessageManager.getString("action.apply"));
+    applyProxyButton.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        saveProxySettings();
+        applyProxyButton.setEnabled(false);
+      }
+    });
     gbc.gridy++;
-    proxyPanel.add(proxyAuth, gbc);
-
-    // username and password
-    JPanel upPanel = new JPanel();
-    upPanel.setLayout(new GridBagLayout());
-    // username row
-    c.gridy = 0;
-    c.gridx = 0;
-    c.gridwidth = 1;
-    c.weightx = 0.4;
-    c.anchor = GridBagConstraints.LINE_END;
-    upPanel.add(proxyAuthUsernameLabel, c);
-
-    c.gridx++;
-    c.weightx = 1.0;
-    c.anchor = GridBagConstraints.LINE_START;
-    upPanel.add(proxyAuthUsernameTB, c);
+    gbc.fill = GridBagConstraints.NONE;
+    gbc.anchor = GridBagConstraints.LINE_END;
+    proxyPanel.add(applyProxyButton, gbc);
 
-    // password row
-    c.gridy++;
-    c.gridx = 0;
-    c.weightx = 0.4;
-    c.anchor = GridBagConstraints.LINE_END;
-    upPanel.add(proxyAuthPasswordLabel, c);
+    return proxyPanel;
+  }
 
-    c.gridx++;
-    c.weightx = 1.0;
-    c.anchor = GridBagConstraints.LINE_START;
-    upPanel.add(proxyAuthPasswordTB, c);
+  public void proxyAuthPasswordCheckHighlight(boolean enabled)
+  {
+    proxyAuthPasswordCheckHighlight(enabled, false);
+  }
 
-    c.gridx++;
-    c.weightx = 0.4;
-    c.anchor = GridBagConstraints.LINE_START;
-    upPanel.add(passwordNotStoredLabel, c);
+  public void proxyAuthPasswordCheckHighlight(boolean enabled,
+          boolean grabFocus)
+  {
+    if (enabled && proxyType.isSelected(customProxy.getModel())
+            && proxyAuth.isSelected()
+            && !proxyAuthUsernameTB.getText().isEmpty()
+            && proxyAuthPasswordPB.getDocument().getLength() == 0)
+    {
+      if (grabFocus)
+        proxyAuthPasswordPB.grabFocus();
+      proxyAuthPasswordPB.setBackground(Color.PINK);
+    }
+    else
+    {
+      proxyAuthPasswordPB.setBackground(Color.WHITE);
+    }
+  }
 
-    gbc.gridy++;
-    proxyPanel.add(upPanel, gbc);
+  public void applyProxyButtonEnabled(boolean enabled)
+  {
+    applyProxyButton.setEnabled(enabled);
+  }
 
-    return proxyPanel;
+  public void saveProxySettings()
+  {
+    // overridden in Preferences
   }
 
   private String displayUserHostPort(String user, String host, String port)
@@ -1556,11 +1704,13 @@ public class GPreferences extends JPanel
 
     ypos += lineSpacing;
     structureViewerPathLabel = new JLabel();
-    structureViewerPathLabel.setFont(LABEL_FONT);// new Font("SansSerif", 0, 11));
+    structureViewerPathLabel.setFont(LABEL_FONT);// new Font("SansSerif", 0,
+                                                 // 11));
     structureViewerPathLabel.setHorizontalAlignment(SwingConstants.LEFT);
     structureViewerPathLabel.setText(MessageManager
             .formatMessage("label.viewer_path", "Chimera(X)"));
-    structureViewerPathLabel.setBounds(new Rectangle(10, ypos, 170, height));
+    structureViewerPathLabel
+            .setBounds(new Rectangle(10, ypos, 170, height));
     structureViewerPathLabel.setEnabled(false);
     structureTab.add(structureViewerPathLabel);
 
@@ -1618,14 +1768,14 @@ public class GPreferences extends JPanel
     /*
      * hide Chimera options in JalviewJS
      */
-    if (Platform.isJS()) 
+    if (Platform.isJS())
     {
       structureViewerPathLabel.setVisible(false);
       structureViewerPath.setVisible(false);
       viewerLabel.setVisible(false);
       structViewer.setVisible(false);
     }
-    
+
     return structureTab;
   }
 
@@ -2002,13 +2152,13 @@ public class GPreferences extends JPanel
     visualTab.add(fontNameCB);
     visualTab.add(fontSizeCB);
     visualTab.add(fontStyleCB);
-    
+
     if (Platform.isJS())
     {
       startupCheckbox.setVisible(false);
       startupFileTextfield.setVisible(false);
     }
-    
+
     return visualTab;
   }
 
@@ -2020,8 +2170,8 @@ public class GPreferences extends JPanel
   {
     BackupFilesPresetEntry savedPreset = BackupFilesPresetEntry
             .getSavedBackupEntry();
-    enableBackupFiles
-            .setSelected(Cache.getDefault(BackupFiles.ENABLED, !Platform.isJS()));
+    enableBackupFiles.setSelected(
+            Cache.getDefault(BackupFiles.ENABLED, !Platform.isJS()));
 
     BackupFilesPresetEntry backupfilesCustomEntry = BackupFilesPresetEntry
             .createBackupFilesPresetEntry(Cache
@@ -2098,7 +2248,6 @@ public class GPreferences extends JPanel
       }
     });
 
-
     // enable checkbox 1 col
     gbc.gridwidth = 1;
     gbc.gridheight = 1;
@@ -2171,8 +2320,8 @@ public class GPreferences extends JPanel
     presetsComboLabel = new JLabel(title + ":");
     presetsPanel.add(presetsComboLabel, gbc);
 
-    List<Object> entries = Arrays
-            .asList((Object[]) BackupFilesPresetEntry.backupfilesPresetEntries);
+    List<Object> entries = Arrays.asList(
+            (Object[]) BackupFilesPresetEntry.backupfilesPresetEntries);
     List<String> tooltips = Arrays.asList(
             BackupFilesPresetEntry.backupfilesPresetEntryDescriptions);
     backupfilesPresetsCombo = JvSwingUtils.buildComboWithTooltips(entries,
@@ -2199,7 +2348,8 @@ public class GPreferences extends JPanel
         {
           if (customiseCheckbox.isSelected())
           {
-            // got here by clicking on customiseCheckbox so don't change the values
+            // got here by clicking on customiseCheckbox so don't change the
+            // values
             backupfilesCustomOptionsSetEnabled();
           }
           else
@@ -2278,13 +2428,11 @@ public class GPreferences extends JPanel
 
   private JPanel initBackupsTabFilenameExamplesPanel()
   {
-    String title = MessageManager
-            .getString("label.scheme_examples");
+    String title = MessageManager.getString("label.scheme_examples");
     TitledBorder tb = new TitledBorder(title);
     exampleFilesPanel.setBorder(tb);
     exampleFilesPanel.setLayout(new GridBagLayout());
 
-
     backupfilesExampleLabel.setEditable(false);
     backupfilesExampleLabel
             .setBackground(exampleFilesPanel.getBackground());
@@ -2345,8 +2493,7 @@ public class GPreferences extends JPanel
   }
 
   protected void setComboIntStringKey(
-          JComboBox<Object> backupfilesPresetsCombo2,
-          int key)
+          JComboBox<Object> backupfilesPresetsCombo2, int key)
   {
     for (int i = 0; i < backupfilesPresetsCombo2.getItemCount(); i++)
     {
@@ -2616,9 +2763,8 @@ public class GPreferences extends JPanel
 
     JPanel jp = new JPanel();
     jp.setLayout(new FlowLayout());
-    oldBackupFilesLabel
-            .setText(MessageManager
-                    .getString("label.autodelete_old_backup_files"));
+    oldBackupFilesLabel.setText(
+            MessageManager.getString("label.autodelete_old_backup_files"));
     oldBackupFilesLabel.setFont(LABEL_FONT);
     oldBackupFilesLabel.setHorizontalAlignment(SwingConstants.LEFT);
     jp.add(oldBackupFilesLabel);
@@ -2778,7 +2924,8 @@ public class GPreferences extends JPanel
 
     }
 
-    // add some extra empty lines to pad out the example files box. ugh, please tell
+    // add some extra empty lines to pad out the example files box. ugh, please
+    // tell
     // me how to do this better
     int remainingLines = lowersurround + uppersurround + 1 - lineNumber;
     if (remainingLines > 0)
@@ -2857,8 +3004,7 @@ public class GPreferences extends JPanel
   private void backupfilesKeepAllSetEnabled(boolean tryEnabled)
   {
     boolean enabled = tryEnabled && enableBackupFiles.isSelected()
-            && customiseCheckbox.isSelected()
-            && suffixTemplate.getText()
+            && customiseCheckbox.isSelected() && suffixTemplate.getText()
                     .indexOf(BackupFiles.NUM_PLACEHOLDER) > -1;
     keepfilesPanel.setEnabled(enabled);
     backupfilesKeepAll.setEnabled(enabled);
@@ -3077,7 +3223,7 @@ public class GPreferences extends JPanel
     proxyAuthPasswordLabel.setEnabled(enabled);
     passwordNotStoredLabel.setEnabled(enabled);
     proxyAuthUsernameTB.setEnabled(enabled);
-    proxyAuthPasswordTB.setEnabled(enabled);
+    proxyAuthPasswordPB.setEnabled(enabled);
   }
 
   public void setCustomProxyEnabled()
@@ -3100,11 +3246,15 @@ public class GPreferences extends JPanel
   public void proxyType_actionPerformed()
   {
     setCustomProxyEnabled();
+    proxyAuthPasswordCheckHighlight(true);
+    applyProxyButtonEnabled(true);
   }
 
   public void proxyAuth_actionPerformed()
   {
     setProxyAuthEnabled();
+    proxyAuthPasswordCheckHighlight(true);
+    applyProxyButtonEnabled(true);
   }
 
   /**
@@ -3179,4 +3329,3 @@ public class GPreferences extends JPanel
 
   }
 }
-