Unify dialog behavior and reduce code duplication

Makes PasswordChangeDialog and OkCancelApplyDialog an
OkCancelDialog and moves keyboard handling to OkCancelDialog,
plus some minor cleanup.

Author: Tom Gottfried

src/de/bielefeld/umweltamt/aui/HauptFrame.java

@@ -670,7 +670,7 @@ private JMenuItem getPasswordChangeItem() {
             passwordChangeMenuItem.setText("Password ändern");
             passwordChangeMenuItem.setMnemonic(KeyEvent.VK_P);
             passwordChangeMenuItem.setEnabled(true);
-            final JFrame owner = this;
+            final HauptFrame owner = this;
             passwordChangeMenuItem.addActionListener(new java.awt.event.ActionListener() {
                 @Override
                 public void actionPerformed(java.awt.event.ActionEvent e) {

src/de/bielefeld/umweltamt/aui/gui/PasswordChangeDialog.java

@@ -22,24 +22,13 @@
 
 import java.awt.Dimension;
 import java.awt.HeadlessException;
-import java.awt.KeyboardFocusManager;
-import java.awt.KeyEventDispatcher;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
-import java.awt.event.KeyEvent;
 import java.util.Arrays;
-import java.util.List;
 
-import javax.swing.AbstractAction;
-import javax.swing.Action;
-import javax.swing.JButton;
-import javax.swing.JDialog;
-import javax.swing.JFrame;
+import javax.swing.JComponent;
 import javax.swing.JLabel;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JPasswordField;
-import javax.swing.KeyStroke;
 
 import com.jgoodies.forms.builder.PanelBuilder;
 import com.jgoodies.forms.factories.Paddings;
@@ -51,15 +40,16 @@
 import org.hibernate.Transaction;
 import org.hibernate.query.NativeQuery;
 import org.jfree.ui.tabbedui.VerticalLayout;
-import org.postgresql.util.PSQLException;
 
+import de.bielefeld.umweltamt.aui.HauptFrame;
 import de.bielefeld.umweltamt.aui.HibernateSessionFactory;
 import de.bielefeld.umweltamt.aui.utils.AuikLogger;
+import de.bielefeld.umweltamt.aui.utils.dialogbase.OkCancelDialog;
 
 /**
  * Dialog, allowing the user to change the current password
  */
-public class PasswordChangeDialog extends JDialog {
+public class PasswordChangeDialog extends OkCancelDialog {
 
     /** Logging */
     private static final AuikLogger log = AuikLogger.getLogger();
@@ -72,76 +62,27 @@ public class PasswordChangeDialog extends JDialog {
     private JPasswordField newPasswordField;
     private JPasswordField newPasswordConfirmField;
 
-    private JButton okButton;
-    private JButton cancelButton;
-
-    private KeyEventDispatcher keyEventDispatcher;
-
     /**
      * Constructor
      * @param owner Owning frame this dialog will be placed above.
      * @throws HeadlessException
      */
-    public PasswordChangeDialog(JFrame owner){
-        super(owner, "Passwort ändern", true);
-        this.setSize(450, 150);
-        initialize();
+    public PasswordChangeDialog(HauptFrame owner){
+        super("Passwort ändern", owner);
+        this.setSize(450, 200);
     }
 
-    /**
-     * Initialize UI
-     */
-    private void initialize() {
+    @Override
+    protected JComponent buildContentArea() {
         currentPasswordLabel = new JLabel("Aktuelles Passwort:");
         newPasswordLabel = new JLabel("Neues Passwort:");
         newPasswordConfirmLabel = new JLabel("Passwort bestätigen:");
         currentPasswordField = new JPasswordField();
         newPasswordField = new JPasswordField();
         newPasswordConfirmField = new JPasswordField();
-        okButton = new JButton("OK");
-        cancelButton = new JButton("Abbrechen");
 
         currentPasswordField.setPreferredSize(new Dimension(150, 22));
 
-        //Button handlers
-        okButton.addActionListener(new ActionListener() {
-            @Override
-            public void actionPerformed(ActionEvent e) {
-                submit();
-            }
-        });
-        cancelButton.addActionListener(new ActionListener() {
-            @Override
-            public void actionPerformed(ActionEvent e) {
-                close();
-            }
-        });
-
-        //Key handler
-        keyEventDispatcher = new KeyEventDispatcher() {
-            @Override
-            public boolean dispatchKeyEvent(KeyEvent e) {
-                if (e.getID() != KeyEvent.KEY_PRESSED) {
-                    return false;
-                }
-                switch (e.getKeyCode()) {
-                    //Use ESC to cancel
-                    case KeyEvent.VK_ESCAPE:
-                        close();
-                        break;
-                    //Use enter to submit if focus is on new password confirmation field
-                    case KeyEvent.VK_ENTER:
-                        if (newPasswordConfirmField.isFocusOwner()) {
-                            submit();
-                        }
-                        break;
-                }
-                return false;
-            }
-        };
-        KeyboardFocusManager.getCurrentKeyboardFocusManager()
-                .addKeyEventDispatcher(keyEventDispatcher);
-
         //Create form
         FormLayout layout = new FormLayout(
             "right:pref, 4dlu, pref:grow, 4dlu, pref", // Spalten
@@ -164,19 +105,14 @@ public boolean dispatchKeyEvent(KeyEvent e) {
         formPanel.setBorder(Paddings.DIALOG);
         contentPanel.add(formPanel);
 
-        JPanel buttonPanel = new JPanel();
-        buttonPanel.add(okButton);
-        buttonPanel.add(cancelButton);
-        contentPanel.add(buttonPanel);
-
-        this.setContentPane(contentPanel);
-        this.pack();
+        return contentPanel;
     }
 
     /**
      * Check input and submit password change
      */
-    private void submit() {
+    @Override
+    protected void doOk() {
         if (!checkInput()) {
             return;
         }
@@ -187,24 +123,17 @@ private void submit() {
         }
     }
 
-    /**
-     * Cancel action and dispose this dialog
-     */
-    private void close() {
-        PasswordChangeDialog.this.dispose();
-    }
-
     private boolean checkInput() {
         if (checkPasswordEmpty()) {
-             JOptionPane.showMessageDialog(PasswordChangeDialog.this, "Bitte geben Sie ein neues Passwort ein");
-             return false;
+            JOptionPane.showMessageDialog(this, "Bitte geben Sie ein neues Passwort ein");
+            return false;
         }
         if (!checkPasswordConfirmation()) {
-            JOptionPane.showMessageDialog(PasswordChangeDialog.this, "Die Passwörter stimmen nicht überein");
+            JOptionPane.showMessageDialog(this, "Die Passwörter stimmen nicht überein");
             return false;
         }
         if (!checkCurrentPassword()) {
-            JOptionPane.showMessageDialog(PasswordChangeDialog.this, "Das eingegebene Passwort ist nicht korrekt");
+            JOptionPane.showMessageDialog(this, "Das eingegebene Passwort ist nicht korrekt");
             return false;
         }
         return true;

src/de/bielefeld/umweltamt/aui/utils/dialogbase/OkCancelApplyDialog.java

@@ -57,7 +57,7 @@
  * "Ok"- und einem "Abbrechen"-Button.
  * @author David Klotz
  */
-public abstract class OkCancelApplyDialog extends SimpleDialog {
+public abstract class OkCancelApplyDialog extends OkCancelDialog {
     private static final long serialVersionUID = 8544344498787710223L;
 
     public OkCancelApplyDialog(HauptFrame frame) {
@@ -68,30 +68,6 @@ public OkCancelApplyDialog(String title, HauptFrame frame) {
         super(title, frame);
     }
 
-    @Override
-    public Action getFirstButtonAction() {
-        return new AbstractAction(getOkButtonText()) {
-            private static final long serialVersionUID = 5631309928023384305L;
-
-            @Override
-            public void actionPerformed(ActionEvent e) {
-                doOk();
-            }
-        };
-    }
-
-    @Override
-    public Action getSecondButtonAction() {
-        return new AbstractAction("Abbrechen") {
-            private static final long serialVersionUID = -4608327257436896003L;
-
-            @Override
-            public void actionPerformed(ActionEvent e) {
-                doCancel();
-            }
-        };
-    }
-
     @Override
     public Action getThirdButtonAction() {
         return new AbstractAction("Parameter auswählen") {
@@ -104,15 +80,5 @@ public void actionPerformed(ActionEvent e) {
         };
     }
 
-    protected String getOkButtonText() {
-        return "OK";
-    }
-
-    protected abstract void doOk();
-
-    protected void doCancel() {
-        close();
-    }
-
     protected abstract void doApply();
 }

src/de/bielefeld/umweltamt/aui/utils/dialogbase/OkCancelDialog.java

@@ -42,7 +42,10 @@
  */
 package de.bielefeld.umweltamt.aui.utils.dialogbase;
 
+import java.awt.KeyEventDispatcher;
+import java.awt.KeyboardFocusManager;
 import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
 
 import javax.swing.AbstractAction;
 import javax.swing.Action;
@@ -57,12 +60,32 @@
 public abstract class OkCancelDialog extends SimpleDialog {
     private static final long serialVersionUID = -1999038310745668506L;
 
+    private KeyEventDispatcher keyEventDispatcher;
+
     public OkCancelDialog(HauptFrame frame) {
         this(null, frame);
     }
 
     public OkCancelDialog(String title, HauptFrame frame) {
         super(title, frame);
+
+        // Use enter to submit
+        this.getRootPane().setDefaultButton(button1);
+
+        // Use ESC to cancel
+        keyEventDispatcher = new KeyEventDispatcher() {
+            @Override
+            public boolean dispatchKeyEvent(KeyEvent e) {
+                if (e.getID() == KeyEvent.KEY_PRESSED
+                    && e.getKeyCode() == KeyEvent.VK_ESCAPE
+                ) {
+                    close();
+                }
+                return false;
+            }
+        };
+        KeyboardFocusManager.getCurrentKeyboardFocusManager()
+            .addKeyEventDispatcher(keyEventDispatcher);
     }
 
     @Override