Add checkbox, macro checklist provider (#73)

Author: Thodor12

src/main/java/com/ldtteam/blockui/Loader.java

@@ -9,14 +9,15 @@
 import net.minecraft.util.profiling.ProfilerFiller;
 import org.w3c.dom.Document;
 import org.xml.sax.SAXException;
+
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.function.Function;
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-import javax.xml.parsers.ParserConfigurationException;
 
 /**
  * Utilities to load xml files.
@@ -49,6 +50,7 @@ private Loader()
         register("overlay", OverlayView::new);
         register("gradient", Gradient::new);
         register("zoomdragview", ZoomDragView::new);
+        register("checkbox", CheckBox::new);
     }
 
     /**

src/main/java/com/ldtteam/blockui/PaneParams.java

@@ -196,24 +196,25 @@ public String getString(final String name, final String def)
     /**
      * Get the resource location from the name
      * @param name the attribute name
-     * @param def the default value to fallback to
      * @return the parsed resource location
      */
     @Nullable
     public ResourceLocation getResource(final String name)
     {
-        return getProperty(name, Parsers.RESOURCE, null);
+        return getResource(name, (ResourceLocation) null);
     }
 
     /**
      * Get the resource location from the name
      * @param name the attribute name
      * @param def the default value to fallback to
      * @return the parsed resource location
+     * @deprecated use {@link PaneParams#getResource(String, ResourceLocation)} instead.
      */
+    @Deprecated(forRemoval = true, since = "1.20.1")
     public ResourceLocation getResource(final String name, final String def)
     {
-        return getProperty(name, Parsers.RESOURCE, new ResourceLocation(def));
+        return getResource(name, new ResourceLocation(def));
     }
 
     /**
@@ -236,8 +237,8 @@ public ResourceLocation getResource(final String name, final ResourceLocation de
     @Nullable
     public ResourceLocation getResource(final String name, final Consumer<ResourceLocation> loader)
     {
-        ResourceLocation rl = getResource(name, "");
-        if (!rl.getPath().isEmpty())
+        final ResourceLocation rl = getResource(name);
+        if (rl != null && !rl.getPath().isEmpty())
         {
             loader.accept(rl);
             return rl;
@@ -267,7 +268,7 @@ public List<MutableComponent> getMultilineText(final String name, List<MutableCo
     {
         return getProperty(name, Parsers.MULTILINE, def);
     }
-    
+
     /**
      * Get the localized String attribute from the name and revert to the default if not present.
      *

src/main/java/com/ldtteam/blockui/controls/Button.java

@@ -76,6 +76,14 @@ public void setHandler(final ButtonHandler h)
         handler = h;
     }
 
+    /**
+     * @return true if any handler is present
+     */
+    public boolean hasHandler()
+    {
+        return handler != null;
+    }
+
     /**
      * Play click sound and find the proper handler.
      *

src/main/java/com/ldtteam/blockui/controls/ButtonImage.java

@@ -8,14 +8,15 @@
 import com.mojang.blaze3d.systems.RenderSystem;
 import net.minecraft.client.gui.components.AbstractButton;
 import net.minecraft.client.gui.components.WidgetSprites;
+import com.ldtteam.blockui.util.records.SizeI;
+import com.mojang.blaze3d.vertex.PoseStack;
 import net.minecraft.client.renderer.texture.MissingTextureAtlasSprite;
 import net.minecraft.resources.ResourceLocation;
-
-import java.util.Objects;
-
 import net.minecraft.util.Mth;
 import net.neoforged.fml.loading.FMLEnvironment;
 
+import java.util.Objects;
+
 /**
  * Clickable image.
  */
@@ -310,13 +311,34 @@ public void drawSelf(final BOGuiGraphics target, final double mx, final double m
         RenderSystem.defaultBlendFunc();
 
         resolvedTextures.getAndPrepare(isEnabled(), wasCursorInPane).blit(target.pose(), x, y, width, height);
+        postDrawBackground(ms, bind, x, y, width, height, u, v, w, h, mapWidth, mapHeight);
 
         RenderSystem.disableBlend();
         RenderSystem.setShaderColor(1.0F, 1.0F, 1.0F, 1.0F);
 
         super.drawSelf(target, mx, my);
     }
 
+    /**
+     * Called after drawing the button.
+     */
+    public void postDrawBackground(
+      final PoseStack ms,
+      final ResourceLocation image,
+      final int x,
+      final int y,
+      final int width,
+      final int height,
+      final int u,
+      final int v,
+      final int w,
+      final int h,
+      final int mapWidth,
+      final int mapHeight)
+    {
+        // No-op
+    }
+
     @Override
     public void setSize(final int w, final int h)
     {
@@ -356,4 +378,4 @@ public void setTextRenderBox(final int textWidth, final int textHeight)
         this.textHeight = Mth.clamp(textHeight, 0, height - textOffsetY);
         recalcTextRendering();
     }
-}
+}

