Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: remove double gaps in quest requirements #1282

Merged
merged 4 commits into from
Sep 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 229 additions & 0 deletions src/main/java/com/questhelper/panel/DynamicPaddedGridLayout.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
/*
* Copyright (c) 2023, pajlada <https://github.com/pajlada>
* Based on https://github.com/runelite/runelite/blob/754ea00/runelite-client/src/main/java/net/runelite/client/ui/DynamicGridLayout.java (2023-09-20)
* Copyright (c) 2018, Tomas Slusny <slusnucky@gmail.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.questhelper.panel;

import java.awt.*;
import java.util.function.Function;

/**
* Grid layout implementation with support for cells with unequal size.
* Optionally supports padding inbetween cells. This padding is only applied to visible cells, just like
* padding in an HTML table would.
*/
public class DynamicPaddedGridLayout extends GridLayout
{
public DynamicPaddedGridLayout(int rows, int cols, int horizontalPadding, int verticalPadding)
{
super(rows, cols, horizontalPadding, verticalPadding);
}

@Override
public Dimension preferredLayoutSize(Container parent)
{
synchronized (parent.getTreeLock())
{
return calculateSize(parent, Component::getPreferredSize);
}
}

@Override
public Dimension minimumLayoutSize(Container parent)
{
synchronized (parent.getTreeLock())
{
return calculateSize(parent, Component::getMinimumSize);
}
}

@Override
public void layoutContainer(Container parent)
{
synchronized (parent.getTreeLock())
{
final Insets insets = parent.getInsets();
final int numComponents = parent.getComponentCount();
int numRows = getRows();
int numColumns = getColumns();

if (numComponents == 0)
{
return;
}

if (numRows > 0)
{
numColumns = (numComponents + numRows - 1) / numRows;
}
else
{
numRows = (numComponents + numColumns - 1) / numColumns;
}

final int horizontalPadding = getHgap();
final int verticalPadding = getVgap();

// scaling factors
final Dimension pd = preferredLayoutSize(parent);
final Insets parentInsets = parent.getInsets();
int horizontalBorder = parentInsets.left + parentInsets.right;
int verticalBorder = parentInsets.top + parentInsets.bottom;
final double sw = (1.0 * parent.getWidth() - horizontalBorder) / (pd.width - horizontalBorder);
final double sh = (1.0 * parent.getHeight() - verticalBorder) / (pd.height - verticalBorder);

final int[] w = new int[numColumns];
final int[] h = new int[numRows];

// calculate dimensions for all components + apply scaling
for (int i = 0; i < numComponents; i++)
{
final int r = i / numColumns;
final int c = i % numColumns;
final Component comp = parent.getComponent(i);
final Dimension d = comp.getPreferredSize();
d.width = (int) (sw * d.width);
d.height = (int) (sh * d.height);

if (w[c] < d.width)
{
w[c] = d.width;
}

if (h[r] < d.height)
{
h[r] = d.height;
}
}

// Apply new bounds to all child components
for (int c = 0, x = insets.left; c < numColumns; c++)
{
int componentWidth = w[c];

for (int r = 0, y = insets.top; r < numRows; r++)
{
int i = r * numColumns + c;

int componentHeight = h[r];

if (i < numComponents)
{
parent.getComponent(i).setBounds(x, y, componentWidth, componentHeight);
}

if (componentHeight > 0)
{
y += componentHeight + verticalPadding;
}

}

if (componentWidth > 0)
{
x += componentWidth + horizontalPadding;
}
}
}
}

/**
* Calculate outer size of the layout based on it's children and sizer
*
* @param parent parent component
* @param sizer functioning returning dimension of the child component
* @return outer size
*/
private Dimension calculateSize(final Container parent, final Function<Component, Dimension> sizer)
{
final int numComponents = parent.getComponentCount();
int numRows = getRows();
int numColumns = getColumns();
int numVisibleRows = 0;
int numVisibleColumns = 0;

if (numRows > 0)
{
numColumns = (numComponents + numRows - 1) / numRows;
}
else
{
numRows = (numComponents + numColumns - 1) / numColumns;
}

final int[] w = new int[numColumns];
final int[] h = new int[numRows];

// Calculate dimensions for all components
for (int i = 0; i < numComponents; i++)
{
final int r = i / numColumns;
final int c = i % numColumns;
final Component comp = parent.getComponent(i);
final Dimension d = sizer.apply(comp);

if (w[c] < d.width)
{
w[c] = d.width;
}

if (h[r] < d.height)
{
h[r] = d.height;
}
}

// Calculate total width and height of the layout
int totalWidth = 0;
int totalHeight = 0;

for (int j = 0; j < numColumns; j++)
{
int columnWidth = w[j];
if (columnWidth > 0)
{
totalWidth += columnWidth;
numVisibleColumns += 1;
}
}


for (int i = 0; i < numRows; i++)
{
int rowHeight = h[i];
if (rowHeight > 0)
{
totalHeight += rowHeight;
numVisibleRows += 1;
}
}

final Insets insets = parent.getInsets();

// Apply insets and horizontal and vertical padding to layout, accounting only for the visible columns & rows
return new Dimension(insets.left + insets.right + totalWidth + (numVisibleColumns - 1) * getHgap(), insets.top + insets.bottom + totalHeight + (numVisibleRows - 1) * getVgap());
}

}
3 changes: 1 addition & 2 deletions src/main/java/com/questhelper/panel/QuestHelperPanel.java
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
import net.runelite.api.Item;
import net.runelite.api.QuestState;
import net.runelite.client.ui.ColorScheme;
import net.runelite.client.ui.DynamicGridLayout;
import net.runelite.client.ui.PluginPanel;
import net.runelite.client.ui.components.IconTextField;
import net.runelite.client.util.ImageUtil;
Expand Down Expand Up @@ -280,7 +279,7 @@ public void changedUpdate(DocumentEvent e)
searchQuestsPanel.add(allQuestsCompletedPanel, BorderLayout.SOUTH);

