Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component

Class Components

java.lang.Object

is.codion.swing.common.ui.component.Components

public final class Components
extends Object

A factory for ComponentBuilder instances.

Method Summary

Modifier and Type	Method	Description
static NumberField.Builder<BigDecimal>	bigDecimalField()
static ItemComboBoxBuilder<Boolean>	booleanComboBox()
static BorderLayoutPanelBuilder	borderLayoutPanel()	Creates a new BorderLayoutPanelBuilder instance using a new BorderLayout instance with the default horizontal and vertical gap.
static <B extends ButtonBuilder<JButton, Void, B>> ButtonBuilder<JButton,Void,B>	button()
static ControlPanelBuilder.ControlsStep<JPanel,ButtonPanelBuilder>	buttonPanel()
static FileInputPanel.Builder<byte[]>	byteArrayInputPanel()	Provides builder for a byte array based file input panel.
static <B extends TextFieldBuilder<JTextField, Character, B>> TextFieldBuilder<JTextField,Character,B>	characterField()
static CheckBoxBuilder	checkBox()
static <B extends CheckBoxMenuItemBuilder<B>> CheckBoxMenuItemBuilder<B>	checkBoxMenuItem()
static ComboBoxBuilder.ModelStep	comboBox()
static NumberField.Builder<Double>	doubleField()
static NumberSpinnerBuilder<Double>	doubleSpinner()
static FlexibleGridLayoutPanelBuilder	flexibleGridLayoutPanel(int rows, int columns)	Creates a new PanelBuilder instance using a new FlexibleGridLayout with the default horizontal and vertical gap.
static FlowLayoutPanelBuilder	flowLayoutPanel(int alignment)	Creates a new PanelBuilder instance using a new FlowLayout with the default horizontal and vertical gap.
static GridLayoutPanelBuilder	gridLayoutPanel(int rows, int columns)	Creates a new PanelBuilder instance using a new GridLayout with the default horizontal and vertical gap.
static InputPanelBuilder	inputPanel()
static NumberField.Builder<Integer>	integerField()
static NumberSpinnerBuilder<Integer>	integerSpinner()
static ItemComboBoxBuilder.BuilderFactory	itemComboBox()
static <T> ItemSpinnerBuilder<T>	itemSpinner()
static <T> LabelBuilder<T>	label()
static <T> LabelBuilder<T>	label(String text)
static ListBuilder.ModelStep	list()
static ListBoxBuilder.ItemValueStep	listBox()	Creates a JComboBox based ComponentValue instance, represented by the items in the combo box (as opposed to the selected item).
static <T> ListSpinnerBuilder<T>	listSpinner()
static TemporalField.Builder<LocalDate>	localDateField()
static TemporalFieldPanel.Builder<LocalDate>	localDateFieldPanel()
static TemporalField.Builder<LocalDateTime>	localDateTimeField()
static TemporalFieldPanel.Builder<LocalDateTime>	localDateTimeFieldPanel()
static TemporalField.Builder<LocalTime>	localTimeField()
static TemporalFieldPanel.Builder<LocalTime>	localTimeFieldPanel()
static NumberField.Builder<Long>	longField()
static MaskedTextFieldBuilder	maskedTextField()
static MenuBuilder.ControlsStep	menu()
static <C extends JMenuItem, B extends MenuItemBuilder<C, B>> MenuItemBuilder<C,B>	menuItem()
static NullableCheckBoxBuilder	nullableCheckBox()
static TemporalField.Builder<OffsetDateTime>	offsetDateTimeField()
static PanelBuilder.PanelBuilderFactory	panel()
static PasswordFieldBuilder	passwordField()
static FileInputPanel.Builder<Path>	pathInputPanel()	Provides builder for a Path based file input panel.
static ProgressBarBuilder	progressBar()
static RadioButtonBuilder	radioButton()
static <B extends RadioButtonMenuItemBuilder<B>> RadioButtonMenuItemBuilder<B>	radioButtonMenuItem()
static ScrollPaneBuilder	scrollPane()
static NumberField.Builder<Short>	shortField()
static SliderBuilder.ModelStep	slider()
static SplitPaneBuilder	splitPane()
static <B extends TextFieldBuilder<JTextField, String, B>> TextFieldBuilder<JTextField,String,B>	stringField()
static TabbedPaneBuilder	tabbedPane()
static TemporalField.Builder.TemporalClassStep	temporalField()
static TemporalFieldPanel.Builder.TemporalClassStep	temporalFieldPanel()
static TextAreaBuilder	textArea()
static TextFieldBuilder.ValueClassStep	textField()
static TextFieldPanel.Builder	textFieldPanel()
static TextPaneBuilder	textPane()
static <B extends ToggleButtonBuilder<JToggleButton, B>> ToggleButtonBuilder<JToggleButton,B>	toggleButton()
static ControlPanelBuilder.ControlsStep<JToolBar,ToolBarBuilder>	toolBar()

