Merge pull request #125 from jiayushe/task

Minor update to README

README.adoc

@@ -2,12 +2,12 @@
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
 https://travis-ci.org/AY1920S1-CS2103T-W11-1/main[image:https://travis-ci.org/AY1920S1-CS2103T-W11-1/main.svg?branch=master[Build Status]]
-https://coveralls.io/github/AY1920S1-CS2103T-W11-1/main?branch=master[image:https://coveralls.io/repos/github/AY1920S1-CS2103T-W11-1/main/badge.svg?branch=master[Coverage Status]]
+https://coveralls.io/github/AY1920S1-CS2103T-W11-1/main?branch=master[image:https://coveralls.io/repos/github/AY1920S1-CS2103T-W11-1/main/badge.svg?branch=master&service=github[Coverage Status]]
 https://app.netlify.com/sites/algobase/deploys[image:https://img.shields.io/netlify/05fde8a9-d24f-4a79-972e-0e6ea1ceb8a5?logo=netlify[Netlify Status]]
 https://github.com/AY1920S1-CS2103T-W11-1/main/blob/master/LICENSE[image:https://img.shields.io/badge/license-MIT-blue.svg[MIT License]]
 
 ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
+image::docs/images/Ui.png[]
 endif::[]
 
 ifndef::env-github[]

docs/DeveloperGuide.adoc

@@ -71,6 +71,7 @@ image::ArchitectureSequenceDiagram.png[]
 
 The sections below give more details of each component.
 
+//@@author jiayushe
 [[Design-Ui]]
 === UI component
 
@@ -79,7 +80,9 @@ image::UiClassDiagram.png[]
 
 *API* : link:{repoURL}/src/main/java/seedu/algobase/ui/Ui.java[`Ui.java`]
 
