Merge pull request #75 from CSC207-2022F-UofT/feature-edit-main-page

Feature edit main page

Author: ThomasShimUoft

.idea/misc.xml

@@ -9,8 +9,19 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * The main page to edit a flashcard set. Includes the view of all flashcards inside the flashcard set. Including
+ * features of editing title and description of flashcard set, editing independent flashcards, deleting flashcards, and
+ * add flashcards.
+ */
 public class EditorMainPage extends JFrame {
+    /**
+     * Constructs an EditorMainPage object which is a JFrame and constructor opens a new window and makes the frame
+     * visible.
+     * @param flashcardSetId the flashcard set id of the flashcard to edit
+     */
     public EditorMainPage(int flashcardSetId){
+        //Declare and initialize the database gateway, DBGateway.
         IFlashcardSetDataAccess fcSetGateway;
         IFlashcardDataAccess fcGateway;
         IUserDataAccess userGateway;
@@ -22,22 +33,23 @@ public EditorMainPage(int flashcardSetId){
         catch(IOException error){
             throw new RuntimeException("error: file not found");
         }
-
         DBGateway dbGateway = new DBGateway(fcGateway, fcSetGateway, userGateway);
 
+        //Get all the flashcards of the flashcard set.
         FlashcardSetDsRequestModel flashcardSet = fcSetGateway.getFlashcardSet(flashcardSetId);
-
         List<FlashcardDsRequestModel> flashcardData = new ArrayList<>();
         for(int flashcardId: flashcardSet.getFlashcardIds()){
             FlashcardDsRequestModel flashcard = fcGateway.getFlashcard(flashcardId);
             flashcardData.add(flashcard);
         }
+
+        //Create a panel that includes all the flashcards in the flashcard set and a panel with editing buttons.
         ListOfFlashcardsDataPanel listOfFlashcardPanel = new ListOfFlashcardsDataPanel(dbGateway ,flashcardData, flashcardSet, this);
         JScrollPane scrollPane = new JScrollPane(listOfFlashcardPanel);
         //scrollPane.setPreferredSize(new Dimension(100, 100));
         this.add(scrollPane);
 
-
+        //Customize this frame with the title of the flashcard, size of the  panel, and setting frame to be visible.
         this.setTitle("Edit Set \"" + flashcardSet.getTitle() + "\"");
         this.setSize(1000, 800);
         this.setVisible(true);

gradlew

@@ -12,31 +12,34 @@
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
 
+/**
+ * The panel for an individual flashcard. Includes buttons for deleting and editing flashcard for this flashcard.
+ */
 public class FlashcardDataPanel extends JPanel implements ActionListener, WindowListener {
     private final DBGateway dbGateway;
     private final FlashcardDsRequestModel flashcard;
     private final int flashcardSetId;
     JFrame frame;
+    /**
+     * Constructs a FlashcardDataPanel object that includes flashcard information and editing buttons.
+     */
     public FlashcardDataPanel(DBGateway dbGateway, FlashcardDsRequestModel flashcard, int flashcardSetId, JFrame frame){
         this.dbGateway = dbGateway;
         this.frame = frame;
         this.flashcard = flashcard;
         this.flashcardSetId = flashcardSetId;
 
-
+        //Includes flashcard information.
         Border border = BorderFactory.createTitledBorder(flashcard.getTerm());
-
         JLabel descriptionLabel = new JLabel(flashcard.getDefinition());
-
         this.add(descriptionLabel);
 
+        //Buttons for this flashcard panel.
         JPanel buttons = new JPanel();
-
         JButton edit = new JButton("Edit Flashcard");
         buttons.add(edit);
         JButton delete = new JButton("Delete Flashcard");
         buttons.add(delete);
-
         edit.addActionListener(this);
         delete.addActionListener(this);
 
@@ -45,7 +48,12 @@ public FlashcardDataPanel(DBGateway dbGateway, FlashcardDsRequestModel flashcard
         this.setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));
     }
 
-
+    /**
+     * Performs action when an event is listened to. When 'Edit flashcard' is clicked we create a FlashcardEditorMain
+     * object, which we open the flashcard editing page. When delete flashcard is clicked we create a FcRMain object,
+     * which we open the delete flashcard page.
+     * @param event the event to be processed
+     */
     @Override
     public void actionPerformed(ActionEvent event) {
         if(event.getActionCommand().equals("Edit Flashcard")){
@@ -64,6 +72,7 @@ public void windowOpened(WindowEvent e) {}
     public void windowClosing(WindowEvent e) {}
     @Override
     public void windowClosed(WindowEvent e) {
+        //When observing a window close we refresh the page.
         frame.dispose();
         new EditorMainPage(flashcardSetId);
     }

src/main/java/editor_main_page/EditorMainPage.java

@@ -15,21 +15,33 @@
 import java.awt.event.WindowListener;
 import java.util.List;
 
+/**
+ * A panel that includes buttons for flashcard set editing and another JPanel that includes all the
+ * FlashcardDataPanel objects.
+ */
 public class ListOfFlashcardsDataPanel extends JPanel implements ActionListener, WindowListener {
     private final DBGateway dbGateway;
     private final FlashcardSetDsRequestModel flashcardSet;
     JFrame frame;
 
     JPanel flashcardPanels;
 
+    /**
+     * Constructs a ListOfFlashcardsDataPanel object. Includes buttons for adding flashcards, editing flashcards and
+     * refreshing the page.
+     * @param dbGateway The database gateway to access the database information
+     * @param flashcardData All the flashcard information that was retrieved from the database
+     * @param flashcardSet The flashcard set information of this flashcard set
+     * @param frame The EditorMainPage in which this panel lies
+     */
     public ListOfFlashcardsDataPanel(DBGateway dbGateway, List<FlashcardDsRequestModel> flashcardData,
                                      FlashcardSetDsRequestModel flashcardSet, JFrame frame) {
         this.dbGateway = dbGateway;
         this.frame = frame;
         this.flashcardSet = flashcardSet;
-
         flashcardPanels = new JPanel();
 
+        //Buttons for adding flashcard, editing flashcard set, and refresh.
         JPanel buttons = new JPanel();
         JButton addFlashcard = new JButton("Add Flashcard");
         buttons.add(addFlashcard);
@@ -44,6 +56,8 @@ public ListOfFlashcardsDataPanel(DBGateway dbGateway, List<FlashcardDsRequestMod
 
         this.add(buttons);
 
+        //If there are no flashcards we show a label that states that there are no flashcards.
+        //If there are flashcards we show the flashcard information with a FlashcardDataPanel object.
         int numCards = flashcardData.size();
         if (numCards == 0){
             JLabel label = new JLabel("You have no Flashcards in this FlashcardSet.");
@@ -58,15 +72,25 @@ public ListOfFlashcardsDataPanel(DBGateway dbGateway, List<FlashcardDsRequestMod
                 flashcardPanels.add(new FlashcardDataPanel(dbGateway, flashcard, flashcardSet.getFlashcardSetId(),frame));
             }
         }
+        //flashcardPanels customization
         flashcardPanels.setLayout(new FlowLayout());
         flashcardPanels.setComponentOrientation(ComponentOrientation.LEFT_TO_RIGHT);
         flashcardPanels.setPreferredSize(new Dimension(1000,500));
+
+        //This panel customization
         this.add(flashcardPanels);
         this.setLayout(new FlowLayout());
         this.setComponentOrientation(ComponentOrientation.LEFT_TO_RIGHT);
         this.setPreferredSize(new Dimension(500, 1000));
     }
 
+    /**
+     * Performs action when an event is listened to. When 'Refresh is clicked we close this frame and open a new
+     * EditorMainPage. 'When 'Add flashcard' is clicked we create a FcCMain object, which we open the adding flashcard
+     * page. When 'Edit Flashcard Set' is clicked we create a FCSetEditorMain object, which we open the edit flashcard
+     * set page.
+     * @param event the event to be processed
+     */
     @Override
     public void actionPerformed(ActionEvent event) {
         if(event.getActionCommand().equals("Refresh")){
@@ -88,6 +112,7 @@ public void windowOpened(WindowEvent e) {}
     public void windowClosing(WindowEvent e) {}
     @Override
     public void windowClosed(WindowEvent e) {
+        //When observing a window close we refresh the page
         frame.dispose();
         new EditorMainPage(flashcardSet.getFlashcardSetId());
     }