questListPanel.setBorder(new EmptyBorder(8, 10, 0, 10));
questListPanel.setLayout(new DynamicGridLayout(0, 1, 0, 5));
questListPanel.setLayout(new DynamicPaddedGridLayout(0, 1, 0, 5));
questListPanel.setAlignmentX(Component.LEFT_ALIGNMENT);
showMatchingQuests("");

Expand Down
3 changes: 1 addition & 2 deletions src/main/java/com/questhelper/panel/QuestOverviewPanel.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
import net.runelite.api.Client;
import net.runelite.api.Item;
import net.runelite.client.ui.ColorScheme;
import net.runelite.client.ui.DynamicGridLayout;
import net.runelite.client.ui.PluginPanel;
import static net.runelite.client.ui.PluginPanel.PANEL_WIDTH;
import net.runelite.client.util.LinkBrowser;
Expand Down Expand Up @@ -264,7 +263,7 @@ private JPanel generateRequirementPanel(JPanel listPanel, JPanel headerPanel, St
questItemReqs.setMinimumSize(new Dimension(1, headerPanel.getPreferredSize().height));
headerPanel.add(questItemReqs, BorderLayout.NORTH);

listPanel.setLayout(new DynamicGridLayout(0, 1, 0, 1));
listPanel.setLayout(new DynamicPaddedGridLayout(0, 1, 0, 1));
listPanel.setBorder(new EmptyBorder(10, 5, 10, 5));

requirementPanel.add(headerPanel, BorderLayout.NORTH);
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/com/questhelper/panel/QuestStepPanel.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
import net.runelite.client.ui.ColorScheme;
import javax.swing.*;
import javax.swing.border.EmptyBorder;
import net.runelite.client.ui.DynamicGridLayout;
import net.runelite.client.ui.FontManager;
import net.runelite.client.util.SwingUtil;

Expand Down Expand Up @@ -181,7 +180,7 @@ public void addRequirements(String text, List<Requirement> reqs, String borderLa
questRequirementsHeader.add(questReqsTitle, BorderLayout.NORTH);

JPanel questRequirementsListPanel = new JPanel();
questRequirementsListPanel.setLayout(new DynamicGridLayout(0, 1, 0, 1));
questRequirementsListPanel.setLayout(new DynamicPaddedGridLayout(0, 1, 0, 1));
questRequirementsListPanel.setBorder(new EmptyBorder(5, 5, 5, 5));


Expand Down