add javadoc
[jSite.git] / src / de / todesbaum / jsite / gui / ProjectInsertPage.java
index ef06fc5..563ef3c 100644 (file)
 package de.todesbaum.jsite.gui;
 
 import java.awt.BorderLayout;
+import java.awt.Font;
 import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
 import java.awt.Insets;
+import java.awt.Toolkit;
+import java.awt.datatransfer.Clipboard;
+import java.awt.datatransfer.ClipboardOwner;
+import java.awt.datatransfer.StringSelection;
+import java.awt.datatransfer.Transferable;
+import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
 import java.text.DateFormat;
 import java.text.MessageFormat;
 import java.util.Date;
 
+import javax.swing.AbstractAction;
+import javax.swing.Action;
+import javax.swing.JButton;
 import javax.swing.JComponent;
 import javax.swing.JLabel;
 import javax.swing.JOptionPane;
@@ -35,50 +46,106 @@ import javax.swing.JProgressBar;
 import javax.swing.JTextField;
 import javax.swing.SwingUtilities;
 
-import de.todesbaum.jsite.application.EditionProject;
 import de.todesbaum.jsite.application.Freenet7Interface;
 import de.todesbaum.jsite.application.InsertListener;
 import de.todesbaum.jsite.application.Project;
 import de.todesbaum.jsite.application.ProjectInserter;
 import de.todesbaum.jsite.i18n.I18n;
+import de.todesbaum.jsite.i18n.I18nContainer;
 import de.todesbaum.util.swing.TWizard;
 import de.todesbaum.util.swing.TWizardPage;
 
 /**
- * @author David Roden <droden@gmail.com>
- * @version $Id: ProjectInsertPage.java 408 2006-03-29 09:31:10Z bombe $
+ * Wizard page that shows the progress of an insert.
+ * 
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  */
-public class ProjectInsertPage extends TWizardPage implements InsertListener {
+public class ProjectInsertPage extends TWizardPage implements InsertListener, ClipboardOwner {
 
-       protected TWizard wizard;
-       protected ProjectInserter projectInserter;
+       /** The project inserter. */
+       private ProjectInserter projectInserter;
 
-       protected JTextField requestURITextField;
-       protected JLabel startTimeLabel;
-       protected JProgressBar progressBar;
-       protected long startTime;
+       /** The “copy URI” action. */
+       private Action copyURIAction;
 
-       public ProjectInsertPage() {
-               super();
+       /** The “request URI” textfield. */
+       private JTextField requestURITextField;
+
+       /** The “start time” label. */
+       private JLabel startTimeLabel;
+
+       /** The progress bar. */
+       private JProgressBar progressBar;
+
+       /** The start time of the insert. */
+       private long startTime = 0;
+
+       /**
+        * Creates a new progress insert wizard page.
+        * 
+        * @param wizard
+        *            The wizard this page belongs to
+        */
+       public ProjectInsertPage(final TWizard wizard) {
+               super(wizard);
+               createActions();
                pageInit();
                setHeading(I18n.getMessage("jsite.insert.heading"));
                setDescription(I18n.getMessage("jsite.insert.description"));
+               I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       public void run() {
+                               setHeading(I18n.getMessage("jsite.insert.heading"));
+                               setDescription(I18n.getMessage("jsite.insert.description"));
+                       }
+               });
                projectInserter = new ProjectInserter();
                projectInserter.addInsertListener(this);
        }
 
+       /**
+        * Creates all used actions.
+        */
+       private void createActions() {
+               copyURIAction = new AbstractAction(I18n.getMessage("jsite.project.action.copy-uri")) {
+
+                       @SuppressWarnings("synthetic-access")
+                       public void actionPerformed(ActionEvent actionEvent) {
+                               actionCopyURI();
+                       }
+               };
+               copyURIAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project.action.copy-uri.tooltip"));
+               copyURIAction.putValue(Action.MNEMONIC_KEY, KeyEvent.VK_U);
+               copyURIAction.setEnabled(false);
+
+               I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
+                       public void run() {
+                               copyURIAction.putValue(Action.NAME, I18n.getMessage("jsite.project.action.copy-uri"));
+                               copyURIAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project.action.copy-uri.tooltip"));
+                       }
+               });
+       }
+
+       /**
+        * Initializes the page.
+        */
        private void pageInit() {
                setLayout(new BorderLayout(12, 12));
                add(createProjectInsertPanel(), BorderLayout.CENTER);
        }
 
