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=f9294036a20148bf3ad0e6fef789b0e67aaf9618;hb=01c5d7035474a5eb58f216b6831b2c0d8c174efa;hp=f961cafc16269553f5a76c032c7f944c229b0e43;hpb=64031e27d6b607e5475d081f93581960ef5a82b4;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 f961cafc..f9294036 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
@@ -13,6 +13,7 @@ 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.SubmodelComponentParams;
 
 /**
  * The base class for all GUI components.<br>
@@ -142,7 +143,13 @@ public abstract class GUIComponent
 
 	/**
 	 * Sets the given high-level state to the given value. <br>
-	 * TODO more documentation!
+	 * A high level state ID consists of parts separated by dots ('.').<br>
+	 * 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.<br>
+	 * If there is no dot in a high level state ID, the whole high level state ID is called atomic.<br>
+	 * 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
 	 */
@@ -154,7 +161,7 @@ public abstract class GUIComponent
 
 	/**
 	 * Gets the current value of the given high-level state. <br>
-	 * TODO more documentation!
+	 * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
 	 * 
 	 * @author Daniel Kirschten
 	 */
@@ -197,7 +204,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);
 	}