Index: trunk/src/scriptbuilder/structures/XMLWriter.java =================================================================== --- trunk/src/scriptbuilder/structures/XMLWriter.java (revision 46) +++ trunk/src/scriptbuilder/structures/XMLWriter.java (revision 76) @@ -8,4 +8,11 @@ { + /** + * XML-style opening tag. Example: if given string "my_tag", returns + * "". + * + * @param s the XML element to be included in the tag. + * @return the properly formatted tag + */ public static String openTag(String s) { @@ -13,4 +20,11 @@ } + /** + * XML-style closing tag. Example: if given string "my_tag", returns + * "". + * + * @param s the XML element to be included in the tag. + * @return the properly formatted tag + */ public static String closeTag(String s) { @@ -18,4 +32,11 @@ } + /** + * XML-style empty tag. Example: if given string "my_tag", returns + * "". + * + * @param s the XML element to be included in the tag. + * @return the properly formatted tag + */ public static String emptyTag(String s) { @@ -23,4 +44,12 @@ } + /** + * Creates a pair of XML open and close tags to wrap a simple line of data. + * Useful if only one element need be enclosed in this particular tag. + * + * @param s the data to be wrapped + * @param e the XML element represented by the data + * @return an XML string of the format some_data_goes_here + */ public static String simpleTag(String s, ELEMENT e) { Index: trunk/src/scriptbuilder/structures/TimeSlice.java =================================================================== --- trunk/src/scriptbuilder/structures/TimeSlice.java (revision 67) +++ trunk/src/scriptbuilder/structures/TimeSlice.java (revision 76) @@ -42,4 +42,5 @@ * @param seconds Number of seconds from the beginning of the simulation * that this timeslice occurs + * @param inc the incident to which this timeslice belongs. */ public TimeSlice(int seconds, ScriptIncident inc) Index: trunk/src/scriptbuilder/structures/I_XML_Writable.java =================================================================== --- trunk/src/scriptbuilder/structures/I_XML_Writable.java (revision 46) +++ trunk/src/scriptbuilder/structures/I_XML_Writable.java (revision 76) @@ -1,3 +1,2 @@ - package scriptbuilder.structures; @@ -8,4 +7,10 @@ public interface I_XML_Writable { + + /** + * Translate this object's data into an appropriate XML string. + * + * @return an XML-compliant string representing this object's data + */ String toXML(); } Index: trunk/src/scriptbuilder/structures/ScriptIncident.java =================================================================== --- trunk/src/scriptbuilder/structures/ScriptIncident.java (revision 58) +++ trunk/src/scriptbuilder/structures/ScriptIncident.java (revision 76) @@ -221,4 +221,9 @@ } + /** + * Write this incident, in proper XML form, to the file in question. + * + * @param f the destination savefile + */ public void saveIncidentToFile(File f) { @@ -298,4 +303,7 @@ { + /** + * The slice which has received focus in this event. + */ public TimeSlice slice; @@ -325,4 +333,7 @@ { + /** + * The incident which has received focus in this event. + */ public ScriptIncident incident; Index: trunk/src/scriptbuilder/structures/events/ActivityLogEvaluationEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/ActivityLogEvaluationEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/ActivityLogEvaluationEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public ActivityLogEvaluationEvent() { @@ -25,4 +28,7 @@ } + /** + * A list of the expected actions held by this evaluation event. + */ public ArrayList expectedAction = new ArrayList(); Index: trunk/src/scriptbuilder/structures/events/RadioEvaluationEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/RadioEvaluationEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/RadioEvaluationEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public RadioEvaluationEvent() { @@ -25,4 +28,7 @@ } + /** + * A list of the expected actions held by this evaluation event. + */ public ArrayList expectedAction = new ArrayList(); Index: trunk/src/scriptbuilder/structures/events/CADEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/CADEvent.java (revision 47) +++ trunk/src/scriptbuilder/structures/events/CADEvent.java (revision 76) @@ -21,4 +21,7 @@ { + /** + * Constructor. + */ public CADEvent() { @@ -26,6 +29,12 @@ } + /** + * True if this CAD event has sub-events. + */ public boolean hasSubEvents = false; + /** + * Description of this event. + */ public String detail = ""; Index: trunk/src/scriptbuilder/structures/events/CHPRadioEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/CHPRadioEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/CHPRadioEvent.java (revision 76) @@ -22,4 +22,7 @@ { + /** + * Constructor. + */ public CHPRadioEvent() { @@ -27,8 +30,17 @@ } + /** + * List of the lines of dialog in this event. + */ public ArrayList lines = new ArrayList(); + /** + * List of the corresponding roles for each line of dialog. + */ public ArrayList roles = new ArrayList(); + /** + * Path for the audio file to be played during this event. + */ public String radioFile = ""; Index: trunk/src/scriptbuilder/structures/events/FacilitatorEvaluationEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/FacilitatorEvaluationEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/FacilitatorEvaluationEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public FacilitatorEvaluationEvent() { @@ -25,4 +28,7 @@ } + /** + * A list of the expected actions held by this evaluation event. + */ public ArrayList expectedAction = new ArrayList(); Index: trunk/src/scriptbuilder/structures/events/ATMSEvaluationEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/ATMSEvaluationEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/ATMSEvaluationEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public ATMSEvaluationEvent() { @@ -25,4 +28,7 @@ } + /** + * A list of the expected actions held by this evaluation event. + */ public ArrayList expectedAction = new ArrayList(); Index: trunk/src/scriptbuilder/structures/events/CCTVEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/CCTVEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/CCTVEvent.java (revision 76) @@ -12,6 +12,6 @@ /** - * Data model for a CCTV event. (Just a stub; CCTV events aren't currently - * used.) A CCTV event has, for now, a string message. + * Data model for a CCTV event(Just a stub; CCTV events aren't currently + * used). A CCTV event has, for now, a string message. * * @author Bryan McGuffin @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public CCTVEvent() { @@ -25,4 +28,7 @@ } + /** + * The message represented by this event. + */ public String message = ""; Index: trunk/src/scriptbuilder/structures/events/ParamicsEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/ParamicsEvent.java (revision 47) +++ trunk/src/scriptbuilder/structures/events/ParamicsEvent.java (revision 76) @@ -21,4 +21,7 @@ { + /** + * Constructor. + */ public ParamicsEvent() { Index: trunk/src/scriptbuilder/structures/events/AudioEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/AudioEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/AudioEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public AudioEvent() { @@ -25,6 +28,12 @@ } + /** + * Length of the audio to be played, in seconds. + */ public Integer audioLength = 0; + /** + * File path for the audio file. + */ public String audioPath = ""; Index: trunk/src/scriptbuilder/structures/events/MaintenanceRadioEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/MaintenanceRadioEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/MaintenanceRadioEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public MaintenanceRadioEvent() { Index: trunk/src/scriptbuilder/structures/events/TowEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/TowEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/TowEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public TowEvent() { Index: trunk/src/scriptbuilder/structures/events/CMSEvaluationEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/CMSEvaluationEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/CMSEvaluationEvent.java (revision 76) @@ -21,4 +21,7 @@ { + /** + * Constructor. + */ public CMSEvaluationEvent() { Index: trunk/src/scriptbuilder/structures/events/CADEvaluationEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/CADEvaluationEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/CADEvaluationEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public CADEvaluationEvent() { @@ -25,4 +28,7 @@ } + /** + * A list of the expected actions held by this evaluation event. + */ public ArrayList expectedAction = new ArrayList(); Index: trunk/src/scriptbuilder/structures/events/UnitEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/UnitEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/UnitEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public UnitEvent() { Index: trunk/src/scriptbuilder/structures/events/TMTRadioEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/TMTRadioEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/TMTRadioEvent.java (revision 76) @@ -20,4 +20,7 @@ { + /** + * Constructor. + */ public TMTRadioEvent() { Index: trunk/src/scriptbuilder/structures/events/TelephoneEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/events/TelephoneEvent.java (revision 46) +++ trunk/src/scriptbuilder/structures/events/TelephoneEvent.java (revision 76) @@ -22,4 +22,7 @@ { + /** + * Constructor. + */ public TelephoneEvent() { Index: trunk/src/scriptbuilder/structures/ScriptEvent.java =================================================================== --- trunk/src/scriptbuilder/structures/ScriptEvent.java (revision 72) +++ trunk/src/scriptbuilder/structures/ScriptEvent.java (revision 76) @@ -18,5 +18,5 @@ * Compare the Script Events based on their type enum. * - * @param o the other script event to be compared + * @param a the other script event to be compared * @return -1, 0, or 1 depending on if this event's type comes before, * simultaneously, or after the other event's type in the enum list @@ -130,4 +130,10 @@ } + /** + * Generate a new script event object of the specified type. + * + * @param t the type of the script event + * @return a new I_ScriptEvent object matching the given type + */ public static I_ScriptEvent factoryByType(ScriptEventType t) { @@ -172,5 +178,11 @@ } } - + + /** + * Determines if the event in question is an evaluation event. + * + * @param event the event to be checked + * @return true if the event implements I_EvaluationEvent + */ public static boolean isEvaluationEvent(I_ScriptEvent event) { Index: trunk/src/scriptbuilder/structures/MyScriptHandler.java =================================================================== --- trunk/src/scriptbuilder/structures/MyScriptHandler.java (revision 45) +++ trunk/src/scriptbuilder/structures/MyScriptHandler.java (revision 76) @@ -241,8 +241,10 @@ /** * Constructor. Initializes incident map. - */ - public MyScriptHandler(SimulationScript s) - { - script = s; + * + * @param scr the script into which the XML file is being read + */ + public MyScriptHandler(SimulationScript scr) + { + script = scr; incidentMap = new TreeMap(); eventMap = new TreeMap(); @@ -255,5 +257,5 @@ * Get the list of incidents that have been parsed from the script file. * - * @returns Vector of Incident objects. + * @return Vector of Incident objects. */ public Vector getIncidents() @@ -265,5 +267,5 @@ * Get the list of units that have been parsed from the script file. * - * @returns Vector of Unit objects. + * @return Vector of Unit objects. */ public ArrayList getUnits() Index: trunk/src/scriptbuilder/structures/SimulationScript.java =================================================================== --- trunk/src/scriptbuilder/structures/SimulationScript.java (revision 65) +++ trunk/src/scriptbuilder/structures/SimulationScript.java (revision 76) @@ -50,6 +50,12 @@ }; + /** + * The file to which this script will be saved. + */ public File saveFile = null; + /** + * The name of this script. + */ public String title = ""; @@ -160,4 +166,10 @@ } + /** + * Add a new incident to the script. + * + * @param sci the incident to be added. + * @return true if there was enough room to add this incident. + */ public boolean addIncident(ScriptIncident sci) { @@ -170,4 +182,9 @@ } + /** + * Write this script, in proper XML format, to the file in question. + * + * @param f the destination savefile to be written. + */ public void saveScriptToFile(File f) { @@ -262,4 +279,10 @@ } + /** + * Counts the number of incidents currently running. + * + * @return the number of non-null incidents currently in the script. A + * number between 0 and INCIDENT_FILL_COUNT, inclusive. + */ public int incidentCount() { Index: trunk/src/scriptbuilder/gui/IncidentEditorFrame.java =================================================================== --- trunk/src/scriptbuilder/gui/IncidentEditorFrame.java (revision 73) +++ trunk/src/scriptbuilder/gui/IncidentEditorFrame.java (revision 76) @@ -240,4 +240,6 @@ * 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) Index: trunk/src/scriptbuilder/gui/panels/TimelineTickPanel.java =================================================================== --- trunk/src/scriptbuilder/gui/panels/TimelineTickPanel.java (revision 74) +++ trunk/src/scriptbuilder/gui/panels/TimelineTickPanel.java (revision 76) @@ -33,9 +33,8 @@ 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,5 +98,6 @@ /** * 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,7 +136,8 @@ /** * 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) Index: trunk/src/scriptbuilder/gui/panels/TimeStampPanel.java =================================================================== --- trunk/src/scriptbuilder/gui/panels/TimeStampPanel.java (revision 54) +++ trunk/src/scriptbuilder/gui/panels/TimeStampPanel.java (revision 76) @@ -41,8 +41,6 @@ /** - * 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,10 +87,8 @@ /** - * 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) Index: trunk/src/scriptbuilder/gui/panels/IncidentPaletteAddPanel.java =================================================================== --- trunk/src/scriptbuilder/gui/panels/IncidentPaletteAddPanel.java (revision 64) +++ trunk/src/scriptbuilder/gui/panels/IncidentPaletteAddPanel.java (revision 76) @@ -22,4 +22,7 @@ { + /** + * The script incident represented by this panel. + */ public ScriptIncident incident; @@ -27,5 +30,8 @@ /** - * 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) Index: trunk/src/scriptbuilder/gui/IncidentPaletteFrame.java =================================================================== --- trunk/src/scriptbuilder/gui/IncidentPaletteFrame.java (revision 73) +++ trunk/src/scriptbuilder/gui/IncidentPaletteFrame.java (revision 76) @@ -31,4 +31,7 @@ private SimulationScript dummyScript; + /** + * The list of incidents to be displayed in the palette. + */ public ArrayList incidentList; @@ -36,9 +39,12 @@ /** - * 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,5 +60,5 @@ incidentList = loadIncidentsFromFiles("Incidents"); - recalculateList(); + refresh(); } @@ -128,5 +134,5 @@ } - private void recalculateList() + private void refresh() { @@ -136,9 +142,15 @@ } + /** + * 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(); } } Index: trunk/src/scriptbuilder/gui/drawers/TimeSliceDrawer.java =================================================================== --- trunk/src/scriptbuilder/gui/drawers/TimeSliceDrawer.java (revision 53) +++ trunk/src/scriptbuilder/gui/drawers/TimeSliceDrawer.java (revision 76) @@ -103,5 +103,4 @@ * @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)