Merge branch 'development' of https://gitlab.lrz.de/lrr-tum/students/eragp-misim...
[Mograsim.git] / net.mograsim.logic.ui / src / net / mograsim / logic / ui / model / components / GUIComponent.java
index a586616..83e6d61 100644 (file)
@@ -5,9 +5,10 @@ import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.TreeMap;
 import java.util.function.Consumer;
-import java.util.function.Supplier;
+
+import com.google.gson.JsonElement;
+import com.google.gson.JsonNull;
 
 import net.haspamelodica.swt.helper.gcs.GeneralGC;
 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
@@ -37,14 +38,12 @@ public abstract class GUIComponent
        protected final Map<String, Pin> pinsUnmodifiable;
 
        private final List<Consumer<? super GUIComponent>> componentMovedListeners;
+       private final List<Consumer<? super GUIComponent>> componentResizedListeners;
        private final List<Consumer<? super Pin>> pinAddedListeners;
        private final List<Consumer<? super Pin>> pinRemovedListeners;
        private final List<Runnable> redrawListeners;
 
        private final Runnable redrawListenerForSubcomponents;
-       // Defines how the GUIComponent is referenced in SubmodelComponentParams
-       protected Supplier<String> identifierDelegate = () -> "class:".concat(getClass().getCanonicalName());
-
        // creation and destruction
 
        public GUIComponent(ViewModelModifiable model)
@@ -55,6 +54,7 @@ public abstract class GUIComponent
                this.pinsUnmodifiable = Collections.unmodifiableMap(pinsByName);
 
                this.componentMovedListeners = new ArrayList<>();
+               this.componentResizedListeners = new ArrayList<>();
                this.pinAddedListeners = new ArrayList<>();
                this.pinRemovedListeners = new ArrayList<>();
                this.redrawListeners = new ArrayList<>();
@@ -138,6 +138,38 @@ public abstract class GUIComponent
                return pin;
        }
 
+       // high-level access
+
+       /**
+        * Sets the given high-level state to the given value. <br>
+        * A high level state ID consists of parts separated by dots ('.').<br>
+        * The last part (the part after the last dot) is called "atomic high level state ID". The parts before that part are called
+        * "subcomponent ID"s.<br>
+        * If there is no dot in a high level state ID, the whole high level state ID is called atomic.<br>
+        * Note that subcomponent IDs don't have to correspond to actual subcomponents. For example, a RAM component may supply subcomponent IDs
+        * "c0000", "c0001" ... "cFFFF" without actually having a subcomponent for each cell. It also is allowed for an atomic high level state
+        * ID to be delegated to a subcomponent.
+        * 
+        * @author Daniel Kirschten
+        */
+       @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);
+       }
+
+       /**
+        * Gets the current value of the given high-level state. <br>
+        * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
+        * 
+        * @author Daniel Kirschten
+        */
+       @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);
+       }
+
        // "graphical" operations
 
        /**
@@ -162,6 +194,7 @@ public abstract class GUIComponent
        {
                bounds.width = width;
                bounds.height = height;
+               callComponentResizedListener();
                requestRedraw();
        }
 
@@ -171,7 +204,7 @@ public abstract class GUIComponent
         * 
         * @author Daniel Kirschten
         */
-       public Rectangle getBounds()
+       public final Rectangle getBounds()
        {
                return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);
        }
@@ -237,18 +270,10 @@ public abstract class GUIComponent
 
        // serializing
 
-       /**
-        * @return an identifier used to reference this GUIComponent inside of {@link SubmodelComponentParams}
-        */
-       public String getIdentifier()
-       {
-               return identifierDelegate.get();
-       }
-
-       @SuppressWarnings("static-method")
-       public Map<String, Object> getInstantiationParameters()
+       @SuppressWarnings("static-method") // this method is intended to be overridden
+       public JsonElement getParams()
        {
-               return new TreeMap<>();
+               return JsonNull.INSTANCE;
        }
 
        // listeners
@@ -264,19 +289,22 @@ public abstract class GUIComponent
        }
 
        // @formatter:off
-       public void addComponentMovedListener   (Consumer<? super GUIComponent> listener) {componentMovedListeners.add   (listener);}
-       public void addPinAddedListener         (Consumer<? super Pin         > listener) {pinAddedListeners      .add   (listener);}
-       public void addPinRemovedListener       (Consumer<? super Pin         > listener) {pinRemovedListeners    .add   (listener);}
-       public void addRedrawListener           (Runnable                       listener) {redrawListeners        .add   (listener);}
-
-       public void removeComponentMovedListener(Consumer<? super GUIComponent> listener) {componentMovedListeners .remove(listener);}
-       public void removePinAddedListener      (Consumer<? super Pin         > listener) {pinAddedListeners       .remove(listener);}
-       public void removePinRemovedListener    (Consumer<? super Pin         > listener) {pinRemovedListeners     .remove(listener);}
-       public void removeRedrawListener        (Runnable                       listener) {redrawListeners         .remove(listener);}
-
-       private void callComponentMovedListeners(     ) {componentMovedListeners.forEach(l -> l.accept(this));}
-       private void callPinAddedListeners      (Pin p) {pinAddedListeners      .forEach(l -> l.accept(p   ));}
-       private void callPinRemovedListeners    (Pin p) {pinRemovedListeners    .forEach(l -> l.accept(p   ));}
-       private void callRedrawListeners        (     ) {redrawListeners        .forEach(l -> l.run(       ));}
+       public void addComponentMovedListener      (Consumer<? super GUIComponent> listener) {componentMovedListeners  .add   (listener);}
+       public void addComponentResizedListener    (Consumer<? super GUIComponent> listener) {componentResizedListeners.add   (listener);}
+       public void addPinAddedListener            (Consumer<? super Pin         > listener) {pinAddedListeners        .add   (listener);}
+       public void addPinRemovedListener          (Consumer<? super Pin         > listener) {pinRemovedListeners      .add   (listener);}
+       public void addRedrawListener              (Runnable                       listener) {redrawListeners          .add   (listener);}
+
+       public void removeComponentMovedListener   (Consumer<? super GUIComponent> listener) {componentMovedListeners  .remove(listener);}
+       public void removeComponentResizedListener (Consumer<? super GUIComponent> listener) {componentResizedListeners.remove(listener);}
+       public void removePinAddedListener         (Consumer<? super Pin         > listener) {pinAddedListeners        .remove(listener);}
+       public void removePinRemovedListener       (Consumer<? super Pin         > listener) {pinRemovedListeners      .remove(listener);}
+       public void removeRedrawListener           (Runnable                       listener) {redrawListeners          .remove(listener);}
+
+       private void callComponentMovedListeners (     ) {componentMovedListeners  .forEach(l -> l.accept(this));}
+       private void callComponentResizedListener(     ) {componentResizedListeners.forEach(l -> l.accept(this));}
+       private void callPinAddedListeners       (Pin p) {pinAddedListeners        .forEach(l -> l.accept(p   ));}
+       private void callPinRemovedListeners     (Pin p) {pinRemovedListeners      .forEach(l -> l.accept(p   ));}
+       private void callRedrawListeners         (     ) {redrawListeners          .forEach(l -> l.run(       ));}
        // @formatter:on
 }
\ No newline at end of file