Add read only new alias manager dialog.

Change-Id: I4d367f83d06c6de965c7b383ea7b3d22a66e6def
Reviewed-on: http://gerrit.dmdirc.com/3531
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/ui_swing/components/GenericTableModel.java

@@ -106,6 +106,18 @@ public class GenericTableModel<T> extends AbstractTableModel {
         }
     }
 
+    /**
+     * Returns the value at the specified row.
+     *
+     * @param rowIndex Index to retrieve
+     *
+     * @return Value at the specified row
+     */
+    public T getValue(final int rowIndex) {
+        Preconditions.checkElementIndex(rowIndex, values.size());
+        return values.get(rowIndex);
+    }
+
     /**
      * Sets the name of the header for a specific column.
      *

src/com/dmdirc/addons/ui_swing/components/menubar/SettingsMenu.java

@@ -53,18 +53,22 @@ public class SettingsMenu extends JMenu implements ActionListener {
     private final DialogProvider<SwingPreferencesDialog> prefsDialogProvider;
     /** Provider of alias manager dialogs. */
     private final DialogProvider<AliasManagerDialog> aliasDialogProvider;
+    /** Provider of alias manager dialogs. */
+    private final DialogProvider<com.dmdirc.addons.ui_swing.dialogs.newaliases.AliasManagerDialog> newAliasDialogProvider;
 
     @Inject
     public SettingsMenu(
             final DialogProvider<ProfileManagerDialog> profileDialogProvider,
             final DialogProvider<ActionsManagerDialog> actionsDialogProvider,
             final DialogProvider<SwingPreferencesDialog> prefsDialogProvider,
-            final DialogProvider<AliasManagerDialog> aliasDialogProvider) {
+            final DialogProvider<AliasManagerDialog> aliasDialogProvider,
+            final DialogProvider<com.dmdirc.addons.ui_swing.dialogs.newaliases.AliasManagerDialog> newAliasDialogProvider) {
         super("Settings");
         this.profileDialogProvider = profileDialogProvider;
         this.actionsDialogProvider = actionsDialogProvider;
         this.prefsDialogProvider = prefsDialogProvider;
         this.aliasDialogProvider = aliasDialogProvider;
+        this.newAliasDialogProvider = newAliasDialogProvider;
 
         setMnemonic('e');
         initSettingsMenu();
@@ -105,6 +109,13 @@ public class SettingsMenu extends JMenu implements ActionListener {
         menuItem.setActionCommand("Aliases");
         menuItem.addActionListener(this);
         add(menuItem);
+
+        menuItem = new JMenuItem();
+        menuItem.setMnemonic('l');
+        menuItem.setText("New Alias Manager");
+        menuItem.setActionCommand("NewAliases");
+        menuItem.addActionListener(this);
+        add(menuItem);
     }
 
     @Override
@@ -122,6 +133,9 @@ public class SettingsMenu extends JMenu implements ActionListener {
             case "Aliases":
                 aliasDialogProvider.displayOrRequestFocus();
                 break;
+            case "NewAliases":
+                newAliasDialogProvider.displayOrRequestFocus();
+                break;
         }
     }
 

src/com/dmdirc/addons/ui_swing/dialogs/newaliases/AliasManagerController.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.ui_swing.dialogs.newaliases;
+
+/**
+ * Alias manager dialog controller reacts to actions in the UI.
+ */
+public class AliasManagerController {
+
+    private final AliasManagerModel model;
+    private final AliasManagerDialog dialog;
+
+    public AliasManagerController(final AliasManagerDialog dialog,
+            final AliasManagerModel model) {
+        this.model = model;
+        this.dialog = dialog;
+    }
+
+    public void addAlias(final String name, final int minArguments, final String substitutions) {
+        model.addAlias(name, minArguments, substitutions);
+    }
+
+    public void removeAlias(final String name) {
+        model.removeAlias(name);
+    }
+
+    public void editAlias(final String name, final int minArguments, final String substitutions) {
+        model.editAlias(name, minArguments, substitutions);
+    }
+
+    public void saveAndCloseDialog() {
+        model.save();
+        dialog.dispose();
+    }
+
+    public void discardAndCloseDialog() {
+        dialog.dispose();
+    }
+
+}