Methods inherited from class java.lang.Object

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

Method Details

button

public static <B extends ButtonBuilder<JButton,
Void,
B>>
ButtonBuilder<JButton,Void,B> button()

Type Parameters:

B - the builder type

Returns:

a JButton builder

checkBox

public static CheckBoxBuilder checkBox()

Returns:

a JCheckBox builder

nullableCheckBox

public static NullableCheckBoxBuilder nullableCheckBox()

Returns:

a NullableCheckBox builder

radioButton

public static RadioButtonBuilder radioButton()

Returns:

a JRadioButton builder

toggleButton

public static <B extends ToggleButtonBuilder<JToggleButton,
B>>
ToggleButtonBuilder<JToggleButton,B> toggleButton()

Type Parameters:

B - the builder type

Returns:

a JToggleButton builder

menuItem

public static <C extends JMenuItem,
B extends MenuItemBuilder<C,
B>>
MenuItemBuilder<C,B> menuItem()

Type Parameters:

C - the component type

B - the builder type

Returns:

a new JMenuItem builder

checkBoxMenuItem

public static <B extends CheckBoxMenuItemBuilder<B>>
CheckBoxMenuItemBuilder<B> checkBoxMenuItem()

Type Parameters:

B - the builder type

Returns:

a new JCheckBoxMenuItem builder

radioButtonMenuItem

public static <B extends RadioButtonMenuItemBuilder<B>>
RadioButtonMenuItemBuilder<B> radioButtonMenuItem()

Type Parameters:

B - the builder type

Returns:

a new JRadioButtonMenuItem builder

booleanComboBox

public static ItemComboBoxBuilder<Boolean> booleanComboBox()

Returns:

a boolean based ItemComboBoxBuilder

itemComboBox

public static ItemComboBoxBuilder.BuilderFactory itemComboBox()

Returns:

a ItemComboBoxBuilder.BuilderFactory

comboBox

public static ComboBoxBuilder.ModelStep comboBox()

Returns:

a ComboBoxBuilder.ModelStep

listBox

public static ListBoxBuilder.ItemValueStep listBox()

Creates a JComboBox based ComponentValue instance, represented by the items in the combo box (as opposed to the selected item). The provided itemValue supplies new items to add to the combo box.

• KeyEvent.VK_INSERT adds the current value to the list
• KeyEvent.VK_DELETE deletes the selected item from the list.

Returns:

a new ListBoxBuilder.ItemValueStep

temporalFieldPanel

public static TemporalFieldPanel.Builder.TemporalClassStep temporalFieldPanel()

Returns:

a TemporalFieldPanel.Builder.TemporalClassStep builder

localTimeFieldPanel

public static TemporalFieldPanel.Builder<LocalTime> localTimeFieldPanel()

Returns:

a LocalTime based TemporalFieldPanel builder

localDateFieldPanel

public static TemporalFieldPanel.Builder<LocalDate> localDateFieldPanel()

Returns:

a LocalDate based TemporalFieldPanel builder

localDateTimeFieldPanel

public static TemporalFieldPanel.Builder<LocalDateTime> localDateTimeFieldPanel()

Returns:

a LocalDateTime based TemporalFieldPanel builder

textFieldPanel

public static TextFieldPanel.Builder textFieldPanel()

Returns:

a TextFieldPanel builder

textArea

public static TextAreaBuilder textArea()

Returns:

a JTextArea builder

textPane

public static TextPaneBuilder textPane()

Returns:

a JTextPane builder

stringField

public static <B extends TextFieldBuilder<JTextField,
String,
B>>
TextFieldBuilder<JTextField,String,B> stringField()

Type Parameters:

B - the builder type

Returns:

a JTextField builder

characterField

public static <B extends TextFieldBuilder<JTextField,
Character,
B>>
TextFieldBuilder<JTextField,Character,B> characterField()

Type Parameters:

B - the builder type

Returns:

a JTextField builder

textField

public static TextFieldBuilder.ValueClassStep textField()

Returns:

a JTextField builder

localTimeField

public static TemporalField.Builder<LocalTime> localTimeField()

Returns:

a LocalTime based TemporalField builder

localDateField

public static TemporalField.Builder<LocalDate> localDateField()

Returns:

a LocalDate based TemporalField builder

localDateTimeField

public static TemporalField.Builder<LocalDateTime> localDateTimeField()

Returns:

a LocalDateTime based TemporalField builder

offsetDateTimeField

public static TemporalField.Builder<OffsetDateTime> offsetDateTimeField()

Returns:

