updated

Author: Rustam-Z

README.md

@@ -28,4 +28,11 @@ Updated: December 13, 2020
 
 - https://www.youtube.com/watch?v=RxjXC1SM1A4
 
-- https://stackoverflow.com/questions/4246351/creating-random-colour-in-java
+- https://stackoverflow.com/questions/4246351/creating-random-colour-in-java
+
+- https://stackoverflow.com/questions/782265/how-do-i-use-swingworker-in-java
+
+- https://docs.oracle.com/javase/tutorial/essential/concurrency/sleep.html
+
+- https://stackoverflow.com/questions/1097366/java-swing-revalidate-vs-repaint
+

Sorting.java

@@ -1,35 +1,35 @@
+// Main GUI part of Sorting.
+
 import javax.swing.*;
 import java.awt.*;
 import java.awt.event.*;
 import java.util.*;
 
 public class Sorting extends Main {
+    // Object of the SortingAlgorithm, which includes the sorting algorithms
     SortingAlgorithm sortAlgo = new SortingAlgorithm();
 
-    // Panels
+    // Panels: pPanel1 - option bar, pPanel2 - visualization bar
     JPanel pPanel1, pPanel2;
 
-    // Sorting Buttons
-    JButton jbtRandomize, jbtMerge, jbtBubble, jbtInsertion, jbtSelection, jbtStart;  // Sorting Buttons
-
-    // Random Creator
-    Random rand = new Random();
+    // Option buttons for choosing sorting techniques, speed, and size of array
+    // Will be added to pPanel1
+    JButton jbtRandomize, jbtMerge, jbtBubble, jbtInsertion, jbtSelection, jbtStart;
 
     // Progress Bar
     JProgressBar jb1;
 
     Sorting(){
-        // Create Panel
         // Panel for options (bubble sort, insertion sort...)
         pPanel1 = new JPanel();        
         pPanel1.setLayout(new GridLayout(1, 7));
         pPanel1.setBackground(Color.CYAN);
 
-        // Panel for main algorithm
+        // Panel for visualization part
         pPanel2 = new JPanel();
         pPanel2.setLayout(new BorderLayout());
 
-        // Buttons for sorting
+        // Buttons
         jbtRandomize = new JButton("Randomize");//create button
         jbtMerge = new JButton("Merge Sort");//create button
         jbtBubble = new JButton("Bubble Sort");//create button
@@ -43,15 +43,15 @@ public class Sorting extends Main {
         // jb1.setValue(rand.nextInt(100));
         // jb1.setStringPainted(true);
 
-        // Adding elements to Panel 1
-        pPanel1.add(jbtRandomize); pPanel1.add(jbtMerge); pPanel1.add(jbtSelection);
-        pPanel1.add(jbtBubble); pPanel1.add(jbtInsertion); pPanel1.add(jbtStart);
+        // Adding elements to pPanel1
+        pPanel1.add(jbtRandomize); pPanel1.add(jbtStart);
+        pPanel1.add(jbtMerge); pPanel1.add(jbtSelection); pPanel1.add(jbtBubble); pPanel1.add(jbtInsertion);
 
-        // Adding elements to Panel 2
+        // Adding elements to pPanel2
         pPanel2.add(sortAlgo, BorderLayout.CENTER);
         // pPanel2.add(jb1, BorderLayout.WEST);
 
-        // Register listeners
+        // Register listener, event handling
         ListenerClass listener = new ListenerClass();
         jbtRandomize.addActionListener(listener);
         jbtMerge.addActionListener(listener);
@@ -60,18 +60,21 @@ public class Sorting extends Main {
         jbtSelection.addActionListener(listener);
         jbtStart.addActionListener(listener);
 
-        // Add Panels to the panel
+        // Add Panels to the Main JFrame
         add(pPanel1, BorderLayout.NORTH);
         add(pPanel2, BorderLayout.CENTER);
     }
 
     class ListenerClass implements ActionListener {
+        // Handles the Button operations
+
         public void actionPerformed(ActionEvent e) {
             if (e.getSource() == jbtRandomize) {
                 sortAlgo.initShuffler();
             }
-            else if (e.getSource() == jbtMerge)
+            else if (e.getSource() == jbtMerge) {
                 System.out.println("jbtMerge button clicked");
+            }
             else if (e.getSource() == jbtBubble) {
                 sortAlgo.bubbleSort(); // Bubble sort algotithm
                 sortAlgo.initShuffler(); // shuffling
@@ -82,13 +85,14 @@ else if (e.getSource() == jbtInsertion) {
                 sortAlgo.initShuffler(); // shuffling
                 System.out.println("jbtInsertion button clicked");
             }
-            else if (e.getSource() == jbtSelection)
+            else if (e.getSource() == jbtSelection) {
                 System.out.println("jbtSelection button clicked");
+            }
             else if (e.getSource() == jbtStart) {
                 System.out.println("jbtStart button clicked");
             }
-
             // setVisible(false); // will close the previous window
         }
-    } 
-}
+    } // ListenerClass
+
+} // Sorting

SortingAlgorithm.java

@@ -1,3 +1,5 @@
+// Implementation of Sorting algorithms
+
 import java.awt.Color;
 import java.awt.Dimension;
 import java.awt.Graphics;
@@ -20,22 +22,23 @@ public class SortingAlgorithm extends JPanel {
         setBackground(Color.BLACK);
         setPreferredSize(new Dimension(WIDTH, HEIGHT));
         initBarHeight(); // initialize the height of each bar
-        //initShuffler(); // shuffle each bar
+        // initShuffler(); // shuffle each bar
     }
 
     @Override
     public void paintComponent(Graphics g) {
         super.paintComponent(g);
 
-        Random random = new Random(); // Random
+        // Create randomizer
+        Random random = new Random(); 
 
         // Drawing the rectangles
         Graphics2D g2d = (Graphics2D)g;
         Rectangle2D.Float bar;
 
         for(int i = 0; i < SIZE; i++ ) {
             final float hue = random.nextFloat();
-            final float saturation = 0.9f;//1.0 for brilliant, 0.0 for dull
+            final float saturation = 0.9f; //1.0 for brilliant, 0.0 for dull
             final float luminance = 1.0f; //1.0 for brighter, 0.0 for black
 
             g2d.setColor(Color.getHSBColor(hue, saturation, luminance));
@@ -78,7 +81,7 @@ public Void doInBackground() throws InterruptedException {
     }
 
     public void bubbleSort() {
-        /*Buuble sort algorithm*/
+        /*Bubble sorting algorithm*/
         sorter = new SwingWorker<>() {
             @Override
             public Void doInBackground() throws InterruptedException {
@@ -89,7 +92,7 @@ public Void doInBackground() throws InterruptedException {
                             traversing_index--; // just for annimation
 
                             Thread.sleep(1); // controls the speed
-                            repaint(); //
+                            repaint(); // we need it because we ofter replace the contents of a JPanel
                         }
                     }   
                 }