X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.ui%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fui%2Fmodel%2Fcomponents%2FGUIComponent.java;h=bf9ea85bebfa82e37756cf3b38890dd0a661d0ee;hb=5ece0acf049bf9af2933f513fe0206565681f622;hp=562f73a4f64ab1aa5fd90b9a50c377e7e7a15e49;hpb=fd5d1e21b18b426d78f0c9b5084f63a774876d9a;p=Mograsim.git
diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
index 562f73a4..bf9ea85b 100644
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
@@ -1,19 +1,20 @@
package net.mograsim.logic.ui.model.components;
import java.util.ArrayList;
-import java.util.Collection;
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;
import net.mograsim.logic.ui.model.ViewModelModifiable;
import net.mograsim.logic.ui.model.wires.Pin;
+import net.mograsim.logic.ui.serializing.snippets.HighLevelStateHandler;
/**
* The base class for all GUI components.
@@ -27,35 +28,39 @@ public abstract class GUIComponent
* The model this component is a part of.
*/
protected final ViewModelModifiable model;
+ /**
+ * The name of this component. Is unique in its model.
+ */
+ public final String name;
private final Rectangle bounds;
/**
* The list of all pins of this component by name.
*/
private final Map pinsByName;
/**
- * An unmodifiable view of {@link #pinsByName}.{@link Map#values() values()}.
+ * An unmodifiable view of {@link #pinsByName}.
*/
- protected final Collection pinsUnmodifiable;
+ protected final Map pinsUnmodifiable;
private final List> componentMovedListeners;
+ private final List> componentResizedListeners;
private final List> pinAddedListeners;
private final List> pinRemovedListeners;
private final List redrawListeners;
private final Runnable redrawListenerForSubcomponents;
- // Defines how the GUIComponent is referenced in SubmodelComponentParams
- protected Supplier identifierDelegate = () -> "class:".concat(getClass().getCanonicalName());
-
// creation and destruction
- public GUIComponent(ViewModelModifiable model)
+ public GUIComponent(ViewModelModifiable model, String name)
{
this.model = model;
+ this.name = name == null ? model.getDefaultComponentName(this) : name;
this.bounds = new Rectangle(0, 0, 0, 0);
this.pinsByName = new HashMap<>();
- this.pinsUnmodifiable = Collections.unmodifiableCollection(pinsByName.values());
+ 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<>();
@@ -81,9 +86,16 @@ public abstract class GUIComponent
/**
* Adds the given pin to this component and calls pinAddedListeners and redrawListeners.
+ *
+ * @throws IllegalArgumentException if the pin doesn't belong to this component
+ * @throws IllegalArgumentException if there already is a pin with the given name
+ *
+ * @author Daniel Kirschten
*/
protected void addPin(Pin pin)
{
+ if (pin.component != this)
+ throw new IllegalArgumentException("Can't add a pin not belonging to this component!");
if (pinsByName.containsKey(pin.name))
throw new IllegalArgumentException("Duplicate pin name: " + pin.name);
pinsByName.put(pin.name, pin);
@@ -95,7 +107,9 @@ public abstract class GUIComponent
/**
* Removes the given pin from this component and calls pinAddedListeners and redrawListeners.
*
- * @throws NullPointerException if there was no pin with this name.
+ * @throws NullPointerException if there was no pin with this name
+ *
+ * @author Daniel Kirschten
*/
protected void removePin(String name)
{
@@ -110,7 +124,7 @@ public abstract class GUIComponent
*
* @author Daniel Kirschten
*/
- public Collection getPins()
+ public Map getPins()
{
return pinsUnmodifiable;
}
@@ -130,6 +144,38 @@ public abstract class GUIComponent
return pin;
}
+ // 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.
+ *
+ * @see #getHighLevelState(String)
+ * @see HighLevelStateHandler#setHighLevelState(String, Object)
+ *
+ * @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.
+ * See {@link HighLevelStateHandler#setHighLevelState(String, Object)} for an explanation of high-level state IDs.
+ *
+ * @see #setHighLevelState(String, Object)
+ * @see HighLevelStateHandler#getHighLevelState(String)
+ *
+ * @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
/**
@@ -154,6 +200,7 @@ public abstract class GUIComponent
{
bounds.width = width;
bounds.height = height;
+ callComponentResizedListener();
requestRedraw();
}
@@ -163,7 +210,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);
}
@@ -211,6 +258,8 @@ public abstract class GUIComponent
/**
* Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this
* click.
+ *
+ * @author Daniel Kirschten
*/
@SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden
public boolean clicked(double x, double y)
@@ -227,18 +276,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 getInstantiationParameters()
+ @SuppressWarnings("static-method") // this method is intended to be overridden
+ public JsonElement getParams()
{
- return new TreeMap<>();
+ return JsonNull.INSTANCE;
}
// listeners
@@ -254,19 +295,22 @@ public abstract class GUIComponent
}
// @formatter:off
- public void addComponentMovedListener (Consumer listener) {componentMovedListeners.add (listener);}
- public void addPinAddedListener (Consumer listener) {pinAddedListeners .add (listener);}
- public void addPinRemovedListener (Consumer listener) {pinRemovedListeners .add (listener);}
- public void addRedrawListener (Runnable listener) {redrawListeners .add (listener);}
-
- public void removeComponentMovedListener(Consumer listener) {componentMovedListeners .remove(listener);}
- public void removePinAddedListener (Consumer listener) {pinAddedListeners .remove(listener);}
- public void removePinRemovedListener (Consumer 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 listener) {componentMovedListeners .add (listener);}
+ public void addComponentResizedListener (Consumer listener) {componentResizedListeners.add (listener);}
+ public void addPinAddedListener (Consumer listener) {pinAddedListeners .add (listener);}
+ public void addPinRemovedListener (Consumer listener) {pinRemovedListeners .add (listener);}
+ public void addRedrawListener (Runnable listener) {redrawListeners .add (listener);}
+
+ public void removeComponentMovedListener (Consumer listener) {componentMovedListeners .remove(listener);}
+ public void removeComponentResizedListener (Consumer listener) {componentResizedListeners.remove(listener);}
+ public void removePinAddedListener (Consumer listener) {pinAddedListeners .remove(listener);}
+ public void removePinRemovedListener (Consumer 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