a OffsetDateTime based TemporalField builder

temporalField

public static TemporalField.Builder.TemporalClassStep temporalField()

Returns:

a TemporalField builder

shortField

public static NumberField.Builder<Short> shortField()

Returns:

a Short based NumberField builder

integerField

public static NumberField.Builder<Integer> integerField()

Returns:

an Integer based NumberField builder

longField

public static NumberField.Builder<Long> longField()

Returns:

a Long based NumberField builder

doubleField

public static NumberField.Builder<Double> doubleField()

Returns:

a Double based NumberField builder

bigDecimalField

public static NumberField.Builder<BigDecimal> bigDecimalField()

Returns:

a BigDecimal based NumberField builder

maskedTextField

public static MaskedTextFieldBuilder maskedTextField()

Returns:

a JFormattedTextField builder

passwordField

public static PasswordFieldBuilder passwordField()

Returns:

a JPasswordField builder

doubleSpinner

public static NumberSpinnerBuilder<Double> doubleSpinner()

Returns:

a Double based JSpinner builder

integerSpinner

public static NumberSpinnerBuilder<Integer> integerSpinner()

Returns:

an Integer based JSpinner builder

listSpinner

public static <T> ListSpinnerBuilder<T> listSpinner()

Type Parameters:

T - the value type

Returns:

a JSpinner builder

itemSpinner

public static <T> ItemSpinnerBuilder<T> itemSpinner()

Type Parameters:

T - the value type

Returns:

a JSpinner builder

slider

public static SliderBuilder.ModelStep slider()

Returns:

a JSlider builder

list

public static ListBuilder.ModelStep list()

Returns:

a new list builder

label

public static <T> LabelBuilder<T> label()

Type Parameters:

T - the type to display in the label (using value.toString() or "" for null).

Returns:

a JLabel builder

label

public static <T> LabelBuilder<T> label(String text)

Type Parameters:

T - the type to display in the label (using value.toString() or "" for null).

Parameters:

text - the label text

Returns:

a JLabel builder

panel

public static PanelBuilder.PanelBuilderFactory panel()

Returns:

a JPanel builder factory

inputPanel

public static InputPanelBuilder inputPanel()

Returns:

a InputPanelBuilder

tabbedPane

public static TabbedPaneBuilder tabbedPane()

Returns:

a JTabbedPane builder

splitPane

public static SplitPaneBuilder splitPane()

Returns:

a JSplitPane builder

scrollPane

public static ScrollPaneBuilder scrollPane()

Returns:

a JScrollPane builder

progressBar

public static ProgressBarBuilder progressBar()

Returns:

an indeterminate JProgressBar builder

pathInputPanel

public static FileInputPanel.Builder<Path> pathInputPanel()

Provides builder for a Path based file input panel.

Returns:

a FileInputPanel builder

byteArrayInputPanel

public static FileInputPanel.Builder<byte[]> byteArrayInputPanel()

Provides builder for a byte array based file input panel.

Returns:

a FileInputPanel builder

toolBar

public static ControlPanelBuilder.ControlsStep<JToolBar,ToolBarBuilder> toolBar()

Returns:

a JToolBar builder

buttonPanel

public static ControlPanelBuilder.ControlsStep<JPanel,ButtonPanelBuilder> buttonPanel()

Returns:

a button panel builder

borderLayoutPanel

public static BorderLayoutPanelBuilder borderLayoutPanel()

Creates a new BorderLayoutPanelBuilder instance using a new BorderLayout instance with the default horizontal and vertical gap.

Returns:

a border layout panel builder

See Also:

• Layouts.GAP

gridLayoutPanel

public static GridLayoutPanelBuilder gridLayoutPanel(int rows,
 int columns)

Creates a new PanelBuilder instance using a new GridLayout with the default horizontal and vertical gap.

Parameters:

rows - the number of rows

columns - the number of columns

Returns:

a grid layout panel builder

See Also:

• Layouts.GAP

flexibleGridLayoutPanel

public static FlexibleGridLayoutPanelBuilder flexibleGridLayoutPanel(int rows,
 int columns)

Creates a new PanelBuilder instance using a new FlexibleGridLayout with the default horizontal and vertical gap.

Parameters:

rows - the number of rows

columns - the number of columns

Returns:

a flexible grid layout panel builder

See Also:

• Layouts.GAP

flowLayoutPanel

public static FlowLayoutPanelBuilder flowLayoutPanel(int alignment)

Creates a new PanelBuilder instance using a new FlowLayout with the default horizontal and vertical gap.

Parameters:

alignment - the flow layout alignment

Returns:

a flow layout panel builder

See Also:

• Layouts.GAP

menu

public static MenuBuilder.ControlsStep menu()

Returns:

a new menu builder