1 package net.mograsim.logic.ui.model.components;
3 import java.util.ArrayList;
4 import java.util.Collections;
5 import java.util.HashMap;
8 import java.util.TreeMap;
9 import java.util.function.Consumer;
10 import java.util.function.Supplier;
12 import net.haspamelodica.swt.helper.gcs.GeneralGC;
13 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
14 import net.mograsim.logic.ui.model.ViewModelModifiable;
15 import net.mograsim.logic.ui.model.wires.Pin;
18 * The base class for all GUI components.<br>
19 * A <code>GUIComponent</code> has a position and size. The size can only be modified by subclasses.<br>
21 * @author Daniel Kirschten
23 public abstract class GUIComponent
26 * The model this component is a part of.
28 protected final ViewModelModifiable model;
29 private final Rectangle bounds;
31 * The list of all pins of this component by name.
33 private final Map<String, Pin> pinsByName;
35 * An unmodifiable view of {@link #pinsByName}.
37 protected final Map<String, Pin> pinsUnmodifiable;
39 private final List<Consumer<? super GUIComponent>> componentMovedListeners;
40 private final List<Consumer<? super Pin>> pinAddedListeners;
41 private final List<Consumer<? super Pin>> pinRemovedListeners;
42 private final List<Runnable> redrawListeners;
44 private final Runnable redrawListenerForSubcomponents;
45 // Defines how the GUIComponent is referenced in SubmodelComponentParams
46 protected Supplier<String> identifierDelegate = () -> getClass().getSimpleName();
48 // creation and destruction
50 public GUIComponent(ViewModelModifiable model)
53 this.bounds = new Rectangle(0, 0, 0, 0);
54 this.pinsByName = new HashMap<>();
55 this.pinsUnmodifiable = Collections.unmodifiableMap(pinsByName);
57 this.componentMovedListeners = new ArrayList<>();
58 this.pinAddedListeners = new ArrayList<>();
59 this.pinRemovedListeners = new ArrayList<>();
60 this.redrawListeners = new ArrayList<>();
62 redrawListenerForSubcomponents = this::requestRedraw;
64 model.componentCreated(this);
68 * Destroys this component. This method implicitly calls {@link ViewModelModifiable#componentDestroyed(GUIComponent)
69 * componentDestroyed()} for the model this component is a part of.
71 * @author Daniel Kirschten
75 pinsByName.values().forEach(p -> pinRemovedListeners.forEach(l -> l.accept(p)));
76 model.componentDestroyed(this);
82 * Adds the given pin to this component and calls pinAddedListeners and redrawListeners.
84 * @throws IllegalArgumentException if the pin doesn't belong to this component
85 * @throws IllegalArgumentException if there already is a pin with the given name
87 * @author Daniel Kirschten
89 protected void addPin(Pin pin)
91 if (pin.component != this)
92 throw new IllegalArgumentException("Can't add a pin not belonging to this component!");
93 if (pinsByName.containsKey(pin.name))
94 throw new IllegalArgumentException("Duplicate pin name: " + pin.name);
95 pinsByName.put(pin.name, pin);
96 callPinAddedListeners(pin);
97 pin.addRedrawListener(redrawListenerForSubcomponents);
102 * Removes the given pin from this component and calls pinAddedListeners and redrawListeners.
104 * @throws NullPointerException if there was no pin with this name
106 * @author Daniel Kirschten
108 protected void removePin(String name)
110 Pin pin = pinsByName.remove(name);
111 callPinRemovedListeners(pin);
112 pin.removeRedrawListener(redrawListenerForSubcomponents);
117 * Returns a collection of pins of this component.
119 * @author Daniel Kirschten
121 public Map<String, Pin> getPins()
123 return pinsUnmodifiable;
127 * Returns the pin with the given name of this component.
129 * @throws IllegalArgumentException if there is no pin with the given name
131 * @author Daniel Kirschten
133 public Pin getPin(String name)
135 Pin pin = pinsByName.get(name);
137 throw new IllegalArgumentException("No pin with the name " + name);
144 * Sets the given high-level state to the given value. <br>
145 * A high level state ID consists of parts separated by dots ('.').<br>
146 * The last part (the part after the last dot) is called "atomic high level state ID". The parts before that part are called
147 * "subcomponent ID"s.<br>
148 * If there is no dot in a high level state ID, the whole high level state ID is called atomic.<br>
149 * Note that subcomponent IDs don't have to correspond to actual subcomponents. For example, a RAM component may supply subcomponent IDs
150 * "c0000", "c0001" ... "cFFFF" without actually having a subcomponent for each cell. It also is allowed for an atomic high level state
151 * ID to be delegated to a subcomponent.
153 * @author Daniel Kirschten
155 @SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden
156 public void setHighLevelState(String stateID, Object newState)
158 throw new IllegalArgumentException("No high level state with ID " + stateID);
162 * Gets the current value of the given high-level state. <br>
163 * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
165 * @author Daniel Kirschten
167 @SuppressWarnings("static-method") // this method is intended to be overridden
168 public Object getHighLevelState(String stateID)
170 throw new IllegalArgumentException("No high level state with ID " + stateID);
173 // "graphical" operations
176 * Sets the position of this component and calls componentMovedListeners and redrawListeners.
178 * @author Daniel Kirschten
180 public void moveTo(double x, double y)
184 callComponentMovedListeners();
189 * Sets the size of this component and calls redrawListeners.
191 * @author Daniel Kirschten
193 protected void setSize(double width, double height)
195 bounds.width = width;
196 bounds.height = height;
201 * Returns the bounds of this component. Is a bit slower than {@link #getPosX()}, {@link #getPosY()}, {@link #getWidth},
202 * {@link #getHeight}, because new objects are created.
204 * @author Daniel Kirschten
206 public final Rectangle getBounds()
208 return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);
212 * Returns the x coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
214 * @author Daniel Kirschten
216 public double getPosX()
222 * Returns the y coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
224 * @author Daniel Kirschten
226 public double getPosY()
232 * Returns the (graphical) width of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
234 * @author Daniel Kirschten
236 public double getWidth()
242 * Returns the height of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
244 * @author Daniel Kirschten
246 public double getHeight()
248 return bounds.height;
252 * Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this
255 * @author Daniel Kirschten
257 @SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden
258 public boolean clicked(double x, double y)
264 * Render this component to the given gc, in absoulute coordinates.
266 * @author Daniel Kirschten
268 public abstract void render(GeneralGC gc, Rectangle visibleRegion);
273 * @return an identifier used to reference this GUIComponent inside of {@link SubmodelComponentParams}
275 public String getIdentifier()
277 return identifierDelegate.get();
280 @SuppressWarnings("static-method")
281 public Map<String, Object> getInstantiationParameters()
283 return new TreeMap<>();
289 * Calls redraw listeners.
291 * @author Daniel Kirschten
293 protected void requestRedraw()
295 callRedrawListeners();
299 public void addComponentMovedListener (Consumer<? super GUIComponent> listener) {componentMovedListeners.add (listener);}
300 public void addPinAddedListener (Consumer<? super Pin > listener) {pinAddedListeners .add (listener);}
301 public void addPinRemovedListener (Consumer<? super Pin > listener) {pinRemovedListeners .add (listener);}
302 public void addRedrawListener (Runnable listener) {redrawListeners .add (listener);}
304 public void removeComponentMovedListener(Consumer<? super GUIComponent> listener) {componentMovedListeners .remove(listener);}
305 public void removePinAddedListener (Consumer<? super Pin > listener) {pinAddedListeners .remove(listener);}
306 public void removePinRemovedListener (Consumer<? super Pin > listener) {pinRemovedListeners .remove(listener);}
307 public void removeRedrawListener (Runnable listener) {redrawListeners .remove(listener);}
309 private void callComponentMovedListeners( ) {componentMovedListeners.forEach(l -> l.accept(this));}
310 private void callPinAddedListeners (Pin p) {pinAddedListeners .forEach(l -> l.accept(p ));}
311 private void callPinRemovedListeners (Pin p) {pinRemovedListeners .forEach(l -> l.accept(p ));}
312 private void callRedrawListeners ( ) {redrawListeners .forEach(l -> l.run( ));}