Changeset 532 in tmcsimulator for trunk/src

Timestamp:

11/27/2019 07:56:32 AM (6 years ago)

Author:

jdalbey

Message:

Login.java, CADClient.java: Implement #206, login screen has drop down box of student names read from a config file.

Location:

trunk/src/tmcsim

Files:

• application.properties (modified) (1 diff)
• client/CADClient.java (modified) (7 diffs)
• client/cadclientgui/screens/Login.java (modified) (9 diffs)

trunk/src/tmcsim/application.properties

@@ -1 @@
-#Tue, 12 Nov 2019 08:57:23 -0800
+#Wed, 27 Nov 2019 09:34:13 -0800
 
-Application.revision=522
+Application.revision=531
 
-Application.buildnumber=198
+Application.buildnumber=199

trunk/src/tmcsim/client/CADClient.java

@@ -9 +9 @@
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
+import java.awt.image.BufferedImage;
+import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
@@ -19 +21 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import javax.imageio.ImageIO;
+import javax.swing.ImageIcon;
 import javax.swing.JDialog;
 
@@ -88 +92 @@
                 "CADRmiPort"), CLIENT_CAD_POS("CADPosition"), CLIENT_USER_ID(
                 "CADUserID"), KEYBOARD_TYPE("KeyboardType"), DISPLAY_TYPE(
-                "DisplayType");
+                "DisplayType"), STUDENT_NAMES_FILE("StudentNamesFile");
 
         public String name;
@@ -182 +186 @@
         // This ensures they all have access to each other and the data model
         theClientGUI.screen = new ScreenManager(theCoorInt);
-        theClientGUI.login = new Login();
+        theClientGUI.login = new Login(cadClientProp.getProperty(PROPERTIES.STUDENT_NAMES_FILE.name).trim());
         theClientGUI.client = this;
 