src/com/dmdirc/addons/ui_swing/dialogs/newaliases/AliasManagerDialog.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.ui_swing.dialogs.newaliases;
+
+import com.dmdirc.addons.ui_swing.dialogs.StandardDialog;
+import com.dmdirc.addons.ui_swing.injection.MainWindow;
+import com.dmdirc.interfaces.ui.AliasDialogModel;
+
+import java.awt.Dimension;
+import java.awt.Window;
+
+import javax.inject.Inject;
+import javax.swing.JButton;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.JSpinner;
+import javax.swing.JSplitPane;
+import javax.swing.JTable;
+import javax.swing.JTextArea;
+import javax.swing.JTextField;
+
+import net.miginfocom.layout.PlatformDefaults;
+import net.miginfocom.swing.MigLayout;
+
+/**
+ * Dialog to list and change command aliases.
+ */
+public class AliasManagerDialog extends StandardDialog {
+
+    private static final long serialVersionUID = 1;
+    private final AliasManagerModel model;
+    private final AliasManagerController controller;
+    private final AliasManagerLinker linker;
+
+    @Inject
+    public AliasManagerDialog(@MainWindow final Window mainFrame,
+            final AliasDialogModel dialogModel) {
+        super(mainFrame, ModalityType.DOCUMENT_MODAL);
+        this.model = new AliasManagerModel(dialogModel);
+        controller = new AliasManagerController(this, model);
+        linker = new AliasManagerLinker(controller, model, this);
+        final JTable aliasList = new JTable();
+        final JTextField command = new JTextField();
+        final JSpinner argumentsNumber = new JSpinner();
+        final JTextArea response = new JTextArea();
+        final JButton addAlias = new JButton("Add Alias");
+        final JButton deleteAlias = new JButton("Delete Alias");
+        getOkButton();
+        getCancelButton();
+        setLayout(new MigLayout("fill, pack"));
+        setMinimumSize(new Dimension(800, 400));
+        final JScrollPane scrollPane = new JScrollPane(aliasList);
+        aliasList.setPreferredScrollableViewportSize(new Dimension(800, 150));
+        scrollPane.setMinimumSize(new Dimension(750, 150));
+        final JSplitPane splitPane = new JSplitPane(JSplitPane.VERTICAL_SPLIT, true, scrollPane,
+                getAliasDetails(command, argumentsNumber, response));
+        splitPane.setDividerSize((int) PlatformDefaults.getPanelInsets(0).getValue());
+
+        add(splitPane, "spanx 5, grow, push, wrap");
+        add(addAlias, "split 2, sgx button");
+        add(deleteAlias, "sgx button");
+        add(getLeftButton(), "sgx button");
+        add(getRightButton(), "sgx button");
+
+        linker.bindCommandList(aliasList);
+        linker.bindCommand(command);
+        linker.bindArgumentsNumber(argumentsNumber);
+        linker.bindResponse(response);
+        linker.bindAddAlias(addAlias);
+        linker.bindDeleteAlias(deleteAlias);
+        linker.bindOKButton(getOkButton());
+        linker.bindCancelButton(getCancelButton());
+        model.load();
+    }
+
+    /**
+     * Creates a panel showing all alias details.
+     *
+     * @param command         Command name
+     * @param argumentsNumber Number of arguments
+     * @param response        Alias substitution
+     *
+     * @return Panel to display
+     */
+    private JPanel getAliasDetails(final JTextField command,
+            final JSpinner argumentsNumber, final JTextArea response) {
+        final JPanel aliasDetails = new JPanel();
+        aliasDetails.setLayout(new MigLayout("fill, ins 0"));
+        aliasDetails.add(new JLabel("Command: "));
+        aliasDetails.add(command, "sgy args, growx, pushx");
+        aliasDetails.add(new JLabel("#Arguments: "));
+        aliasDetails.add(argumentsNumber, "sgy args, growx, pushx, wrap");
+        aliasDetails.add(new JLabel("Response: "));
+        aliasDetails.add(new JScrollPane(response), "span 3, grow, push, wrap");
+        return aliasDetails;
+    }
+
+}

src/com/dmdirc/addons/ui_swing/dialogs/newaliases/AliasManagerLinker.java

