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.function.Consumer;
10 import net.haspamelodica.swt.helper.gcs.GeneralGC;
11 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
12 import net.mograsim.logic.ui.model.ViewModelModifiable;
13 import net.mograsim.logic.ui.model.wires.Pin;
16 * The base class for all GUI components.<br>
17 * A <code>GUIComponent</code> has a position and size. The size can only be modified by subclasses.<br>
19 * @author Daniel Kirschten
21 public abstract class GUIComponent
24 * The model this component is a part of.
26 protected final ViewModelModifiable model;
27 private final Rectangle bounds;
29 * The list of all pins of this component by name.
31 private final Map<String, Pin> pinsByName;
33 * An unmodifiable view of {@link #pinsByName}.
35 protected final Map<String, Pin> pinsUnmodifiable;
37 private final List<Consumer<? super GUIComponent>> componentMovedListeners;
38 private final List<Consumer<? super Pin>> pinAddedListeners;
39 private final List<Consumer<? super Pin>> pinRemovedListeners;
40 private final List<Runnable> redrawListeners;
42 private final Runnable redrawListenerForSubcomponents;
44 // creation and destruction
46 public GUIComponent(ViewModelModifiable model)
49 this.bounds = new Rectangle(0, 0, 0, 0);
50 this.pinsByName = new HashMap<>();
51 this.pinsUnmodifiable = Collections.unmodifiableMap(pinsByName);
53 this.componentMovedListeners = new ArrayList<>();
54 this.pinAddedListeners = new ArrayList<>();
55 this.pinRemovedListeners = new ArrayList<>();
56 this.redrawListeners = new ArrayList<>();
58 redrawListenerForSubcomponents = this::requestRedraw;
60 model.componentCreated(this);
64 * Destroys this component. This method implicitly calls {@link ViewModelModifiable#componentDestroyed(GUIComponent)
65 * componentDestroyed()} for the model this component is a part of.
67 * @author Daniel Kirschten
71 pinsByName.values().forEach(p -> pinRemovedListeners.forEach(l -> l.accept(p)));
72 model.componentDestroyed(this);
78 * Adds the given pin to this component and calls pinAddedListeners and redrawListeners.
80 * @throws IllegalArgumentException if the pin doesn't belong to this component
81 * @throws IllegalArgumentException if there already is a pin with the given name
83 * @author Daniel Kirschten
85 protected void addPin(Pin pin)
87 if (pin.component != this)
88 throw new IllegalArgumentException("Can't add a pin not belonging to this component!");
89 if (pinsByName.containsKey(pin.name))
90 throw new IllegalArgumentException("Duplicate pin name: " + pin.name);
91 pinsByName.put(pin.name, pin);
92 callPinAddedListeners(pin);
93 pin.addRedrawListener(redrawListenerForSubcomponents);
98 * Removes the given pin from this component and calls pinAddedListeners and redrawListeners.
100 * @throws NullPointerException if there was no pin with this name
102 * @author Daniel Kirschten
104 protected void removePin(String name)
106 Pin pin = pinsByName.remove(name);
107 callPinRemovedListeners(pin);
108 pin.removeRedrawListener(redrawListenerForSubcomponents);
113 * Returns a collection of pins of this component.
115 * @author Daniel Kirschten
117 public Map<String, Pin> getPins()
119 return pinsUnmodifiable;
123 * Returns the pin with the given name of this component.
125 * @throws IllegalArgumentException if there is no pin with the given name
127 * @author Daniel Kirschten
129 public Pin getPin(String name)
131 Pin pin = pinsByName.get(name);
133 throw new IllegalArgumentException("No pin with the name " + name);
140 * Sets the given high-level state to the given value. <br>
141 * A high level state ID consists of parts separated by dots ('.').<br>
142 * The last part (the part after the last dot) is called "atomic high level state ID". The parts before that part are called
143 * "subcomponent ID"s.<br>
144 * If there is no dot in a high level state ID, the whole high level state ID is called atomic.<br>
145 * Note that subcomponent IDs don't have to correspond to actual subcomponents. For example, a RAM component may supply subcomponent IDs
146 * "c0000", "c0001" ... "cFFFF" without actually having a subcomponent for each cell. It also is allowed for an atomic high level state
147 * ID to be delegated to a subcomponent.
149 * @author Daniel Kirschten
151 @SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden
152 public void setHighLevelState(String stateID, Object newState)
154 throw new IllegalArgumentException("No high level state with ID " + stateID);
158 * Gets the current value of the given high-level state. <br>
159 * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
161 * @author Daniel Kirschten
163 @SuppressWarnings("static-method") // this method is intended to be overridden
164 public Object getHighLevelState(String stateID)
166 throw new IllegalArgumentException("No high level state with ID " + stateID);
169 // "graphical" operations
172 * Sets the position of this component and calls componentMovedListeners and redrawListeners.
174 * @author Daniel Kirschten
176 public void moveTo(double x, double y)
180 callComponentMovedListeners();
185 * Sets the size of this component and calls redrawListeners.
187 * @author Daniel Kirschten
189 protected void setSize(double width, double height)
191 bounds.width = width;
192 bounds.height = height;
197 * Returns the bounds of this component. Is a bit slower than {@link #getPosX()}, {@link #getPosY()}, {@link #getWidth},
198 * {@link #getHeight}, because new objects are created.
200 * @author Daniel Kirschten
202 public final Rectangle getBounds()
204 return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);
208 * Returns the x coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
210 * @author Daniel Kirschten
212 public double getPosX()
218 * Returns the y coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
220 * @author Daniel Kirschten
222 public double getPosY()
228 * Returns the (graphical) width of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
230 * @author Daniel Kirschten
232 public double getWidth()
238 * Returns the height of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
240 * @author Daniel Kirschten
242 public double getHeight()
244 return bounds.height;
248 * Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this
251 * @author Daniel Kirschten
253 @SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden
254 public boolean clicked(double x, double y)
260 * Render this component to the given gc, in absoulute coordinates.
262 * @author Daniel Kirschten
264 public abstract void render(GeneralGC gc, Rectangle visibleRegion);
269 * Calls redraw listeners.
271 * @author Daniel Kirschten
273 protected void requestRedraw()
275 callRedrawListeners();
279 public void addComponentMovedListener (Consumer<? super GUIComponent> listener) {componentMovedListeners.add (listener);}
280 public void addPinAddedListener (Consumer<? super Pin > listener) {pinAddedListeners .add (listener);}
281 public void addPinRemovedListener (Consumer<? super Pin > listener) {pinRemovedListeners .add (listener);}
282 public void addRedrawListener (Runnable listener) {redrawListeners .add (listener);}
284 public void removeComponentMovedListener(Consumer<? super GUIComponent> listener) {componentMovedListeners .remove(listener);}
285 public void removePinAddedListener (Consumer<? super Pin > listener) {pinAddedListeners .remove(listener);}
286 public void removePinRemovedListener (Consumer<? super Pin > listener) {pinRemovedListeners .remove(listener);}
287 public void removeRedrawListener (Runnable listener) {redrawListeners .remove(listener);}
289 private void callComponentMovedListeners( ) {componentMovedListeners.forEach(l -> l.accept(this));}
290 private void callPinAddedListeners (Pin p) {pinAddedListeners .forEach(l -> l.accept(p ));}
291 private void callPinRemovedListeners (Pin p) {pinRemovedListeners .forEach(l -> l.accept(p ));}
292 private void callRedrawListeners ( ) {redrawListeners .forEach(l -> l.run( ));}