add javadoc
[jSite.git] / src / de / todesbaum / jsite / gui / ProjectFilesPage.java
index 1b5b8c6..872650a 100644 (file)
@@ -31,7 +31,10 @@ import java.awt.event.KeyEvent;
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashSet;
+import java.util.Iterator;
 import java.util.List;
+import java.util.Set;
 
 import javax.swing.AbstractAction;
 import javax.swing.Action;
@@ -60,54 +63,91 @@ import javax.swing.event.ListSelectionListener;
 import javax.swing.text.BadLocationException;
 import javax.swing.text.Document;
 
-import de.todesbaum.jsite.application.EditionProject;
 import de.todesbaum.jsite.application.FileOption;
 import de.todesbaum.jsite.application.Project;
 import de.todesbaum.jsite.i18n.I18n;
+import de.todesbaum.jsite.i18n.I18nContainer;
 import de.todesbaum.util.mime.DefaultMIMETypes;
 import de.todesbaum.util.swing.TLabel;
 import de.todesbaum.util.swing.TWizard;
 import de.todesbaum.util.swing.TWizardPage;
 
 /**
- * @author David Roden <droden@gmail.com>
- * @version $Id: ProjectFilesPage.java 404 2006-03-26 02:11:03Z bombe $
+ * Wizard page that lets the user manage the files of a project.
+ * 
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  */
 public class ProjectFilesPage extends TWizardPage implements ActionListener, ListSelectionListener, DocumentListener, FileScannerListener, ChangeListener {
 
-       protected TWizard wizard;
-
-       protected Project project;
+       /** The project. */
+       private Project project;
 
+       /** The “scan files” action. */
        private Action scanAction;
+
+       /** The “edit container” action. */
        private Action editContainerAction;
+
+       /** The “add container” action. */
        private Action addContainerAction;
-       private Action deleteContainerAction;
 
-       protected JList projectFileList;
+       /** The “delete container” action. */
+       protected Action deleteContainerAction;
+
+       /** The list of project files. */
+       private JList projectFileList;
+
+       /** The “default file” checkbox. */
        private JCheckBox defaultFileCheckBox;
+
+       /** The “insert” checkbox. */
        private JCheckBox fileOptionsInsertCheckBox;
+
+       /** The “custom key” textfield. */
        private JTextField fileOptionsCustomKeyTextField;
+
+       /** The “mime type” combo box. */
        private JComboBox fileOptionsMIMETypeComboBox;
-       protected DefaultComboBoxModel containerComboBoxModel;
+
+       /** The “mime type” combo box model. */
+       private DefaultComboBoxModel containerComboBoxModel;
+
+       /** The “container” combo box. */
        private JComboBox fileOptionsContainerComboBox;
+
+       /** The “edition replacement range” spinner. */
        private JSpinner replaceEditionRangeSpinner;
+
+       /** The “replacement” check box. */
        private JCheckBox replacementCheckBox;
 
-       public ProjectFilesPage() {
-               super();
+       /**
+        * Creates a new project file page.
+        * 
+        * @param wizard
+        *            The wizard the page belongs to
+        */
+       public ProjectFilesPage(final TWizard wizard) {
+               super(wizard);
                pageInit();
        }
 
+       /**
+        * Initializes the page and all its actions and components.
+        */
        private void pageInit() {
                createActions();
                setLayout(new BorderLayout(12, 12));
                add(createProjectFilesPanel(), BorderLayout.CENTER);
        }
 
+       /**
+        * Creates all actions.
+        */
        private void createActions() {
                scanAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.rescan")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionScan();
                        }
@@ -117,6 +157,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
 
                addContainerAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.add-container")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionAddContainer();
                        }
@@ -126,6 +167,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
 
                editContainerAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.edit-container")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionEditContainer();
                        }
@@ -135,19 +177,46 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
 
                deleteContainerAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.delete-container")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionDeleteContainer();
                        }
                };
                deleteContainerAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project-files.action.delete-container.tooltip"));
                deleteContainerAction.setEnabled(false);
+
+               I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
+                       public void run() {
+                               scanAction.putValue(Action.NAME, I18n.getMessage("jsite.project-files.action.rescan"));
+                               scanAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project-files.action.rescan.tooltip"));
+                               addContainerAction.putValue(Action.NAME, I18n.getMessage("jsite.project-files.action.add-container"));
+                               addContainerAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project-files.action.add-container.tooltip"));
+                               editContainerAction.putValue(Action.NAME, I18n.getMessage("jsite.project-files.action.edit-container"));
+                               editContainerAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project-files.action.edit-container.tooltip"));
+                               deleteContainerAction.putValue(Action.NAME, I18n.getMessage("jsite.project-files.action.delete-container"));
+                               deleteContainerAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project-files.action.delete-container.tooltip"));
+                       }
+               });
        }
 
