src/main/java/de/todesbaum/jsite/gui/NodeManagerPage.java

   1 /*
   2  * jSite - NodeManagerPage.java - Copyright © 2006–2012 David Roden
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package de.todesbaum.jsite.gui;
  20
  21 import java.awt.BorderLayout;
  22 import java.awt.Dimension;
  23 import java.awt.FlowLayout;
  24 import java.awt.GridBagConstraints;
  25 import java.awt.GridBagLayout;
  26 import java.awt.Insets;
  27 import java.awt.event.ActionEvent;
  28 import java.awt.event.KeyEvent;
  29 import java.util.ArrayList;
  30 import java.util.List;
  31
  32 import javax.swing.AbstractAction;
  33 import javax.swing.Action;
  34 import javax.swing.DefaultListModel;
  35 import javax.swing.JButton;
  36 import javax.swing.JLabel;
  37 import javax.swing.JList;
  38 import javax.swing.JOptionPane;
  39 import javax.swing.JPanel;
  40 import javax.swing.JScrollPane;
  41 import javax.swing.JSpinner;
  42 import javax.swing.JTextField;
  43 import javax.swing.ListSelectionModel;
  44 import javax.swing.SpinnerNumberModel;
  45 import javax.swing.border.EmptyBorder;
  46 import javax.swing.event.ChangeEvent;
  47 import javax.swing.event.ChangeListener;
  48 import javax.swing.event.DocumentEvent;
  49 import javax.swing.event.DocumentListener;
  50 import javax.swing.event.ListSelectionEvent;
  51 import javax.swing.event.ListSelectionListener;
  52 import javax.swing.text.BadLocationException;
  53 import javax.swing.text.Document;
  54
  55 import de.todesbaum.jsite.application.Node;
  56 import de.todesbaum.jsite.i18n.I18n;
  57 import de.todesbaum.jsite.i18n.I18nContainer;
  58 import de.todesbaum.util.swing.TLabel;
  59 import de.todesbaum.util.swing.TWizard;
  60 import de.todesbaum.util.swing.TWizardPage;
  61
  62 /**
  63  * Wizard page that lets the user edit his nodes.
  64  *
  65  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  66  */
  67 public class NodeManagerPage extends TWizardPage implements ListSelectionListener, DocumentListener, ChangeListener {
  68
  69         /** List of node manager listeners. */
  70         private List<NodeManagerListener> nodeManagerListeners = new ArrayList<NodeManagerListener>();
  71
  72         /** The “add node” action. */
  73         protected Action addNodeAction;
  74
  75         /** The “delete node” action. */
  76         protected Action deleteNodeAction;
  77
  78         /** The node list model. */
  79         private DefaultListModel nodeListModel;
  80
  81         /** The node list. */
  82         private JList nodeList;
  83
  84         /** The node name textfield. */
  85         private JTextField nodeNameTextField;
  86
  87         /** The node hostname textfield. */
  88         private JTextField nodeHostnameTextField;
  89
  90         /** The spinner for the node port. */
  91         private JSpinner nodePortSpinner;
  92
  93         /**
  94          * Creates a new node manager wizard page.
  95          *
  96          * @param wizard
  97          *            The wizard this page belongs to
  98          */
  99         public NodeManagerPage(final TWizard wizard) {
 100                 super(wizard);
 101                 pageInit();
 102                 setHeading(I18n.getMessage("jsite.node-manager.heading"));
 103                 setDescription(I18n.getMessage("jsite.node-manager.description"));
 104                 I18nContainer.getInstance().registerRunnable(new Runnable() {
 105
 106                         @Override
 107                         public void run() {
 108                                 setHeading(I18n.getMessage("jsite.node-manager.heading"));
 109                                 setDescription(I18n.getMessage("jsite.node-manager.description"));
 110                         }
 111                 });
 112         }
 113
 114         /**
 115          * Adds a listener for node manager events.
 116          *
 117          * @param nodeManagerListener
 118          *            The listener to add
 119          */
 120         public void addNodeManagerListener(NodeManagerListener nodeManagerListener) {
 121                 nodeManagerListeners.add(nodeManagerListener);
 122         }
 123
 124         /**
 125          * Removes a listener for node manager events.
 126          *
 127          * @param nodeManagerListener
 128          *            The listener to remove
 129          */
 130         public void removeNodeManagerListener(NodeManagerListener nodeManagerListener) {
 131                 nodeManagerListeners.remove(nodeManagerListener);
 132         }
 133
 134         /**
 135          * Notifies all listeners that the node configuration has changed.
 136          *
 137          * @param nodes
 138          *            The new list of nodes
 139          */
 140         protected void fireNodesUpdated(Node[] nodes) {
 141                 for (NodeManagerListener nodeManagerListener : nodeManagerListeners) {
 142                         nodeManagerListener.nodesUpdated(nodes);
 143                 }
 144         }
 145
 146         /**
 147          * Notifies all listeners that a new node was selected.
 148          *
 149          * @param node
 150          *            The newly selected node
 151          */
 152         protected void fireNodeSelected(Node node) {
 153                 for (NodeManagerListener nodeManagerListener : nodeManagerListeners) {
 154                         nodeManagerListener.nodeSelected(node);
 155                 }
 156         }
 157
 158         /**
 159          * Creates all actions.
 160          */
 161         private void createActions() {
 162                 addNodeAction = new AbstractAction(I18n.getMessage("jsite.node-manager.add-node")) {
 163
 164                         @Override
 165                         @SuppressWarnings("synthetic-access")
 166                         public void actionPerformed(ActionEvent actionEvent) {
 167                                 addNode();
 168                         }
 169                 };
 170
 171                 deleteNodeAction = new AbstractAction(I18n.getMessage("jsite.node-manager.delete-node")) {
 172
 173                         @Override
 174                         @SuppressWarnings("synthetic-access")
 175                         public void actionPerformed(ActionEvent actionEvent) {
 176                                 deleteNode();
 177                         }
 178                 };
 179                 deleteNodeAction.setEnabled(false);
 180
 181                 I18nContainer.getInstance().registerRunnable(new Runnable() {
 182
 183                         @Override
 184                         public void run() {
 185                                 addNodeAction.putValue(Action.NAME, I18n.getMessage("jsite.node-manager.add-node"));
 186                                 deleteNodeAction.putValue(Action.NAME, I18n.getMessage("jsite.node-manager.delete-node"));
 187                         }
 188                 });
 189         }
 190
 191         /**
 192          * Initializes the page and all components in it.
 193          */
 194         private void pageInit() {
 195                 createActions();
 196                 nodeListModel = new DefaultListModel();
 197                 nodeList = new JList(nodeListModel);
 198                 nodeList.setName("node-list");
 199                 nodeList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
 200                 nodeList.addListSelectionListener(this);
 201                 nodeList.setPreferredSize(new Dimension(250, -1));
 202
 203                 nodeNameTextField = new JTextField("");
 204                 nodeNameTextField.getDocument().putProperty("Name", "node-name");
 205                 nodeNameTextField.getDocument().addDocumentListener(this);
 206                 nodeNameTextField.setEnabled(false);
 207
 208                 nodeHostnameTextField = new JTextField("localhost");
 209                 nodeHostnameTextField.getDocument().putProperty("Name", "node-hostname");
 210                 nodeHostnameTextField.getDocument().addDocumentListener(this);
 211                 nodeHostnameTextField.setEnabled(false);
 212
 213                 nodePortSpinner = new JSpinner(new SpinnerNumberModel(9481, 1, 65535, 1));
 214                 nodePortSpinner.setName("node-port");
 215                 nodePortSpinner.addChangeListener(this);
 216                 nodePortSpinner.setEnabled(false);
 217
 218                 JPanel buttonPanel = new JPanel(new FlowLayout(FlowLayout.LEADING, 12, 12));
 219                 buttonPanel.setBorder(new EmptyBorder(-12, -12, -12, -12));
 220                 buttonPanel.add(new JButton(addNodeAction));
 221                 buttonPanel.add(new JButton(deleteNodeAction));
 222
 223                 JPanel centerPanel = new JPanel(new BorderLayout());
 224                 JPanel nodeInformationPanel = new JPanel(new GridBagLayout());
 225                 centerPanel.add(nodeInformationPanel, BorderLayout.PAGE_START);
 226                 nodeInformationPanel.add(buttonPanel, new GridBagConstraints(0, 0, 2, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0));
 227                 final JLabel nodeInformationLabel = new JLabel("<html><b>" + I18n.getMessage("jsite.node-manager.node-information") + "</b></html>");
 228                 nodeInformationPanel.add(nodeInformationLabel, new GridBagConstraints(0, 1, 2, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 0, 0, 0), 0, 0));
 229                 final TLabel nodeNameLabel = new TLabel(I18n.getMessage("jsite.node-manager.name") + ":", KeyEvent.VK_N, nodeNameTextField);
 230                 nodeInformationPanel.add(nodeNameLabel, new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
 231                 nodeInformationPanel.add(nodeNameTextField, new GridBagConstraints(1, 2, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
 232                 final TLabel nodeHostnameLabel = new TLabel(I18n.getMessage("jsite.node-manager.hostname") + ":", KeyEvent.VK_H, nodeHostnameTextField);
 233                 nodeInformationPanel.add(nodeHostnameLabel, new GridBagConstraints(0, 3, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
 234                 nodeInformationPanel.add(nodeHostnameTextField, new GridBagConstraints(1, 3, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
 235                 final TLabel nodePortLabel = new TLabel(I18n.getMessage("jsite.node-manager.port") + ":", KeyEvent.VK_P, nodePortSpinner);
 236                 nodeInformationPanel.add(nodePortLabel, new GridBagConstraints(0, 4, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
 237                 nodeInformationPanel.add(nodePortSpinner, new GridBagConstraints(1, 4, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 6, 0, 0), 0, 0));
 238
 239                 setLayout(new BorderLayout(12, 12));
 240                 add(new JScrollPane(nodeList), BorderLayout.LINE_START);
 241                 add(centerPanel, BorderLayout.CENTER);
 242
 243                 I18nContainer.getInstance().registerRunnable(new Runnable() {
 244
 245                         @Override
 246                         public void run() {
 247                                 nodeInformationLabel.setText("<html><b>" + I18n.getMessage("jsite.node-manager.node-information") + "</b></html>");
 248                                 nodeNameLabel.setText(I18n.getMessage("jsite.node-manager.name") + ":");
 249                                 nodeHostnameLabel.setText(I18n.getMessage("jsite.node-manager.hostname") + ":");
 250                                 nodePortLabel.setText(I18n.getMessage("jsite.node-manager.port") + ":");
 251                         }
 252                 });
 253         }
 254
 255         /**
 256          * {@inheritDoc}
 257          */
 258         @Override
 259         public void pageAdded(TWizard wizard) {
 260                 this.wizard.setNextEnabled(nodeListModel.getSize() > 0);
 261                 this.wizard.setPreviousName(I18n.getMessage("jsite.wizard.previous"));
 262                 this.wizard.setNextName(I18n.getMessage("jsite.wizard.next"));
 263                 this.wizard.setQuitName(I18n.getMessage("jsite.wizard.quit"));
 264         }
 265
 266         /**
 267          * Sets the node list.
 268          *
 269          * @param nodes
 270          *            The list of nodes
 271          */
 272         public void setNodes(Node[] nodes) {
 273                 nodeListModel.clear();
 274                 for (Node node : nodes) {
 275                         nodeListModel.addElement(node);
 276                 }
 277                 nodeList.repaint();
 278                 fireNodesUpdated(nodes);
 279         }
 280
 281         /**
 282          * Returns the node list.
 283          *
 284          * @return The list of nodes
 285          */
 286         public Node[] getNodes() {
 287                 Node[] returnNodes = new Node[nodeListModel.getSize()];
 288                 for (int nodeIndex = 0, nodeCount = nodeListModel.getSize(); nodeIndex < nodeCount; nodeIndex++) {
 289                         returnNodes[nodeIndex] = (Node) nodeListModel.get(nodeIndex);
 290                 }
 291                 return returnNodes;
 292         }
 293
 294         /**
 295          * Returns the currently selected node.
 296          *
 297          * @return The selected node, or <code>null</code> if no node is selected
 298          */
 299         private Node getSelectedNode() {
 300                 return (Node) nodeList.getSelectedValue();
 301         }
 302
 303         /**
 304          * Updates node name or hostname when the user types into the textfields.
 305          *
 306          * @see #insertUpdate(DocumentEvent)
 307          * @see #removeUpdate(DocumentEvent)
 308          * @see #changedUpdate(DocumentEvent)
 309          * @see DocumentListener
 310          * @param documentEvent
 311          *            The document event
 312          */
 313         private void updateTextField(DocumentEvent documentEvent) {
 314                 Node node = getSelectedNode();
 315                 if (node == null) {
 316                         return;
 317                 }
 318                 Document document = documentEvent.getDocument();
 319                 String documentText = null;
 320                 try {
 321                         documentText = document.getText(0, document.getLength());
 322                 } catch (BadLocationException ble1) {
 323                         /* ignore. */
 324                 }
 325                 if (documentText == null) {
 326                         return;
 327                 }
 328                 String documentName = (String) document.getProperty("Name");
 329                 if ("node-name".equals(documentName)) {
 330                         node.setName(documentText);
 331                         nodeList.repaint();
 332                         fireNodesUpdated(getNodes());
 333                 } else if ("node-hostname".equals(documentName)) {
 334                         node.setHostname(documentText);
 335                         nodeList.repaint();
 336                         fireNodesUpdated(getNodes());
 337                 }
 338         }
 339
 340         //
 341         // ACTIONS
 342         //
 343
 344         /**
 345          * Adds a new node to the list of nodes.
 346          */
 347         private void addNode() {
 348                 Node node = new Node("localhost", 9481, I18n.getMessage("jsite.node-manager.new-node"));
 349                 nodeListModel.addElement(node);
 350         nodeList.setSelectedIndex(nodeListModel.size() - 1);
 351                 deleteNodeAction.setEnabled(nodeListModel.size() > 1);
 352                 wizard.setNextEnabled(true);
 353                 fireNodesUpdated(getNodes());
 354         }
 355
 356         /**
 357          * Deletes the currently selected node from the list of nodes.
 358          */
 359         private void deleteNode() {
 360                 Node node = getSelectedNode();
 361                 if (node == null) {
 362                         return;
 363                 }
 364                 if (JOptionPane.showConfirmDialog(wizard, I18n.getMessage("jsite.node-manager.delete-node.warning"), null, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) == JOptionPane.CANCEL_OPTION) {
 365                         return;
 366                 }
 367                 int nodeIndex = nodeListModel.indexOf(node);
 368                 nodeListModel.removeElement(node);
 369                 nodeList.repaint();
 370                 fireNodeSelected((Node) nodeListModel.get(Math.min(nodeIndex, nodeListModel.size() - 1)));
 371                 fireNodesUpdated(getNodes());
 372                 deleteNodeAction.setEnabled(nodeListModel.size() > 1);
 373                 wizard.setNextEnabled(nodeListModel.size() > 0);
 374         }
 375
 376         //
 377         // INTERFACE ListSelectionListener
 378         //
 379
 380         /**
 381          * {@inheritDoc}
 382          */
 383         @Override
 384         @SuppressWarnings("null")
 385         public void valueChanged(ListSelectionEvent e) {
 386                 Object source = e.getSource();
 387                 if (source instanceof JList) {
 388                         JList sourceList = (JList) source;
 389                         if ("node-list".equals(sourceList.getName())) {
 390                                 Node node = (Node) sourceList.getSelectedValue();
 391                                 boolean enabled = (node != null);
 392                                 nodeNameTextField.setEnabled(enabled);
 393                                 nodeHostnameTextField.setEnabled(enabled);
 394                                 nodePortSpinner.setEnabled(enabled);
 395                                 deleteNodeAction.setEnabled(enabled && (nodeListModel.size() > 1));
 396                                 if (enabled) {
 397                                         nodeNameTextField.setText(node.getName());
 398                                         nodeHostnameTextField.setText(node.getHostname());
 399                                         nodePortSpinner.setValue(node.getPort());
 400                                 } else {
 401                                         nodeNameTextField.setText("");
 402                                         nodeHostnameTextField.setText("localhost");
 403                                         nodePortSpinner.setValue(9481);
 404                                 }
 405                         }
 406                 }
 407         }
 408
 409         //
 410         // INTERFACE DocumentListener
 411         //
 412
 413         /**
 414          * {@inheritDoc}
 415          */
 416         @Override
 417         public void insertUpdate(DocumentEvent e) {
 418                 updateTextField(e);
 419         }
 420
 421         /**
 422          * {@inheritDoc}
 423          */
 424         @Override
 425         public void removeUpdate(DocumentEvent e) {
 426                 updateTextField(e);
 427         }
 428
 429         /**
 430          * {@inheritDoc}
 431          */
 432         @Override
 433         public void changedUpdate(DocumentEvent e) {
 434                 updateTextField(e);
 435         }
 436
 437         //
 438         // INTERFACE ChangeListener
 439         //
 440
 441         /**
 442          * {@inheritDoc}
 443          */
 444         @Override
 445         public void stateChanged(ChangeEvent e) {
 446                 Object source = e.getSource();
 447                 Node selectedNode = getSelectedNode();
 448                 if (selectedNode == null) {
 449                         return;
 450                 }
 451                 if (source instanceof JSpinner) {
 452                         JSpinner sourceSpinner = (JSpinner) source;
 453                         if ("node-port".equals(sourceSpinner.getName())) {
 454                                 selectedNode.setPort((Integer) sourceSpinner.getValue());
 455                                 fireNodeSelected(selectedNode);
 456                                 nodeList.repaint();
 457                         }
 458                 }
 459         }
 460
 461 }