Refactoring (structure + doc)

1 files changed, 108 insertions, 56 deletions

diff --git a/src/esieequest/view/app/UserInterface.java b/src/esieequest/view/app/UserInterface.java
index 4f87ef6..b6035c5 100644
--- a/src/esieequest/view/app/UserInterface.java
+++ b/src/esieequest/view/app/UserInterface.java
@@ -1,29 +1,32 @@
 package esieequest.view.app;
 
-import javax.swing.JPanel;
-import javax.swing.JButton;
-import javax.swing.JTextPane;
-import javax.swing.JLabel;
-import javax.swing.border.EmptyBorder;
-
-import esieequest.controller.GameEngine;
-import esieequest.model.Game;
-import esieequest.view.View;
-
 import java.awt.BorderLayout;
 import java.awt.Dimension;
+import java.awt.Font;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.net.URL;
 import java.util.HashMap;
 
+import javax.swing.JButton;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
 import javax.swing.JTextField;
+import javax.swing.JTextPane;
+import javax.swing.border.EmptyBorder;
 
 import com.wordpress.tipsforjava.swing.StretchIcon;
 
-import java.awt.Font;
+import esieequest.controller.GameEngine;
+import esieequest.model.Game;
+import esieequest.view.View;
 
-public abstract class UserInterface implements View, ActionListener {
+/**
+ * The Swing based graphical user interface.
+ * 
+ * @author Pacien TRAN-GIRARD
+ */
+abstract class UserInterface implements View, ActionListener {
 
         protected Game game;
         private GameEngine gameEngine;
@@ -40,24 +43,27 @@ public abstract class UserInterface implements View, ActionListener {
         private JTextField inputField;
 
         /**
-         * Create the panel.
+         * The default constructor.
          */
         public UserInterface() {
                 this.buildUI();
                 this.inputField.addActionListener(this);
                 this.setControlsState(false);
-                inputField.setEnabled(true);
+                this.inputField.setEnabled(true);
         }
 
+        /**
+         * Creates the interface widgets.
+         */
         private void buildUI() {
                 this.layout = new JPanel();
                 this.layout.setLayout(new BorderLayout(0, 0));
 
-                JPanel menuPanel = new JPanel();
+                final JPanel menuPanel = new JPanel();
                 this.layout.add(menuPanel, BorderLayout.NORTH);
                 menuPanel.setLayout(new BorderLayout(0, 0));
 
-                JPanel questPanel = new JPanel();
+                final JPanel questPanel = new JPanel();
                 menuPanel.add(questPanel, BorderLayout.CENTER);
 
                 this.questTextPane = new JTextPane();
@@ -65,40 +71,40 @@ public abstract class UserInterface implements View, ActionListener {
                 this.questTextPane.setText("ESIEEquest");
                 questPanel.add(this.questTextPane);
 
-                JPanel gamePanel = new JPanel();
+                final JPanel gamePanel = new JPanel();
                 menuPanel.add(gamePanel, BorderLayout.WEST);
 
-                JButton newButton = new JButton("New");
+                final JButton newButton = new JButton("New");
                 newButton.setToolTipText("New game");
                 gamePanel.add(newButton);
 
-                JButton soundButton = new JButton("Sound");
+                final JButton soundButton = new JButton("Sound");
                 soundButton.setToolTipText("Toggle sound");
                 gamePanel.add(soundButton);
 
-                JPanel filePanel = new JPanel();
+                final JPanel filePanel = new JPanel();
                 menuPanel.add(filePanel, BorderLayout.EAST);
 
-                JButton loadButton = new JButton("Load");
+                final JButton loadButton = new JButton("Load");
                 loadButton.setToolTipText("Load a game");
                 filePanel.add(loadButton);
 
-                JButton saveButton = new JButton("Save");
+                final JButton saveButton = new JButton("Save");
                 saveButton.setToolTipText("Save the current game");
                 filePanel.add(saveButton);
 
-                JPanel imagePanel = new JPanel();
-                layout.add(imagePanel, BorderLayout.CENTER);
+                final JPanel imagePanel = new JPanel();
+                this.layout.add(imagePanel, BorderLayout.CENTER);
                 imagePanel.setLayout(new BorderLayout(0, 0));
 
                 this.imageLabel = new JLabel();
                 imagePanel.add(this.imageLabel);
 
-                JPanel userPanel = new JPanel();
+                final JPanel userPanel = new JPanel();
                 this.layout.add(userPanel, BorderLayout.SOUTH);
                 userPanel.setLayout(new BorderLayout(0, 0));
 
-                JPanel dispPanel = new JPanel();
+                final JPanel dispPanel = new JPanel();
                 dispPanel.setBorder(new EmptyBorder(5, 5, 5, 0));
                 userPanel.add(dispPanel, BorderLayout.CENTER);
                 dispPanel.setLayout(new BorderLayout(0, 0));
@@ -108,54 +114,54 @@ public abstract class UserInterface implements View, ActionListener {
                 this.infoTextPane.setText("Welcome to ESIEEquest!");
                 dispPanel.add(this.infoTextPane);
 
-                inputField = new JTextField();
-                dispPanel.add(inputField, BorderLayout.SOUTH);
-                inputField.setColumns(10);
+                this.inputField = new JTextField();
+                dispPanel.add(this.inputField, BorderLayout.SOUTH);
+                this.inputField.setColumns(10);
 
-                JPanel controlPanel = new JPanel();
+                final JPanel controlPanel = new JPanel();
                 controlPanel.setBorder(new EmptyBorder(5, 5, 5, 5));
                 userPanel.add(controlPanel, BorderLayout.EAST);
                 controlPanel.setLayout(new BorderLayout(0, 0));
 
-                JPanel topControlPanel = new JPanel();
+                final JPanel topControlPanel = new JPanel();
                 controlPanel.add(topControlPanel, BorderLayout.NORTH);
                 topControlPanel.setLayout(new BorderLayout(0, 0));
 
-                JButton forwardButton = new JButton("↥");
+                final JButton forwardButton = new JButton("↥");
                 forwardButton.setFont(new Font("Dialog", Font.BOLD, 19));
                 forwardButton.setToolTipText("Go forward");
                 topControlPanel.add(forwardButton, BorderLayout.CENTER);
 
-                JButton inventoryButton = new JButton("⇱");
+                final JButton inventoryButton = new JButton("⇱");
                 inventoryButton.setFont(new Font("Dialog", Font.BOLD, 19));
                 inventoryButton.setToolTipText("Use item");
                 topControlPanel.add(inventoryButton, BorderLayout.WEST);
 
-                JButton actionButton = new JButton("⇲");
+                final JButton actionButton = new JButton("⇲");
                 actionButton.setFont(new Font("Dialog", Font.BOLD, 19));
                 actionButton.setToolTipText("Talk/Take item");
                 topControlPanel.add(actionButton, BorderLayout.EAST);
 
-                JPanel bottomControlPanel = new JPanel();
+                final JPanel bottomControlPanel = new JPanel();
                 controlPanel.add(bottomControlPanel, BorderLayout.SOUTH);