hide container section
[jSite.git] / src / de / todesbaum / jsite / gui / ProjectFilesPage.java
index 4ae819f..b5f4a26 100644 (file)
@@ -35,7 +35,6 @@ import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
-import java.util.Map.Entry;
 
 import javax.swing.AbstractAction;
 import javax.swing.Action;
@@ -74,42 +73,81 @@ import de.todesbaum.util.swing.TWizard;
 import de.todesbaum.util.swing.TWizardPage;
 
 /**
- * @author David Roden <droden@gmail.com>
- * @version $Id$
+ * 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 Project project;
+       /** The project. */
+       private Project project;
+
+       /** The “scan files” action. */
+       private Action scanAction;
+
+       /** The “edit container” action. */
+       private Action editContainerAction;
 
-       protected Action scanAction;
-       protected Action editContainerAction;
-       protected Action addContainerAction;
+       /** The “add container” action. */
+       private Action addContainerAction;
+
+       /** The “delete container” action. */
        protected Action deleteContainerAction;
 
-       protected JList projectFileList;
+       /** 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;
 
+       /**
+        * 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();
                        }
@@ -119,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();
                        }
@@ -128,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();
                        }
@@ -137,6 +177,7 @@ 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();
                        }
@@ -146,6 +187,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
 
                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"));
@@ -159,6 +201,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                });
        }
 
+       /**
+        * {@inheritDoc}
+        */
        @Override
        public void pageAdded(TWizard wizard) {
                actionScan();
@@ -167,6 +212,11 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                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));
 
@@ -217,6 +267,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsMIMETypeComboBox.setToolTipText(I18n.getMessage("jsite.project-files.mime-type.tooltip"));
                fileOptionsMIMETypeComboBox.setName("project-files.mime-type");
                fileOptionsMIMETypeComboBox.addActionListener(this);
+               fileOptionsMIMETypeComboBox.setEditable(true);
                fileOptionsMIMETypeComboBox.setEnabled(false);
 
                final TLabel mimeTypeLabel = new TLabel(I18n.getMessage("jsite.project-files.mime-type") + ":", KeyEvent.VK_M, fileOptionsMIMETypeComboBox);
@@ -229,13 +280,21 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsContainerComboBox.setName("project-files.container");
                fileOptionsContainerComboBox.addActionListener(this);
                fileOptionsContainerComboBox.setEnabled(false);
+               fileOptionsContainerComboBox.setVisible(false);
 
                final TLabel containerLabel = new TLabel(I18n.getMessage("jsite.project-files.container") + ":", KeyEvent.VK_C, fileOptionsContainerComboBox);
+               containerLabel.setVisible(false);
+               JButton addContainerButton = new JButton(addContainerAction);
+               addContainerButton.setVisible(false);
+               JButton editContainerButton = new JButton(editContainerAction);
+               editContainerButton.setVisible(false);
+               JButton deleteContainerButton = new JButton(deleteContainerAction);
+               deleteContainerButton.setVisible(false);
                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));
-               fileOptionsPanel.add(new JButton(deleteContainerAction), new GridBagConstraints(4, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
+               fileOptionsPanel.add(addContainerButton, 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(editContainerButton, new GridBagConstraints(3, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
+               fileOptionsPanel.add(deleteContainerButton, new GridBagConstraints(4, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
 
                JPanel fileOptionsReplacementPanel = new JPanel(new FlowLayout(FlowLayout.LEADING, 6, 6));
                fileOptionsReplacementPanel.setBorder(new EmptyBorder(-6, -6, -6, -6));
@@ -260,6 +319,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
 
                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"));
@@ -282,6 +342,12 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                return projectFilesPanel;
        }
 
+       /**
+        * 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()));
@@ -295,6 +361,11 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                });
        }
 
+       /**
+        * 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++) {
@@ -303,14 +374,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);
@@ -318,7 +392,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);
                }
        }
@@ -327,7 +401,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]);
 
@@ -340,7 +417,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;
@@ -353,7 +433,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();
@@ -367,7 +450,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);
@@ -377,11 +460,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("");
@@ -391,12 +477,18 @@ 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();
@@ -411,7 +503,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                                        entriesToRemove.add(filename);
                                }
                        }
-                       for (String filename: entriesToRemove) {
+                       for (String filename : entriesToRemove) {
                                project.setFileOption(filename, null);
                        }
                } else {
@@ -419,6 +511,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                }
                SwingUtilities.invokeLater(new Runnable() {
 
+                       @SuppressWarnings("synthetic-access")
                        public void run() {
                                wizard.setPreviousEnabled(true);
                                wizard.setNextEnabled(!error);
@@ -523,6 +616,13 @@ 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) {
@@ -534,6 +634,7 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                        String text = document.getText(0, document.getLength());
                        fileOption.setCustomKey(text);
                } catch (BadLocationException ble1) {
+                       /* ignore. */
                }
        }