src/net/pterodactylus/jsite/gui/MainWindow.java

   1 /*
   2  * jSite2 - MainWindow.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.jsite.gui;
  21
  22 import java.awt.BorderLayout;
  23 import java.awt.Component;
  24 import java.awt.Container;
  25 import java.awt.Dimension;
  26 import java.awt.event.WindowAdapter;
  27 import java.awt.event.WindowEvent;
  28 import java.awt.event.WindowListener;
  29 import java.beans.PropertyChangeEvent;
  30 import java.beans.PropertyChangeListener;
  31 import java.util.HashMap;
  32 import java.util.Map;
  33 import java.util.Timer;
  34 import java.util.TimerTask;
  35 import java.util.logging.Logger;
  36
  37 import javax.swing.Box;
  38 import javax.swing.BoxLayout;
  39 import javax.swing.Icon;
  40 import javax.swing.JButton;
  41 import javax.swing.JFrame;
  42 import javax.swing.JMenu;
  43 import javax.swing.JMenuBar;
  44 import javax.swing.JOptionPane;
  45 import javax.swing.JPanel;
  46 import javax.swing.JTabbedPane;
  47 import javax.swing.JToolBar;
  48 import javax.swing.SwingConstants;
  49 import javax.swing.border.EmptyBorder;
  50
  51 import net.pterodactylus.jsite.core.Node;
  52 import net.pterodactylus.jsite.i18n.I18n;
  53 import net.pterodactylus.jsite.i18n.I18nable;
  54 import net.pterodactylus.jsite.i18n.gui.I18nAction;
  55 import net.pterodactylus.jsite.i18n.gui.I18nMenu;
  56 import net.pterodactylus.jsite.main.Version;
  57 import net.pterodactylus.jsite.project.Project;
  58 import net.pterodactylus.util.image.IconLoader;
  59 import net.pterodactylus.util.logging.Logging;
  60 import net.pterodactylus.util.swing.StatusBar;
  61 import net.pterodactylus.util.swing.SwingUtils;
  62
  63 /**
  64  * Defines the main window of the application.
  65  *
  66  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  67  */
  68 public class MainWindow extends JFrame implements WindowListener, I18nable, PropertyChangeListener {
  69
  70         /** Logger. */
  71         @SuppressWarnings("unused")
  72         private static final Logger logger = Logging.getLogger(MainWindow.class.getName());
  73
  74         /** The swing interface that receives all actions. */
  75         private final SwingInterface swingInterface;
  76
  77         /** The status bar. */
  78         private StatusBar statusBar = new StatusBar();
  79
  80         /** Timer for clearing the status bar. */
  81         private Timer statusBarClearTimer = new Timer("StatusBar Cleaner", true);
  82
  83         /** Object for status bar clearing ticker event. */
  84         private TimerTask statusBarClearTimerTask;
  85
  86         /** Delay (in seconds) after which to clear status bar. */
  87         private int statusBarClearDelay = 5000;
  88
  89         /** The icon for offline nodes. */
  90         private Icon offlineIcon;
  91
  92         /** The icon for online nodes. */
  93         private Icon onlineIcon;
  94
  95         /** The icon for error nodes. */
  96         private Icon errorIcon;
  97
  98         /** The content pane. */
  99         private JPanel contentPane = new JPanel(new BorderLayout(12, 12));
 100
 101         /** The jSite menu. */
 102         private I18nMenu jSiteMenu;
 103
 104         /** The node menu. */
 105         private I18nMenu nodeMenu;
 106
 107         /** The language menu. */
 108         private I18nMenu languageMenu;
 109
 110         /** The about menu. */
 111         private I18nMenu helpMenu;
 112
 113         /** The tabbed project pane. */
 114         private JTabbedPane projectPane;
 115
 116         /** The project overview panel. */
 117         private Box projectOverviewPanel;
 118
 119         /** Maps from node to menus. */
 120         private final Map<Node, JMenu> nodeMenus = new HashMap<Node, JMenu>();
 121
 122         /** Maps from nodes to node panels. */
 123         private final Map<Node, NodeLabel> nodeLabels = new HashMap<Node, NodeLabel>();
 124
 125         /**
 126          * Creates a new main window that redirects all actions to the given swing
 127          * interface.
 128          *
 129          * @param swingInterface
 130          *            The swing interface to receive all actions
 131          */
 132         public MainWindow(SwingInterface swingInterface) {
 133                 super("jSite " + Version.getVersion());
 134                 this.swingInterface = swingInterface;
 135                 initWindow();
 136                 setPreferredSize(new Dimension(480, 280));
 137                 pack();
 138                 SwingUtils.center(this);
 139                 I18n.registerI18nable(this);
 140                 addWindowListener(this);
 141                 setIconImage(IconLoader.loadImage("/jSite-frame-icon.png"));
 142         }
 143
 144         //
 145         // ACCESSORS
 146         //
 147
 148         /**
 149          * Sets the text of the status bar.
 150          *
 151          * @param text
 152          *            The text of the status bar
 153          */
 154         public void setStatusBarText(String text) {
 155                 statusBar.setText(text);
 156                 synchronized (statusBar) {
 157                         if (statusBarClearTimerTask != null) {
 158                                 statusBarClearTimerTask.cancel();
 159                         }
 160                         statusBarClearTimerTask = new TimerTask() {
 161
 162                                 @SuppressWarnings("synthetic-access")
 163                                 @Override
 164                                 public void run() {
 165                                         statusBar.setText("\u00a0");
 166                                 }
 167
 168                         };
 169                         statusBarClearTimer.schedule(statusBarClearTimerTask, statusBarClearDelay);
 170                 }
 171         }
 172
 173         /**
 174          * Returns the status bar clear delay (in milliseconds).
 175          *
 176          * @return The status bar clear delay
 177          */
 178         public int getStatusBarClearDelay() {
 179                 return statusBarClearDelay;
 180         }
 181
 182         /**
 183          * Sets the status bar clear delay (in milliseconds).
 184          *
 185          * @param statusBarClearDelay
 186          *            The status bar clear delay
 187          */
 188         public void setStatusBarClearDelay(int statusBarClearDelay) {
 189                 this.statusBarClearDelay = statusBarClearDelay;
 190         }
 191
 192         /**
 193          * Sets whether the advanced mode is activated.
 194          *
 195          * @param advancedMode
 196          *            <code>true</code> if the advanced mode is activated,
 197          *            <code>false</code> if the simple mode is activated
 198          */
 199         public void setAdvancedMode(boolean advancedMode) {
 200                 /* doesn’t do anything right now. */
 201         }
 202
 203         /**
 204          * {@inheritDoc}
 205          */
 206         @Override
 207         public Container getContentPane() {
 208                 return contentPane;
 209         }
 210
 211         /**
 212          * Returns the currently selected project.
 213          *
 214          * @return The currently selected project
 215          */
 216         public Project getSelectedProject() {
 217                 return null;
 218         }
 219
 220         /**
 221          * Sets the given node to the “online” state.
 222          *
 223          * @param node
 224          *            The node to set online
 225          */
 226         public void setOnline(Node node) {
 227                 nodeLabels.get(node).setOnline();
 228         }
 229
 230         /**
 231          * Sets the given node to the “offline” state in the status bar.
 232          *
 233          * @param node
 234          *            The node to set offline
 235          */
 236         public void setOffline(Node node) {
 237                 nodeLabels.get(node).setOffline();
 238         }
 239
 240         /**
 241          * Sets the given node to the “error” state in the status bar.
 242          *
 243          * @param node
 244          *            The node to set the error state for
 245          */
 246         public void setError(Node node) {
 247                 nodeLabels.get(node).setError();
 248         }
 249
 250         //
 251         // ACTIONS
 252         //
 253
 254         /**
 255          * Adds a node to the menu.
 256          *
 257          * @param node
 258          *            The node to add
 259          */
 260         void addNode(Node node) {
 261                 JMenu newNodeMenu = new JMenu(node.getName());
 262                 nodeMenus.put(node, newNodeMenu);
 263                 newNodeMenu.add(swingInterface.getNodeConnectAction(node));
 264                 newNodeMenu.add(swingInterface.getNodeDisconnectAction(node));
 265                 newNodeMenu.addSeparator();
 266                 newNodeMenu.add(swingInterface.getNodeEditAction(node));
 267                 newNodeMenu.add(swingInterface.getNodeDeleteAction(node));
 268                 nodeMenu.add(newNodeMenu);
 269                 NodeLabel nodeLabel = new NodeLabel(swingInterface, node, onlineIcon, offlineIcon, errorIcon);
 270                 nodeLabels.put(node, nodeLabel);
 271                 statusBar.addSideComponent(nodeLabel);
 272                 node.addPropertyChangeListener(this);
 273         }
 274
 275         /**
 276          * Removes a node from the menu.
 277          *
 278          * @param node
 279          *            The node to remove
 280          */
 281         void removeNode(Node node) {
 282                 nodeMenu.remove(nodeMenus.remove(node));
 283                 statusBar.removeSideComponent(nodeLabels.remove(node));
 284                 node.removePropertyChangeListener(this);
 285         }
 286
 287         /**
 288          * Adds a project to the project pane.
 289          *
 290          * @param project
 291          *            The project to add
 292          * @param switchToProject
 293          *            <code>true</code> to switch to the new panel,
 294          *            <code>false</code> to not change the current panel
 295          */
 296         void addProject(Project project, boolean switchToProject) {
 297                 ProjectPanel projectPanel = new ProjectPanel(swingInterface, project);
 298                 int newTabIndex = projectPane.getTabCount();
 299                 projectPane.add(project.getName(), projectPanel);
 300                 projectPane.setToolTipTextAt(newTabIndex, project.getDescription());
 301                 project.addPropertyChangeListener(this);
 302                 if (switchToProject) {
 303                         projectPane.setSelectedIndex(newTabIndex);
 304                         while (project.getBasePath().length() == 0) {
 305                                 JOptionPane.showMessageDialog(this, I18n.get("mainWindow.information.changeProjectBasePath.message"), I18n.get("mainWindow.information.changeProjectBasePath.title"), JOptionPane.INFORMATION_MESSAGE);
 306                                 projectPanel.changeBasePath();
 307                         }
 308                 }
 309         }
 310
 311         /**
 312          * Removes the pane containing the given project.
 313          *
 314          * @param project
 315          *            The project whose pane to remove
 316          */
 317         void removeProject(Project project) {
 318                 int projectIndex = getProjectIndex(project);
 319                 projectPane.remove(projectIndex);
 320         }
 321
 322         /**
 323          * @param project
 324          */
 325         void projectInsertStarted(Project project) {
 326                 int projectIndex = getProjectIndex(project);
 327                 if (projectIndex == -1) {
 328                         return;
 329                 }
 330                 projectPane.setTitleAt(projectIndex, I18n.get("projectPanel.title.starting", project.getName()));
 331         }
 332
 333         /**
 334          * @param project
 335          * @param totalBlocks
 336          * @param requiredBlocks
 337          * @param successfulBlocks
 338          * @param failedBlocks
 339          * @param fatallyFailedBlocks
 340          * @param finalizedTotal
 341          */
 342         void projectInsertProgressed(Project project, int totalBlocks, int requiredBlocks, int successfulBlocks, int failedBlocks, int fatallyFailedBlocks, boolean finalizedTotal) {
 343                 int projectIndex = getProjectIndex(project);
 344                 if (projectIndex == -1) {
 345                         return;
 346                 }
 347                 projectPane.setTitleAt(projectIndex, I18n.get("projectPanel.title.progress", project.getName(), requiredBlocks / (double) successfulBlocks));
 348         }
 349
 350         /**
 351          * @param project
 352          */
 353         void projectInsertGeneratedURI(Project project) {
 354                 /* TODO - update panel. */
 355         }
 356
 357         /**
 358          * @param project
 359          * @param success
 360          */
 361         void projectInsertFinished(Project project, boolean success) {
 362                 int projectIndex = getProjectIndex(project);
 363                 if (projectIndex == -1) {
 364                         return;
 365                 }
 366                 projectPane.setTitleAt(projectIndex, project.getName());
 367         }
 368
 369         //
 370         // PRIVATE METHODS
 371         //
 372
 373         /**
 374          * Returns the index of the project panel that contains the given project.
 375          *
 376          * @param project
 377          *            The wanted project
 378          * @return The index of {@link #projectPane}’s tab that contains the given
 379          *         project, or <code>-1</code> if the project can not be found
 380          */
 381         private int getProjectIndex(Project project) {
 382                 int tabCount = projectPane.getTabCount();
 383                 for (int tabIndex = 1; tabIndex < tabCount; tabIndex++) {
 384                         Component tabComponent = projectPane.getComponentAt(tabIndex);
 385                         if (tabComponent instanceof ProjectPanel) {
 386                                 if (((ProjectPanel) tabComponent).getProject() == project) {
 387                                         return tabIndex;
 388                                 }
 389                         }
 390                 }
 391                 return -1;
 392         }
 393
 394         /**
 395          * Initializes the window by creating all its components.
 396          */
 397         private void initWindow() {
 398                 onlineIcon = IconLoader.loadIcon("/node-online.png");
 399                 offlineIcon = IconLoader.loadIcon("/node-offline.png");
 400                 errorIcon = IconLoader.loadIcon("/node-error.png");
 401
 402                 JMenuBar menuBar = new JMenuBar();
 403
 404                 jSiteMenu = new I18nMenu("mainWindow.menu.jSite");
 405                 menuBar.add(jSiteMenu);
 406
 407                 jSiteMenu.add(new FixedJMenuItem(swingInterface.getConfigureAction()));
 408                 jSiteMenu.addSeparator();
 409                 jSiteMenu.add(new FixedJMenuItem(swingInterface.getImportConfigAction()));
 410                 jSiteMenu.addSeparator();
 411                 jSiteMenu.add(new FixedJMenuItem(swingInterface.getQuitAction()));
 412
 413                 nodeMenu = new I18nMenu("mainWindow.menu.node");
 414                 menuBar.add(nodeMenu);
 415
 416                 nodeMenu.add(new FixedJMenuItem(swingInterface.getAddNodeAction()));
 417                 nodeMenu.addSeparator();
 418
 419                 languageMenu = new I18nMenu("mainWindow.menu.language");
 420                 menuBar.add(languageMenu);
 421
 422                 for (I18nAction languageAction: swingInterface.getLanguageActions()) {
 423                         languageMenu.add(new FixedJMenuItem(languageAction));
 424                 }
 425
 426                 menuBar.add(Box.createHorizontalGlue());
 427
 428                 helpMenu = new I18nMenu("mainWindow.menu.help");
 429                 menuBar.add(helpMenu);
 430
 431                 helpMenu.add(new FixedJMenuItem(swingInterface.getHelpAboutAction()));
 432
 433                 setJMenuBar(menuBar);
 434
 435                 JToolBar toolBar = new JToolBar(I18n.get("mainWindow.toolbar.name"));
 436                 toolBar.add(swingInterface.getAddNodeAction());
 437                 toolBar.addSeparator();
 438                 toolBar.add(swingInterface.getQuitAction());
 439                 super.getContentPane().add(toolBar, BorderLayout.PAGE_START);
 440
 441                 super.getContentPane().add(contentPane, BorderLayout.CENTER);
 442
 443                 addWindowListener(new WindowAdapter() {
 444
 445                         /**
 446                          * {@inheritDoc}
 447                          */
 448                         @SuppressWarnings("synthetic-access")
 449                         @Override
 450                         public void windowClosing(WindowEvent windowEvent) {
 451                                 swingInterface.getQuitAction().actionPerformed(null);
 452                         }
 453                 });
 454
 455                 initComponents();
 456         }
 457
 458         /**
 459          * Initializes all components of this window.
 460          */
 461         private void initComponents() {
 462                 super.getContentPane().add(statusBar, BorderLayout.PAGE_END);
 463                 contentPane.setBorder(new EmptyBorder(12, 12, 12, 12));
 464
 465                 projectPane = new JTabbedPane(SwingConstants.TOP, JTabbedPane.SCROLL_TAB_LAYOUT);
 466                 contentPane.add(projectPane, BorderLayout.CENTER);
 467
 468                 projectOverviewPanel = new Box(BoxLayout.PAGE_AXIS);
 469                 projectOverviewPanel.setName(I18n.get("mainWindow.pane.overview.title"));
 470                 projectPane.add(projectOverviewPanel);
 471                 projectOverviewPanel.setBorder(new EmptyBorder(12, 12, 12, 12));
 472                 projectOverviewPanel.add(Box.createVerticalGlue());
 473                 JButton addProjectButton = new JButton(swingInterface.getAddProjectAction());
 474                 addProjectButton.setAlignmentX(0.5f);
 475                 projectOverviewPanel.add(addProjectButton);
 476                 projectOverviewPanel.add(Box.createVerticalGlue());
 477         }
 478
 479         //
 480         // INTERFACE I18nable
 481         //
 482
 483         /**
 484          * {@inheritDoc}
 485          */
 486         public void updateI18n() {
 487                 swingInterface.getConfigureAction().updateI18n();
 488                 swingInterface.getImportConfigAction().updateI18n();
 489                 swingInterface.getQuitAction().updateI18n();
 490                 swingInterface.getAddNodeAction().updateI18n();
 491                 swingInterface.getAddProjectAction().updateI18n();
 492                 swingInterface.getHelpAboutAction().updateI18n();
 493                 jSiteMenu.updateI18n();
 494                 nodeMenu.updateI18n();
 495                 languageMenu.updateI18n();
 496                 for (Node node: swingInterface.getNodes()) {
 497                         swingInterface.getNodeConnectAction(node).updateI18n();
 498                         swingInterface.getNodeDisconnectAction(node).updateI18n();
 499                         swingInterface.getNodeEditAction(node).updateI18n();
 500                         swingInterface.getNodeDeleteAction(node).updateI18n();
 501                 }
 502                 for (Project project: swingInterface.getProjects()) {
 503                         swingInterface.getCloneProjectAction(project).updateI18n();
 504                         swingInterface.getDeleteProjectAction(project).updateI18n();
 505                 }
 506                 for (I18nAction languageAction: swingInterface.getLanguageActions()) {
 507                         languageAction.updateI18n();
 508                 }
 509                 helpMenu.updateI18n();
 510                 getJMenuBar().revalidate();
 511                 projectPane.setTitleAt(0, I18n.get("mainWindow.pane.overview.title"));
 512                 for (int componentIndex = 0; componentIndex < projectPane.getTabCount(); componentIndex++) {
 513                         Component tabComponent = projectPane.getComponentAt(componentIndex);
 514                         if (tabComponent instanceof ProjectPanel) {
 515                                 ((ProjectPanel) tabComponent).updateI18n();
 516                         }
 517                 }
 518         }
 519
 520         //
 521         // INTERFACE WindowListener
 522         //
 523
 524         /**
 525          * {@inheritDoc}
 526          */
 527         public void windowActivated(WindowEvent e) {
 528                 /* do nothing. */
 529         }
 530
 531         /**
 532          * {@inheritDoc}
 533          */
 534         public void windowClosed(WindowEvent e) {
 535                 /* do nothing. */
 536         }
 537
 538         /**
 539          * {@inheritDoc}
 540          */
 541         public void windowClosing(WindowEvent e) {
 542                 swingInterface.getQuitAction().actionPerformed(null);
 543         }
 544
 545         /**
 546          * {@inheritDoc}
 547          */
 548         public void windowDeactivated(WindowEvent e) {
 549                 /* do nothing. */
 550         }
 551
 552         /**
 553          * {@inheritDoc}
 554          */
 555         public void windowDeiconified(WindowEvent e) {
 556                 /* do nothing. */
 557         }
 558
 559         /**
 560          * {@inheritDoc}
 561          */
 562         public void windowIconified(WindowEvent e) {
 563                 /* do nothing. */
 564         }
 565
 566         /**
 567          * {@inheritDoc}
 568          */
 569         public void windowOpened(WindowEvent e) {
 570                 /* do nothing. */
 571         }
 572
 573         //
 574         // INTERFACE PropertyChangeListener
 575         //
 576
 577         /**
 578          * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
 579          */
 580         public void propertyChange(PropertyChangeEvent propertyChangeEvent) {
 581                 Object eventSource = propertyChangeEvent.getSource();
 582                 String propertyName = propertyChangeEvent.getPropertyName();
 583                 if (eventSource instanceof Project) {
 584                         /* if a project was changed, update the tab title and tooltip. */
 585                         if (Project.PROPERTY_NAME.equals(propertyName) || Project.PROPERTY_DESCRIPTION.equals(propertyName)) {
 586                                 Project project = (Project) eventSource;
 587                                 int projectIndex = getProjectIndex(project);
 588                                 if (projectIndex != -1) {
 589                                         projectPane.setTitleAt(projectIndex, project.getName());
 590                                         projectPane.setToolTipTextAt(projectIndex, project.getDescription());
 591                                         projectPane.repaint();
 592                                 }
 593                         }
 594                 } else if (eventSource instanceof Node) {
 595                         if (propertyName.equals(Node.PROPERTY_NAME)) {
 596                                 Node changedNode = (Node) eventSource;
 597                                 nodeMenus.get(changedNode).setText(changedNode.getName());
 598                         }
 599                 }
 600         }
 601
 602 }