Skip to content

Commit

Permalink
Merge pull request #339 from iamdiluxedbutcooler/update-ui-dg
Browse files Browse the repository at this point in the history
Update UI section of the UG and the UML diagram
  • Loading branch information
FionaQY authored Nov 11, 2024
2 parents cb6d69d + 037fbc5 commit 0a038f4
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 46 deletions.
81 changes: 35 additions & 46 deletions docs/diagrams/UiClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -3,70 +3,59 @@
skinparam arrowThickness 1.1
skinparam arrowColor UI_COLOR_T4
skinparam classBackgroundColor UI_COLOR
skinparam linetype ortho

package UI <<Rectangle>>{
Class "<<interface>>\nUi" as Ui
Class "{abstract}\nUiPart" as UiPart
Class UiManager
Class MainWindow
Class HelpWindow
Class ResultDisplay
Class ClientListPanel
Class ClientCard
Class ClientCardField
Class ClientDetailPanel
Class StatusBarFooter
Class CommandBox
Class StatusPieChart
package Logic <<Rectangle>> {
Class HiddenLogic #FFFFFF
}

package Model <<Rectangle>> {
Class HiddenModel #FFFFFF
package UI <<Rectangle>>{
Class "<<interface>>\nUi" as Ui
Class "{abstract}\nUiPart" as UiPart
Class UiManager
Class MainWindow
Class HelpWindow
Class ResultDisplay
Class ClientListPanel
Class ClientDetailPanel
Class StatusBarFooter
Class CommandBox
Class StatusPieChart
Class ClientCard
Class ClientCardField
}

package Logic <<Rectangle>> {
Class HiddenLogic #FFFFFF
package Model <<Rectangle>> {
Class HiddenModel #FFFFFF
}

Class HiddenOutside #FFFFFF
HiddenOutside ..> Ui

HiddenOutside -right-> Ui
UiManager -up-|> Ui
UiManager .left.|> Ui
UiManager -down-> "1" MainWindow

MainWindow *-down-> "1" CommandBox
MainWindow *-down-> "1" CommandBox
MainWindow *-down-> "1" ResultDisplay
MainWindow *-down-> "1" ClientDetailPanel
MainWindow *-down-> "1" ClientListPanel
MainWindow *-down-> "1" StatusBarFooter
MainWindow *-down-> "1" StatusPieChart
MainWindow *-down-> "1" ClientListPanel
MainWindow *-down-> "1" ClientDetailPanel
MainWindow -right-> "0..1" HelpWindow
MainWindow --> "0..1" HelpWindow

ClientListPanel *-right-> "*" ClientCard
ClientListPanel *-down-> "*" ClientCard
ClientCard *-down-> "6" ClientCardField
note bottom of ClientCardField : Depends on the Ikonli package for icons

MainWindow -up-|> UiPart
ResultDisplay -up-|> UiPart
CommandBox -up-|> UiPart
ClientListPanel -up-|> UiPart
ClientCard -up-|> UiPart
ClientDetailPanel -up-|> UiPart
StatusBarFooter -up-|> UiPart
HelpWindow -up-|> UiPart
StatusPieChart -up-|> UiPart
note bottom of ClientCardField : Depends on the Ikonli package for icons

ClientCard -right-> Model
ClientDetailPanel -right-> Model
UiManager -down-> Logic
MainWindow -down-> Logic
ClientCard --|> UiPart
ClientDetailPanel --|> UiPart
StatusBarFooter --|> UiPart
HelpWindow --|> UiPart
StatusPieChart --|> UiPart

CommandBox -[hidden]down- ResultDisplay
ResultDisplay -[hidden]down- StatusBarFooter
StatusBarFooter -[hidden]down- StatusPieChart
StatusPieChart -[hidden]down- ClientListPanel
ClientListPanel -[hidden]down- ClientDetailPanel
ClientDetailPanel -[hidden]down- HelpWindow
ClientCard .down.> Model
ClientDetailPanel .down.> Model
UiManager -up-> Logic
MainWindow -up-> Logic

@enduml
Binary file modified docs/images/UiClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0a038f4

Please sign in to comment.