Changeset 76 in tmcsimulator-scriptbuilder for trunk/src/scriptbuilder/gui

Timestamp:

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

Author:

bmcguffin

Message:

Added javadoc for several files.

Location:

trunk/src/scriptbuilder/gui

Files:

• IncidentEditorFrame.java (modified) (1 diff)
• IncidentPaletteFrame.java (modified) (5 diffs)
• drawers/TimeSliceDrawer.java (modified) (1 diff)
• panels/IncidentPaletteAddPanel.java (modified) (2 diffs)
• panels/TimeStampPanel.java (modified) (2 diffs)
• panels/TimelineTickPanel.java (modified) (3 diffs)

trunk/src/scriptbuilder/gui/IncidentEditorFrame.java

@@ -240 +240 @@
      * Constructor. Prep new script model, initialize the GUI, and add listeners
      * for all buttons.
+     * 
+     * @param theIncident the Script Incident which this window will edit.
      */
     public IncidentEditorFrame(ScriptIncident theIncident)

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();
         }
     }

trunk/src/scriptbuilder/gui/drawers/TimeSliceDrawer.java

@@ -103 +103 @@
      * @param g2d the graphics component
      * @param slice the timeSlice to draw
-     * @param collapsed if true, don't draw the event icons
      */
     public static void DrawScriptBuilderTimeSlice(Graphics2D g2d, TimeSlice slice)

trunk/src/scriptbuilder/gui/panels/IncidentPaletteAddPanel.java

@@ -22 +22 @@
 {
 
+    /**
+     * The script incident represented by this panel.
+     */
     public ScriptIncident incident;
 
@@ -27 +30 @@
 
     /**
-     * Creates new form IncidentPaletteAddPanel
+     * Create new IncidentPaletteAddPanel from the form.
+     *
+     * @param inc the incident to be represented in this panel.
+     * @param frame the parent palette which holds this panel.
      */
     public IncidentPaletteAddPanel(ScriptIncident inc, IncidentPaletteFrame frame)

trunk/src/scriptbuilder/gui/panels/TimeStampPanel.java

@@ -41 +41 @@
 
     /**
-     * Update the length interval and the dimensions of the panel. NOTE: This
-     * method implementation is an exact duplication of the update method in
-     * panels.TimelineTickPanel. I'm not sure if it actually accomplishes
-     * anything here.
+     * Update the length interval and the dimensions of the panel. This version
+     * of the method is used in the main script builder window.
      *
      * @param script The simulation script model
@@ -89 +87 @@
 
     /**
-     * Update the length interval and the dimensions of the panel. NOTE: This
-     * method implementation is an exact duplication of the update method in
-     * panels.TimelineTickPanel. I'm not sure if it actually accomplishes
-     * anything here.
+     * Update the length interval and the dimensions of the panel. This version
+     * of the method is used in the individual incident editor window.
      *
-     * @param script The simulation script model
+     * @param incident the incident which this window is editing.
      */
     public void update(ScriptIncident incident)

trunk/src/scriptbuilder/gui/panels/TimelineTickPanel.java

@@ -33 +33 @@
     private boolean focused = false;
 
-    public void setZoom(float zoom)
-    {
-        repaint();
-    }
-
+//    public void setZoom(float zoom)
+//    {
+//        repaint();
+//    }
     /**
      * Listener for the mouse. Is notified when the mouse enters, exits, or
@@ -99 +98 @@
     /**
      * Update the panel's dimensions based on number of events, zoom level, and
-     * which events are collapsed.
+     * which events are collapsed. The version of the method is used in the main
+     * script builder.
      *
      * @param script The main script model
@@ -136 +136 @@
     /**
      * Update the panel's dimensions based on number of events, zoom level, and
-     * which events are collapsed.
-     *
-     * @param script The main script model
+     * which events are collapsed. This version of the method is used in the
+     * individual incident editor.
+     *
+     * @param incident the incident being edited
      */
     public void update(ScriptIncident incident)