@@ -0,0 +1,163 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.ui_swing.dialogs.newaliases;
+
+import com.dmdirc.addons.ui_swing.components.GenericTableModel;
+import com.dmdirc.commandparser.aliases.Alias;
+
+import com.google.common.base.Optional;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.beans.PropertyChangeEvent;
+import java.beans.PropertyChangeListener;
+
+import javax.swing.JButton;
+import javax.swing.JSpinner;
+import javax.swing.JTable;
+import javax.swing.JTextArea;
+import javax.swing.JTextField;
+import javax.swing.ListSelectionModel;
+import javax.swing.event.ListSelectionEvent;
+import javax.swing.event.ListSelectionListener;
+
+/**
+ * Links the Alias Manager Dialog with its controller and model.
+ */
+public class AliasManagerLinker {
+
+    private final AliasManagerController controller;
+    private final AliasManagerModel model;
+    private final AliasManagerDialog dialog;
+
+    public AliasManagerLinker(final AliasManagerController controller,
+            final AliasManagerModel model,
+            final AliasManagerDialog dialog) {
+        this.controller = controller;
+        this.model = model;
+        this.dialog = dialog;
+    }
+
+    public void bindCommandList(final JTable commandList) {
+        final GenericTableModel<Alias> commandModel = new GenericTableModel<>(
+                Alias.class, "getName", "getMinArguments", "getSubstitution");
+        commandModel.setHeaderNames("Name", "Minimum Arguments", "Substitution");
+        commandList.setModel(commandModel);
+        commandList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
+        commandList.getSelectionModel().addListSelectionListener(new ListSelectionListener() {
+            @Override
+            public void valueChanged(final ListSelectionEvent e) {
+                final int index = commandList.getSelectedRow();
+                if (index == -1) {
+                    model.setSelectedAlias(Optional.<Alias>absent());
+                } else {
+                    model.setSelectedAlias(Optional.fromNullable(commandModel.getValue(index)));
+                }
+            }
+        });
+        model.addPropertyChangeListener("aliases", new PropertyChangeListener() {
+
+            @Override
+            public void propertyChange(final PropertyChangeEvent evt) {
+                for (Alias alias : model.getAliases()) {
+                    commandModel.addValue(alias);
+                }
+            }
+        });
+    }
+
+    public void bindCommand(final JTextField command) {
+        command.setEnabled(false);
+        model.addPropertyChangeListener("selectedAlias", new PropertyChangeListener() {
+
+            @Override
+            public void propertyChange(PropertyChangeEvent evt) {
+                final Optional<Alias> selectedAlias = model.getSelectedAlias();
+                command.setEnabled(selectedAlias.isPresent());
+                if (selectedAlias.isPresent()) {
+                    command.setText(selectedAlias.get().getName());
+                } else {
+                    command.setText("");
+                }
+            }
+        });
+    }
+
+    public void bindArgumentsNumber(final JSpinner argumentsNumber) {
+        argumentsNumber.setEnabled(false);
+        model.addPropertyChangeListener("selectedAlias", new PropertyChangeListener() {
+
+            @Override
+            public void propertyChange(PropertyChangeEvent evt) {
+                final Optional<Alias> selectedAlias = model.getSelectedAlias();
+                argumentsNumber.setEnabled(selectedAlias.isPresent());
+                if (selectedAlias.isPresent()) {
+                    argumentsNumber.setValue(model.getSelectedAlias().get().getMinArguments());
+                } else {
+                    argumentsNumber.setValue(0);
+                }
+            }
+        });
+    }
+
+    public void bindResponse(final JTextArea response) {
+        response.setEnabled(false);
+        model.addPropertyChangeListener("selectedAlias", new PropertyChangeListener() {
+
+            @Override
+            public void propertyChange(PropertyChangeEvent evt) {
+                final Optional<Alias> selectedAlias = model.getSelectedAlias();
+                response.setEnabled(selectedAlias.isPresent());
+                if (selectedAlias.isPresent()) {
+                    response.setText(model.getSelectedAlias().get().getSubstitution());
+                } else {
+                    response.setText("");
+                }
+            }
+        });
+    }
+
+    public void bindAddAlias(final JButton addAlias) {
+        addAlias.setEnabled(false);
+    }
+
+    public void bindDeleteAlias(final JButton deleteAlias) {
+        deleteAlias.setEnabled(false);
+    }
+
+    public void bindOKButton(final JButton okButton) {
+        okButton.setEnabled(false);
+    }
+
+    public void bindCancelButton(final JButton cancelButton) {
+        cancelButton.setEnabled(true);
+        cancelButton.addActionListener(new ActionListener() {
+
+            @Override
+            public void actionPerformed(final ActionEvent e) {
+                controller.discardAndCloseDialog();
+            }
+        });
+    }
+
+}

