Final Commit

This is the completed enhancement. I have found this useful so I might
expand on it in the future, but for now I think I am finished with it.

Author: patrick-slagle

src/simplejavatexteditor/JavaAutoComplete.java

@@ -16,12 +16,14 @@
 import javax.swing.text.BadLocationException;
 
 /**
- * <h1>Auto complete functionality for java keywords, brackets and
+ * <h1>Auto complete functionality multiple programming languages, including brackets and
  * parentheses</h1>
  *
  * <p>
- * An ArrayList is created for the keywords and the brackets. If the word
- * currently being typed matches a word in the list, a Runnable inner class is
+ * An ArrayList is created for the keywords and the brackets.
+ * Logic for setting the content of the ArrayList is
+ * found in UI.java. If the word currently being typed
+ * matches a word in the list, a Runnable inner class is
  * implemented to handle the word completion.
  *
  * Two other inner classes are also used. The second one handles when the enter
@@ -42,6 +44,7 @@ public class JavaAutoComplete
     private ArrayList<String> words = new ArrayList<>();
 
     SupportedKeywords kw;
+
     //Keep track of when code completion
     //has been activated
     private enum Mode {
@@ -57,12 +60,8 @@ private enum Mode {
     private int pos;
     private String content;
 
-    public JavaAutoComplete(UI ui) {
-        this.ui = ui;
-        textArea = ui.getEditor();
-    }
-
     public JavaAutoComplete(UI ui, ArrayList<String> al) {
+        //Set the keywords
         words = al;
         kw = new SupportedKeywords();
         brackets = kw.getbrackets();
@@ -281,8 +280,4 @@ public void removeUpdate(DocumentEvent e) {
     @Override
     public void changedUpdate(DocumentEvent e) {
     }
-
-    public void removeListener() {
-        textArea.getDocument().removeDocumentListener(this);
-    }
 }

src/simplejavatexteditor/SupportedKeywords.java

@@ -2,6 +2,14 @@
 
 import java.util.ArrayList;
 
+/**
+ * <h1>A class to store the programming language keywords and
+ * provide access to them.</h1>
+ *
+ * <p>Makes multiple language support possible and makes adding new language
+ * support convenient. To add more keywords, add a string array and getters
+ * to this class. Then, update the switch statement in UI.java.</p>
+ */
 public class SupportedKeywords {
     private String[] java = {"abstract", "assert", "boolean",
             "break", "byte", "case", "catch", "char", "class", "const",
@@ -19,8 +27,8 @@ public class SupportedKeywords {
                 "typedef", "volatile", "char", "do", "extern", "if", "return", "static",
                 "union", "while", "asm", "dynamic_cast", "namespace", "reinterpret_cast", "try",
                 "bool", "explicit", "new", "static_cast", "typeid", "catch", "false", "operator",
-                "template", "typename", "class", "friend", "private", "this", "using", "const_cast", "inline",
-                "public", "throw", "virtual", "delete", "mutable", "protected", "true", "wchar_t", };
+                "template", "typename", "class", "friend", "private", "this", "using", "const_cast",
+                "inline", "public", "throw", "virtual", "delete", "mutable", "protected", "true", "wchar_t" };
 
     private String[] brackets = { "{", "(" };
     private String[] bCompletions = { "}", ")" };
@@ -31,18 +39,18 @@ public String[] getCppKeywords() {
         return cpp;
     }
     public ArrayList<String> getbracketCompletions() {
-        ArrayList<String> alist = new ArrayList<>();
+        ArrayList<String> al = new ArrayList<>();
         for(String completion : bCompletions) {
-            alist.add(completion);
+            al.add(completion);
         }
-        return alist;
+        return al;
     }
     public ArrayList<String> getbrackets() {
-        ArrayList<String> alist = new ArrayList<>();
+        ArrayList<String> al = new ArrayList<>();
         for(String completion : brackets) {
-            alist.add(completion);
+            al.add(completion);
         }
-        return alist;
+        return al;
     }
     public ArrayList<String> setKeywords(String[] arr) {
         ArrayList<String> al = new ArrayList<>();

src/simplejavatexteditor/UI.java

@@ -19,20 +19,23 @@
 package simplejavatexteditor;
 
 // GUI
+
 import javax.swing.*;
-import java.awt.BorderLayout;
-import java.awt.Container;
-import java.awt.Font;
-import java.awt.event.*;
-// Input Stream
-import java.io.*;
-// Various
+import javax.swing.border.Border;
+import java.awt.*;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.InputEvent;
+import java.awt.event.KeyEvent;
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileReader;
+import java.io.FileWriter;
 import java.util.ArrayList;
-import java.util.EventListener;
 import java.util.Scanner;
-import javax.swing.border.Border;
-import javax.swing.event.DocumentListener;
-import javax.xml.bind.Marshaller;
+
+// Input Stream
+// Various
 
 public class UI extends JFrame implements ActionListener {
 
@@ -43,7 +46,11 @@ public class UI extends JFrame implements ActionListener {
 	private final JMenu menuFile, menuEdit, menuFind, menuAbout;
 	private final JMenuItem newFile, openFile, saveFile, close, clearFile, quickFind, aboutMe, aboutSoftware;
 	private final JToolBar mainToolbar;
-        JButton newButton, openButton, saveButton, clearButton, quickButton, aboutMeButton, aboutButton, closeButton, spaceButton1, spaceButton2;
+        JButton newButton, openButton,
+				saveButton, clearButton,
+				quickButton, aboutMeButton,
+				aboutButton, closeButton,
+				spaceButton1, spaceButton2;
 
         //setup icons - File Menu
         private final ImageIcon newIcon = new ImageIcon("icons/new.png");
@@ -61,8 +68,8 @@ public class UI extends JFrame implements ActionListener {
         private final ImageIcon aboutMeIcon = new ImageIcon("icons/about_me.png");
         private final ImageIcon aboutIcon = new ImageIcon("icons/about.png");
 
-		private boolean hasListener = false;
-		JavaAutoComplete autocomplete;
+	JavaAutoComplete autocomplete;
+	private boolean hasListener = false;
 
 	public UI() {
 		container = getContentPane();
@@ -78,14 +85,10 @@ public UI() {
 
 		// Set a default font for the TextArea
 		textArea = new JTextArea("", 0,0);
-<<<<<<< Updated upstream
-		textArea.setFont(new Font("Century Gothic", Font.BOLD, 12)); 
-    		textArea.setTabSize(2);
-=======
 		textArea.setFont(new Font("Century Gothic", Font.BOLD, 12));
 		textArea.setTabSize(2);
-
->>>>>>> Stashed changes
+		textArea.setFont(new Font("Century Gothic", Font.BOLD, 12));
+		textArea.setTabSize(2);
 
 		// This is why we didn't have to worry about the size of the TextArea!
 		getContentPane().setLayout(new BorderLayout()); // the BorderLayout bit makes it fill it automatically
@@ -285,15 +288,24 @@ else if(e.getSource() == saveFile || e.getSource() == saveButton) {
 					// Close the file stream
 					out.close();
 
+					//If the user saves files with supported
+					//file types more than once, we need to remove
+					//previous listeners to avoid bugs.
 					if(hasListener) {
 						textArea.getDocument().removeDocumentListener(autocomplete);
 						hasListener = false;
 					}
 
+					//With the keywords located in a separate class,
+					//we can support multiple languages and not have to do
+					//much to add new ones.
 					SupportedKeywords kw = new SupportedKeywords();
 					ArrayList<String> arrayList;
 					String[] list = { ".java", ".cpp" };
 
+					//Iterate through the list, find the supported
+					//file extension, apply the appropriate getter method from
+					//the keyword class
 					for(int i = 0; i < list.length; i++) {
 						if(file.getName().endsWith(list[i])) {
 							switch(i) {
@@ -340,16 +352,4 @@ else if(e.getSource() == aboutSoftware || e.getSource() == aboutButton) {
 		}
 
 	}
-
-	/*
-	bool hasListener = false
-
-	for..
-	if..
-	if(hasListener) {
-		removeListener
-	}
-	switch..
-//It has a
-	 */
 }