+       /**
+        * {@inheritDoc}
+        */
+       @Override
        public void pageAdded(TWizard wizard) {
-               this.wizard = wizard;
                actionScan();
+               this.wizard.setPreviousName(I18n.getMessage("jsite.wizard.previous"));
+               this.wizard.setNextName(I18n.getMessage("jsite.project-files.insert-now"));
+               this.wizard.setQuitName(I18n.getMessage("jsite.wizard.quit"));
        }
 
+       /**
+        * Creates the panel contains the project file list and options.
+        * 
+        * @return The created panel
+        */
        private JComponent createProjectFilesPanel() {
                JPanel projectFilesPanel = new JPanel(new BorderLayout(12, 12));
 
@@ -165,7 +234,8 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
 
                fileOptionsPanel.add(new JButton(scanAction), new GridBagConstraints(0, 0, 5, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0));
 
-               fileOptionsPanel.add(new JLabel("<html><b>" + I18n.getMessage("jsite.project-files.file-options") + "</b></html>"), new GridBagConstraints(0, 1, 5, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 0, 0, 0), 0, 0));
+               final JLabel fileOptionsLabel = new JLabel("<html><b>" + I18n.getMessage("jsite.project-files.file-options") + "</b></html>");
+               fileOptionsPanel.add(fileOptionsLabel, new GridBagConstraints(0, 1, 5, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 0, 0, 0), 0, 0));
 
                defaultFileCheckBox = new JCheckBox(I18n.getMessage("jsite.project-files.default"));
                defaultFileCheckBox.setToolTipText(I18n.getMessage("jsite.project-files.default.tooltip"));
@@ -189,7 +259,8 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsCustomKeyTextField.setEnabled(false);
                fileOptionsCustomKeyTextField.getDocument().addDocumentListener(this);
 
