2 * jSite2 - MainWindow.java -
3 * Copyright © 2008 David Roden
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.
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.
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.
20 package net.pterodactylus.jsite.gui;
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;
33 import java.util.Timer;
34 import java.util.TimerTask;
35 import java.util.logging.Logger;
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;
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;
64 * Defines the main window of the application.
66 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
68 public class MainWindow extends JFrame implements WindowListener, I18nable, PropertyChangeListener {
71 @SuppressWarnings("unused")
72 private static final Logger logger = Logging.getLogger(MainWindow.class.getName());
74 /** The swing interface that receives all actions. */
75 private final SwingInterface swingInterface;
77 /** The status bar. */
78 private StatusBar statusBar = new StatusBar();
80 /** Timer for clearing the status bar. */
81 private Timer statusBarClearTimer = new Timer("StatusBar Cleaner", true);
83 /** Object for status bar clearing ticker event. */
84 private TimerTask statusBarClearTimerTask;
86 /** Delay (in seconds) after which to clear status bar. */
87 private int statusBarClearDelay = 5000;
89 /** The icon for offline nodes. */
90 private Icon offlineIcon;
92 /** The icon for online nodes. */
93 private Icon onlineIcon;
95 /** The icon for error nodes. */
96 private Icon errorIcon;
98 /** The content pane. */
99 private JPanel contentPane = new JPanel(new BorderLayout(12, 12));
101 /** The jSite menu. */
102 private I18nMenu jSiteMenu;
104 /** The node menu. */
105 private I18nMenu nodeMenu;
107 /** The language menu. */
108 private I18nMenu languageMenu;
110 /** The about menu. */
111 private I18nMenu helpMenu;
113 /** The tabbed project pane. */
114 private JTabbedPane projectPane;
116 /** The project overview panel. */
117 private Box projectOverviewPanel;
119 /** Maps from node to menus. */
120 private final Map<Node, JMenu> nodeMenus = new HashMap<Node, JMenu>();
122 /** Maps from nodes to node panels. */
123 private final Map<Node, NodeLabel> nodeLabels = new HashMap<Node, NodeLabel>();
126 * Creates a new main window that redirects all actions to the given swing
129 * @param swingInterface
130 * The swing interface to receive all actions
132 public MainWindow(SwingInterface swingInterface) {
133 super("jSite " + Version.getVersion());
134 this.swingInterface = swingInterface;
136 setPreferredSize(new Dimension(480, 280));
138 SwingUtils.center(this);
139 I18n.registerI18nable(this);
140 addWindowListener(this);
141 setIconImage(IconLoader.loadImage("/jSite-frame-icon.png"));
149 * Sets the text of the status bar.
152 * The text of the status bar
154 public void setStatusBarText(String text) {
155 statusBar.setText(text);
156 synchronized (statusBar) {
157 if (statusBarClearTimerTask != null) {
158 statusBarClearTimerTask.cancel();
160 statusBarClearTimerTask = new TimerTask() {
162 @SuppressWarnings("synthetic-access")
165 statusBar.setText("\u00a0");
169 statusBarClearTimer.schedule(statusBarClearTimerTask, statusBarClearDelay);
174 * Returns the status bar clear delay (in milliseconds).
176 * @return The status bar clear delay
178 public int getStatusBarClearDelay() {
179 return statusBarClearDelay;
183 * Sets the status bar clear delay (in milliseconds).
185 * @param statusBarClearDelay
186 * The status bar clear delay
188 public void setStatusBarClearDelay(int statusBarClearDelay) {
189 this.statusBarClearDelay = statusBarClearDelay;
193 * Sets whether the advanced mode is activated.
195 * @param advancedMode
196 * <code>true</code> if the advanced mode is activated,
197 * <code>false</code> if the simple mode is activated
199 public void setAdvancedMode(boolean advancedMode) {
200 /* doesn’t do anything right now. */
207 public Container getContentPane() {
212 * Returns the currently selected project.
214 * @return The currently selected project
216 public Project getSelectedProject() {
221 * Sets the given node to the “online” state.
224 * The node to set online
226 public void setOnline(Node node) {
227 nodeLabels.get(node).setOnline();
231 * Sets the given node to the “offline” state in the status bar.
234 * The node to set offline
236 public void setOffline(Node node) {
237 nodeLabels.get(node).setOffline();
241 * Sets the given node to the “error” state in the status bar.
244 * The node to set the error state for
246 public void setError(Node node) {
247 nodeLabels.get(node).setError();
255 * Adds a node to the menu.
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);
276 * Removes a node from the menu.
281 void removeNode(Node node) {
282 nodeMenu.remove(nodeMenus.remove(node));
283 statusBar.removeSideComponent(nodeLabels.remove(node));
284 node.removePropertyChangeListener(this);
288 * Adds a project to the project pane.
292 * @param switchToProject
293 * <code>true</code> to switch to the new panel,
294 * <code>false</code> to not change the current panel
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();
312 * Removes the pane containing the given project.
315 * The project whose pane to remove
317 void removeProject(Project project) {
318 int projectIndex = getProjectIndex(project);
319 projectPane.remove(projectIndex);
325 void projectInsertStarted(Project project) {
326 int projectIndex = getProjectIndex(project);
327 if (projectIndex == -1) {
330 projectPane.setTitleAt(projectIndex, I18n.get("projectPanel.title.starting", project.getName()));
336 * @param requiredBlocks
337 * @param successfulBlocks
338 * @param failedBlocks
339 * @param fatallyFailedBlocks
340 * @param finalizedTotal
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) {
347 projectPane.setTitleAt(projectIndex, I18n.get("projectPanel.title.progress", project.getName(), requiredBlocks / (double) successfulBlocks));
353 void projectInsertGeneratedURI(Project project) {
354 /* TODO - update panel. */
361 void projectInsertFinished(Project project, boolean success) {
362 int projectIndex = getProjectIndex(project);
363 if (projectIndex == -1) {
366 projectPane.setTitleAt(projectIndex, project.getName());
374 * Returns the index of the project panel that contains the given 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
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) {
395 * Initializes the window by creating all its components.
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");
402 JMenuBar menuBar = new JMenuBar();
404 jSiteMenu = new I18nMenu("mainWindow.menu.jSite");
405 menuBar.add(jSiteMenu);
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()));
413 nodeMenu = new I18nMenu("mainWindow.menu.node");
414 menuBar.add(nodeMenu);
416 nodeMenu.add(new FixedJMenuItem(swingInterface.getAddNodeAction()));
417 nodeMenu.addSeparator();
419 languageMenu = new I18nMenu("mainWindow.menu.language");
420 menuBar.add(languageMenu);
422 for (I18nAction languageAction: swingInterface.getLanguageActions()) {
423 languageMenu.add(new FixedJMenuItem(languageAction));
426 menuBar.add(Box.createHorizontalGlue());
428 helpMenu = new I18nMenu("mainWindow.menu.help");
429 menuBar.add(helpMenu);
431 helpMenu.add(new FixedJMenuItem(swingInterface.getHelpAboutAction()));
433 setJMenuBar(menuBar);
435 JToolBar toolBar = new JToolBar(I18n.get("mainWindow.toolbar.name"));
436 toolBar.add(swingInterface.getConfigureAction());
437 toolBar.add(swingInterface.getQuitAction());
438 toolBar.addSeparator();
439 toolBar.add(swingInterface.getAddNodeAction());
440 super.getContentPane().add(toolBar, BorderLayout.PAGE_START);
442 super.getContentPane().add(contentPane, BorderLayout.CENTER);
444 addWindowListener(new WindowAdapter() {
449 @SuppressWarnings("synthetic-access")
451 public void windowClosing(WindowEvent windowEvent) {
452 swingInterface.getQuitAction().actionPerformed(null);
460 * Initializes all components of this window.
462 private void initComponents() {
463 super.getContentPane().add(statusBar, BorderLayout.PAGE_END);
464 contentPane.setBorder(new EmptyBorder(12, 12, 12, 12));
466 projectPane = new JTabbedPane(SwingConstants.TOP, JTabbedPane.SCROLL_TAB_LAYOUT);
467 contentPane.add(projectPane, BorderLayout.CENTER);
469 projectOverviewPanel = new Box(BoxLayout.PAGE_AXIS);
470 projectOverviewPanel.setName(I18n.get("mainWindow.pane.overview.title"));
471 projectPane.add(projectOverviewPanel);
472 projectOverviewPanel.setBorder(new EmptyBorder(12, 12, 12, 12));
473 projectOverviewPanel.add(Box.createVerticalGlue());
474 JButton addProjectButton = new JButton(swingInterface.getAddProjectAction());
475 addProjectButton.setAlignmentX(0.5f);
476 projectOverviewPanel.add(addProjectButton);
477 projectOverviewPanel.add(Box.createVerticalGlue());
481 // INTERFACE I18nable
487 public void updateI18n() {
488 swingInterface.getConfigureAction().updateI18n();
489 swingInterface.getImportConfigAction().updateI18n();
490 swingInterface.getQuitAction().updateI18n();
491 swingInterface.getAddNodeAction().updateI18n();
492 swingInterface.getAddProjectAction().updateI18n();
493 swingInterface.getHelpAboutAction().updateI18n();
494 jSiteMenu.updateI18n();
495 nodeMenu.updateI18n();
496 languageMenu.updateI18n();
497 for (Node node: swingInterface.getNodes()) {
498 swingInterface.getNodeConnectAction(node).updateI18n();
499 swingInterface.getNodeDisconnectAction(node).updateI18n();
500 swingInterface.getNodeEditAction(node).updateI18n();
501 swingInterface.getNodeDeleteAction(node).updateI18n();
503 for (Project project: swingInterface.getProjects()) {
504 swingInterface.getCloneProjectAction(project).updateI18n();
505 swingInterface.getDeleteProjectAction(project).updateI18n();
507 for (I18nAction languageAction: swingInterface.getLanguageActions()) {
508 languageAction.updateI18n();
510 helpMenu.updateI18n();
511 getJMenuBar().revalidate();
512 projectPane.setTitleAt(0, I18n.get("mainWindow.pane.overview.title"));
513 for (int componentIndex = 0; componentIndex < projectPane.getTabCount(); componentIndex++) {
514 Component tabComponent = projectPane.getComponentAt(componentIndex);
515 if (tabComponent instanceof ProjectPanel) {
516 ((ProjectPanel) tabComponent).updateI18n();
522 // INTERFACE WindowListener
528 public void windowActivated(WindowEvent e) {
535 public void windowClosed(WindowEvent e) {
542 public void windowClosing(WindowEvent e) {
543 swingInterface.getQuitAction().actionPerformed(null);
549 public void windowDeactivated(WindowEvent e) {
556 public void windowDeiconified(WindowEvent e) {
563 public void windowIconified(WindowEvent e) {
570 public void windowOpened(WindowEvent e) {
575 // INTERFACE PropertyChangeListener
579 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
581 public void propertyChange(PropertyChangeEvent propertyChangeEvent) {
582 Object eventSource = propertyChangeEvent.getSource();
583 String propertyName = propertyChangeEvent.getPropertyName();
584 if (eventSource instanceof Project) {
585 /* if a project was changed, update the tab title and tooltip. */
586 if (Project.PROPERTY_NAME.equals(propertyName) || Project.PROPERTY_DESCRIPTION.equals(propertyName)) {
587 Project project = (Project) eventSource;
588 int projectIndex = getProjectIndex(project);
589 if (projectIndex != -1) {
590 projectPane.setTitleAt(projectIndex, project.getName());
591 projectPane.setToolTipTextAt(projectIndex, project.getDescription());
592 projectPane.repaint();
595 } else if (eventSource instanceof Node) {
596 if (propertyName.equals(Node.PROPERTY_NAME)) {
597 Node changedNode = (Node) eventSource;
598 nodeMenus.get(changedNode).setText(changedNode.getName());