src/com/dmdirc/addons/ui_swing/dialogs/newaliases/AliasManagerModel.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.ui_swing.dialogs.newaliases;
+
+import com.dmdirc.commandparser.aliases.Alias;
+import com.dmdirc.interfaces.ui.AliasDialogModel;
+
+import com.google.common.base.Optional;
+
+import java.beans.PropertyChangeListener;
+import java.beans.PropertyChangeListenerProxy;
+import java.beans.PropertyChangeSupport;
+import java.util.Collection;
+
+/**
+ * Alias manager dialog model stores state of the UI, mostly proxying to the core model.
+ */
+public class AliasManagerModel {
+
+    /** Profile change support. */
+    private final PropertyChangeSupport pcs;
+    /** Core alias dialog mode. */
+    private final AliasDialogModel model;
+
+    public AliasManagerModel(final AliasDialogModel model) {
+        this.model = model;
+        pcs = new PropertyChangeSupport(this);
+    }
+
+    public void load() {
+        final PropertyChangeListener[] listeners = pcs.getPropertyChangeListeners();
+        for (PropertyChangeListener listener : listeners) {
+            if (listener instanceof PropertyChangeListenerProxy) {
+                final PropertyChangeListenerProxy proxy = (PropertyChangeListenerProxy) listener;
+                pcs.firePropertyChange(proxy.getPropertyName(), null, null);
+            }
+        }
+    }
+
+    public Collection<Alias> getAliases() {
+        return model.getAliases();
+    }
+
+    public Optional<Alias> getAlias(final String name) {
+        return model.getAlias(name);
+    }
+
+    public void addAlias(final String name, final int minArguments, final String substitution) {
+        model.addAlias(name, minArguments, substitution);
+        pcs.firePropertyChange("addAlias", "", name);
+    }
+
+    public void editAlias(final String name, final int minArguments, final String substitution) {
+        model.editAlias(null, minArguments, null);
+        pcs.firePropertyChange("editAlias", name, name);
+    }
+
+    public void renameAlias(final String oldName, final String newName) {
+        model.renameAlias(oldName, newName);
+        pcs.firePropertyChange("renameAlias", oldName, newName);
+    }
+
+    public void removeAlias(final String name) {
+        model.removeAlias(name);
+        pcs.firePropertyChange("deleteAlias", name, "");
+    }
+
+    public void setSelectedAlias(final Optional<Alias> alias) {
+        final Optional<Alias> oldAlias = model.getSelectedAlias();
+        model.setSelectedAlias(alias);
+        pcs.firePropertyChange("selectedAlias", oldAlias, alias);
+    }
+
+    public Optional<Alias> getSelectedAlias() {
+        return model.getSelectedAlias();
+    }
+
+    public void save() {
+        model.save();
+    }
+
+    public void addPropertyChangeListener(final PropertyChangeListener listener) {
+        pcs.addPropertyChangeListener(listener);
+    }
+
+    public void addPropertyChangeListener(final String name, final PropertyChangeListener listener) {
+        pcs.addPropertyChangeListener(name, listener);
+    }
+
+    public void removePropertyChangeListener(final PropertyChangeListener listener) {
+        pcs.removePropertyChangeListener(listener);
+    }
+
+}

src/com/dmdirc/addons/ui_swing/injection/DialogModule.java

@@ -41,12 +41,15 @@ import com.dmdirc.addons.ui_swing.dialogs.profiles.ProfileManagerDialog;
 import com.dmdirc.addons.ui_swing.dialogs.serversetting.ServerSettingsDialog;
 import com.dmdirc.addons.ui_swing.dialogs.updater.SwingRestartDialog;
 import com.dmdirc.addons.ui_swing.dialogs.updater.SwingUpdaterDialog;
+import com.dmdirc.commandparser.aliases.AliasManager;
+import com.dmdirc.commandparser.aliases.CoreAliasDialogModel;
 import com.dmdirc.config.prefs.PreferencesManager;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.LifecycleController;
 import com.dmdirc.interfaces.config.ConfigProvider;
 import com.dmdirc.interfaces.config.IdentityFactory;
+import com.dmdirc.interfaces.ui.AliasDialogModel;
 import com.dmdirc.plugins.ServiceManager;
 
 import java.awt.Window;
@@ -79,6 +82,11 @@ public class DialogModule {
     public static @interface ForSettings {
     }
 
+    @Provides
+    public AliasDialogModel getAliasDialogModel(final AliasManager aliasManager) {
+        return new CoreAliasDialogModel(aliasManager);
+    }
+
     @Provides
     @Singleton
     public DialogProvider<NewServerDialog> getNewServerDialogProvider(
@@ -107,6 +115,13 @@ public class DialogModule {
         return new DialogProvider<>(provider);
     }
 
+    @Provides
+    @Singleton
+    public DialogProvider<com.dmdirc.addons.ui_swing.dialogs.newaliases.AliasManagerDialog> getNewAliasManagerDialogProvider(
+            final Provider<com.dmdirc.addons.ui_swing.dialogs.newaliases.AliasManagerDialog> provider) {
+        return new DialogProvider<>(provider);
+    }
+
     @Provides
     @Singleton
     public DialogProvider<ErrorListDialog> getErrorListDialogProvider(