Skip to content

Commit

Permalink
Merge pull request #262 from lxz333/branch-A-DG-Ui
Browse files Browse the repository at this point in the history
Modify the Ui part of DG
  • Loading branch information
SFCoding123 authored Mar 31, 2023
2 parents 6b84c87 + 5550c3e commit a0b79a6
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 4 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,7 @@ src/test/data/sandbox/
docs/_site/
0-mc.pdf
1-mc.pdf
3-mc.pdf
2-mc.pdf
3-mc.pdf


4 changes: 2 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ The sections below give more details of each component.

The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)

![Structure of the UI Component](images/UiClassDiagram.png)
![Structure of the UI Component](images/UiClassDiagramNew.png)

The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter`, `DetailDisplay`etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.

The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)

Expand Down
29 changes: 29 additions & 0 deletions docs/diagrams/UiClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ Class PersonListPanel
Class PersonCard
Class StatusBarFooter
Class CommandBox
Class AddAppointmentWindow
Class AddPatientWindow
Class AddMcInfo
Class ErrorMessageDisplay
Class DetailDisplay
Class FileCard
Class FileComparator
Class FileList
Class ObservableFile
Class UiFile
}

package Model <<Rectangle>> {
Expand All @@ -34,7 +44,20 @@ MainWindow *-down-> "1" CommandBox
MainWindow *-down-> "1" ResultDisplay
MainWindow *-down-> "1" PersonListPanel
MainWindow *-down-> "1" StatusBarFooter
MainWindow *-down-> "*" DetailDisplay
MainWindow --> "0..1" HelpWindow
DetailDisplay --> "0..1" AddAppointmentWindow
DetailDisplay --> "0..1" AddMcInfo
PersonListPanel --> "0..1" AddPatientWindow
AddMcInfo *-down-> "0..1" ErrorMessageDisplay
AddPatientWindow *-down-> "0..1" ErrorMessageDisplay
AddAppointmentWindow *-down-> "0..1" ErrorMessageDisplay
FileList ---> "*" FileCard
DetailDisplay *-down-> "1" FileList
FileCard ---> "*" FileComparator
ObservableFile --> "*" UiFile
DetailDisplay *-down-> "1" ObservableFile


PersonListPanel -down-> "*" PersonCard

Expand All @@ -46,6 +69,12 @@ PersonListPanel --|> UiPart
PersonCard --|> UiPart
StatusBarFooter --|> UiPart
HelpWindow --|> UiPart
AddAppointmentWindow --|> UiPart
AddPatientWindow ---|> UiPart
DetailDisplay --|> UiPart
FileCard --|> UiPart
FileList --|> UiPart
AddMcInfo --|> UiPart

PersonCard ..> Model
UiManager -right-> Logic
Expand Down
Binary file added docs/images/UiClassDiagramNew.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion src/main/java/seedu/address/ui/HelpWindow.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
*/
public class HelpWindow extends UiPart<Stage> {

public static final String USERGUIDE_URL = "https://se-education.org/addressbook-level3/UserGuide.html";
public static final String USERGUIDE_URL =
"https://github.com/AY2223S2-CS2103T-W11-4/tp/blob/master/docs/UserGuide.md";
public static final String HELP_MESSAGE = "Refer to the user guide: " + USERGUIDE_URL;

private static final Logger logger = LogsCenter.getLogger(HelpWindow.class);
Expand Down

0 comments on commit a0b79a6

Please sign in to comment.