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=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..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 @@ -142,7 +142,13 @@ public abstract class GUIComponent /** * Sets the given high-level state to the given value.
- * TODO more documentation! + * 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 */ @@ -154,7 +160,7 @@ public abstract class GUIComponent /** * Gets the current value of the given high-level state.
- * TODO more documentation! + * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs. * * @author Daniel Kirschten */ @@ -197,7 +203,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); }