feat(hw2): new map, docs

NeverBehave · NeverBehave · commit d11c8e89f74f · 2021-03-03T14:54:41.000-05:00
diff --git a/ConwayGameOfLifeWithGUI/docs/allclasses-index.html b/ConwayGameOfLifeWithGUI/docs/allclasses-index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>All Classes</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/allpackages-index.html b/ConwayGameOfLifeWithGUI/docs/allpackages-index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>All Packages</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/Cell.html b/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/Cell.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>Cell</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="declaration: package: com.luox6.conway, class: Cell">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/ConwayMap.html b/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/ConwayMap.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>ConwayMap</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="declaration: package: com.luox6.conway, class: ConwayMap">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/Main.html b/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/Main.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>Main</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="declaration: package: com.luox6.conway, class: Main">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/MapCollection.html b/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/MapCollection.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>MapCollection</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="declaration: package: com.luox6.conway, class: MapCollection">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/package-summary.html b/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/package-summary.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>com.luox6.conway</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="declaration: package: com.luox6.conway">
 <meta name="generator" content="javadoc/PackageWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/package-tree.html b/ConwayGameOfLifeWithGUI/docs/com/luox6/conway/package-tree.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>com.luox6.conway Class Hierarchy</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="tree: package: com.luox6.conway">
 <meta name="generator" content="javadoc/PackageTreeWriter">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/constant-values.html b/ConwayGameOfLifeWithGUI/docs/constant-values.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>Constant Field Values</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="summary of constants">
 <meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/deprecated-list.html b/ConwayGameOfLifeWithGUI/docs/deprecated-list.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>Deprecated List</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="deprecated elements">
 <meta name="generator" content="javadoc/DeprecatedListWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/help-doc.html b/ConwayGameOfLifeWithGUI/docs/help-doc.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>API Help</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/index-all.html b/ConwayGameOfLifeWithGUI/docs/index-all.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>Index</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="index">
 <meta name="generator" content="javadoc/SingleIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/docs/index.html b/ConwayGameOfLifeWithGUI/docs/index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>Generated Documentation (Untitled)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="index redirect">
 <meta name="generator" content="javadoc/IndexRedirectWriter">
 <link rel="canonical" href="com/luox6/conway/package-summary.html">
diff --git a/ConwayGameOfLifeWithGUI/docs/overview-tree.html b/ConwayGameOfLifeWithGUI/docs/overview-tree.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (15) on Sun Feb 28 03:56:03 EST 2021 -->
+<!-- Generated by javadoc (15) on Wed Mar 03 14:54:28 EST 2021 -->
 <title>Class Hierarchy</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2021-02-28">
+<meta name="dc.created" content="2021-03-03">
 <meta name="description" content="class tree">
 <meta name="generator" content="javadoc/TreeWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/ConwayGameOfLifeWithGUI/manuals/gui/manual/7.png b/ConwayGameOfLifeWithGUI/manuals/gui/manual/7.png
diff --git a/ConwayGameOfLifeWithGUI/manuals/gui/manual/8.png b/ConwayGameOfLifeWithGUI/manuals/gui/manual/8.png
diff --git a/ConwayGameOfLifeWithGUI/manuals/manual.md b/ConwayGameOfLifeWithGUI/manuals/manual.md
@@ -168,7 +168,7 @@ To start GUI, follow the command in `README.md` and when you see console appears
 
 ## Basic Usage
 
-The appearance of the Application may varies on differnt platform. For example, on Linux, it may looks like this: 
+The appearance of the Application may varies on different platforms. For example, on Linux, it may look like this: 
 
 ![](./gui/manual/1.png)
 
@@ -189,15 +189,15 @@ There are two ways to change map status:
 - Load file using File menu on the top
 - Manually click the map
 
-Each of the block is clickable and you may toggle the cell status (live or dead). However, this action can only be done before the simutaion has started. You will see a warning if you tried to changed the stage when simulation is in progress. 
+Each of the block is clickable, and you may toggle the cell status (live or dead). However, this action can only be done before the simutaion has started. You will see a warning if you tried to change the stage when simulation is in progress. 
 
 **Notice: You may find cell survival time > current tick index, that's because App counts initial LIVE cell with 1 tick survival time**
 
 ![](./gui/manual/3.png)
 
 #### Set as Begin
 
