Refactor ui package

Author: xiaoyu-nus

copyright.txt

@@ -1,7 +1,6 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
 Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
 - AddressApp.ico
 
 Copyright by Jan Jan Kovařík - http://glyphicons.com/

docs/DeveloperGuide.adoc

@@ -79,7 +79,7 @@ image::UiClassDiagram.png[]
 
 *API* : link:{repoURL}/src/main/java/seedu/address/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`, `ItemListPanel`, `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`]
 

docs/diagrams/ArchitectureSequenceDiagram.puml

@@ -13,7 +13,7 @@ activate ui UI_COLOR
 ui -[UI_COLOR]> logic : execute("delete 1")
 activate logic LOGIC_COLOR
 
-logic -[LOGIC_COLOR]> model : deletePerson(p)
+logic -[LOGIC_COLOR]> model : deleteItem(p)
 activate model MODEL_COLOR
 
 model -[MODEL_COLOR]-> logic

docs/diagrams/BetterModelClassDiagram.puml

@@ -4,18 +4,18 @@ skinparam arrowThickness 1.1
 skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
 
-AddressBook *-right-> "1" UniquePersonList
+AddressBook *-right-> "1" UniqueItemList
 AddressBook *-right-> "1" UniqueTagList
-UniqueTagList -[hidden]down- UniquePersonList
-UniqueTagList -[hidden]down- UniquePersonList
+UniqueTagList -[hidden]down- UniqueItemList
+UniqueTagList -[hidden]down- UniqueItemList
 
 UniqueTagList *-right-> "*" Tag
-UniquePersonList o-right-> Person
+UniqueItemList o-right-> Item
 
-Person o-up-> "*" Tag
+Item o-up-> "*" Tag
 
-Person *--> Name
-Person *--> Phone
-Person *--> Email
-Person *--> Address
+Item *--> Name
+Item *--> Phone
+Item *--> Email
+Item *--> Address
 @enduml

docs/diagrams/DeleteSequenceDiagram.puml

@@ -48,7 +48,7 @@ deactivate AddressBookParser
 LogicManager -> DeleteCommand : execute()
 activate DeleteCommand
 
-DeleteCommand -> Model : deletePerson(1)
+DeleteCommand -> Model : deleteItem(1)
 activate Model
 
 Model --> DeleteCommand

docs/diagrams/ModelClassDiagram.puml

@@ -15,13 +15,13 @@ Class ModelManager
 Class UserPrefs
 Class ReadOnlyUserPrefs
 
-Package Person {
-Class Person
+Package Item {
+Class Item
 Class Address
 Class Email
 Class Name
 Class Phone
-Class UniquePersonList
+Class UniqueItemList
 }
 
 Package Tag {
@@ -40,17 +40,17 @@ ModelManager o--> "1" AddressBook
 ModelManager o-left-> "1" UserPrefs
 UserPrefs .up.|> ReadOnlyUserPrefs
 
-AddressBook *--> "1" UniquePersonList
-UniquePersonList o--> "*" Person
-Person *--> Name
-Person *--> Phone
-Person *--> Email
-Person *--> Address
-Person *--> "*" Tag
+AddressBook *--> "1" UniqueItemList
+UniqueItemList o--> "*" Item
+Item *--> Name
+Item *--> Phone
+Item *--> Email
+Item *--> Address
+Item *--> "*" Tag
 
 Name -[hidden]right-> Phone
 Phone -[hidden]right-> Address
 Address -[hidden]right-> Email
 
-ModelManager -->"1" Person : filtered list
+ModelManager -->"1" Item : filtered list
 @enduml

docs/diagrams/StorageClassDiagram.puml

@@ -19,6 +19,6 @@ StorageManager o--> AddressBookStorage
 JsonUserPrefsStorage .left.|> UserPrefsStorage
 JsonAddressBookStorage .left.|> AddressBookStorage
 JsonAddressBookStorage .down.> JsonSerializableAddressBookStorage
-JsonSerializableAddressBookStorage .right.> JsonSerializablePerson
-JsonSerializablePerson .right.> JsonAdaptedTag
+JsonSerializableAddressBookStorage .right.> JsonSerializableItem
+JsonSerializableItem .right.> JsonAdaptedTag
 @enduml

docs/diagrams/UiClassDiagram.puml

@@ -11,8 +11,8 @@ Class UiManager
 Class MainWindow
 Class HelpWindow
 Class ResultDisplay
-Class PersonListPanel
-Class PersonCard
+Class ItemListPanel
+Class ItemCard
 Class StatusBarFooter
 Class CommandBox
 }
@@ -33,25 +33,25 @@ UiManager -down-> MainWindow
 MainWindow --> HelpWindow
 MainWindow *-down-> CommandBox
 MainWindow *-down-> ResultDisplay
-MainWindow *-down-> PersonListPanel
+MainWindow *-down-> ItemListPanel
 MainWindow *-down-> StatusBarFooter
 
-PersonListPanel -down-> PersonCard
+ItemListPanel -down-> ItemCard
 
 MainWindow -left-|> UiPart
 
 ResultDisplay --|> UiPart
 CommandBox --|> UiPart
-PersonListPanel --|> UiPart
-PersonCard --|> UiPart
+ItemListPanel --|> UiPart
+ItemCard --|> UiPart
 StatusBarFooter --|> UiPart
 HelpWindow -down-|> UiPart
 
-PersonCard ..> Model
+ItemCard ..> Model
 UiManager -right-> Logic
 MainWindow -left-> Logic
 
-PersonListPanel -[hidden]left- HelpWindow
+ItemListPanel -[hidden]left- HelpWindow
 HelpWindow -[hidden]left- CommandBox
 CommandBox -[hidden]left- ResultDisplay
 ResultDisplay -[hidden]left- StatusBarFooter

docs/diagrams/tracing/LogicSequenceDiagram.puml

@@ -13,7 +13,7 @@ create ecp
 abp -> ecp
 abp -> ecp ++: parse(arguments)
 create ec
-ecp -> ec ++: index, editPersonDescriptor
+ecp -> ec ++: index, editItemDescriptor
 ec --> ecp --
 ecp --> abp --: command
 abp --> logic --: command

src/main/java/io/xpire/model/Xpire.java

@@ -44,8 +44,6 @@ public void resetData(ReadOnlyXpire newData) {
         this.setItems(newData.getItemList());
     }
 
-    //// person-level operations
-
     /**
      * Returns true if an item with the same identity as {@code item} exists in xpire.
      */

src/main/java/io/xpire/ui/HelpWindow.java

@@ -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/AY1920S1-CS2103T-F11-2/main/blob/master/docs/UserGuide.adoc";
     public static final String HELP_MESSAGE = "Refer to the user guide: " + USERGUIDE_URL;
 
     private static final Logger logger = LogsCenter.getLogger(HelpWindow.class);

src/main/java/io/xpire/ui/ItemCard.java

@@ -10,7 +10,7 @@
 import javafx.scene.layout.Region;
 
 /**
- * An UI component that displays information of a {@code Person}.
+ * An UI component that displays information of a {@code Item}.
  */
 public class ItemCard extends UiPart<Region> {
 
@@ -21,7 +21,6 @@ public class ItemCard extends UiPart<Region> {
      * As a consequence, UI elements' variable names cannot be set to such keywords
      * or an exception will be thrown by JavaFX during runtime.
      *
-     * @see <a href="https://github.com/se-edu/addressbook-level4/issues/336">The issue on AddressBook level 4</a>
      */
 
     public final Item item;

src/main/java/io/xpire/ui/ItemListPanel.java

@@ -11,7 +11,7 @@
 import javafx.scene.layout.Region;
 
 /**
- * Panel containing the list of persons.
+ * Panel containing the list of items.
  */
 public class ItemListPanel extends UiPart<Region> {
     private static final String FXML = "ItemListPanel.fxml";

src/main/java/io/xpire/ui/MainWindow.java

@@ -42,7 +42,7 @@ public class MainWindow extends UiPart<Stage> {
     private MenuItem helpMenuItem;
 
     @FXML
-    private StackPane personListPanelPlaceholder;
+    private StackPane itemListPanelPlaceholder;
 
     @FXML
     private StackPane resultDisplayPlaceholder;
@@ -108,7 +108,7 @@ private void setAccelerator(MenuItem menuItem, KeyCombination keyCombination) {
      */
     void fillInnerParts() {
         itemListPanel = new ItemListPanel(logic.getFilteredItemList());
-        personListPanelPlaceholder.getChildren().add(itemListPanel.getRoot());
+        itemListPanelPlaceholder.getChildren().add(itemListPanel.getRoot());
 
         resultDisplay = new ResultDisplay();
         resultDisplayPlaceholder.getChildren().add(resultDisplay.getRoot());

src/main/java/io/xpire/ui/UiManager.java

@@ -20,7 +20,7 @@ public class UiManager implements Ui {
     public static final String ALERT_DIALOG_PANE_FIELD_ID = "alertDialogPane";
 
     private static final Logger logger = LogsCenter.getLogger(UiManager.class);
-    private static final String ICON_APPLICATION = "/images/address_book_32.png";
+    private static final String ICON_APPLICATION = "/images/xpire_icon.png";
 
     private Logic logic;
     private MainWindow mainWindow;

src/main/resources/images/address_book_32.png

@@ -328,7 +328,7 @@
     -fx-text-fill: white;
 }
 
-#filterField, #personListPanel, #personWebpage {
+#filterField, #itemListPanel, #itemWebpage {
     -fx-effect: innershadow(gaussian, black, 10, 0, 0, 0);
 }
 

src/main/resources/images/xpire_icon.png

@@ -12,9 +12,9 @@
 <?import javafx.scene.layout.VBox?>
 
 <fx:root type="javafx.stage.Stage" xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1"
-         title="Address App" minWidth="450" minHeight="600" onCloseRequest="#handleExit">
+         title="Xpire" minWidth="450" minHeight="600" onCloseRequest="#handleExit">
   <icons>
-    <Image url="@/images/address_book_32.png" />
+    <Image url="@/images/xpire_icon.png" />
   </icons>
   <scene>
     <Scene>
@@ -46,11 +46,11 @@
           </padding>
         </StackPane>
 
-        <VBox fx:id="personList" styleClass="pane-with-border" minWidth="340" prefWidth="340" VBox.vgrow="ALWAYS">
+        <VBox fx:id="itemList" styleClass="pane-with-border" minWidth="340" prefWidth="340" VBox.vgrow="ALWAYS">
           <padding>
             <Insets top="10" right="10" bottom="10" left="10" />
           </padding>
-          <StackPane fx:id="personListPanelPlaceholder" VBox.vgrow="ALWAYS"/>
+          <StackPane fx:id="itemListPanelPlaceholder" VBox.vgrow="ALWAYS"/>
         </VBox>
 
         <StackPane fx:id="statusbarPlaceholder" VBox.vgrow="NEVER" />

src/main/resources/view/DarkTheme.css

@@ -1,6 +1,6 @@
 {
   "items": [ {
-    "name": "Valid Person",
+    "name": "Valid Item",
     "expiryDate": "18/12/2019"
   }, {
     "name": "Item With Invalid expiryDate Field",

src/main/resources/view/MainWindow.fxml

@@ -10,7 +10,7 @@ public class AppUtilTest {
 
     @Test
     public void getImage_exitingImage() {
-        assertNotNull(AppUtil.getImage("/images/address_book_32.png"));
+        assertNotNull(AppUtil.getImage("/images/xpire_icon.png"));
     }
 
     @Test

src/test/data/JsonXpireStorageTest/invalidAndValidItemXpire.json

@@ -118,7 +118,7 @@ public static void assertCommandFailure(Command command, Model actualModel, Stri
         assertEquals(expectedFilteredList, actualModel.getFilteredItemList());
     }
     /**
-     * Updates {@code model}'s filtered list to show only the person at the given {@code targetIndex} in the
+     * Updates {@code model}'s filtered list to show only the item at the given {@code targetIndex} in the
      * {@code model}'s expiry date tracker.
      */
     public static void showItemAtIndex(Model model, Index targetIndex) {

src/test/java/io/xpire/commons/util/AppUtilTest.java

@@ -11,7 +11,7 @@
 import io.xpire.model.tag.Tag;
 
 /**
- * A utility class to help with building EditPersonDescriptor objects.
+ * A utility class to help with building EditItemDescriptor objects.
  */
 public class EditItemDescriptorBuilder {
 

src/test/java/io/xpire/logic/commands/CommandTestUtil.java

@@ -10,7 +10,7 @@
 import io.xpire.model.util.SampleDataUtil;
 
 /**
- * A utility class to help with building Person objects.
+ * A utility class to help with building Item objects.
  */
 public class ItemBuilder {
 
@@ -30,10 +30,10 @@ public ItemBuilder() {
     /**
      * Initializes the ItemBuilder with the data of {@code itemToCopy}.
      */
-    public ItemBuilder(Item personToCopy) {
-        name = personToCopy.getName();
-        expiryDate = personToCopy.getExpiryDate();
-        tags = new HashSet<>(personToCopy.getTags());
+    public ItemBuilder(Item itemToCopy) {
+        name = itemToCopy.getName();
+        expiryDate = itemToCopy.getExpiryDate();
+        tags = new HashSet<>(itemToCopy.getTags());
     }
 
     /**

src/test/java/io/xpire/testutil/EditItemDescriptorBuilder.java

@@ -33,21 +33,21 @@ public static Path getFilePathInSandboxFolder(String fileName) {
     }
 
     /**
-     * Returns the middle index of the person in the {@code model}'s person list.
+     * Returns the middle index of the item in the {@code model}'s item list.
      */
     public static Index getMidIndex(Model model) {
         return Index.fromOneBased(model.getFilteredItemList().size() / 2);
     }
 
     /**
-     * Returns the last index of the person in the {@code model}'s person list.
+     * Returns the last index of the item in the {@code model}'s item list.
      */
     public static Index getLastIndex(Model model) {
         return Index.fromOneBased(model.getFilteredItemList().size());
     }
 
     /**
-     * Returns the person in the {@code model}'s person list at {@code index}.
+     * Returns the item in the {@code model}'s item list at {@code index}.
      */
     public static Item getItem(Model model, Index index) {
         return model.getFilteredItemList().get(index.getZeroBased());

src/test/java/io/xpire/testutil/ItemBuilder.java

@@ -8,7 +8,7 @@
 import io.xpire.model.item.Item;
 
 /**
- * A utility class containing a list of {@code Person} objects to be used in tests.
+ * A utility class containing a list of {@code Item} objects to be used in tests.
  */
 public class TypicalItems {
 
@@ -31,7 +31,7 @@ public class TypicalItems {
     private TypicalItems() {} // prevents instantiation
 
     /**
-     * Returns an {@code AddressBook} with all the typical persons.
+     * Returns an {@code AddressBook} with all the typical items.
      */
     public static Xpire getTypicalExpiryDateTracker() {
         Xpire edt = new Xpire();