-               fileOptionsPanel.add(new TLabel(I18n.getMessage("jsite.project-files.custom-key"), KeyEvent.VK_K, fileOptionsCustomKeyTextField), new GridBagConstraints(0, 4, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
+               final TLabel customKeyLabel = new TLabel(I18n.getMessage("jsite.project-files.custom-key") + ":", KeyEvent.VK_K, fileOptionsCustomKeyTextField);
+               fileOptionsPanel.add(customKeyLabel, new GridBagConstraints(0, 4, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
                fileOptionsPanel.add(fileOptionsCustomKeyTextField, new GridBagConstraints(1, 4, 4, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
 
                fileOptionsMIMETypeComboBox = new JComboBox(DefaultMIMETypes.getAllMIMETypes());
@@ -198,7 +269,8 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsMIMETypeComboBox.addActionListener(this);
                fileOptionsMIMETypeComboBox.setEnabled(false);
 
-               fileOptionsPanel.add(new TLabel(I18n.getMessage("jsite.project-files.mime-type"), KeyEvent.VK_M, fileOptionsMIMETypeComboBox), new GridBagConstraints(0, 5, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
+               final TLabel mimeTypeLabel = new TLabel(I18n.getMessage("jsite.project-files.mime-type") + ":", KeyEvent.VK_M, fileOptionsMIMETypeComboBox);
+               fileOptionsPanel.add(mimeTypeLabel, new GridBagConstraints(0, 5, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
                fileOptionsPanel.add(fileOptionsMIMETypeComboBox, new GridBagConstraints(1, 5, 4, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
 
                containerComboBoxModel = new DefaultComboBoxModel();
@@ -208,7 +280,8 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsContainerComboBox.addActionListener(this);
                fileOptionsContainerComboBox.setEnabled(false);
 
-               fileOptionsPanel.add(new TLabel(I18n.getMessage("jsite.project-files.container"), KeyEvent.VK_C, fileOptionsContainerComboBox), new GridBagConstraints(0, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
+               final TLabel containerLabel = new TLabel(I18n.getMessage("jsite.project-files.container") + ":", KeyEvent.VK_C, fileOptionsContainerComboBox);
+               fileOptionsPanel.add(containerLabel, new GridBagConstraints(0, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
                fileOptionsPanel.add(fileOptionsContainerComboBox, new GridBagConstraints(1, 6, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
                fileOptionsPanel.add(new JButton(addContainerAction), new GridBagConstraints(2, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
                fileOptionsPanel.add(new JButton(editContainerAction), new GridBagConstraints(3, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
@@ -229,20 +302,61 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                replaceEditionRangeSpinner.setToolTipText(I18n.getMessage("jsite.project-files.replacement.edition-range.tooltip"));
                replaceEditionRangeSpinner.addChangeListener(this);
                replaceEditionRangeSpinner.setEnabled(false);
-               fileOptionsReplacementPanel.add(new JLabel(I18n.getMessage("jsite.project-files.replacement.edition-range")));
+               final JLabel editionRangeLabel = new JLabel(I18n.getMessage("jsite.project-files.replacement.edition-range"));
+               fileOptionsReplacementPanel.add(editionRangeLabel);
                fileOptionsReplacementPanel.add(replaceEditionRangeSpinner);
 
                fileOptionsPanel.add(fileOptionsReplacementPanel, new GridBagConstraints(0, 7, 5, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 18, 0, 0), 0, 0));
 
+               I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       @SuppressWarnings("synthetic-access")
+                       public void run() {
+                               fileOptionsLabel.setText("<html><b>" + I18n.getMessage("jsite.project-files.file-options") + "</b></html>");
+                               defaultFileCheckBox.setText(I18n.getMessage("jsite.project-files.default"));
+                               defaultFileCheckBox.setToolTipText(I18n.getMessage("jsite.project-files.default.tooltip"));
+                               fileOptionsInsertCheckBox.setText(I18n.getMessage("jsite.project-files.insert"));
+                               fileOptionsInsertCheckBox.setToolTipText(I18n.getMessage("jsite.project-files.insert.tooltip"));
+                               fileOptionsCustomKeyTextField.setToolTipText(I18n.getMessage("jsite.project-files.custom-key.tooltip"));
+                               customKeyLabel.setText(I18n.getMessage("jsite.project-files.custom-key") + ":");
+                               fileOptionsMIMETypeComboBox.setToolTipText(I18n.getMessage("jsite.project-files.mime-type.tooltip"));
+                               mimeTypeLabel.setText(I18n.getMessage("jsite.project-files.mime-type") + ":");
+                               fileOptionsContainerComboBox.setToolTipText(I18n.getMessage("jsite.project-files.container.tooltip"));
+                               containerLabel.setText(I18n.getMessage("jsite.project-files.container") + ":");
+                               replacementCheckBox.setText(I18n.getMessage("jsite.project-files.replacement"));
+                               replacementCheckBox.setToolTipText(I18n.getMessage("jsite.project-files.replacement.tooltip"));
+                               replaceEditionRangeSpinner.setToolTipText(I18n.getMessage("jsite.project-files.replacement.edition-range.tooltip"));
+                               editionRangeLabel.setText(I18n.getMessage("jsite.project-files.replacement.edition-range"));
+                       }
+               });
+
                return projectFilesPanel;
        }
 
-       public void setProject(Project project) {
+       /**
+        * Sets the project whose files to manage.
+        * 
+        * @param project
+        *            The project whose files to manage
+        */
+       public void setProject(final Project project) {
                this.project = project;
                setHeading(MessageFormat.format(I18n.getMessage("jsite.project-files.heading"), project.getName()));
                setDescription(I18n.getMessage("jsite.project-files.description"));
+               I18nContainer.getInstance().registerRunnable(new Runnable() {
+
+                       public void run() {
+                               setHeading(MessageFormat.format(I18n.getMessage("jsite.project-files.heading"), project.getName()));
+                               setDescription(I18n.getMessage("jsite.project-files.description"));
+                       }
+               });
        }
 
+       /**
+        * Returns a list of all project files.
+        * 
+        * @return All project files
+        */
        private List<String> getProjectFiles() {
                List<String> files = new ArrayList<String>();
                for (int index = 0, size = projectFileList.getModel().getSize(); index < size; index++) {
@@ -251,14 +365,17 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                return files;
        }
 
-       protected void rebuildContainerComboBox() {
+       /**
+        * Updates the container combo box model.
+        */
+       private void rebuildContainerComboBox() {
                /* scan files for containers */
                List<String> files = getProjectFiles();
                List<String> containers = new ArrayList<String>(); // ComboBoxModel
                // sucks. No
                // contains()!
                containers.add("");
-               for (String filename: files) {
+               for (String filename : files) {
                        String container = project.getFileOption(filename).getContainer();
                        if (!containers.contains(container)) {
                                containers.add(container);
@@ -266,7 +383,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                }
                Collections.sort(containers);
                containerComboBoxModel.removeAllElements();
-               for (String container: containers) {
+               for (String container : containers) {
                        containerComboBoxModel.addElement(container);
                }
        }
@@ -275,7 +392,10 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
        // ACTIONS
        //
 
-       protected void actionScan() {
+       /**
+        * Rescans the project’s files.
+        */
+       private void actionScan() {
                projectFileList.clearSelection();
                projectFileList.setListData(new Object[0]);
 
@@ -288,7 +408,10 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                new Thread(fileScanner).start();
        }
 
-       protected void actionAddContainer() {
+       /**
+        * Adds a container.
+        */
+       private void actionAddContainer() {
                String containerName = JOptionPane.showInputDialog(wizard, I18n.getMessage("jsite.project-files.action.add-container.message") + ":", null, JOptionPane.INFORMATION_MESSAGE);
                if (containerName == null) {
                        return;
@@ -301,7 +424,10 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsContainerComboBox.setSelectedItem(containerName);
        }
 
-       protected void actionEditContainer() {
+       /**
+        * Edits the container.
+        */
+       private void actionEditContainer() {
                String selectedFilename = (String) projectFileList.getSelectedValue();
                FileOption fileOption = project.getFileOption(selectedFilename);
                String oldContainerName = fileOption.getContainer();
@@ -315,7 +441,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                        return;
                }
                List<String> files = getProjectFiles();
-               for (String filename: files) {
+               for (String filename : files) {
                        fileOption = project.getFileOption(filename);
                        if (fileOption.getContainer().equals(oldContainerName)) {
                                fileOption.setContainer(containerName);
@@ -325,11 +451,14 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsContainerComboBox.setSelectedItem(containerName);
        }
 
-       protected void actionDeleteContainer() {
+       /**
+        * Deletes the container.
+        */
+       private void actionDeleteContainer() {
                if (JOptionPane.showConfirmDialog(wizard, I18n.getMessage("jsite.project-files.action.delete-container.message"), null, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) == JOptionPane.OK_OPTION) {
                        String containerName = (String) fileOptionsContainerComboBox.getSelectedItem();
                        List<String> files = getProjectFiles();
-                       for (String filename: files) {
+                       for (String filename : files) {
                                FileOption fileOption = project.getFileOption(filename);
                                if (fileOption.getContainer().equals(containerName)) {
                                        fileOption.setContainer("");
@@ -339,23 +468,41 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                }
        }
 
+       /**
+        * {@inheritDoc}
+        * <p>
+        * Updates the file list.
+        */
        public void fileScannerFinished(FileScanner fileScanner) {
                final boolean error = fileScanner.isError();
                if (!error) {
                        final List<String> files = fileScanner.getFiles();
                        SwingUtilities.invokeLater(new Runnable() {
 
+                               @SuppressWarnings("synthetic-access")
                                public void run() {
                                        projectFileList.setListData(files.toArray(new String[files.size()]));
                                        projectFileList.clearSelection();
                                        rebuildContainerComboBox();
                                }
                        });
+                       Set<String> entriesToRemove = new HashSet<String>();
+                       Iterator<String> filenames = project.getFileOptions().keySet().iterator();
+                       while (filenames.hasNext()) {
+                               String filename = filenames.next();
+                               if (!files.contains(filename)) {
+                                       entriesToRemove.add(filename);
+                               }
+                       }
+                       for (String filename : entriesToRemove) {
+                               project.setFileOption(filename, null);
+                       }
                } else {
                        JOptionPane.showMessageDialog(wizard, I18n.getMessage("jsite.project-files.scan-error"), null, JOptionPane.ERROR_MESSAGE);
                }
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                wizard.setPreviousEnabled(true);
                                wizard.setNextEnabled(!error);
@@ -434,7 +581,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                addContainerAction.setEnabled(enabled);
                editContainerAction.setEnabled(enabled);
                deleteContainerAction.setEnabled(enabled);
-               replacementCheckBox.setEnabled(enabled && insert && (project instanceof EditionProject));
+               replacementCheckBox.setEnabled(enabled && insert);
                if (filename != null) {
                        FileOption fileOption = project.getFileOption(filename);
                        defaultFileCheckBox.setSelected(filename.equals(project.getIndexFile()));
@@ -460,16 +607,25 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
        // INTERFACE DocumentListener
        //
 
+       /**
+        * Updates the options of the currently selected file with the changes made
+        * in the “custom key” textfield.
+        * 
+        * @param documentEvent
+        *            The document event to process
+        */
        private void processDocumentUpdate(DocumentEvent documentEvent) {
                String filename = (String) projectFileList.getSelectedValue();
-               if (filename == null)
+               if (filename == null) {
                        return;
+               }
                FileOption fileOption = project.getFileOption(filename);
                Document document = documentEvent.getDocument();
                try {
                        String text = document.getText(0, document.getLength());
                        fileOption.setCustomKey(text);
                } catch (BadLocationException ble1) {
+                       /* ignore. */
                }
        }
 
@@ -503,8 +659,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
         */
        public void stateChanged(ChangeEvent changeEvent) {
                String filename = (String) projectFileList.getSelectedValue();
-               if (filename == null)
+               if (filename == null) {
                        return;
+               }
                FileOption fileOption = project.getFileOption(filename);
                Object source = changeEvent.getSource();
                if (source instanceof JSpinner) {