Refine entry tooltips

enigma-swing/build.gradle

@@ -20,6 +20,15 @@ plugins {
 	alias(libs.plugins.shadow)
 }
 
+sourceSets {
+	guiVisualization
+}
+
+configurations {
+	guiVisualizationRuntimeClasspath.extendsFrom runtimeClasspath
+	guiVisualizationCompileClasspath.extendsFrom compileClasspath
+}
+
 dependencies {
 	implementation project(':enigma')
 	implementation project(':enigma-server')
@@ -32,7 +41,9 @@ dependencies {
 	implementation libs.swing.dpi
 	implementation libs.fontchooser
 	implementation libs.javaparser
+
 	testImplementation(testFixtures(project(':enigma')))
+	guiVisualizationImplementation(project)
 }
 
 application {
@@ -97,6 +108,20 @@ project(":enigma").file("src/test/java/org/quiltmc/enigma/input").listFiles().ea
 
 registerTestTask("complete")
 
+final guiVisualizationJar = tasks.register('guiVisualizationJar', Jar.class) {
+	from(sourceSets.guiVisualization.output)
+
+	archiveFileName = 'gui-visualization.jar'
+	destinationDirectory = layout.buildDirectory.map { it.dir('gui-visualization') }
+}
+
+tasks.register('visualizeGui', JavaExec) {
+	dependsOn(guiVisualizationJar)
+
+	classpath = sourceSets.guiVisualization.runtimeClasspath
+	mainClass = 'org.quilt.internal.gui.visualization.Main'
+}
+
 void registerPrintColorKeyGroupsMapCode(String lafsName, LookAndFeel... lookAndFeels) {
 	tasks.register("print" + lafsName + "ColorKeyGroupsMapCode", PrintColorKeyGroupsMapCodeTask) { task ->
 		task.lookAndFeels = lookAndFeels as List

enigma-swing/src/guiVisualization/java/org/quilt/internal/gui/visualization/Main.java

@@ -0,0 +1,120 @@
+package org.quilt.internal.gui.visualization;
+
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridAlignAndFillVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridAlignmentVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridCheckersVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridColumnVisualiser;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridDefaultRowVisualiser;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridDiagonalBricksVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridFillVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridExtentOverlapVisualiser;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridPriorityFillVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridPriorityScrollPanesVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridPriorityVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridQuiltVisualiser;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridRelativeExtentOverlapVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridRelativeRowsVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridSparseVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridGreaterVisualizer;
+import org.quilt.internal.gui.visualization.flex_grid.FlexGridTetrisVisualizer;
+
+import javax.swing.JButton;
+import javax.swing.JFrame;
+import javax.swing.WindowConstants;
+import java.awt.Dimension;
+import java.awt.FlowLayout;
+import java.awt.Toolkit;
+import java.awt.Window;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+import java.util.concurrent.atomic.AtomicReference;
+
+/**
+ * The main entrypoint for {@link Visualizer}s.
+ *
+ * <p> Opens a window full of buttons that open visualizer windows.
+ */
+public final class Main {
+	private Main() {
+		throw new UnsupportedOperationException();
+	}
+
+	private static final JFrame WINDOW = new JFrame("Gui Visualization");
+
+	// bootstrap
+	static {
+		registerVisualizer(new FlexGridDefaultRowVisualiser());
+		registerVisualizer(new FlexGridColumnVisualiser());
+		registerVisualizer(new FlexGridQuiltVisualiser());
+		registerVisualizer(new FlexGridExtentOverlapVisualiser());
+		registerVisualizer(new FlexGridFillVisualizer());
+		registerVisualizer(new FlexGridAlignmentVisualizer());
+		registerVisualizer(new FlexGridAlignAndFillVisualizer());
+		registerVisualizer(new FlexGridPriorityVisualizer());
+		registerVisualizer(new FlexGridPriorityFillVisualizer());
+		registerVisualizer(new FlexGridSparseVisualizer());
+		registerVisualizer(new FlexGridGreaterVisualizer());
+		registerVisualizer(new FlexGridCheckersVisualizer());
+		registerVisualizer(new FlexGridDiagonalBricksVisualizer());
+		registerVisualizer(new FlexGridTetrisVisualizer());
+		registerVisualizer(new FlexGridPriorityScrollPanesVisualizer());
+		registerVisualizer(new FlexGridRelativeRowsVisualizer());
+		registerVisualizer(new FlexGridRelativeExtentOverlapVisualizer());
+	}
+
+	private static void position(Window window) {
+		final Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
+		final int x = (screenSize.width - window.getWidth()) / 2;
+		final int y = (screenSize.height - window.getHeight()) / 2;
+
+		window.setLocation(x, y);
+	}
+
+	public static void main(String[] args) {
+		WINDOW.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
+
+		WINDOW.setLayout(new FlowLayout());
+
+		final Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
+		final int width = screenSize.width * 2 / 3;
+		final int height = screenSize.height * 2 / 3;
+		final int x = (screenSize.width - width) / 2;
+		final int y = (screenSize.height - height) / 2;
+
+		WINDOW.setBounds(x, y, width, height);
+		WINDOW.setVisible(true);
+	}
+
+	private static void registerVisualizer(Visualizer visualizer) {
+		final JButton button = new JButton(visualizer.getTitle());
+		final AtomicReference<JFrame> currentWindow = new AtomicReference<>();
+
+		button.addActionListener(e -> {
+			final JFrame window = currentWindow.updateAndGet(old -> {
+				if (old != null) {
+					old.dispose();
+				}
+
+				return new JFrame(visualizer.getTitle());
+			});
+
+			visualizer.visualize(window);
+
+			window.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
+			window.addWindowListener(new WindowAdapter() {
+				@Override
+				public void windowClosed(WindowEvent e) {
+					final JFrame window = currentWindow.get();
+					if (window == null || !window.isDisplayable()) {
+						WINDOW.requestFocus();
+					}
+				}
+			});
+
+			position(window);
+			window.setVisible(true);
+		});
+
+		WINDOW.add(button);
+	}
+}

enigma-swing/src/guiVisualization/java/org/quilt/internal/gui/visualization/Visualizer.java

@@ -0,0 +1,22 @@
+package org.quilt.internal.gui.visualization;
+
+import javax.swing.JFrame;
+
+/**
+ * A visualizer populates a window with content to help visualize what GUI code does.
+ *
+ * <p> Visualizers are registered in {@link Main}.
+ */
+public interface Visualizer {
+	/**
+	 * The title of the visualizer.
+	 *
+	 * <p> Used by {@link Main} for the visualizer's button text and window titles.
+	 */
+	String getTitle();
+
+	/**
+	 * Populates the passed {@code window} with content for visualization.
+	 */
+	void visualize(JFrame window);
+}

enigma-swing/src/guiVisualization/java/org/quilt/internal/gui/visualization/flex_grid/FlexGridAlignAndFillVisualizer.java

@@ -0,0 +1,33 @@
+package org.quilt.internal.gui.visualization.flex_grid;
+
+import org.quilt.internal.gui.visualization.Visualizer;
+import org.quilt.internal.gui.visualization.util.VisualUtils;
+
+import javax.swing.JFrame;
+
+public class FlexGridAlignAndFillVisualizer implements Visualizer {
+	@Override
+	public String getTitle() {
+		return "Flex Grid Align & Fill";
+	}
+
+	@Override
+	public void visualize(JFrame window) {
+		VisualUtils.visualizeFlexGridQuilt(
+				window,
+				c -> c.fillNone().alignTopLeft(),
+				c -> c.fillOnlyY().alignTopCenter(),
+				c -> c.fillNone().alignTopRight(),
+
+				c -> c.fillOnlyX().alignCenterLeft(),
+				c -> c.fillBoth().alignCenter(),
+				c -> c.fillOnlyX().alignCenterRight(),
+
+				c -> c.fillNone().alignBottomLeft(),
+				c -> c.fillOnlyY().alignBottomCenter(),
+				c -> c.fillNone().alignBottomRight()
+		);
+
+		window.pack();
+	}
+}

enigma-swing/src/guiVisualization/java/org/quilt/internal/gui/visualization/flex_grid/FlexGridAlignmentVisualizer.java

@@ -0,0 +1,47 @@
+package org.quilt.internal.gui.visualization.flex_grid;
+
+import org.quilt.internal.gui.visualization.Visualizer;
+import org.quilt.internal.gui.visualization.util.VisualBox;
+import org.quilt.internal.gui.visualization.util.VisualUtils;
+import org.quiltmc.enigma.gui.util.layout.flex_grid.constraints.FlexGridConstraints;
+import org.quiltmc.enigma.gui.util.layout.flex_grid.constraints.FlexGridConstraints.Absolute;
+
+import javax.swing.JFrame;
+
+public class FlexGridAlignmentVisualizer implements Visualizer {
+	private static final int SPACER_SIZE = (int) (VisualBox.DEFAULT_SIZE * 1.2);
+
+	private static VisualBox createSpacer() {
+		return VisualBox.ofFixed(SPACER_SIZE);
+	}
+
+	@Override
+	public String getTitle() {
+		return "Flex Grid Alignment";
+	}
+
+	@Override
+	public void visualize(JFrame window) {
+		VisualUtils.visualizeFlexGridQuilt(
+				window,
+				Absolute::alignTopLeft, Absolute::alignTopCenter, Absolute::alignTopRight,
+				Absolute::alignCenterLeft, Absolute::alignCenter, Absolute::alignCenterRight,
+				Absolute::alignBottomLeft, Absolute::alignBottomCenter, Absolute::alignBottomRight
+		);
+
+		final Absolute constraints = FlexGridConstraints.createAbsolute();
+		window.add(createSpacer(), constraints);
+		window.add(createSpacer(), constraints.nextColumn());
+		window.add(createSpacer(), constraints.nextColumn());
+
+		window.add(createSpacer(), constraints.nextRow());
+		window.add(createSpacer(), constraints.nextColumn());
+		window.add(createSpacer(), constraints.nextColumn());
+
+		window.add(createSpacer(), constraints.nextRow());
+		window.add(createSpacer(), constraints.nextColumn());
+		window.add(createSpacer(), constraints.nextColumn());
+
+		window.pack();
+	}
+}

enigma-swing/src/guiVisualization/java/org/quilt/internal/gui/visualization/flex_grid/FlexGridCheckersVisualizer.java

@@ -0,0 +1,38 @@
+package org.quilt.internal.gui.visualization.flex_grid;
+
+import org.quilt.internal.gui.visualization.Visualizer;
+import org.quilt.internal.gui.visualization.util.VisualBox;
+import org.quiltmc.enigma.gui.util.layout.flex_grid.FlexGridLayout;
+import org.quiltmc.enigma.gui.util.layout.flex_grid.constraints.FlexGridConstraints;
+
+import javax.swing.JFrame;
+import java.awt.Color;
+
+public class FlexGridCheckersVisualizer implements Visualizer {
+	private static final int BOARD_SIZE = 8;
+
+	@Override
+	public String getTitle() {
+		return "Flex Grid Checkers";
+	}
+
+	@Override
+	public void visualize(JFrame window) {
+		window.setLayout(new FlexGridLayout());
+
+		final FlexGridConstraints.Absolute constraints = FlexGridConstraints.createAbsolute();
+
+		boolean placeOnEvenY = false;
+		for (int x = 0; x < BOARD_SIZE; x++) {
+			for (int y = 0; y < BOARD_SIZE; y++) {
+				if (placeOnEvenY == (y % 2 == 0)) {
+					window.add(VisualBox.of(Color.RED), constraints.pos(x, y));
+				}
+			}
+
+			placeOnEvenY = !placeOnEvenY;
+		}
+
+		window.pack();
+	}
+}

enigma-swing/src/guiVisualization/java/org/quilt/internal/gui/visualization/flex_grid/FlexGridColumnVisualiser.java

@@ -0,0 +1,27 @@
+package org.quilt.internal.gui.visualization.flex_grid;
+
+import org.quilt.internal.gui.visualization.Visualizer;
+import org.quiltmc.enigma.gui.util.layout.flex_grid.constraints.FlexGridConstraints;
+import org.quiltmc.enigma.gui.util.layout.flex_grid.FlexGridLayout;
+
+import javax.swing.JFrame;
+import javax.swing.JLabel;
+
+public class FlexGridColumnVisualiser implements Visualizer {
+	@Override
+	public String getTitle() {
+		return "Flex Grid Column";
+	}
+
+	@Override
+	public void visualize(JFrame window) {
+		window.setLayout(new FlexGridLayout());
+
+		final FlexGridConstraints.Absolute constraints = FlexGridConstraints.createAbsolute();
+		window.add(new JLabel("Label 1"), constraints);
+		window.add(new JLabel("Label 2"), constraints.nextRow());
+		window.add(new JLabel("Label 3"), constraints.nextRow());
+
+		window.pack();
+	}
+}

enigma-swing/src/guiVisualization/java/org/quilt/internal/gui/visualization/flex_grid/FlexGridDefaultRowVisualiser.java

@@ -0,0 +1,25 @@
+package org.quilt.internal.gui.visualization.flex_grid;
+
+import org.quilt.internal.gui.visualization.Visualizer;
+import org.quiltmc.enigma.gui.util.layout.flex_grid.FlexGridLayout;
+
+import javax.swing.JFrame;
+import javax.swing.JLabel;
+
+public class FlexGridDefaultRowVisualiser implements Visualizer {
+	@Override
+	public String getTitle() {
+		return "Flex Grid Default Row";
+	}
+
+	@Override
+	public void visualize(JFrame window) {
+		window.setLayout(new FlexGridLayout());
+
+		window.add(new JLabel("Label 1"));
+		window.add(new JLabel("Label 2"));
+		window.add(new JLabel("Label 3"));
+
+		window.pack();
+	}
+}