Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UI and model diagrams #263

Merged
merged 2 commits into from
Nov 12, 2023
Merged

Update UI and model diagrams #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fd7dbb
update UI and ModelClass model
Kailash201 Nov 12, 2023
18562a7
Merge branch 'Branch-v1.4' of https://github.com/AY2324S1-CS2103T-T10…
Kailash201 Nov 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ The **API** of this component is specified in [`Ui.java`](https://github.com/AY2

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.

`GroupTimeContainer` is a helper class that process the data from the `model` in `Calendar` and passes the processed data to `DayCard` which will be then displayed in the `UI`.

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/AY2324S1-CS2103T-T10-3/tp/blob/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/AY2324S1-CS2103T-T10-3/tp/blob/master/src/main/resources/view/MainWindow.fxml)

The `UI` component,
Expand Down
18 changes: 14 additions & 4 deletions docs/diagrams/ModelClassDiagram.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ Class UserPrefs
Class UniquePersonList
Class Person
Class Email
Class Groups
Class Group
Class Name
Class Phone
Class FreeTimes
Class GroupList
class TimeIntervalList
class TimeInterval
class Time
class GroupRemark
Class I #FFFFFF
}

Expand All @@ -41,22 +42,31 @@ AddressBook *--> "1" UniquePersonList
UniquePersonList --> "~* all" Person

AddressBook *--> "1" GroupList
GroupList --> "*" Groups
GroupList --> "*" Group

Person *--> Name
Person *--> Phone
Person *--> "1" GroupList
Person *--> Email
Person *--> "1" TimeIntervalList

Group *--> TimeIntervalList
Group -->"*" Person
Group *--> GroupRemark

TimeIntervalList --> "*" TimeInterval
TimeInterval *--> Time

Person -[hidden]up--> I
UniquePersonList -[hidden]right-> I

Name -[hidden]right-> Phone
Phone -[hidden]right-> Email
Email -[hidden]right-> Groups



ModelManager --> "~* filtered" Person
ModelManager --> "~* filtered" Group


@enduml
7 changes: 5 additions & 2 deletions docs/diagrams/UiClassDiagram.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Class CommandBox
Class Calendar
Class DayCard
Class EachDayTaskLine
Class GroupTimeContainer
}

package Model <<Rectangle>> {
Expand All @@ -42,9 +43,11 @@ MainWindow --> "0..1" HelpWindow

PersonListPanel -down-> "*" PersonCard

Calendar -down-> "7" DayCard
Calendar *-down-> "7" DayCard
Calendar *-> GroupTimeContainer

DayCard -down-> "*" EachDayTaskLine
DayCard *-down-> "*" EachDayTaskLine
DayCard -left-> GroupTimeContainer

MainWindow -left-|> UiPart

Expand Down
Loading