[Gridarta-commit] SF.net SVN: gridarta:[8168] trunk/src/app/net/sf/gridarta/gui/ gameobjectattributespanel/EventsTab.java

[<aki...@us...>]

Revision: 8168
          http://gridarta.svn.sourceforge.net/gridarta/?rev=8168&view=rev
Author:   akirschbaum
Date:     2010-06-06 10:47:47 +0000 (Sun, 06 Jun 2010)

Log Message:
-----------
Add comments.

Modified Paths:
--------------
    trunk/src/app/net/sf/gridarta/gui/gameobjectattributespanel/EventsTab.java

Modified: trunk/src/app/net/sf/gridarta/gui/gameobjectattributespanel/EventsTab.java
===================================================================
--- trunk/src/app/net/sf/gridarta/gui/gameobjectattributespanel/EventsTab.java	2010-06-06 10:43:45 UTC (rev 8167)
+++ trunk/src/app/net/sf/gridarta/gui/gameobjectattributespanel/EventsTab.java	2010-06-06 10:47:47 UTC (rev 8168)
@@ -57,10 +57,8 @@
  */
 public class EventsTab<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractGameObjectAttributesTab<G, A, R> {
 
-    // constants for the 'task' parameter in editEvent()
-
     /**
-     * The action builder.
+     * The {@link ActionBuilder}.
      */
     @NotNull
     private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
@@ -72,7 +70,7 @@
     private final Frame parent;
 
     /**
-     * The map manager.
+     * The {@link MapManager}.
      */
     @NotNull
     private final MapManager<G, A, R> mapManager;
@@ -113,23 +111,39 @@
     @NotNull
     private final JScrollPane ssa;
 
+    /**
+     * The action for "add new event".
+     */
     @NotNull
     private final Action aEventAddNew = ACTION_BUILDER.createAction(false, "eventAddNew", this);
 
+    /**
+     * The action for "edit event parameters".
+     */
     @NotNull
     private final Action aEventEditData = ACTION_BUILDER.createAction(false, "eventEditData", this);
 
+    /**
+     * The action for "edit event code".
+     */
     @NotNull
     private final Action aEventEdit = ACTION_BUILDER.createAction(false, "eventEdit", this);
 
+    /**
+     * The action for "remove event".
+     */
     @NotNull
     private final Action aEventRemove = ACTION_BUILDER.createAction(false, "eventRemove", this);
 
+    /**
+     * The {@link JList} that shows all events.
+     */
     @NotNull
     private final JList eventList = new JList();
 
     /**
-     * The currently selected game object.
+     * The currently selected game object. Set to <code>null</code> if none is
+     * selected.
      */
     @Nullable
     private GameObject<G, A, R> selectedGameObject = null;
@@ -153,14 +167,12 @@
         this.scriptArchDataUtils = scriptArchDataUtils;
         this.scriptArchUtils = scriptArchUtils;
 
-        // create ScrollPane for list scrolling
         ssa = new JScrollPane(eventList);
         ssa.setBorder(new EtchedBorder());
         ssa.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);
         ssa.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
         ssa.setPreferredSize(new Dimension(80, 40));
 
-        // create buttons
         final Container grid = new JPanel(new GridLayout(4, 1));
         grid.add(new JButton(aEventAddNew));
         grid.add(new JButton(aEventEditData));
@@ -354,4 +366,4 @@
         aEventRemove.setEnabled(removeButton);
     }
 
-}
+} // class EventsTab


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.