Refactor HomeScreen Controller - Create Tab Screen Classes and Add JavaDocs

[pwgit-create]

Description:

This task involves refactoring the HomeScreen controller by breaking out parts of its code into separate tab
screen classes. Additionally, we'll create a base class for these tabs as suggested by Stefan and agreed upon by
pwgit.

We also need to add JavaDoc comments above all existing screen classes and methods in the new tab classes (and
other undocumented parts) to improve documentation consistency and maintainability.

Current HomeScreen Code:

public class HomeScreen extends BaseScreen {
    /**
     * The root panel containing all other UI components.
     */
    private JPanel rootPanel;

    // Other fields, methods, and logic...

    @Override
    protected String getScreenName() {
        return "Home";
    }

    @Override
    public JPanel getRootPanel() {
        return rootPanel;
    }

    /**
     * Returns the button used to add a new directory.
     *
     * @return JButton representing the "Add New Directory" button.
     */
    public JButton getAddNewDirectoryButton() {
        return newDirectoryButton;
    }

    // Other getter methods...
}

Tasks:

1. Break down HomeScreen code into separate tab screen classes:

   • Extract functionality related to each tab (home, scan, recent diffs, settings, files) into their own
     respective classes.
   • Ensure each class extends a new base tab class.

2. Create a Base Tab Class:

   • Develop a common base class for all tab screens with shared functionality and properties.

3. Add JavaDoc Comments:

   • Add comprehensive JavaDoc comments above the class name in all existing screens (including HomeScreen).
   • Add JavaDoc comments to methods and other undocumented parts of both existing and new classes.

4. Update HomeScreen Controller:

   • Ensure the HomeScreen class now delegates tab-specific functionality to their respective tab classes.
   • Maintain consistent behavior and UI structure as in the current implementation.

5. Testing:

   • Thoroughly test the refactored code to ensure all functionality works correctly.
   • Verify that JavaDoc comments are correctly formatted and informative.

---

Acceptance Criteria:

1. HomeScreen controller has been refactored with each tab's functionality moved to separate classes.
2. A base class for tabs has been created and is being used by all tab-specific classes.
3. All screens, including new tab classes, have comprehensive JavaDoc comments above the class name and methods.
4. Existing and new code is well-documented, making it easier to understand and maintain.
5. Functionality tests confirm that everything works as expected post-refactoring.

---