summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnits/newGUI
diff options
context:
space:
mode:
authorAdrien Hopkins <ahopk127@my.yorku.ca>2021-12-24 16:03:26 -0500
committerAdrien Hopkins <ahopk127@my.yorku.ca>2021-12-24 16:03:26 -0500
commitda3a5098602f8177f6d5dac4a322f70d6fdf9126 (patch)
tree325d439c9ea7d4a8885332792b83ec00dd609ede /src/main/java/sevenUnits/newGUI
parent4f754b0bc136b972607aa1b39f2358bd98dc4e1c (diff)
Did some API design for user settings, and moved GUI to a new package
Diffstat (limited to 'src/main/java/sevenUnits/newGUI')
-rw-r--r--src/main/java/sevenUnits/newGUI/ExpressionConversionView.java48
-rw-r--r--src/main/java/sevenUnits/newGUI/Presenter.java97
-rw-r--r--src/main/java/sevenUnits/newGUI/UnitConversionView.java97
-rw-r--r--src/main/java/sevenUnits/newGUI/UserSettings.java27
-rw-r--r--src/main/java/sevenUnits/newGUI/View.java51
-rw-r--r--src/main/java/sevenUnits/newGUI/package-info.java23
6 files changed, 0 insertions, 343 deletions
diff --git a/src/main/java/sevenUnits/newGUI/ExpressionConversionView.java b/src/main/java/sevenUnits/newGUI/ExpressionConversionView.java
deleted file mode 100644
index 0f00090..0000000
--- a/src/main/java/sevenUnits/newGUI/ExpressionConversionView.java
+++ /dev/null
@@ -1,48 +0,0 @@
-/**
- * Copyright (C) 2021 Adrien Hopkins
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-package sevenUnits.newGUI;
-
-/**
- * A View that can convert unit expressions
- *
- * @author Adrien Hopkins
- * @since 2021-12-15
- */
-public interface ExpressionConversionView extends View {
- /**
- * @return unit expression to convert <em>from</em>
- * @since 2021-12-15
- */
- String getFromExpression();
-
- /**
- * @return unit expression to convert <em>to</em>
- * @since 2021-12-15
- */
- String getToExpression();
-
- /**
- * Shows the output of an expression conversion to the user.
- *
- * @param fromExpression expression converted from
- * @param toExpression expression converted to
- * @param value conversion factor between two expressions
- * @since 2021-12-15
- */
- void showExpressionConversionOutput(String fromExpression,
- String toExpression, double value);
-}
diff --git a/src/main/java/sevenUnits/newGUI/Presenter.java b/src/main/java/sevenUnits/newGUI/Presenter.java
deleted file mode 100644
index 6f7d34a..0000000
--- a/src/main/java/sevenUnits/newGUI/Presenter.java
+++ /dev/null
@@ -1,97 +0,0 @@
-/**
- * Copyright (C) 2021 Adrien Hopkins
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-package sevenUnits.newGUI;
-
-/**
- * An object that handles interactions between the view and the backend code
- *
- * @author Adrien Hopkins
- * @since 2021-12-15
- */
-public final class Presenter {
- /**
- * The view that this presenter communicates with
- */
- private final View view;
-
- /**
- * Creates a Presenter
- *
- * @param view the view that this presenter communicates with
- * @since 2021-12-15
- */
- public Presenter(View view) {
- this.view = view;
- }
-
- /**
- * Sets the dimension of the view's From and To units.
- *
- * @throws UnsupportedOperationException if the view does not support
- * unit-based conversion (does not
- * implement
- * {@link UnitConversionView})
- * @since 2021-12-15
- */
- public void applyDimensionFilter() {}
-
- /**
- * Gets settings from the view and applies them to both view and presenter.
- *
- * @since 2021-12-15
- */
- public void applySettings() {}
-
- /**
- * Converts from the view's input expression to its output expression.
- * Displays an error message if any of the required fields are invalid.
- *
- * @throws UnsupportedOperationException if the view does not support
- * expression-based conversion (does
- * not implement
- * {@link ExpressionConversionView})
- * @since 2021-12-15
- */
- public void convertExpressions() {}
-
- /**
- * Converts from the view's input unit to its output unit. Displays an error
- * message if any of the required fields are invalid.
- *
- * @throws UnsupportedOperationException if the view does not support
- * unit-based conversion (does not
- * implement
- * {@link UnitConversionView})
- * @since 2021-12-15
- */
- public void convertUnits() {}
-
- /**
- * Loads settings from the user's settings file and applies them to the view.
- *
- * @since 2021-12-15
- */
- public void loadSettings() {}
-
- /**
- * Gets user settings from the view then saves them to the user's settings
- * file.
- *
- * @since 2021-12-15
- */
- public void saveSettings() {}
-}
diff --git a/src/main/java/sevenUnits/newGUI/UnitConversionView.java b/src/main/java/sevenUnits/newGUI/UnitConversionView.java
deleted file mode 100644
index dafd461..0000000
--- a/src/main/java/sevenUnits/newGUI/UnitConversionView.java
+++ /dev/null
@@ -1,97 +0,0 @@
-/**
- * Copyright (C) 2021 Adrien Hopkins
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-package sevenUnits.newGUI;
-
-import java.util.List;
-import java.util.Optional;
-import java.util.OptionalDouble;
-
-import sevenUnits.unit.BaseDimension;
-import sevenUnits.unit.Unit;
-import sevenUnits.unit.UnitValue;
-import sevenUnits.utils.NamedObjectProduct;
-import sevenUnits.utils.ObjectProduct;
-
-/**
- * A View that supports single unit-based conversion
- *
- * @author Adrien Hopkins
- * @since 2021-12-15
- */
-public interface UnitConversionView extends View {
- /**
- * @return unit to convert <em>from</em>
- * @since 2021-12-15
- */
- Optional<Unit> getFromSelection();
-
- /**
- * @return value to convert between the units
- * @since 2021-12-15
- */
- OptionalDouble getInputValue();
-
- /**
- * @return selected dimension
- * @since 2021-12-15
- */
- Optional<ObjectProduct<BaseDimension>> getSelectedDimension();
-
- /**
- * @return unit to convert <em>to</em>
- * @since 2021-12-15
- */
- Optional<Unit> getToSelection();
-
- /**
- * Sets the available dimensions for filtering.
- *
- * @param dimensions dimensions to use
- * @since 2021-12-15
- */
- void setDimensions(List<NamedObjectProduct<BaseDimension>> dimensions);
-
- /**
- * Sets the available units to convert from. {@link #getFromSelection} is not
- * required to use one of these units; this method is to be used for views
- * that allow the user to select units from a list.
- *
- * @param units units to convert from
- * @since 2021-12-15
- */
- void setFromUnits(List<? extends Unit> units);
-
- /**
- * Sets the available units to convert to. {@link #getToSelection} is not
- * required to use one of these units; this method is to be used for views
- * that allow the user to select units from a list.
- *
- * @param units units to convert to
- * @since 2021-12-15
- */
- void setToUnits(List<? extends Unit> units);
-
- /**
- * Shows the output of a unit conversion.
- *
- * @param input unit value before conversion, as obtained from the view
- * @param output unit value after conversion
- * @throws NullPointerException if either argument is null
- * @since 2021-12-15
- */
- void showUnitConversionOutput(UnitValue input, UnitValue output);
-}
diff --git a/src/main/java/sevenUnits/newGUI/UserSettings.java b/src/main/java/sevenUnits/newGUI/UserSettings.java
deleted file mode 100644
index 207ef11..0000000
--- a/src/main/java/sevenUnits/newGUI/UserSettings.java
+++ /dev/null
@@ -1,27 +0,0 @@
-/**
- * Copyright (C) 2021 Adrien Hopkins
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-package sevenUnits.newGUI;
-
-/**
- * An object containing all of the user settings for a 7Units session.
- *
- * @author Adrien Hopkins
- * @since 2021-12-15
- */
-public final class UserSettings {
-
-}
diff --git a/src/main/java/sevenUnits/newGUI/View.java b/src/main/java/sevenUnits/newGUI/View.java
deleted file mode 100644
index 8758a41..0000000
--- a/src/main/java/sevenUnits/newGUI/View.java
+++ /dev/null
@@ -1,51 +0,0 @@
-/**
- * Copyright (C) 2021 Adrien Hopkins
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-package sevenUnits.newGUI;
-
-/**
- * An object that controls user interaction with 7Units
- *
- * @author Adrien Hopkins
- * @since 2021-12-15
- */
-public interface View {
- /**
- * @return settings user has set in the view
- * @since 2021-12-15
- */
- UserSettings getUserSettings();
-
- /**
- * Sets the user settings on the settings page, if this view has one. Does
- * not update settings internally; this is intended for loading settings from
- * a file.
- *
- * @param settings settings to set
- * @since 2021-12-15
- */
- void setUserSettings(UserSettings settings);
-
- /**
- * Shows an error message.
- *
- * @param title title of error message; on any view that uses an error
- * dialog, this should be the title of the error dialog.
- * @param message error message
- * @since 2021-12-15
- */
- void showErrorMessage(String title, String message);
-}
diff --git a/src/main/java/sevenUnits/newGUI/package-info.java b/src/main/java/sevenUnits/newGUI/package-info.java
deleted file mode 100644
index b58dccc..0000000
--- a/src/main/java/sevenUnits/newGUI/package-info.java
+++ /dev/null
@@ -1,23 +0,0 @@
-/**
- * Copyright (C) 2021 Adrien Hopkins
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-/**
- * The MVP GUI of SevenUnits
- *
- * @author Adrien Hopkins
- * @since 2021-12-15
- */
-package sevenUnits.newGUI; \ No newline at end of file