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

Timestamp:

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

Author:

bmcguffin

Message:

Added javadoc for several files.

Location:

trunk/src/scriptbuilder/gui/panels

Files:

• IncidentPaletteAddPanel.java (modified) (2 diffs)
• TimeStampPanel.java (modified) (2 diffs)
• TimelineTickPanel.java (modified) (3 diffs)

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)