-However, if you still want to edit the map, you may use the button `Set as Begin` on the toolbar located on the left side of the map. This function will set current map as a new round of simulation so that you can edit the map and run the simulation from that point. 
+However, if you still want to edit the map, you may use the button `Set as Begin` on the toolbar located on the left side of the map. This function will set the current map as a new round of simulation so that you can edit the map and run the simulation from that point. 
 
 **Notice: this action will clear all survival times, previous maps, etc. and only keeps the cell statuses.**
 
@@ -206,6 +206,10 @@ However, if you still want to edit the map, you may use the button `Set as Begin
 
 If you want to reset the map but keeps the map row/col, click the button and a blank map will be set
 
+#### New Map
+
+If you want to manually set the map, click the button and enter the row and col you want accordingly. It will create an empty map with given size for you. Please note that all existing cell/map data will be destroyed.
+
 ### Load&Save
 
 You may also load and save the result for future usage. You may find these actions under `File` Menu.
@@ -231,9 +235,9 @@ When you click `Save Current map as...`, a dialog will ask for name and location
 
 ##### Filename format
 
-Since there may be multiple files generated at this point. To avoid file overwrite, string `%1d` in the filename format will be replaced with map index. 
+Since there may be multiple files generated at this point, to avoid overwriting result, string `%1d` in the filename format will be replaced with map index. 
 
-Click save button and choose a directory. Please be sure the directory **does not** contain other file with name that has the same output pattern, or it may be overwrite. 
+Click save button and choose a directory. Please be sure the directory **does not** contain other files with names that has the same output pattern, or it might be overwritten. 
 
 You may change the range save multiple different range. Once you have done, simply close the window by clicking the X on the top right.
 
@@ -247,24 +251,47 @@ You may change the UI of the application by editing configuration. To open confi
 
 #### Colors
 
-You may change the color of based on cell status and the text color over it. Simply click the color blocks on the right column and a color chooser will appear. 
+You may change the color of based on cell status, and the text color over it. Simply click the color blocks on the right column, and a color chooser will appear. 
 
-Once you have decided a color, click ok and you may find the map appear changed at the same time.
+Once you have decided a color, click ok, and you may find the map appear changed at the same time.
 
 #### Survival Time
 
-Click the checkbox to toggle number on the cell. You may found there is an update delay when there are many cells. 
+Click the checkbox to toggle number on the cell. You may find there is an update delay when there are many cells. 
 
 #### Shade Level
 
-If a cell is surviving a long time, its color will getting darker and darker. However, to avoid color being too dark and hard to distinguish, the Shade level here will catagorized cells' survival time and the total ticks passed. If the cell has survived most of the ticks, it will be X times darker than the new cells, where X is the setting value. The less the lighter (E.g. X - 1 times, but stop at 1). This value only defines the maximum it can reach.
+If a cell is surviving a long time, its color will get darker and darker. However, to avoid color being too dark and hard to distinguish, the Shade level here will categorize cells' survival time, and the total ticks passed. If the cell has survived most of the ticks, it will be X times darker than the new cells, where X is the setting value. The less the lighter (E.g. X - 1 times, but stop at 1). This value only defines the maximum it can reach.
 
-When the value is 1, no shade will apply. This number must be an positive number, or a warning will appear.
+When the value is 1, no shade will apply. This number must be a positive number, or a warning will appear.
 
 ---
 
-Once you have finished set upm you may close the configuration by clicking X on the top right. **Your changes will be save immediately after you have changed the value. For text field, please press ENTER to confirm your decision.**
+Once you have finished set up, you may close the configuration by clicking X on the top right. **Your changes will be saved immediately after you have changed the value. For text field, please press ENTER to confirm your decision.**
 
 ### Typing and number
 
-For shade level and ticks to go to, the input box accept a number. **Please press enter to confirm** and if the input given cannot be parsed as a valid number, a warning will be given. Please double check your input and try again.
+For shade level and ticks to go to, the input box accept a number. **Please press enter to confirm** and if the input given cannot be parsed as a valid number, a warning will be given. Please double check your input and try again.
+
+
+## Extra Tips
+
+### Toolbar can be dragged away from the main panel
+
+By holding the gray bar on the left side panel, you may drag the panel to another desire location and expand your working space.
+
+![](./gui/manual/7.png)
+
+If you want to restore the layout, simply click the X you the right top, and it will go back to the main frame.
+
+### Survival time emitted
+
+Sometimes you may find that the cells' survival time cannot fit the UI and won't show correctly. In this case, you may hover your mouse to the cell and its exact number will appear.
+
+![](./gui/manual/8.png)
+
+### Slow initialization time
+
+When the program is generating maps (new map, loading file), it might be slow to response. Please be patient. 
+
+After initialization, it is expected to have faster response time. The suggested size of the map is no larger than (200x200)
diff --git a/ConwayGameOfLifeWithGUI/manuals/manual.pdf b/ConwayGameOfLifeWithGUI/manuals/manual.pdf
diff --git a/ConwayGameOfLifeWithGUI/manuals/tests.md b/ConwayGameOfLifeWithGUI/manuals/tests.md
@@ -29,7 +29,7 @@ ConwayMap is the a map represents the status of cells
 
 #### MapCollection
 
-MapCollection is a collection of ConwayMap, represent a progress from a single map
+MapCollection is a collection of ConwayMap, represent continuous progress from a single map
 
 - map index increments
 - collection reset
@@ -90,13 +90,13 @@ Commands to run these examples have also listed in the manual. It is believed th
 
 Game rules are also tested at `example2.txt` and `example3.txt` by stepping through the generated files.
 
-You may find the expected output in `tests/result` section. Use `diff` for the file generated from the program with corresponded command -- these should be identical or it means something goes wrong.
+You may find the expected output in `tests/result` section. Use `diff` for the file generated from the program with corresponded command -- these should be identical, or it means something goes wrong.
 
 Some examples inspired by [Wikipedia](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life).
 
 ### GUI & Action test
 
-As the underlying data representation has both tested by unit test and the manual test section, for the GUI part, it is mostly focus whether the data bindings are working, or if target behaviors are reached.
+As the underlying data representation has both tested by the unit test and the manual test section, for the GUI part, it is mostly focused whether the data bindings are working, or if target behaviors are reached.
 
 #### Before simulation
 
@@ -110,31 +110,36 @@ You may find the status bar on the left bottom shown as "Ready to start"
 
 - warning when cell is pressed
 - calculated simulation status on the right bottom should be a positive number
-- top stepper number will changed as step forward and step back
+- top stepper number will change as step forward and step back
 - the number of live/dead cell on the bottom middle should update with the map
 
-**Notice: it is normal that the calculated simulation is 1 less then the cell survival time. The App calculated the survival at stage 0 with times 1**
+**Notice: it is normal that the calculated simulation is 1 less than the cell survival time. The App calculated the survival at stage 0 with times 1**
 
 #### Toolbar
 
 - `Set as Begin` should clear all cells' survival time (0 for dead, 1 for live)
+- `New Map` should pop up a dialog asking for row and give error if value cannot be parsed or less than 1 
 - `Reset` should set everything of the map to 0 but keep the row and col as the same
 - `Configuration` should invoke configuration panel
+- toolbar can be dragged out of the window and restore with no problem (by clicking the exit button of the pane)
 
 #### Save file
 
-- file with give name will appear and can be open via menu -> open file
+- file with given name will appear and can be open via a menu -> open file
 - range saving button result and override notice
 - filename format
 
+in the test folder, `example2-result` contains the result where saved range from 0 to 32, as a reference
+
 #### Configuration
 
 - setting persistence
 - setting update should immediately reflect to the board
-- cell color changes
+- cell color changes accordingly
 - hide/show cell survival time
-- cell shade changes
+- cell shade changes accordingly
 
 #### Warnings
 
-- At any time, the textfield expected number but failed to parse will give warning
+- at any time, textfields that expected number but failed to parse will give warning
+- at any time, if the action of textfield failed, the value will be restored to its previous value
diff --git a/ConwayGameOfLifeWithGUI/manuals/tests.pdf b/ConwayGameOfLifeWithGUI/manuals/tests.pdf
diff --git a/ConwayGameOfLifeWithGUI/src/com/luox6/conway/gui/GUIController.java b/ConwayGameOfLifeWithGUI/src/com/luox6/conway/gui/GUIController.java
diff --git a/ConwayGameOfLifeWithGUI/src/com/luox6/conway/gui/components/VisualActionPanel.java b/ConwayGameOfLifeWithGUI/src/com/luox6/conway/gui/components/VisualActionPanel.java
diff --git a/ConwayGameOfLifeWithGUI/src/com/luox6/conway/gui/factories/Dialog.java b/ConwayGameOfLifeWithGUI/src/com/luox6/conway/gui/factories/Dialog.java
