Module com.marginallyclever.robotoverlord

Package com.marginallyclever.ro3

Class PanelHelper

java.lang.Object

com.marginallyclever.ro3.PanelHelper

public class PanelHelper
extends Object

PanelHelper is a collection of static methods to help build panels.

Constructor Summary

Constructors

Constructor	Description
PanelHelper()

Method Summary

Modifier and Type	Method	Description
static void	addColorChooser(JPanel parent, String title, Supplier<Color> startColor, Consumer<Color> consumer, GridBagConstraints gbc)	A convenience method to add a color chooser to a panel.
static void	addLabelAndComponent(JPanel pane, String labelText, JComponent component)	A convenience method to add a label and component to a panel that is built with GridLayout.
static void	addLabelAndComponent(JPanel pane, String labelText, JComponent component, GridBagConstraints gbc)	A convenience method to add a label and component to a panel that is built with GridBagLayout.
static void	addLimit(JPanel pane, GridBagConstraints gbc, String label, double value, Consumer<Double> consumer, double infinite)	A convenience method to add an angle limit to a panel (in degrees).
static <T extends Node> NodeSelector<T>	addNodeSelector(JPanel pane, String label, NodePath<T> nodePath, GridBagConstraints gbc)	A convenience method to add a label and component to a panel that is expected to be built with GridBagConstraint.
static JFormattedTextField	addNumberField(String toolTip, double value, NumberFormatter formatter)	A convenience method to add a number field to a panel.
static JFormattedTextField	addNumberFieldDouble(String toolTip, double value)	A convenience method to add a number field to a panel.
static JFormattedTextField	addNumberFieldInt(String toolTip, int value)	A convenience method to add a number field to a panel.
static void	addSelector(JPanel pane, GridBagConstraints gbc, String label, NodePath<ODEBody> originalValue, Consumer<ODEBody> consumer)	A convenience method to add a NodeSelector to a panel.
static JComponent	createRange(double max, double min, double value, Consumer<Double> consumer)	Create a range slider with two decimal places that displays the value on the right.
static void	enableLimit(boolean isSelected, JSpinner spinner, Consumer<Double> consumer, double infinite)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PanelHelper

public PanelHelper()

Method Details

addLabelAndComponent

public static void addLabelAndComponent(JPanel pane,
 String labelText,
 JComponent component)

A convenience method to add a label and component to a panel that is built with GridLayout.

Parameters:

pane - the panel to add to

labelText - the text for the label

component - the component to add

addLabelAndComponent

public static void addLabelAndComponent(JPanel pane,
 String labelText,
 JComponent component,
 GridBagConstraints gbc)

A convenience method to add a label and component to a panel that is built with GridBagLayout.

Parameters:

pane - the panel to add to

labelText - the text for the label

component - the component to add

gbc - the GridBagConstraints to use

addNodeSelector

public static <T extends Node> NodeSelector<T> addNodeSelector(JPanel pane,
 String label,
 NodePath<T> nodePath,
 GridBagConstraints gbc)

A convenience method to add a label and component to a panel that is expected to be built with GridBagConstraint.

Type Parameters:

T - the type filter for the NodeSelector.

Parameters:

pane - the panel to add to

label - the text for the label

nodePath - the NodePath to use

gbc - the GridBagConstraints to use

Returns:

the NodeSelector

addColorChooser

public static void addColorChooser(JPanel parent,
 String title,
 Supplier<Color> startColor,
 Consumer<Color> consumer,
 GridBagConstraints gbc)

A convenience method to add a color chooser to a panel.

Parameters:

parent - the parent panel

title - the title for the color chooser

startColor - the initial color

consumer - the consumer to accept the color

gbc - the GridBagConstraints to use

addNumberFieldDouble

public static JFormattedTextField addNumberFieldDouble(String toolTip,
 double value)

A convenience method to add a number field to a panel.

Parameters:

toolTip - the tooltip for the field

value - the initial value

Returns:

the JFormattedTextField

addNumberFieldInt

public static JFormattedTextField addNumberFieldInt(String toolTip,
 int value)

A convenience method to add a number field to a panel.

Parameters:

toolTip - the tooltip for the field

value - the initial value

Returns:

the JFormattedTextField

addNumberField

public static JFormattedTextField addNumberField(String toolTip,
 double value,
 NumberFormatter formatter)

A convenience method to add a number field to a panel.

Parameters:

toolTip - the tooltip for the field

value - the initial value

formatter - the NumberFormatter to use

Returns:

the JFormattedTextField

addLimit

public static void addLimit(JPanel pane,
 GridBagConstraints gbc,
 String label,
 double value,
 Consumer<Double> consumer,
 double infinite)

A convenience method to add an angle limit to a panel (in degrees).

Parameters:

pane - the panel to add to

gbc - the GridBagConstraints to use

label - the label for the limit

value - the initial value

consumer - the consumer to accept the value

infinite - the value to use for infinite (no limit)

enableLimit

public static void enableLimit(boolean isSelected,
 JSpinner spinner,
 Consumer<Double> consumer,
 double infinite)

addSelector

public static void addSelector(JPanel pane,
 GridBagConstraints gbc,
 String label,
 NodePath<ODEBody> originalValue,
 Consumer<ODEBody> consumer)

A convenience method to add a NodeSelector to a panel.

Parameters:

pane - the panel to add to

gbc - the GridBagConstraints to use

label - the label for the selector

originalValue - the original value

consumer - the consumer to accept the value

createRange

public static JComponent createRange(double max,
 double min,
 double value,
 Consumer<Double> consumer)

Create a range slider with two decimal places that displays the value on the right.

Parameters:

max - the maximum value

min - the minimum value

value - the initial value

consumer - the consumer to accept the value

Returns:

the JComponent