@@ -345 +349 @@
         // CAD Simulator's connection information.
         if (cadClientProp.getProperty(PROPERTIES.CAD_SIM_HOST.name) == null
-                || cadClientProp.getProperty(PROPERTIES.CAD_SIM_PORT.name) == null) {
+                || cadClientProp.getProperty(PROPERTIES.CAD_SIM_PORT.name) == null
+                || cadClientProp.getProperty(PROPERTIES.STUDENT_NAMES_FILE.name) == null) {
             cadClientLogger.logp(Level.SEVERE, "SimulationManager",
                     "Constructor", "Null value in properties file.");
@@ -522 +527 @@
     private JDialog createSplashScreen()
     {
-        final int dialogSize = 300;  // desired width and height of dialog
+        final int dialogSize = 268;  // desired width and height of dialog
         // create the dialog
         JDialog dlg = new JDialog(null,"VisiCAD loading",Dialog.ModalityType.MODELESS);
@@ -534 +539 @@
         // Add the msg to the center of the dialog
         dlg.add(dlgMsg,BorderLayout.CENTER); 
+        // Add TriTech banner to top of screen 
+        try {
+            BufferedImage myPicture = ImageIO.read(new File("images/CADMenuImages/Tritech.png"));
+            JLabel picLabel = new JLabel(new ImageIcon(myPicture));
+            dlg.add(picLabel, BorderLayout.NORTH);
+        } catch (IOException ex) {
+            Logger.getLogger(Login.class.getName()).log(Level.SEVERE, null, ex);
+        }        
         // Set how big we want the dialog to be
         dlg.setSize(dialogSize, dialogSize);

trunk/src/tmcsim/client/cadclientgui/screens/Login.java

@@ -1 +1 @@
 package tmcsim.client.cadclientgui.screens;
 
+import java.awt.BorderLayout;
 import java.awt.Color;
 import static java.awt.Component.LEFT_ALIGNMENT;
@@ -9 +10 @@
 import java.awt.event.KeyEvent;
 import java.awt.event.KeyListener;
+import java.awt.image.BufferedImage;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Scanner;
+import java.util.Vector;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import javax.imageio.ImageIO;
 import javax.swing.Box;
 import javax.swing.BoxLayout;
+import javax.swing.ImageIcon;
 import javax.swing.JButton;
+import javax.swing.JComboBox;
 import javax.swing.JFrame;
 import javax.swing.JLabel;
@@ -26 +42 @@
  * @author Vincent
  */
-public class Login extends JFrame implements KeyListener
+public class Login extends JFrame
 {
     private Box login;
-    private JTextField userNameField;
+    private JComboBox<String> userNameCombo;
     private JTextField passwordField;
     public static String kNamePrompt = "Enter your name";
-
-    public Login()
-    {
+    /** a list of student names that will be displayed on the login screen */
+    private Vector<String> students;
+    
+    public Login(String studentNamesFile)
+    {
+        readNamesFile(studentNamesFile);
         initView();
     }
 
+    /** 
+     * A list of student names is read from a file.  The intent is to allow the
+     * system operators to customize the login display for each training session
+     * with the names of participants in that training. 
+     * @param studentNamesFile the full path to a text file of student names
+     * @author jdalbey  ticket #206
+     */
+    private void readNamesFile(String studentNamesFile)
+    {
+        FileInputStream fis = null;
+        try {
+            // Prepare an input stream from the names file
+            fis = new FileInputStream(studentNamesFile);
+            // Scan the names into a string
+            Scanner s = new Scanner(fis).useDelimiter("\\A");
+            String out = s.next();
+            // split string into an array
+            String[] results = out.split("\\n");
+            // Initialize the student name list
+            students = new Vector();
+            // Make sure to truncate names before putting in list
+            for (String name: results)
+            {
+                String truncName = name.trim();
+                // Limit name length so it fits in the combo box
+                if (truncName.length() > 26)
+                {
+                    truncName = truncName.substring(0,25);
+                }
+                // Add the validated name to the list of students
+                students.add(truncName);
+            }
+            // Append the default name 
+            students.add("Anonymous Trainee");
+        } catch (FileNotFoundException ex) {
+            Logger.getLogger(Login.class.getName()).log(Level.SEVERE, null, ex);
+        } finally {
+            try {
+                fis.close();
+            } catch (IOException ex) {
+                Logger.getLogger(Login.class.getName()).log(Level.SEVERE, null, ex);
+            }
+        }
+    }
     private ActionListener newEnterActionListener()
     {
@@ -45 +108 @@
             {
                 setVisible(false);
-                // Check if user provided a username JD
-                String userEntry = userNameField.getText();
-                if (userEntry.equals(kNamePrompt))
-                {
-                    ScreenManager.setUserName("Anonymous Trainee");
-                }
-                else
-                {
-                    ScreenManager.setUserName(userEntry);
-                }
+                // Extract the selected student name from the combo box
+                String userEntry = (String) userNameCombo.getSelectedItem();
+                ScreenManager.setUserName(userEntry);
                 ScreenManager.openCADMenu();
                 ScreenManager.openAssignedIncidents();
@@ -60 +116 @@
                 ScreenManager.openPendingIncidents();
                 ScreenManager.openPowerlineUI();
+                // a secret password allows special permission
                 if (!passwordField.getText().equals("Dispatcher"))
                 {
@@ -81 +138 @@
     private void initView()
     {
+        // create a combo box containing the student names
+        userNameCombo = new JComboBox<String>(students);
+        // Create a scrollbar after ten names
+        userNameCombo.setMaximumRowCount(10);
+        userNameCombo.setForeground(Color.BLUE);
+        userNameCombo.setFont(new Font("Arial", Font.BOLD, 14));
+        
         login = new Box(BoxLayout.Y_AXIS);
         login.setAlignmentX(LEFT_ALIGNMENT);
         JPanel whiteBackground = new JPanel();
+        whiteBackground.setLayout(new BorderLayout());
         whiteBackground.setAlignmentX(LEFT_ALIGNMENT);
         whiteBackground.setBackground(Color.WHITE);
@@ -89 +154 @@
         whiteBackground.setMinimumSize(new Dimension(750, 150));
         whiteBackground.setPreferredSize(new Dimension(750, 150));
+        // Add TriTech banner to top of screen (ticket #205)
+        try {
+            BufferedImage myPicture = ImageIO.read(new File("images/TritechLoginBanner.png"));
+            JLabel picLabel = new JLabel(new ImageIcon(myPicture));
+            whiteBackground.add(picLabel, BorderLayout.CENTER);
+        } catch (IOException ex) {
+            Logger.getLogger(Login.class.getName()).log(Level.SEVERE, null, ex);
+        }
         login.add(whiteBackground);
 
@@ -134 +207 @@
         JLabel userNameLabel = new JLabel("User name ");
         userNameLabel.setForeground(Color.WHITE);
-        userNameField = new JTextField(kNamePrompt);
-        userNameField.addKeyListener(this);
-        userNameField.setForeground(Color.GRAY);
         Box userNameBox = new Box(BoxLayout.X_AXIS);
         userNameBox.setAlignmentX(LEFT_ALIGNMENT);
         userNameBox.add(Box.createHorizontalStrut(10));
         userNameBox.add(userNameLabel);
-        userNameBox.add(userNameField);
+        userNameBox.add(userNameCombo);
         leftBox.add(userNameBox);
 
@@ -212 +282 @@
         setVisible(true);
     }
-
-    /** 
-     * This keylistener removes the prompt displayed in the username text box
-     * the first time the user presses a key.  Fixes #96
-     * @author jdalbey
-     * @param evt 
-     */
-    public void keyPressed(KeyEvent evt) 
-    {
-        // See if the text in the box is the initial prompt
-        // If so, the user hasn't typed anything yet, this is the 1st keypress
-        // Even the shift key will be caught here.
-        if (userNameField.getText().equals(kNamePrompt))
-        {
-            userNameField.setText("");
-            // Change the text color from gray to black
-            userNameField.setForeground(Color.BLACK);
-        }
-    }
-
-    public void keyReleased(KeyEvent e) {}
-    public void keyTyped(KeyEvent e) {}
+    
+    /** Local main for unit testing */
+    public static void main(String[] args) 
+    {
+        new Login("config/student_names.txt");
+    }
+    
 }