add javadoc
[jSite2.git] / src / net / pterodactylus / jsite / gui / ProjectPanel.java
1 /*
2  * jSite2 - ProjectPanel.java -
3  * Copyright © 2008 David Roden
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 package net.pterodactylus.jsite.gui;
21
22 import java.awt.BorderLayout;
23 import java.awt.FlowLayout;
24 import java.awt.GridBagLayout;
25
26 import javax.swing.BorderFactory;
27 import javax.swing.JButton;
28 import javax.swing.JPanel;
29
30 import net.pterodactylus.jsite.core.Project;
31
32 /**
33  * A panel that contains all information about a project and lets the user edit
34  * the properties of the project.
35  *
36  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
37  * @version $Id$
38  */
39 public class ProjectPanel extends JPanel {
40
41         /** The Swing interface. */
42         private final SwingInterface swingInterface;
43
44         /** The project to show. */
45         private final Project project;
46
47         /**
48          * Creates a new project panel.
49          *
50          * @param swingInterface
51          *            The Swing interface
52          * @param project
53          *            The project to display
54          */
55         public ProjectPanel(SwingInterface swingInterface, Project project) {
56                 super(new BorderLayout(12, 12));
57                 this.swingInterface = swingInterface;
58                 this.project = project;
59                 initComponents();
60         }
61
62         //
63         // ACCESSORS
64         //
65
66         /**
67          * Returns the project that is displayed in this panel.
68          *
69          * @return The project of this panel
70          */
71         public Project getProject() {
72                 return project;
73         }
74
75         //
76         // PRIVATE METHODS
77         //
78
79         /**
80          * Initializes all components of the panel.
81          */
82         private void initComponents() {
83                 setBorder(BorderFactory.createEmptyBorder(12, 12, 12, 12));
84
85                 JPanel propertiesPanel = createPropertiesPanel();
86                 add(propertiesPanel, BorderLayout.CENTER);
87
88                 JPanel buttonPanel = createButtonPanel();
89                 add(buttonPanel, BorderLayout.PAGE_END);
90         }
91
92         /**
93          * Creates the properties panel.
94          *
95          * @return The properties panel
96          */
97         private JPanel createPropertiesPanel() {
98                 JPanel propertiesPanel = new JPanel(new GridBagLayout());
99
100                 return propertiesPanel;
101         }
102
103         /**
104          * Creates the button panel.
105          *
106          * @return The button panel
107          */
108         private JPanel createButtonPanel() {
109                 JPanel buttonPanel = new JPanel(new FlowLayout(FlowLayout.TRAILING, 12, 12));
110                 buttonPanel.setBorder(BorderFactory.createEmptyBorder(-12, -12, -12, -12));
111
112                 buttonPanel.add(new JButton(swingInterface.getDeleteProjectAction()));
113                 buttonPanel.add(new JButton(swingInterface.getCloneProjectAction()));
114
115                 return buttonPanel;
116         }
117
118 }