Changeset 76 in tmcsimulator-scriptbuilder for trunk/src/scriptbuilder/gui/IncidentPaletteFrame.java

Timestamp:

08/25/2017 12:22:28 PM (9 years ago)

Author:

bmcguffin

Message:

Added javadoc for several files.

File:

• trunk/src/scriptbuilder/gui/IncidentPaletteFrame.java (modified) (5 diffs)

trunk/src/scriptbuilder/gui/IncidentPaletteFrame.java

@@ -31 +31 @@
     private SimulationScript dummyScript;
 
+    /**
+     * The list of incidents to be displayed in the palette.
+     */
     public ArrayList<ScriptIncident> incidentList;
 
@@ -36 +39 @@
 
     /**
-     * Creates new form IncidentPaletteFrame
+     * Create new IncidentPaletteFrame from the form.
+     *
+     * @param scr The currently running script, to which new incidents will be
+     * added.
      */
-    public IncidentPaletteFrame(SimulationScript s)
-    {
-        script = s;
+    public IncidentPaletteFrame(SimulationScript scr)
+    {
+        script = scr;
 
         panelAdd = new JPanel();
@@ -54 +60 @@
         incidentList = loadIncidentsFromFiles("Incidents");
 
-        recalculateList();
+        refresh();
 
     }
@@ -128 +134 @@
     }
 
-    private void recalculateList()
+    private void refresh()
     {
 
@@ -136 +142 @@
     }
 
+    /**
+     * Attempt to add an incident to the script. If successful, refresh the
+     * palette.
+     *
+     * @param incPanel the Add Panel which holds the incident to be added.
+     */
     public void addIncidentToScript(IncidentPaletteAddPanel incPanel)
     {
         if (script.addIncident(incPanel.incident))
         {
-            recalculateList();
+            refresh();
         }
     }