-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.
+The UI consists of a `MainWindow` that is made up of parts
+e.g.`CommandBox`, `ResultDisplay`, `DetailsTabPane`, `DisplayTabPane`, `TaskManagementPane`, `StatusBarFooter` etc.
+All these, including the `MainWindow`, inherit from the abstract `UiPart` class.
 
 The `UI` component uses 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 link:{repoURL}/src/main/java/seedu/address/ui/MainWindow.java[`MainWindow`] is specified in link:{repoURL}/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`]
 
@@ -110,6 +113,7 @@ Given below is the Sequence Diagram for interactions within the `Logic` componen
 image::DeleteSequenceDiagram.png[]
 
 NOTE: The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+//@@author
 
 //@@author le0tan
 [[Design-Model]]
@@ -146,7 +150,6 @@ image::design/model/ProblemSearchRulePackageDiagram.png[width="60%"]
 
 .Structure of the PlanSearchRule Package
 image::design/model/PlanSearchRulePackageDiagram.png[width='60%']
-
 //@@author
 
 //@@author jiayushe
@@ -162,16 +165,16 @@ The `Storage` component,
 
 * can store `UserPref` objects in json format.
 * can retrieve `UserPref` objects from json format.
-* can store the AlgoBase app data including `Plan`, `Problem`, `Tag`, `Task` objects in relational manner in json format.
-* can retrieve `Plan`, `Problem`, `Tag`, `Task` objects from json format.
+* can store the AlgoBase app data including `GuiState`, `Plan`, `Problem`, `ProblemSearchRule`, `Tag`, `Task` objects in relational manner in json format.
+* can retrieve `GuiState`, `Plan`, `Problem`, `ProblemSearchRule`, `Tag`, `Task` objects from json format.
 
 [[Design-Commons]]
 === Common classes
 
 Classes used by multiple components are in the `seedu.algobase.commons` package.
 
-It contains utility files for configuration `ConfigUtil`, file handling `FileUtil`, ID generation `IdUtil`,
-JSON storage `JsonUtil`, string manipulation `StringUtil` and others.
+It contains utility files for configuration `ConfigUtil`, file handling `FileUtil`,
+JSON storage `JsonUtil`, string manipulation `StringUtil` and others including `AppUtil` and `CollectionUtil`.
 //@@author
 
 == Implementation

docs/diagrams/StorageClassDiagram.puml

@@ -18,10 +18,20 @@ StorageManager o--> AlgoBaseStorage
 
 JsonUserPrefsStorage .left.|> UserPrefsStorage
 JsonAlgoBaseStorage .left.|> AlgoBaseStorage
-JsonAlgoBaseStorage .down.> JsonSerializableAlgoBaseStorage
-JsonSerializableAlgoBaseStorage .down.> JsonAdaptedPlan
-JsonSerializableAlgoBaseStorage .down.> JsonAdaptedProblem
-JsonSerializableAlgoBaseStorage .down.> JsonAdaptedTag
-JsonAdaptedProblem .right.> JsonAdaptedTag
-JsonAdaptedPlan .right.> JsonAdaptedTask
+JsonAlgoBaseStorage .down.> JsonSerializableAlgoBase
+JsonSerializableAlgoBase .down.> JsonAdaptedGuiState
+JsonSerializableAlgoBase .down.> JsonAdaptedPlan
+JsonSerializableAlgoBase .down.> JsonAdaptedProblem
+JsonSerializableAlgoBase .down.> JsonAdaptedProblemSearchRule
+JsonSerializableAlgoBase .down.> JsonAdaptedTag
+JsonAdaptedGuiState .down.> JsonAdaptedTabManager
+JsonAdaptedProblem .down.> JsonAdaptedTag
+JsonAdaptedProblemSearchRule .down.> JsonAdaptedNameContainsKeywordsPredicate
+JsonAdaptedProblemSearchRule .down.> JsonAdaptedAuthorMatchesKeywordsPredicate
+JsonAdaptedProblemSearchRule .down.> JsonAdaptedDescriptionContainsKeywordsPredicate
+JsonAdaptedProblemSearchRule .down.> JsonAdaptedSourceMatchesKeywordsPredicate
+JsonAdaptedProblemSearchRule .down.> JsonAdaptedDifficultyIsInRangePredicate
+JsonAdaptedProblemSearchRule .down.> JsonAdaptedTagIncludesKeywordsPredicate
+JsonAdaptedPlan .down.> JsonAdaptedTask
+JsonAdaptedTabManager .down.> JsonAdaptedTab
 @enduml

docs/diagrams/UiClassDiagram.puml

@@ -11,8 +11,18 @@ Class UiManager
 Class MainWindow
 Class HelpWindow
 Class ResultDisplay
-Class PersonListPanel
-Class PersonCard
+Class DetailsTabPane
+Class DisplayTabPane
+Class TaskManagementPane
+Class FindRuleListPanel
+Class FindRuleCard
+Class ProblemListPanel
+Class ProblemCard
+Class PlanListPanel
+Class PlanCard
+Class TagListPanel
+Class TagCard
+Class TaskCard
 Class StatusBarFooter
 Class CommandBox
 }
@@ -33,28 +43,55 @@ UiManager -down-> MainWindow
 MainWindow --> HelpWindow
 MainWindow *-down-> CommandBox
 MainWindow *-down-> ResultDisplay
-MainWindow *-down-> PersonListPanel
+MainWindow *-down-> DetailsTabPane
+MainWindow *-down-> DisplayTabPane
+MainWindow *-down-> TaskManagementPane
 MainWindow *-down-> StatusBarFooter
 
-PersonListPanel -down-> PersonCard
+DisplayTabPane *-down-> FindRuleListPanel
+DisplayTabPane *-down-> ProblemListPanel
+DisplayTabPane *-down-> PlanListPanel
+DisplayTabPane *-down-> TagListPanel
+
+TaskManagementPane -down-> TaskCard
+FindRuleListPanel -down-> FindRuleCard
+ProblemListPanel -down-> ProblemCard
+PlanListPanel -down-> PlanCard
+TagListPanel -down-> TagCard
 
 MainWindow -left-|> UiPart
 
 ResultDisplay --|> UiPart
 CommandBox --|> UiPart
-PersonListPanel --|> UiPart
-PersonCard --|> UiPart
+DetailsTabPane --|> UiPart
+DisplayTabPane --|> UiPart
+TaskManagementPane --|> UiPart
+FindRuleListPanel --|> UiPart
+FindRuleCard --|> UiPart
+ProblemListPanel --|> UiPart
+ProblemCard --|> UiPart
+PlanListPanel --|> UiPart
+PlanCard --|> UiPart
+TagListPanel --|> UiPart
+TagCard --|> UiPart
+TaskCard --|> UiPart
 StatusBarFooter --|> UiPart
 HelpWindow -down-|> UiPart
 
-PersonCard ..> Model
+FindRuleCard ..> Model
+ProblemCard ..> Model
+PlanCard ..> Model
+TagCard ..> Model
+TaskCard ..> Model
 UiManager -right-> Logic
 MainWindow -left-> Logic
 
-PersonListPanel -[hidden]left- HelpWindow
 HelpWindow -[hidden]left- CommandBox
 CommandBox -[hidden]left- ResultDisplay
 ResultDisplay -[hidden]left- StatusBarFooter
+StatusBarFooter -[hidden]left- DetailsTabPane
+DetailsTabPane -[hidden]left- DisplayTabPane
+DisplayTabPane -[hidden]left- TaskManagementPane
 
 MainWindow -[hidden]-|> UiPart
 @enduml

src/main/resources/view/MainWindow.fxml

@@ -13,7 +13,7 @@
 <?import javafx.stage.Stage?>
 
 <fx:root type="javafx.stage.Stage" xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1"
-         title="AlgoBase App" minWidth="1000" minHeight="850" onCloseRequest="#handleExit">
+         title="AlgoBase App" minWidth="1000" minHeight="700" onCloseRequest="#handleExit">
   <icons>
     <Image url="@/images/address_book_32.png" />
   </icons>

src/main/resources/view/TaskManagementPane.fxml

@@ -12,14 +12,14 @@
          <Label fx:id="currentPlan" styleClass="cell_big_label_white" text="\$currentPlan" />
       </children>
    </StackPane>
-   <StackPane layoutY="36.0" prefHeight="370.0" prefWidth="398.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0">
+   <StackPane layoutY="36.0" prefHeight="270.0" prefWidth="398.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0">
       <children>
-          <ListView fx:id="taskListView" minHeight="342.0" minWidth="300.0" prefHeight="372.0" prefWidth="398.0" />
+          <ListView fx:id="taskListView" minHeight="242.0" minWidth="200.0" prefHeight="272.0" prefWidth="398.0" />
       </children>
    </StackPane>
-   <StackPane layoutX="14.0" layoutY="410.0" prefHeight="189.0" prefWidth="398.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="410.0">
+   <StackPane layoutX="14.0" layoutY="410.0" prefHeight="189.0" prefWidth="398.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="300.0">
       <children>
-         <PieChart fx:id="taskProgressChart" maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" prefHeight="178.0" prefWidth="398.0" />
+         <PieChart fx:id="taskProgressChart" prefHeight="178.0" prefWidth="398.0" />
       </children>
    </StackPane>
 </AnchorPane>