X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.model%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fmodel%2Fmodel%2Fcomponents%2FGUIComponent.java;h=382d7e377b905b5ad4b54fe84de064b31f0f7feb;hb=6f717d2b76148b0d49c342f9ab937ba87d81dddb;hp=1b97cd311dbbd16f89337b039d1f9a9c577fcbfa;hpb=b5d8c2d71e27350ea7c9314e40df5bb0584271cd;p=Mograsim.git diff --git a/net.mograsim.logic.model/src/net/mograsim/logic/model/model/components/GUIComponent.java b/net.mograsim.logic.model/src/net/mograsim/logic/model/model/components/GUIComponent.java index 1b97cd31..382d7e37 100644 --- a/net.mograsim.logic.model/src/net/mograsim/logic/model/model/components/GUIComponent.java +++ b/net.mograsim.logic.model/src/net/mograsim/logic/model/model/components/GUIComponent.java @@ -14,11 +14,13 @@ import net.haspamelodica.swt.helper.gcs.GeneralGC; import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle; import net.mograsim.logic.model.model.ViewModelModifiable; import net.mograsim.logic.model.model.wires.Pin; -import net.mograsim.logic.model.serializing.snippets.HighLevelStateHandler; +import net.mograsim.logic.model.snippets.HighLevelStateHandler; /** * The base class for all GUI components.
- * A GUIComponent has a position and size. The size can only be modified by subclasses.
+ * A GUIComponent has a reference to the ViewModel it belongs to.
+ * A GUIComponent has a name. This name is unique in the model the GUIComponent belongs to.
+ * A GUIComponent has a position and size. The size can only be modified by subclasses. * * @author Daniel Kirschten */ @@ -29,7 +31,7 @@ public abstract class GUIComponent */ protected final ViewModelModifiable model; /** - * The name of this component. Is unique in its model. + * The name of this component. Is unique for all components in its model. */ public final String name; private final Rectangle bounds; @@ -147,31 +149,31 @@ public abstract class GUIComponent // high-level access /** - * Sets the given high-level state to the given value.
- * See {@link HighLevelStateHandler#setHighLevelState(String, Object)} for an explanation of high-level state IDs. + * Gets the current value of the given high-level state.
+ * See {@link HighLevelStateHandler} for an explanation of high-level state IDs. * - * @see #getHighLevelState(String) - * @see HighLevelStateHandler#setHighLevelState(String, Object) + * @see #setHighLevelState(String, Object) + * @see HighLevelStateHandler#getHighLevelState(String) * * @author Daniel Kirschten */ - @SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden - public void setHighLevelState(String stateID, Object newState) + @SuppressWarnings("static-method") // this method is intended to be overridden + public Object getHighLevelState(String stateID) { throw new IllegalArgumentException("No high level state with ID " + stateID); } /** - * Gets the current value of the given high-level state.
- * See {@link HighLevelStateHandler#setHighLevelState(String, Object)} for an explanation of high-level state IDs. + * Sets the given high-level state to the given value.
+ * See {@link HighLevelStateHandler} for an explanation of high-level state IDs. * - * @see #setHighLevelState(String, Object) - * @see HighLevelStateHandler#getHighLevelState(String) + * @see #getHighLevelState(String) + * @see HighLevelStateHandler#setHighLevelState(String, Object) * * @author Daniel Kirschten */ - @SuppressWarnings("static-method") // this method is intended to be overridden - public Object getHighLevelState(String stateID) + @SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden + public void setHighLevelState(String stateID, Object newState) { throw new IllegalArgumentException("No high level state with ID " + stateID); } @@ -277,7 +279,7 @@ public abstract class GUIComponent // serializing @SuppressWarnings("static-method") // this method is intended to be overridden - public JsonElement getParams() + public JsonElement getParamsForSerializing() { return JsonNull.INSTANCE; }