Dijiktra's Algo added again

Author: Med16-11

src/sortvisualiser/MainApp.java

@@ -7,36 +7,35 @@
 import javax.swing.SwingUtilities;
 
 public class MainApp {
-    private final JFrame window;
+    private final JFrame window;/*JFrame is a class of the javax.swing package. It provides GUI interface
+                                 Frame works like the main window where components like labels, buttons, textfields are added to create a GUI.*/
+    public static final int WIN_WIDTH = 1280; // Assigning width of main frame window
+    public static final int WIN_HEIGHT = 720; //Assigning height of main frame window
 
-    public static final int WIN_WIDTH = 1280;
-    public static final int WIN_HEIGHT = 720;
-
-    private final ArrayList<Screen> screens;
+    private final ArrayList<Screen> screens; // created a arraylist of type Screen
 
     public MainApp() {
-        screens = new ArrayList<>();
-        window = new JFrame ("Sort visualiser");
-        window.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
-        window.setVisible(true);
+        screens = new ArrayList<>();  // Initialising a new arraylist of screens
+        window = new JFrame ("Sort visualiser"); // Heading of GUI window
+        window.setVisible(true); // For making the GUI visible or not
     }
 
-    public Screen getCurrentScreen() {
+    public Screen getCurrentScreen() { //returns current screen
         return screens.get(screens.size() - 1);
     }
 
-    public void pushScreen(Screen screen) {
-        if (!screens.isEmpty()) {
+    public void pushScreen(Screen screen) {   //initialised a method to push screen that takes object of Screen class as parameter
+        if (!screens.isEmpty()) {             // if screen is not empty then remove the current screen from GUI
             window.remove(getCurrentScreen());
         }
-        screens.add(screen);
-        window.setContentPane(screen);
-        window.validate();
+        screens.add(screen);                   // If screen is empty, add a new screen to GUi
+        window.setContentPane(screen);         // Set the content pane through the screen object
+        window.validate();                     //Inbuilt function
         screen.onOpen();
     }
 
-    public void popScreen() {
-        if (!screens.isEmpty()) {
+    public void popScreen() {               //initiated a method to pop the window and screen on GUI
+        if (!screens.isEmpty()) {           // if screen is not empty then remove the window and screen
             Screen prev = getCurrentScreen();
             screens.remove(prev);
             window.remove(prev);
@@ -52,15 +51,14 @@ public void popScreen() {
         }
     }
 
-    public void start() {
+    public void start() {      // starts and push the main menu screen onto the GUI
         pushScreen(new MainMenuScreen(this));
         window.pack();
     }
 
-    public static void main(String... args) {
-        System.setProperty("sun.java2d.opengl", "true");
+    public static void main(String[] args) {
         SwingUtilities.invokeLater(() -> {
             new MainApp().start();
         });
     }
-}
+}

src/sortvisualiser/SortArray.java

@@ -21,8 +21,6 @@
 
 /**
  * The array that can be sorted
- *
- * @author mhops
  */
 public class SortArray extends JPanel {
     public static final int DEFAULT_WIN_WIDTH = 1280;
@@ -43,8 +41,14 @@ public class SortArray extends JPanel {
     private String tandComplexity = " ";
     private ISortAlgorithm algorithm;
     private long algorithmDelay = 0;
+<<<<<<< HEAD
     private final JSpinner spinner;
     //private int arrayChanges = 0; // Number of changes to the array the current algorithm has taken so far
+=======
+
+    private final JSpinner spinner;
+
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
 
     public SortArray() {
         setBackground(Color.DARK_GRAY);
@@ -145,7 +149,6 @@ public void paintComponent(Graphics g) {
             panelGraphics.drawString(" Current algorithm: " + algorithmName, 10, 30);
             panelGraphics.drawString(" Time Complexity & Space Complexity: " + tandComplexity, 10, 55);
             panelGraphics.drawString("Current step delay: " + algorithmDelay + "ms", 10, 80);
-//            panelGraphics.drawString("     Array Changes: " + arrayChanges, 10, 105);
 
             drawBars(panelGraphics);
         } finally {
@@ -239,4 +242,4 @@ public void setAlgorithm(ISortAlgorithm algorithm) {
         algorithmDelay = algorithm.getDelay();
         spinner.setValue((int) algorithm.getDelay());
     }
-}
+}

src/sortvisualiser/screens/MainMenuScreen.java

@@ -15,18 +15,27 @@
 import sortvisualiser.MainApp;
 import sortvisualiser.algorithms.*;
 
-
 public final class MainMenuScreen extends Screen {
+<<<<<<< HEAD
     private static final Color BACKGROUND_COLOUR = Color.BLUE; //defining color of background
     private final ArrayList<AlgorithmCheckBox> checkBoxes; 
 
     public MainMenuScreen(MainApp app) {
         super(app);
         checkBoxes = new ArrayList<>(); //array that contains the checkboxes
         setUpGUI();
+=======
+    private static final Color BACKGROUND_COLOUR = Color.BLUE;  // sets the background color
+    private final ArrayList<AlgorithmCheckBox> checkBoxes;  // creates an arraylist for the checkboxes in the GUI screen
+
+    public MainMenuScreen(MainApp app) {
+        super(app);
+        checkBoxes = new ArrayList<>();  // we initialised the checkbox arraylist
+        setUpGUI(); //called the setUpGUI method defined below
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
     }
 
-    private void addCheckBox(ISortAlgorithm algorithm, JPanel panel) {
+    private void addCheckBox(ISortAlgorithm algorithm, JPanel panel) { //add the checkboxes for sorting algos in the mainMenuScreen of GUI window
         JRadioButton box = new JRadioButton("", true);
         box.setAlignmentX(Component.LEFT_ALIGNMENT);
         box.setBackground(BACKGROUND_COLOUR);
@@ -35,19 +44,26 @@ private void addCheckBox(ISortAlgorithm algorithm, JPanel panel) {
         panel.add(box);
     }
 
-    private void initContainer(JPanel p) {
+    private void initContainer(JPanel p) { //Container class init() method
         p.setLayout(new BoxLayout(p, BoxLayout.PAGE_AXIS));
         p.setBackground(BACKGROUND_COLOUR);
     }
 
+<<<<<<< HEAD
     public void setUpGUI() {
         JPanel sortAlgorithmContainer = new JPanel(); 
         JPanel optionsContainer = new JPanel();
+=======
+    public void setUpGUI() { // method created to setup the GUI window, i.e setting background and alignment
+        JPanel sortAlgorithmContainer = new JPanel(); // object for sorting array window
+        JPanel optionsContainer = new JPanel();  // object for main menu class i.e, with the radio buttons for sort algos
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
         JPanel outerContainer = new JPanel();
         initContainer(this);
         initContainer(optionsContainer);
         initContainer(sortAlgorithmContainer);
 
+<<<<<<< HEAD
         outerContainer.setBackground(BACKGROUND_COLOUR);
         outerContainer.setLayout(new BoxLayout(outerContainer, BoxLayout.LINE_AXIS));
 
@@ -60,6 +76,10 @@ public void setUpGUI() {
         } catch (IOException e) {
             System.out.println("Unable to load logo");
         }
+=======
+        outerContainer.setBackground(BACKGROUND_COLOUR);  // set the background color
+        outerContainer.setLayout(new BoxLayout(outerContainer, BoxLayout.LINE_AXIS)); // set the layout
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
 
         sortAlgorithmContainer.setAlignmentX(Component.LEFT_ALIGNMENT);//Examples of components are the buttons, checkboxes, and scrollbars of a typical graphical user interface
         addCheckBox(new BubbleSort(),       sortAlgorithmContainer);
@@ -69,7 +89,12 @@ public void setUpGUI() {
         addCheckBox(new InsertionSort(),    sortAlgorithmContainer);
         addCheckBox(new RadixSort(),        sortAlgorithmContainer);
 
+<<<<<<< HEAD
         JButton startButton = new JButton("Start"); //button text
+=======
+
+        JButton startButton = new JButton("Start"); // start button for mainmenu in GUI
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
         startButton.addActionListener((ActionEvent e) -> {
             ArrayList<ISortAlgorithm> algorithms = new ArrayList<>();
             for (AlgorithmCheckBox cb : checkBoxes) {
@@ -97,7 +122,7 @@ public void setUpGUI() {
     }
 
     @Override
-    public void onOpen() {
+    public void onOpen() {  // unchecks all the radiobutton
         checkBoxes.forEach((box) -> {
             box.unselect();
 
@@ -129,4 +154,4 @@ public ISortAlgorithm getAlgorithm() {
         }
     }
 
-}
+}

src/sortvisualiser/screens/Screen.java

@@ -5,18 +5,27 @@
 import javax.swing.JPanel;
 import sortvisualiser.MainApp;
 
+<<<<<<< HEAD
 public abstract class Screen extends JPanel { //making a child class from parent class JPanel
     protected MainApp app; //protected keyword is an access modifier used for attributes, 
     //methods and constructors, making them accessible in the same package and subclasses
+=======
+public abstract class Screen extends JPanel {
+    protected MainApp app;   // object of MainApp class
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
 
     public Screen(MainApp app) {
-        this.app = app;
+        this.app = app;       // setter function
     }
 
     @Override
     public Dimension getPreferredSize() {
+<<<<<<< HEAD
         return new Dimension(WIN_WIDTH, WIN_HEIGHT); //se
+=======
+        return new Dimension(WIN_WIDTH, WIN_HEIGHT);    // return dimension of window
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
     }
 
-    public abstract void onOpen();
-}
+    public abstract void onOpen(); //abstract onOpen method used for starting a sort ting window from beginning
+}

src/sortvisualiser/screens/SortingVisualiserScreen.java

@@ -7,33 +7,37 @@
 import sortvisualiser.SortArray;
 import sortvisualiser.algorithms.ISortAlgorithm;
 
+<<<<<<< HEAD
 
 public final class SortingVisualiserScreen extends Screen { //The main class for the sort visualiser GUI
+=======
+public final class SortingVisualiserScreen extends Screen {
+>>>>>>> 6a5781b83e4af42e6dddad64f872c76d885b4356
     private final SortArray sortArray;
     private final ArrayList<ISortAlgorithm> sortQueue;
 
     /**
      * Creates the GUI
-     * @param algorithms List of algorithms to run for visualisation
-     * @param app The main application
+     * List of algorithms to run for visualisation
+     * app The main application
      */
     public SortingVisualiserScreen(ArrayList<ISortAlgorithm> algorithms, MainApp app) {
         super(app);
-        setLayout(new BorderLayout());
-        sortArray = new SortArray();
-        add(sortArray, BorderLayout.CENTER);
-        sortQueue = algorithms;
+        setLayout(new BorderLayout());   // sets the border of GUI window
+        sortArray = new SortArray();  // creates object of SortArray class
+        add(sortArray, BorderLayout.CENTER);    // adds the radiobutton for the selected sorting algorithm
+        sortQueue = algorithms; // adds the algorithm to teh arraylist
     }
 
-    private void longSleep() {
+    private void longSleep() {      // used for delay
         try {
             Thread.sleep(1000);
         } catch (InterruptedException ex) {
             ex.printStackTrace();
         }
     }
 
-    private void shuffleAndWait() {
+    private void shuffleAndWait() { // method for shuffling the rearranged arrays and changing their colors
         sortArray.shuffle();
         sortArray.resetColours();
         longSleep();
@@ -72,4 +76,4 @@ public void done() {
 
         swingWorker.execute();
     }
-}
+}