3.1 (#189)

* context menu things

* a bunch of things

* compiles

* finally works

* context menus finally working again

* mroe stuff

* new delegating widget, remove obsolete ContextMenuOption

* panels can have their own theme

* improve context menu theme

* deprecate single arg ModularScreen ctor

* open overlays via new event & deprecate OverlayManager & OverlayHandler

* clean up

* more clean up

* dropdown widget

* javadoc

* relativeToScreen works again

* reorganize IWidget

* fixes & cleanup

* fix applyPos issue

* minor adjustments and fixes

Author: brachy84

src/main/java/com/cleanroommc/modularui/ClientProxy.java

@@ -10,7 +10,6 @@
 import com.cleanroommc.modularui.keybind.KeyBindHandler;
 import com.cleanroommc.modularui.screen.ClientScreenHandler;
 import com.cleanroommc.modularui.test.EventHandler;
-import com.cleanroommc.modularui.test.OverlayTest;
 import com.cleanroommc.modularui.test.TestItem;
 import com.cleanroommc.modularui.theme.ThemeManager;
 import com.cleanroommc.modularui.theme.ThemeReloadCommand;
@@ -70,9 +69,6 @@ void preInit(FMLPreInitializationEvent event) {
             testKey = new KeyBinding("key.test", KeyConflictContext.IN_GAME, Keyboard.KEY_NUMPAD4, "key.categories.modularui");
             ClientRegistry.registerKeyBinding(testKey);
         }
-        if (ModularUIConfig.enableTestOverlays) {
-            OverlayTest.init();
-        }
 
         DrawableSerialization.init();
         RenderingRegistry.registerEntityRenderingHandler(HoloScreenEntity.class, ScreenEntityRender::new);

src/main/java/com/cleanroommc/modularui/GuiError.java

@@ -1,9 +1,6 @@
 package com.cleanroommc.modularui;
 
-import com.cleanroommc.modularui.api.widget.IGuiElement;
-
-import com.cleanroommc.modularui.network.NetworkHandler;
-
+import com.cleanroommc.modularui.api.widget.IWidget;
 import com.cleanroommc.modularui.network.NetworkUtils;
 
 import org.apache.logging.log4j.Level;
@@ -12,18 +9,18 @@
 
 public class GuiError {
 
-    public static void throwNew(IGuiElement guiElement, Type type, String msg) {
+    public static void throwNew(IWidget guiElement, Type type, String msg) {
         if (NetworkUtils.isClient()) {
             GuiErrorHandler.INSTANCE.pushError(guiElement, type, msg);
         }
     }
 
     private final Level level = Level.ERROR;
     private final String msg;
-    private final IGuiElement reference;
+    private final IWidget reference;
     private final Type type;
 
-    protected GuiError(String msg, IGuiElement reference, Type type) {
+    protected GuiError(String msg, IWidget reference, Type type) {
         this.msg = msg;
         this.reference = reference;
         this.type = type;
@@ -33,7 +30,7 @@ public Level getLevel() {
         return level;
     }
 
-    public IGuiElement getReference() {
+    public IWidget getReference() {
         return reference;
     }
 

src/main/java/com/cleanroommc/modularui/GuiErrorHandler.java

@@ -1,6 +1,6 @@
 package com.cleanroommc.modularui;
 
-import com.cleanroommc.modularui.api.widget.IGuiElement;
+import com.cleanroommc.modularui.api.widget.IWidget;
 
 import net.minecraftforge.fml.relauncher.Side;
 import net.minecraftforge.fml.relauncher.SideOnly;
@@ -25,7 +25,7 @@ public void clear() {
         this.errors.clear();
     }
 
-    void pushError(IGuiElement reference, GuiError.Type type, String msg) {
+    void pushError(IWidget reference, GuiError.Type type, String msg) {
         GuiError error = new GuiError(msg, reference, type);
         if (this.errorSet.add(error)) {
             ModularUI.LOGGER.log(error.getLevel(), error);

src/main/java/com/cleanroommc/modularui/ModularUI.java

@@ -7,6 +7,7 @@
 import net.minecraftforge.fml.common.event.FMLPostInitializationEvent;
 import net.minecraftforge.fml.common.event.FMLPreInitializationEvent;
 import net.minecraftforge.fml.common.event.FMLServerStartingEvent;
+import net.minecraftforge.fml.relauncher.FMLLaunchHandler;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -36,6 +37,8 @@ public class ModularUI {
             serverSide = "com.cleanroommc.modularui.CommonProxy")
     public static CommonProxy proxy;
 
+    public static final boolean isDev = FMLLaunchHandler.isDeobfuscatedEnvironment();
+
     @Mod.Instance
     public static ModularUI INSTANCE;
 

src/main/java/com/cleanroommc/modularui/animation/Animator.java

@@ -171,8 +171,6 @@ public Animator curve(IInterpolation curve) {
         return this;
     }
 
-
-
     /**
      * Sets a function which is executed everytime the progress updates, that is on every frame.
      * The argument of the function is the interpolated value.

src/main/java/com/cleanroommc/modularui/api/IGuiHolder.java

@@ -1,5 +1,6 @@
 package com.cleanroommc.modularui.api;
 
+import com.cleanroommc.modularui.ModularUI;
 import com.cleanroommc.modularui.factory.GuiData;
 import com.cleanroommc.modularui.screen.ModularPanel;
 import com.cleanroommc.modularui.screen.ModularScreen;
@@ -24,7 +25,8 @@ public interface IGuiHolder<T extends GuiData> {
      */
     @SideOnly(Side.CLIENT)
     default ModularScreen createScreen(T data, ModularPanel mainPanel) {
-        return new ModularScreen(mainPanel);
+        ModularUI.LOGGER.warn("IGuiHolder.createScreen() should be overridden to pass you own mod id to the ModularScreen. In future versions this method must be overridden or else it will crash!");
+        return new ModularScreen(ModularUI.ID, mainPanel);
     }
 
     /**

src/main/java/com/cleanroommc/modularui/api/IThemeApi.java

@@ -3,6 +3,7 @@
 import com.cleanroommc.modularui.api.drawable.IDrawable;
 import com.cleanroommc.modularui.drawable.GuiTextures;
 import com.cleanroommc.modularui.drawable.Scrollbar;
+import com.cleanroommc.modularui.screen.ModularPanel;
 import com.cleanroommc.modularui.screen.ModularScreen;
 import com.cleanroommc.modularui.theme.SelectableTheme;
 import com.cleanroommc.modularui.theme.SlotTheme;
@@ -167,7 +168,32 @@ default void registerTheme(ThemeBuilder<?> themeBuilder) {
      * @param defaultTheme default theme if no theme was found
      * @return the registered theme for the given screen or the given default theme or {@link #getDefaultTheme()}
      */
-    ITheme getThemeForScreen(String owner, String name, @Nullable String defaultTheme);
+    default ITheme getThemeForScreen(String owner, String name, @Nullable String defaultTheme, @Nullable String fallbackTheme) {
+        return getThemeForScreen(owner, name, null, defaultTheme, fallbackTheme);
+    }
+
+    /**
+     * Gets the appropriate theme for a screen.
+     *
+     * @param owner        owner of the screen
+     * @param name         name of the screen
+     * @param panel        the name
+     * @param defaultTheme default theme if no theme was found
+     * @return the registered theme for the given screen or the given default theme or {@link #getDefaultTheme()}
+     */
+    ITheme getThemeForScreen(String owner, String name, @Nullable String panel, @Nullable String defaultTheme, @Nullable String fallbackTheme);
+
+    /**
+     * Gets the appropriate theme for a specific panel.
+     *
+     * @param panel        the panel to find a theme for
+     * @param defaultTheme default theme if no theme was found
+     * @return the registered theme for the given screen or the given default theme or {@link #getDefaultTheme()}
+     */
+    default ITheme getThemeForScreen(ModularPanel panel, @Nullable String defaultTheme) {
+        ModularScreen screen = panel.getScreen();
+        return getThemeForScreen(screen.getOwner(), screen.getName(), panel.getName(), defaultTheme, screen.getThemeOverride());
+    }
 
     /**
      * Gets the appropriate theme for a screen.
@@ -177,7 +203,7 @@ default void registerTheme(ThemeBuilder<?> themeBuilder) {
      * @return the registered theme for the given screen or the given default theme or {@link #getDefaultTheme()}
      */
     default ITheme getThemeForScreen(ModularScreen screen, @Nullable String defaultTheme) {
-        return getThemeForScreen(screen.getOwner(), screen.getName(), defaultTheme);
+        return getThemeForScreen(screen.getOwner(), screen.getName(), defaultTheme, null);
     }
 
     /**

src/main/java/com/cleanroommc/modularui/api/ITreeNode.java

@@ -0,0 +1,18 @@
+package com.cleanroommc.modularui.api;
+
+import java.util.List;
+
+public interface ITreeNode<T extends ITreeNode<T>> {
+
+    T getParent();
+
+    default boolean hasParent() {
+        return getParent() != null;
+    }
+
+    List<T> getChildren();
+
+    default boolean hasChildren() {
+        return !getChildren().isEmpty();
+    }
+}

src/main/java/com/cleanroommc/modularui/api/layout/IResizeParent.java

@@ -0,0 +1,75 @@
+package com.cleanroommc.modularui.api.layout;
+
+import com.cleanroommc.modularui.api.GuiAxis;
+import com.cleanroommc.modularui.widget.sizer.Area;
+
+public interface IResizeParent {
+
+    /**
+     * @return area of the element
+     */
+    Area getArea();
+
+    /**
+     * @return true if the relative x position is calculated
+     */
+    boolean isXCalculated();
+
+    /**
+     * @return true if the relative y position is calculated
+     */
+    boolean isYCalculated();
+
+    /**
+     * @return true if the width is calculated
+     */
+    boolean isWidthCalculated();
+
+    /**
+     * @return true if the height is calculated
+     */
+    boolean isHeightCalculated();
+
+    boolean areChildrenCalculated();
+
+    boolean isLayoutDone();
+
+    boolean canRelayout(boolean isParentLayout);
+
+    default boolean isSizeCalculated(GuiAxis axis) {
+        return axis.isHorizontal() ? isWidthCalculated() : isHeightCalculated();
+    }
+
+    default boolean isPosCalculated(GuiAxis axis) {
+        return axis.isHorizontal() ? isXCalculated() : isYCalculated();
+    }
+
+    /**
+     * @return true if the relative position and size are fully calculated
+     */
+    default boolean isSelfFullyCalculated(boolean isParentLayout) {
+        return isSelfFullyCalculated() && !canRelayout(isParentLayout);
+    }
+
+    default boolean isSelfFullyCalculated() {
+        return isXCalculated() && isYCalculated() && isWidthCalculated() && isHeightCalculated();
+    }
+
+    default boolean isFullyCalculated() {
+        return isSelfFullyCalculated() && areChildrenCalculated() && isLayoutDone();
+    }
+
+    default boolean isFullyCalculated(boolean isParentLayout) {
+        return isFullyCalculated() && !canRelayout(isParentLayout);
+    }
+
+    /**
+     * @return true if margin and padding are applied on the x-axis
+     */
+    boolean isXMarginPaddingApplied();
+
+    /**
+     * @return true if margin and padding are applied on the y-axis
+     */
+    boolean isYMarginPaddingApplied();
+}

src/main/java/com/cleanroommc/modularui/api/layout/IResizeable.java

@@ -1,103 +1,43 @@
 package com.cleanroommc.modularui.api.layout;
 
 import com.cleanroommc.modularui.api.GuiAxis;
-import com.cleanroommc.modularui.api.widget.IGuiElement;
-import com.cleanroommc.modularui.widget.sizer.Area;
 
 /**
  * An interface that handles resizing of widgets.
  * Usually this interface is not implemented by the users of this library or will even interact with it.
  */
-public interface IResizeable {
+public interface IResizeable extends IResizeParent {
 
     /**
      * Called once before resizing
      */
-    void initResizing();
+    void initResizing(boolean onOpen);
 
     /**
      * Resizes the given element
      *
-     * @param guiElement     element to resize
      * @param isParentLayout if the parent is a layout widget
      * @return true if element is fully resized
      */
-    boolean resize(IGuiElement guiElement, boolean isParentLayout);
+    boolean resize(boolean isParentLayout);
 
     /**
-     * Called if {@link #resize(IGuiElement, boolean)} returned false after children have been resized.
+     * Called if {@link #resize(boolean)} returned false after children have been resized.
      *
-     * @param guiElement element to resize
      * @return if element is fully resized
      */
-    boolean postResize(IGuiElement guiElement);
+    boolean postResize();
 
     /**
      * Called after all elements in the tree are resized and the absolute positions needs to be calculated from the
      * relative postion.
-     *
-     * @param guiElement element that was resized
-     */
-    default void applyPos(IGuiElement guiElement) {}
-
-    /**
-     * @return area of the element
-     */
-    // TODO doesnt fit with the other api methods in this interface
-    Area getArea();
-
-    /**
-     * @return true if the relative x position is calculated
-     */
-    boolean isXCalculated();
-
-    /**
-     * @return true if the relative y position is calculated
      */
-    boolean isYCalculated();
-
-    /**
-     * @return true if the width is calculated
-     */
-    boolean isWidthCalculated();
-
-    /**
-     * @return true if the height is calculated
-     */
-    boolean isHeightCalculated();
-
-    boolean areChildrenCalculated();
-
-    boolean isLayoutDone();
-
-    default boolean isSizeCalculated(GuiAxis axis) {
-        return axis.isHorizontal() ? isWidthCalculated() : isHeightCalculated();
-    }
-
-    default boolean isPosCalculated(GuiAxis axis) {
-        return axis.isHorizontal() ? isXCalculated() : isYCalculated();
-    }
+    default void preApplyPos() {}
 
     /**
-     * @return true if the relative position and size are fully calculated
+     * This converts the relative pos to resizer parent to relative pos to widget parent.
      */
-    default boolean isSelfFullyCalculated(boolean isParentLayout) {
-        return isSelfFullyCalculated() && !canRelayout(isParentLayout);
-    }
-
-    default boolean isSelfFullyCalculated() {
-        return isXCalculated() && isYCalculated() && isWidthCalculated() && isHeightCalculated();
-    }
-
-    default boolean isFullyCalculated() {
-        return isSelfFullyCalculated() && areChildrenCalculated() && isLayoutDone();
-    }
-
-    default boolean isFullyCalculated(boolean isParentLayout) {
-        return isSelfFullyCalculated(isParentLayout) && areChildrenCalculated() && isLayoutDone();
-    }
-
-    boolean canRelayout(boolean isParentLayout);
+    default void applyPos() {}
 
     void setChildrenResized(boolean resized);
 
@@ -182,14 +122,4 @@ default void setMarginPaddingApplied(GuiAxis axis, boolean b) {
             setYMarginPaddingApplied(b);
         }
     }
-
-    /**
-     * @return true if margin and padding are applied on the x-axis
-     */
-    boolean isXMarginPaddingApplied();
-
-    /**
-     * @return true if margin and padding are applied on the y-axis
-     */
-    boolean isYMarginPaddingApplied();
 }