src/main/java/com/ldtteam/blockui/controls/CheckBox.java

@@ -0,0 +1,100 @@
+package com.ldtteam.blockui.controls;
+
+import com.ldtteam.blockui.PaneParams;
+import com.mojang.blaze3d.vertex.PoseStack;
+import net.minecraft.resources.ResourceLocation;
+
+/**
+ * Checkbox used for toggling a checkmark on and off.
+ */
+public class CheckBox extends ButtonImage
+{
+    /**
+     * The image for the checkmark to render over the button.
+     */
+    protected ResourceLocation checkmarkImage;
+
+    /**
+     * Whether the button is checked or not.
+     */
+    private boolean checked = false;
+
+    /**
+     * Default constructor. Makes a small square button.
+     */
+    public CheckBox()
+    {
+        super();
+    }
+
+    /**
+     * Constructor called by the xml loader.
+     *
+     * @param params PaneParams provided in the xml.
+     */
+    public CheckBox(final PaneParams params)
+    {
+        super(params);
+
+        checkmarkImage = params.getResource("checkmark");
+    }
+
+    @Override
+    public boolean handleClick(final double mx, final double my)
+    {
+        checked = !checked;
+        super.handleClick(mx, my);
+        return true;
+    }
+
+    /**
+     * Set the checkmark image.
+     *
+     * @param loc ResourceLocation for the checkmark.
+     */
+    public void setCheckmarkImage(final ResourceLocation loc)
+    {
+        this.checkmarkImage = loc;
+    }
+
+    @Override
+    public void postDrawBackground(
+      final PoseStack ms,
+      final ResourceLocation image,
+      final int x,
+      final int y,
+      final int width,
+      final int height,
+      final int u,
+      final int v,
+      final int w,
+      final int h,
+      final int mapWidth,
+      final int mapHeight)
+    {
+        if (checked)
+        {
+            blit(ms, checkmarkImage, x, y, width, height, u, v, w, h, mapWidth, mapHeight);
+        }
+    }
+
+    /**
+     * Get if the checkbox is currently checked or not.
+     *
+     * @return true if so.
+     */
+    public boolean isChecked()
+    {
+        return checked;
+    }
+
+    /**
+     * Set whether the checkbox is checked or not.
+     *
+     * @param checked the checked state.
+     */
+    public void setChecked(final boolean checked)
+    {
+        this.checked = checked;
+    }
+}

src/main/java/com/ldtteam/blockui/mod/ClientEventSubscriber.java

@@ -77,7 +77,7 @@ public static void onClientTickEvent(final ClientTickEvent event)
                 }));
                 window.addChild(createTestGuiButton(id++, "Tooltip Positioning", new ResourceLocation(BlockUI.MOD_ID, "gui/test2.xml")));
                 window.addChild(createTestGuiButton(id++, "ItemIcon To BlockState", new ResourceLocation(BlockUI.MOD_ID, "gui/test3.xml"), BlockStateTestGui::setup));
-                window.addChild(createTestGuiButton(id++, "Dynamic ScrollingLists", new ResourceLocation(BlockUI.MOD_ID, "gui/test4.xml"), DynamicScrollingListGui::setup));
+                window.addChild(createTestGuiButton(id++, "Scrolling Lists", new ResourceLocation(BlockUI.MOD_ID, "gui/test4.xml"), ScrollingListsGui::setup));
                 window.open();
             }
         }