add javadoc
[jSite.git] / src / de / todesbaum / jsite / gui / ProjectPage.java
index 78763ea..16e4dec 100644 (file)
@@ -68,30 +68,69 @@ import de.todesbaum.util.swing.TWizard;
 import de.todesbaum.util.swing.TWizardPage;
 
 /**
+ * Wizard page that lets the user manage his projects and start inserts.
+ * 
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  */
 public class ProjectPage extends TWizardPage implements ListSelectionListener, DocumentListener, ClipboardOwner {
 
+       /** The freenet interface. */
        private Freenet7Interface freenetInterface;
 
-       protected Action projectLocalPathBrowseAction;
-       protected Action projectAddAction;
-       protected Action projectDeleteAction;
-       protected Action projectCloneAction;
-       protected Action projectCopyURIAction;
-       protected Action projectGenerateKeyAction;
+       /** The “browse” action. */
+       private Action projectLocalPathBrowseAction;
 
+       /** The “add project” action. */
+       private Action projectAddAction;
+
+       /** The “delete project” action. */
+       private Action projectDeleteAction;
+
+       /** The “clone project” action. */
+       private Action projectCloneAction;
+
+       /** The “copy URI” action. */
+       private Action projectCopyURIAction;
+
+       /** The “generate key” action. */
+       private Action projectGenerateKeyAction;
+
+       /** The file chooser. */
        private JFileChooser pathChooser;
+
+       /** The project list model. */
        private SortedListModel projectListModel;
+
+       /** The project list scroll pane. */
        private JScrollPane projectScrollPane;
+
+       /** The project list. */
        private JList projectList;
+
+       /** The project name textfield. */
        private JTextField projectNameTextField;
+
+       /** The project description textfield. */
        private JTextField projectDescriptionTextField;
+
+       /** The local path textfield. */
        private JTextField projectLocalPathTextField;
+
+       /** The public key textfield. */
        private JTextField projectPublicKeyTextField;
+
+       /** The private key textfield. */
        private JTextField projectPrivateKeyTextField;
+
+       /** The project path textfield. */
        private JTextField projectPathTextField;
 
+       /**
+        * Creates a new project page.
+        * 
+        * @param wizard
+        *            The wizard this page belongs to
+        */
        public ProjectPage(final TWizard wizard) {
                super(wizard);
                setLayout(new BorderLayout(12, 12));
@@ -108,7 +147,10 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                });
        }
 
-       protected void dialogInit() {
+       /**
+        * Initializes the page.
+        */
+       private void dialogInit() {
                createActions();
 
                pathChooser = new JFileChooser();
@@ -136,20 +178,32 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
        }
 
        /**
+        * Adds the given listener to the list of listeners.
+        * 
+        * @param listener
+        *            The listener to add
         */
        public void addListSelectionListener(ListSelectionListener listener) {
                projectList.addListSelectionListener(listener);
        }
 
        /**
+        * Removes the given listener from the list of listeners.
+        * 
+        * @param listener
+        *            The listener to remove
         */
        public void removeListSelectionListener(ListSelectionListener listener) {
                projectList.removeListSelectionListener(listener);
        }
 
+       /**
+        * Creates all actions.
+        */
        private void createActions() {
                projectLocalPathBrowseAction = new AbstractAction(I18n.getMessage("jsite.project.action.browse")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionLocalPathBrowse();
                        }
@@ -160,6 +214,7 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
 
                projectAddAction = new AbstractAction(I18n.getMessage("jsite.project.action.add-project")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionAdd();
                        }
@@ -169,6 +224,7 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
 
                projectDeleteAction = new AbstractAction(I18n.getMessage("jsite.project.action.delete-project")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionDelete();
                        }
@@ -179,6 +235,7 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
 
                projectCloneAction = new AbstractAction(I18n.getMessage("jsite.project.action.clone-project")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionClone();
                        }
@@ -189,6 +246,7 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
 
                projectCopyURIAction = new AbstractAction(I18n.getMessage("jsite.project.action.copy-uri")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionCopyURI();
                        }
@@ -199,6 +257,7 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
 
                projectGenerateKeyAction = new AbstractAction(I18n.getMessage("jsite.project.action.generate-new-key")) {
 
+                       @SuppressWarnings("synthetic-access")
                        public void actionPerformed(ActionEvent actionEvent) {
                                actionGenerateNewKey();
                        }
@@ -228,6 +287,11 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                });
        }
 
