hide container section
[jSite.git] / src / de / todesbaum / jsite / gui / ProjectFilesPage.java
index 3789ebd..b5f4a26 100644 (file)
@@ -73,39 +73,77 @@ 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 {
 
+       /** 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;
 
+       /** 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;
+
+       /** 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")) {
 
@@ -163,6 +201,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                });
        }
 
+       /**
+        * {@inheritDoc}
+        */
        @Override
        public void pageAdded(TWizard wizard) {
                actionScan();
@@ -171,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));
 
@@ -221,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);
@@ -233,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));
@@ -287,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()));
@@ -300,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++) {
@@ -308,6 +374,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                return files;
        }
 
+       /**
+        * Updates the container combo box model.
+        */
        private void rebuildContainerComboBox() {
                /* scan files for containers */
                List<String> files = getProjectFiles();
@@ -332,6 +401,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
        // ACTIONS
        //
 
+       /**
+        * Rescans the project’s files.
+        */
        private void actionScan() {
                projectFileList.clearSelection();
                projectFileList.setListData(new Object[0]);
@@ -345,6 +417,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                new Thread(fileScanner).start();
        }
 
+       /**
+        * 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) {
@@ -358,6 +433,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsContainerComboBox.setSelectedItem(containerName);
        }
 
+       /**
+        * Edits the container.
+        */
        private void actionEditContainer() {
                String selectedFilename = (String) projectFileList.getSelectedValue();
                FileOption fileOption = project.getFileOption(selectedFilename);
@@ -382,6 +460,9 @@ public class ProjectFilesPage extends TWizardPage implements ActionListener, Lis
                fileOptionsContainerComboBox.setSelectedItem(containerName);
        }
 
+       /**
+        * 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();
@@ -396,6 +477,11 @@ 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) {
@@ -530,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) {
@@ -541,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. */
                }
        }