Allow scrolling list items to have a dynamic size (#66)

* Allow scrolling list items to have a dynamic size, second edition of #59

Author: Thodor12

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

@@ -76,7 +76,7 @@ public Pane(final PaneParams params)
             height = a.get(1);
         });
 
-        params.getScaledInteger("pos", params.getParentView().x, params.getParentView().y, a -> {
+        params.getScaledInteger("pos", params.getParentLeft(), params.getParentTop(), a -> {
             x = a.get(0);
             y = a.get(1);
         });

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

@@ -33,31 +33,76 @@ public PaneParams(final Node n)
         children = new ArrayList<>(node.getChildNodes().getLength());
     }
 
+    /**
+     * Get the node type.
+     *
+     * @return the name of the node.
+     */
     public String getType()
     {
         return node.getNodeName();
     }
 
+    /**
+     * Get the parent for this pane.
+     *
+     * @return the parent.
+     */
     public View getParentView()
     {
         return parentView;
     }
 
+    /**
+     * Set the parent for this pane.
+     *
+     * @param parent the new parent.
+     */
     public void setParentView(final View parent)
     {
         parentView = parent;
     }
 
+    /**
+     * Get the width of the parent, if any. Defaults to 0 if no parent has been set.
+     *
+     * @return the width.
+     */
     public int getParentWidth()
     {
         return parentView != null ? parentView.getInteriorWidth() : 0;
     }
 
+    /**
+     * Get the height of the parent, if any. Defaults to 0 if no parent has been set.
+     *
+     * @return the height.
+     */
     public int getParentHeight()
     {
         return parentView != null ? parentView.getInteriorHeight() : 0;
     }
 
+    /**
+     * Get the left position of the parent, if any. Defaults to 0 if no parent has been set.
+     *
+     * @return the left position.
+     */
+    public int getParentLeft()
+    {
+        return parentView != null ? parentView.x : 0;
+    }
+
+    /**
+     * Get the top position of the parent, if any. Defaults to 0 if no parent has been set.
+     *
+     * @return the top position.
+     */
+    public int getParentTop()
+    {
+        return parentView != null ? parentView.y : 0;
+    }
+
     public List<PaneParams> getChildren()
     {
         if (!children.isEmpty()) return children;

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

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

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

@@ -0,0 +1,58 @@
+package com.ldtteam.blockui.mod;
+
+import com.ldtteam.blockui.Pane;
+import com.ldtteam.blockui.controls.Text;
+import com.ldtteam.blockui.views.BOWindow;
+import com.ldtteam.blockui.views.ScrollingList;
+import com.ldtteam.blockui.views.ScrollingListContainer.RowSizeModifier;
+import net.minecraft.network.chat.Component;
+
+/**
+ * Sets up gui for dynamic scrolling lists.
+ */
+public class DynamicScrollingListGui
+{
+    public static void setup(final BOWindow window)
+    {
+        final ScrollingList list1 = window.findPaneOfTypeByID("list1", ScrollingList.class);
+        list1.setDataProvider(new ScrollingList.DataProvider()
+        {
+            @Override
+            public int getElementCount()
+            {
+                return 10;
+            }
+
+            @Override
+            public void updateElement(final int index, final Pane rowPane)
+            {
+                rowPane.findPaneByType(Text.class).setText(Component.literal("Hi " + index));
+            }
+        });
+
+        final ScrollingList list2 = window.findPaneOfTypeByID("list2", ScrollingList.class);
+        list2.setDataProvider(new ScrollingList.DataProvider()
+        {
+            @Override
+            public int getElementCount()
+            {
+                return 20;
+            }
+
+            @Override
+            public void modifyRowSize(final int index, final RowSizeModifier modifier)
+            {
+                if (index % 2 == 0)
+                {
+                    modifier.setSize(100, 40);
+                }
+            }
+
+            @Override
+            public void updateElement(final int index, final Pane rowPane)
+            {
+                rowPane.findPaneByType(Text.class).setText(Component.literal("Hi " + index));
+            }
+        });
+    }
+}

src/main/java/com/ldtteam/blockui/util/SafeError.java

@@ -0,0 +1,27 @@
+package com.ldtteam.blockui.util;
+
+import com.ldtteam.blockui.mod.Log;
+import net.minecraftforge.fml.loading.FMLEnvironment;
+
+/**
+ * Utility class for throwing errors which is safe during production.
+ */
+public class SafeError
+{
+    /**
+     * Safe error throw call that only throws an exception during development, but logs an error in production instead so no crashes to desktop may occur.
+     *
+     * @param exception the exception instance.
+     */
+    public static void throwInDev(final RuntimeException exception)
+    {
+        if (FMLEnvironment.production)
+        {
+            Log.getLogger().error(exception.getMessage(), exception);
+        }
+        else
+        {
+            throw exception;
+        }
+    }
+}

src/main/java/com/ldtteam/blockui/views/ScrollingList.java

@@ -2,6 +2,7 @@
 
 import com.ldtteam.blockui.Pane;
 import com.ldtteam.blockui.PaneParams;
+import com.ldtteam.blockui.views.ScrollingListContainer.RowSizeModifier;
 
 import java.util.List;
 import java.util.function.IntSupplier;
@@ -14,11 +15,10 @@
  */
 public class ScrollingList extends ScrollingView
 {
-    protected int childSpacing = 0;
+    protected int          childSpacing = 0;
     // Runtime
     protected DataProvider dataProvider;
-    private PaneParams listNodeParams;
-    private int maxHeight;
+    private   int          maxHeight;
 
     /**
      * Default constructor required by Blockout.
@@ -42,6 +42,7 @@ public ScrollingList(final PaneParams params)
 
     /**
      * Max height setter.
+     *
      * @param maxHeight the height to set.
      */
     public void setMaxHeight(final int maxHeight)
@@ -78,7 +79,7 @@ public void setDataProvider(final DataProvider p)
      */
     public void refreshElementPanes()
     {
-        ((ScrollingListContainer) container).refreshElementPanes(dataProvider, listNodeParams, maxHeight, childSpacing);
+        ((ScrollingListContainer) container).refreshElementPanes(dataProvider, maxHeight, childSpacing);
     }
 
     @Override
@@ -88,7 +89,7 @@ public void onUpdate()
         refreshElementPanes();
     }
 
-        @Override
+    @Override
     protected ScrollingContainer createScrollingContainer()
     {
         return new ScrollingListContainer(this);
@@ -105,7 +106,10 @@ public void parseChildren(final PaneParams params)
 
         // Get the PaneParams for this child, because we'll need it in the future
         // to create more nodes
-        listNodeParams = childNodes.get(0);
+        if (container instanceof ScrollingListContainer scrollingListContainer)
+        {
+            scrollingListContainer.setListNodeParams(childNodes.get(0));
+        }
     }
 
     /**
@@ -131,6 +135,17 @@ public interface DataProvider
          */
         int getElementCount();
 
+        /**
+         * Override this to pick a custom size for this element. Event contains the logic to modify the old size.
+         *
+         * @param index    the index of the row/list element.
+         * @param modifier the object used to modify the size.
+         */
+        default void modifyRowSize(int index, final RowSizeModifier modifier)
+        {
+            // No implementation by default
+        }
+
         /**
          * Override this to update the Panes for a given row.
          *