+       /**
+        * Creates the information panel.
+        * 
+        * @return The information panel
+        */
        private JComponent createInformationPanel() {
                JPanel informationPanel = new JPanel(new BorderLayout(12, 12));
 
@@ -339,29 +403,54 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                return informationPanel;
        }
 
+       /**
+        * Sets the project list.
+        * 
+        * @param projects
+        *            The list of projects
+        */
        public void setProjects(Project[] projects) {
                projectListModel.clear();
-               for (Project project: projects) {
+               for (Project project : projects) {
                        projectListModel.add(project);
                }
        }
 
+       /**
+        * Returns the list of projects.
+        * 
+        * @return The list of projects
+        */
        public Project[] getProjects() {
                return (Project[]) projectListModel.toArray(new Project[projectListModel.size()]);
        }
 
        /**
+        * Sets the freenet interface to use.
+        * 
         * @param freenetInterface
-        *            The freenetInterface to set.
+        *            The freenetInterface to use
         */
        public void setFreenetInterface(Freenet7Interface freenetInterface) {
                this.freenetInterface = freenetInterface;
        }
 
+       /**
+        * Returns the currently selected project.
+        * 
+        * @return The currently selected project
+        */
        public Project getSelectedProject() {
                return (Project) projectList.getSelectedValue();
        }
 
+       /**
+        * Updates the currently selected project with changed information from a
+        * textfield.
+        * 
+        * @param documentEvent
+        *            The document event to process
+        */
        private void setTextField(DocumentEvent documentEvent) {
                Document document = documentEvent.getDocument();
                String propertyName = (String) document.getProperty("name");
@@ -386,6 +475,7 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                                project.setPath(text);
                        }
                } catch (BadLocationException e) {
+                       /* ignore. */
                }
        }
 
@@ -393,7 +483,10 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
        // ACTIONS
        //
 
-       protected void actionLocalPathBrowse() {
+       /**
+        * Lets the user choose a local path for a project.
+        */
+       private void actionLocalPathBrowse() {
                Project project = (Project) projectList.getSelectedValue();
                if (project == null) {
                        return;
@@ -404,7 +497,10 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                }
        }
 
-       protected void actionAdd() {
+       /**
+        * Adds a new project.
+        */
+       private void actionAdd() {
                String[] keyPair = null;
                if (!freenetInterface.hasNode()) {
                        JOptionPane.showMessageDialog(this, I18n.getMessage("jsite.project-files.no-node-selected"), null, JOptionPane.ERROR_MESSAGE);
@@ -427,7 +523,10 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                projectList.setSelectedIndex(projectListModel.size() - 1);
        }
 
-       protected void actionDelete() {
+       /**
+        * Deletes the currently selected project.
+        */
+       private void actionDelete() {
                int selectedIndex = projectList.getSelectedIndex();
                if (selectedIndex > -1) {
                        if (JOptionPane.showConfirmDialog(this, MessageFormat.format(I18n.getMessage("jsite.project.action.delete-project.confirm"), ((Project) projectList.getSelectedValue()).getName()), null, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) == JOptionPane.OK_OPTION) {
@@ -440,7 +539,10 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                }
        }
 
-       protected void actionClone() {
+       /**
+        * Clones the currently selected project.
+        */
+       private void actionClone() {
                int selectedIndex = projectList.getSelectedIndex();
                if (selectedIndex > -1) {
                        Project newProject = new Project((Project) projectList.getSelectedValue());
@@ -450,7 +552,11 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                }
        }
 
-       protected void actionCopyURI() {
+       /**
+        * Copies the request URI of the currently selected project to the
+        * clipboard.
+        */
+       private void actionCopyURI() {
                int selectedIndex = projectList.getSelectedIndex();
                if (selectedIndex > -1) {
                        Project selectedProject = (Project) projectList.getSelectedValue();
@@ -459,7 +565,10 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
                }
        }
 
-       protected void actionGenerateNewKey() {
+       /**
+        * Generates a new key for the currently selected project.
+        */
+       private void actionGenerateNewKey() {
                if (JOptionPane.showConfirmDialog(this, I18n.getMessage("jsite.project.warning.generate-new-key"), null, JOptionPane.OK_CANCEL_OPTION) == JOptionPane.CANCEL_OPTION) {
                        return;
                }
@@ -555,6 +664,7 @@ public class ProjectPage extends TWizardPage implements ListSelectionListener, D
         * {@inheritDoc}
         */
        public void lostOwnership(Clipboard clipboard, Transferable contents) {
+               /* ignore. */
        }
 
 }