+       /**
+        * Creates the main panel.
+        * 
+        * @return The main panel
+        */
        private JComponent createProjectInsertPanel() {
                JComponent projectInsertPanel = new JPanel(new GridBagLayout());
 
                requestURITextField = new JTextField();
                requestURITextField.setEditable(false);
-               requestURITextField.setBackground(getBackground());
-               requestURITextField.setBorder(null);
 
                startTimeLabel = new JLabel();
 
@@ -86,13 +153,34 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener {
                progressBar.setStringPainted(true);
                progressBar.setValue(0);
 
-               projectInsertPanel.add(new JLabel("<html><b>" + I18n.getMessage("jsite.insert.project-information") + "</b></html>"), new GridBagConstraints(0, 0, 2, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0));
-               projectInsertPanel.add(new JLabel(I18n.getMessage("jsite.insert.request-uri") + ":"), new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
+               final JLabel projectInformationLabel = new JLabel("<html><b>" + I18n.getMessage("jsite.insert.project-information") + "</b></html>");
+               projectInsertPanel.add(projectInformationLabel, new GridBagConstraints(0, 0, 2, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0));
+               final JLabel requestURILabel = new JLabel(I18n.getMessage("jsite.insert.request-uri") + ":");
+               projectInsertPanel.add(requestURILabel, new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
                projectInsertPanel.add(requestURITextField, new GridBagConstraints(1, 1, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
-               projectInsertPanel.add(new JLabel(I18n.getMessage("jsite.insert.start-time") + ":"), new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
+               final JLabel startTimeLeftLabel = new JLabel(I18n.getMessage("jsite.insert.start-time") + ":");
+               projectInsertPanel.add(startTimeLeftLabel, new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
                projectInsertPanel.add(startTimeLabel, new GridBagConstraints(1, 2, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
-               projectInsertPanel.add(new JLabel(I18n.getMessage("jsite.insert.progress") + ":"), new GridBagConstraints(0, 3, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
+               final JLabel progressLabel = new JLabel(I18n.getMessage("jsite.insert.progress") + ":");
+               projectInsertPanel.add(progressLabel, new GridBagConstraints(0, 3, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
                projectInsertPanel.add(progressBar, new GridBagConstraints(1, 3, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
+               projectInsertPanel.add(new JButton(copyURIAction), new GridBagConstraints(0, 4, 2, 1, 0.0, 0.0, GridBagConstraints.LINE_END, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
+
+               I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
+                       public void run() {
+                               projectInformationLabel.setText("<html><b>" + I18n.getMessage("jsite.insert.project-information") + "</b></html>");
+                               requestURILabel.setText(I18n.getMessage("jsite.insert.request-uri") + ":");
+                               startTimeLeftLabel.setText(I18n.getMessage("jsite.insert.start-time") + ":");
+                               if (startTime != 0) {
+                                       startTimeLabel.setText(DateFormat.getDateTimeInstance().format(new Date(startTime)));
+                               } else {
+                                       startTimeLabel.setText("");
+                               }
+                               progressLabel.setText(I18n.getMessage("jsite.insert.progress") + ":");
+                       }
+               });
 
                return projectInsertPanel;
        }
@@ -102,43 +190,58 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener {
         */
        @Override
        public void pageAdded(TWizard wizard) {
-               this.wizard = wizard;
-               wizard.setPreviousEnabled(false);
+               this.wizard.setPreviousName(I18n.getMessage("jsite.wizard.previous"));
+               this.wizard.setPreviousEnabled(false);
+               this.wizard.setNextName(I18n.getMessage("jsite.wizard.next"));
+               this.wizard.setQuitName(I18n.getMessage("jsite.wizard.quit"));
+       }
+
+       /**
+        * Starts the insert.
+        */
+       public void startInsert() {
                wizard.setNextEnabled(false);
-               wizard.setQuitEnabled(false);
+               copyURIAction.setEnabled(false);
                progressBar.setValue(0);
+               progressBar.setString(I18n.getMessage("jsite.insert.starting"));
+               progressBar.setFont(progressBar.getFont().deriveFont(Font.PLAIN));
                projectInserter.start();
        }
 
        /**
+        * Sets whether to activate the debug mode.
+        * 
         * @param debug
-        *            The debug to set.
+        *            <code>true</code> to activate the debug mode,
+        *            <code>false</code> to deactivate.
         */
        public void setDebug(boolean debug) {
                projectInserter.setDebug(debug);
        }
 
        /**
+        * Sets the project to insert.
+        * 
         * @param project
-        *            The project to set.
+        *            The project to insert
         */
        public void setProject(final Project project) {
                projectInserter.setProject(project);
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
-                               StringBuffer uriBuffer = new StringBuffer();
-                               uriBuffer.append(project.getRequestURI());
-                               uriBuffer.append(project.getPath());
-                               if (project instanceof EditionProject) {
-                                       uriBuffer.append('-').append(((EditionProject) project).getEdition());
-                               }
-                               uriBuffer.append('/');
-                               requestURITextField.setText(uriBuffer.toString());
+                               requestURITextField.setText(project.getFinalRequestURI(1));
                        }
                });
        }
 
+       /**
+        * Sets the freenet interface to use.
+        * 
+        * @param freenetInterface
+        *            The freenet interface to use
+        */
        public void setFreenetInterface(Freenet7Interface freenetInterface) {
                projectInserter.setFreenetInterface(freenetInterface);
        }
@@ -154,6 +257,7 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener {
                startTime = System.currentTimeMillis();
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                startTimeLabel.setText(DateFormat.getDateTimeInstance().format(new Date(startTime)));
                        }
@@ -163,12 +267,36 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener {
        /**
         * {@inheritDoc}
         */
+       public void projectURIGenerated(Project project, final String uri) {
+               SwingUtilities.invokeLater(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
+                       public void run() {
+                               copyURIAction.setEnabled(true);
+                               requestURITextField.setText(uri);
+                       }
+               });
+       }
+
+       /**
+        * {@inheritDoc}
+        */
        public void projectInsertProgress(Project project, final int succeeded, final int failed, final int fatal, final int total, final boolean finalized) {
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                progressBar.setMaximum(total);
                                progressBar.setValue(succeeded + failed + fatal);
+                               int progress = (succeeded + failed + fatal) * 100 / total;
+                               StringBuilder progressString = new StringBuilder();
+                               progressString.append(progress).append("% (");
+                               progressString.append(succeeded + failed + fatal).append("/").append(total);
+                               progressString.append(")");
+                               progressBar.setString(progressString.toString());
+                               if (finalized) {
+                                       progressBar.setFont(progressBar.getFont().deriveFont(Font.BOLD));
+                               }
                        }
                });
        }
@@ -188,11 +316,37 @@ public class ProjectInsertPage extends TWizardPage implements InsertListener {
                }
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
+                               progressBar.setValue(progressBar.getMaximum());
+                               progressBar.setString(I18n.getMessage("jsite.insert.done"));
                                wizard.setNextEnabled(true);
                                wizard.setQuitEnabled(true);
                        }
                });
        }
 
+       //
+       // ACTIONS
+       //
+
+       /**
+        * Copies the request URI of the project to the clipboard.
+        */
+       private void actionCopyURI() {
+               Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
+               clipboard.setContents(new StringSelection(requestURITextField.getText()), this);
+       }
+
+       //
+       // INTERFACE ClipboardOwner
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       public void lostOwnership(Clipboard clipboard, Transferable contents) {
+               /* ignore. */
+       }
+
 }