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=655422a5b7c51c7a03d7db0ef158ab20d27b1526;hb=35df5a4186f12073d5cdc956b645b882b43b858a;hp=69b02bf91725a3782896e0bdd445e4de1d34678b;hpb=19ee1a7fdb06a1df65cd7df78fed935124496707;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 69b02bf9..655422a5 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,11 +1,11 @@ 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; @@ -14,12 +14,27 @@ import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle; import net.mograsim.logic.ui.model.ViewModelModifiable; import net.mograsim.logic.ui.model.wires.Pin; +/** + * The base class for all GUI components.
+ * A GUIComponent has a position and size. The size can only be modified by subclasses.
+ * + * @author Daniel Kirschten + */ public abstract class GUIComponent { + /** + * The model this component is a part of. + */ protected final ViewModelModifiable model; private final Rectangle bounds; + /** + * The list of all pins of this component by name. + */ private final Map pinsByName; - protected final Collection pinsUnmodifiable; + /** + * An unmodifiable view of {@link #pinsByName}. + */ + protected final Map pinsUnmodifiable; private final List> componentMovedListeners; private final List> pinAddedListeners; @@ -28,121 +43,232 @@ public abstract class GUIComponent private final Runnable redrawListenerForSubcomponents; // Defines how the GUIComponent is referenced in SubmodelComponentParams - protected Supplier identifierDelegate = () -> "class:".concat(getClass().getCanonicalName()); + protected Supplier identifierDelegate = () -> getClass().getSimpleName(); + + // creation and destruction public GUIComponent(ViewModelModifiable model) { this.model = model; 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.pinAddedListeners = new ArrayList<>(); this.pinRemovedListeners = new ArrayList<>(); this.redrawListeners = new ArrayList<>(); - redrawListenerForSubcomponents = this::callRedrawListeners; + redrawListenerForSubcomponents = this::requestRedraw; model.componentCreated(this); } + /** + * Destroys this component. This method implicitly calls {@link ViewModelModifiable#componentDestroyed(GUIComponent) + * componentDestroyed()} for the model this component is a part of. + * + * @author Daniel Kirschten + */ public void destroy() { pinsByName.values().forEach(p -> pinRemovedListeners.forEach(l -> l.accept(p))); model.componentDestroyed(this); } - public void moveTo(double x, double y) - { - bounds.x = x; - bounds.y = y; - callComponentMovedListeners(); - } + // pins /** - * Returns the bounds of this component. Used for calculating which component is clicked. + * 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 */ - public Rectangle getBounds() + protected void addPin(Pin pin) { - return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height); + 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); + callPinAddedListeners(pin); + pin.addRedrawListener(redrawListenerForSubcomponents); + requestRedraw(); } /** - * Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this - * click. + * Removes the given pin from this component and calls pinAddedListeners and redrawListeners. + * + * @throws NullPointerException if there was no pin with this name + * + * @author Daniel Kirschten */ - @SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden - public boolean clicked(double x, double y) + protected void removePin(String name) { - return false; + Pin pin = pinsByName.remove(name); + callPinRemovedListeners(pin); + pin.removeRedrawListener(redrawListenerForSubcomponents); + requestRedraw(); } /** * Returns a collection of pins of this component. + * + * @author Daniel Kirschten */ - public Collection getPins() + public Map getPins() { return pinsUnmodifiable; } + /** + * Returns the pin with the given name of this component. + * + * @throws IllegalArgumentException if there is no pin with the given name + * + * @author Daniel Kirschten + */ public Pin getPin(String name) { - return pinsByName.get(name); + Pin pin = pinsByName.get(name); + if (pin == null) + throw new IllegalArgumentException("No pin with the name " + name); + return pin; } - // @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);} + // high-level access - 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( ));} - // @formatter:on + /** + * Sets the given high-level state to the given value.
+ * A high level state ID consists of parts separated by dots ('.').
+ * 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.
+ * If there is no dot in a high level state ID, the whole high level state ID is called atomic.
+ * 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); + } /** - * Render this component to the given gc. + * Gets the current value of the given high-level state.
+ * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs. + * + * @author Daniel Kirschten */ - public abstract void render(GeneralGC gc, Rectangle visibleRegion); + @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); + } - protected void requestRedraw() + // "graphical" operations + + /** + * Sets the position of this component and calls componentMovedListeners and redrawListeners. + * + * @author Daniel Kirschten + */ + public void moveTo(double x, double y) { - callRedrawListeners(); + bounds.x = x; + bounds.y = y; + callComponentMovedListeners(); + requestRedraw(); } + /** + * Sets the size of this component and calls redrawListeners. + * + * @author Daniel Kirschten + */ protected void setSize(double width, double height) { bounds.width = width; bounds.height = height; - callRedrawListeners(); + requestRedraw(); } - protected void addPin(Pin pin) + /** + * Returns the bounds of this component. Is a bit slower than {@link #getPosX()}, {@link #getPosY()}, {@link #getWidth}, + * {@link #getHeight}, because new objects are created. + * + * @author Daniel Kirschten + */ + public final Rectangle getBounds() { - if (pinsByName.containsKey(pin.name)) - throw new IllegalArgumentException("Duplicate pin name: " + pin.name); - pinsByName.put(pin.name, pin); - callPinAddedListeners(pin); - pin.addRedrawListener(redrawListenerForSubcomponents); - callRedrawListeners(); + return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height); } - protected void removePin(String name) + /** + * Returns the x coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created. + * + * @author Daniel Kirschten + */ + public double getPosX() { - Pin pin = pinsByName.remove(name); - callPinRemovedListeners(pin); - pin.removeRedrawListener(redrawListenerForSubcomponents); - callRedrawListeners(); + return bounds.x; + } + + /** + * Returns the y coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created. + * + * @author Daniel Kirschten + */ + public double getPosY() + { + return bounds.y; } + /** + * Returns the (graphical) width of this component. Is a bit faster than {@link #getBounds()} because no objects are created. + * + * @author Daniel Kirschten + */ + public double getWidth() + { + return bounds.width; + } + + /** + * Returns the height of this component. Is a bit faster than {@link #getBounds()} because no objects are created. + * + * @author Daniel Kirschten + */ + public double getHeight() + { + return bounds.height; + } + + /** + * 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) + { + return false; + } + + /** + * Render this component to the given gc, in absoulute coordinates. + * + * @author Daniel Kirschten + */ + public abstract void render(GeneralGC gc, Rectangle visibleRegion); + + // serializing + /** * @return an identifier used to reference this GUIComponent inside of {@link SubmodelComponentParams} */ @@ -150,4 +276,39 @@ public abstract class GUIComponent { return identifierDelegate.get(); } + + @SuppressWarnings("static-method") + public Map getInstantiationParameters() + { + return new TreeMap<>(); + } + + // listeners + + /** + * Calls redraw listeners. + * + * @author Daniel Kirschten + */ + protected void requestRedraw() + { + callRedrawListeners(); + } + + // @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( ));} + // @formatter:on } \ No newline at end of file