1 package net.mograsim.logic.ui.model.components;
3 import java.util.ArrayList;
4 import java.util.Collection;
5 import java.util.Collections;
6 import java.util.HashMap;
9 import java.util.TreeMap;
10 import java.util.function.Consumer;
11 import java.util.function.Supplier;
13 import net.haspamelodica.swt.helper.gcs.GeneralGC;
14 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
15 import net.mograsim.logic.ui.model.ViewModelModifiable;
16 import net.mograsim.logic.ui.model.wires.Pin;
19 * The base class for all GUI components.<br>
20 * A <code>GUIComponent</code> has a position and size. The size can only be modified by subclasses.<br>
22 * @author Daniel Kirschten
24 public abstract class GUIComponent
27 * The model this component is a part of.
29 protected final ViewModelModifiable model;
30 private final Rectangle bounds;
32 * The list of all pins of this component by name.
34 private final Map<String, Pin> pinsByName;
36 * An unmodifiable view of {@link #pinsByName}<code>.</code>{@link Map#values() values()}.
38 protected final Collection<Pin> pinsUnmodifiable;
40 private final List<Consumer<? super GUIComponent>> componentMovedListeners;
41 private final List<Consumer<? super Pin>> pinAddedListeners;
42 private final List<Consumer<? super Pin>> pinRemovedListeners;
43 private final List<Runnable> redrawListeners;
45 private final Runnable redrawListenerForSubcomponents;
46 // Defines how the GUIComponent is referenced in SubmodelComponentParams
47 protected Supplier<String> identifierDelegate = () -> "class:".concat(getClass().getCanonicalName());
49 // creation and destruction
51 public GUIComponent(ViewModelModifiable model)
54 this.bounds = new Rectangle(0, 0, 0, 0);
55 this.pinsByName = new HashMap<>();
56 this.pinsUnmodifiable = Collections.unmodifiableCollection(pinsByName.values());
58 this.componentMovedListeners = new ArrayList<>();
59 this.pinAddedListeners = new ArrayList<>();
60 this.pinRemovedListeners = new ArrayList<>();
61 this.redrawListeners = new ArrayList<>();
63 redrawListenerForSubcomponents = this::requestRedraw;
65 model.componentCreated(this);
69 * Destroys this component. This method implicitly calls {@link ViewModelModifiable#componentDestroyed(GUIComponent)
70 * componentDestroyed()} for the model this component is a part of.
72 * @author Daniel Kirschten
76 pinsByName.values().forEach(p -> pinRemovedListeners.forEach(l -> l.accept(p)));
77 model.componentDestroyed(this);
83 * Adds the given pin to this component and calls pinAddedListeners and redrawListeners.
85 * @throws IllegalArgumentException if the pin doesn't belong to this component
86 * @throws IllegalArgumentException if there already is a pin with the given name
88 * @author Daniel Kirschten
90 protected void addPin(Pin pin)
92 if (pin.component != this)
93 throw new IllegalArgumentException("Can't add a pin not belonging to this component!");
94 if (pinsByName.containsKey(pin.name))
95 throw new IllegalArgumentException("Duplicate pin name: " + pin.name);
96 pinsByName.put(pin.name, pin);
97 callPinAddedListeners(pin);
98 pin.addRedrawListener(redrawListenerForSubcomponents);
103 * Removes the given pin from this component and calls pinAddedListeners and redrawListeners.
105 * @throws NullPointerException if there was no pin with this name
107 * @author Daniel Kirschten
109 protected void removePin(String name)
111 Pin pin = pinsByName.remove(name);
112 callPinRemovedListeners(pin);
113 pin.removeRedrawListener(redrawListenerForSubcomponents);
118 * Returns a collection of pins of this component.
120 * @author Daniel Kirschten
122 public Collection<Pin> getPins()
124 return pinsUnmodifiable;
128 * Returns the pin with the given name of this component.
130 * @throws IllegalArgumentException if there is no pin with the given name
132 * @author Daniel Kirschten
134 public Pin getPin(String name)
136 Pin pin = pinsByName.get(name);
138 throw new IllegalArgumentException("No pin with the name " + name);
142 // "graphical" operations
145 * Sets the position of this component and calls componentMovedListeners and redrawListeners.
147 * @author Daniel Kirschten
149 public void moveTo(double x, double y)
153 callComponentMovedListeners();
158 * Sets the size of this component and calls redrawListeners.
160 * @author Daniel Kirschten
162 protected void setSize(double width, double height)
164 bounds.width = width;
165 bounds.height = height;
170 * Returns the bounds of this component. Is a bit slower than {@link #getPosX()}, {@link #getPosY()}, {@link #getWidth},
171 * {@link #getHeight}, because new objects are created.
173 * @author Daniel Kirschten
175 public Rectangle getBounds()
177 return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);
181 * Returns the x coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
183 * @author Daniel Kirschten
185 public double getPosX()
191 * Returns the y coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
193 * @author Daniel Kirschten
195 public double getPosY()
201 * Returns the (graphical) width of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
203 * @author Daniel Kirschten
205 public double getWidth()
211 * Returns the height of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
213 * @author Daniel Kirschten
215 public double getHeight()
217 return bounds.height;
221 * Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this
224 * @author Daniel Kirschten
226 @SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden
227 public boolean clicked(double x, double y)
233 * Render this component to the given gc, in absoulute coordinates.
235 * @author Daniel Kirschten
237 public abstract void render(GeneralGC gc, Rectangle visibleRegion);
242 * @return an identifier used to reference this GUIComponent inside of {@link SubmodelComponentParams}
244 public String getIdentifier()
246 return identifierDelegate.get();
249 @SuppressWarnings("static-method")
250 public Map<String, Object> getInstantiationParameters()
252 return new TreeMap<>();
258 * Calls redraw listeners.
260 * @author Daniel Kirschten
262 protected void requestRedraw()
264 callRedrawListeners();
268 public void addComponentMovedListener (Consumer<? super GUIComponent> listener) {componentMovedListeners.add (listener);}
269 public void addPinAddedListener (Consumer<? super Pin > listener) {pinAddedListeners .add (listener);}
270 public void addPinRemovedListener (Consumer<? super Pin > listener) {pinRemovedListeners .add (listener);}
271 public void addRedrawListener (Runnable listener) {redrawListeners .add (listener);}
273 public void removeComponentMovedListener(Consumer<? super GUIComponent> listener) {componentMovedListeners .remove(listener);}
274 public void removePinAddedListener (Consumer<? super Pin > listener) {pinAddedListeners .remove(listener);}
275 public void removePinRemovedListener (Consumer<? super Pin > listener) {pinRemovedListeners .remove(listener);}
276 public void removeRedrawListener (Runnable listener) {redrawListeners .remove(listener);}
278 private void callComponentMovedListeners( ) {componentMovedListeners.forEach(l -> l.accept(this));}
279 private void callPinAddedListeners (Pin p) {pinAddedListeners .forEach(l -> l.accept(p ));}
280 private void callPinRemovedListeners (Pin p) {pinRemovedListeners .forEach(l -> l.accept(p ));}
281 private void callRedrawListeners ( ) {redrawListeners .forEach(l -> l.run( ));}