Lab 4: GUI Enigma (Replacement)

View the video for this lab on YouTube

Setup

Use your solutions from Lab 1 for this assignment (or see the .class files at the bottom of these instructions if you did not receive full credit for that lab):

• Comms.java
• Rotor.java
• Enigma.java

You will be writing two additional files from scratch, so you should create them now:

• EnigmaGUI.java
• EnigmaFrame.java

Github setup

Use git, as discussed in Lab 0, to create a repo called gitusername-lab4, add these five files to it, and commit and push the changes to github. The timestamp of your invitation of the grader as a collaborator must be from this lab session.

Running your program

Run your lab on the command line by executing the following pipeline after compiling all your files:

java EnigmaGUI

Testing your lab

There is no test script for this lab. Your grade is based on running your GUI and testing different input/outputs.

Enigma GUI

In this lab, you are going to write a GUI wrapper around the Enigma program you wrote as part of lab-1.

Reviewing how Engima worked

If you recall, that lab required you to complete three classes

• Rotor : representing a rotor of an Engima Machine
• Enigma : representation of an Enigma Machine
• Comms : the communication (and main method) of an enigma machine.

To decrypt and encrypt, you provided the settings as command line arguments:

                  ,-- inner rotor initially positioned so X is on top
                  |,-- middle rotor initially positioned so # is on top
                  ||  ,-- outer rotor initially positioned so Y is on top
                  || /
java Comms 4 2 3 "X#Y" encrypt
           | | |
           | | `-- outer rotor is rotor 3
           | `-- middle rotor is rotor 2
           `-- inner rotor is rotor 4

And then the input and output on the command line

~/$ java Comms 1 2 3 "###" encrypt
AAA
NDU

~/$ java Comms 3 1 2 "SAT" encrypt
DO#YOUR#BEST#AND#KEEP#ON#KEEPIN#ON
ACAAFAEOZFWKBQKPXZOGIKXTNPEBDXWQCZ

~/$ java Comms 5 2 4 "EST" decrypt
CSHIAWDFGDCOE#EZKJHRWAZDDCBCILON#PKUJEXEXSHINZ
THE#NATIONAL#ANIMAL#OF#SCOTLAND#IS#THE#UNICORN

Building a GUI

The purpose of this lab is to wrap all that functionality into a GUI. For example, here is a screenshot of a GUI implementation that you should be able to achieve:

You must use the following GUI elements in completing this lab

• JComboBox : for selecting the rotor numbers
• JTextField : for selecting the start of the rotors
• JTextArea : for providing input to and output from Enigma
• JButton : for selecting encrypt or decrypt
• JLabel : for including other text references, such as “Inner” or “Middle”

You can use any layout scheme you want for including these elements, but it should look something similar to the screenshot and be obvious in how to use it. For reference, I only used the BorderLayout, but you may find other layouts effective here. (Hint: you may also find it useful to create additional JPanels which organize different parts of your GUI, like the settings and the input/output areas.)

Requirements

Grading rubric and submission

Use git, as discussed in lab zero, to submit your work in a repo called gitusername-lab4. You will be graded on the following: