Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.control

Interface Controls

All Superinterfaces:

Action, ActionListener, Control, EventListener

public interface Controls
extends Control

A collection of controls and separators, note that these can be nested controls.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Controls.Config	Configures controls.
static interface	Controls.ControlsBuilder	A builder for Controls

Nested classes/interfaces inherited from interface is.codion.swing.common.ui.control.Control

Control.ActionCommand, Control.Builder<C extends Control,B extends Control.Builder<C,B>>, Control.BuilderFactory, Control.Command

Field Summary

Fields

Modifier and Type	Field	Description
static final Action	SEPARATOR	A placeholder representing a separator in a Controls instance.

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Method Summary

Modifier and Type	Method	Description
List<Action>	actions()
static Controls.ControlsBuilder	builder()
static Controls.Config	config(ControlSet controls, List<ControlId<?>> defaults)
static Controls	controls(Control... controls)	Constructs a new Controls instance.
static Controls	controls(Action... actions)	Constructs a new Controls instance.
Controls.ControlsBuilder	copy()	Returns a new Control.Builder instance, based on a copy of this control.
boolean	empty()
Action	get(int index)
boolean	notEmpty()
int	size()

Methods inherited from interface javax.swing.Action

accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface is.codion.swing.common.ui.control.Control

background, description, enabled, font, foreground, keys, keyStroke, largeIcon, mnemonic, name, setEnabled, smallIcon

Field Details

SEPARATOR

static final Action SEPARATOR

A placeholder representing a separator in a Controls instance. All methods throw UnsupportedOperationException.

Method Details

actions

List<Action> actions()

Returns:

an unmodifiable view of the actions in this set

size

int size()

Returns:

the number of controls in this controls instance

empty

boolean empty()

Returns:

true if this controls instance contains no controls (ignoring separators)

notEmpty

boolean notEmpty()

Returns:

true if this controls instance contains controls (ignoring separators)

get

Action get(int index)

Parameters:

index - the index

Returns:

the action at the given index

copy

Controls.ControlsBuilder copy()

Description copied from interface: Control

Returns a new Control.Builder instance, based on a copy of this control.

Specified by:

copy in interface Control

Returns:

a new builder

controls

static Controls controls(Action... actions)

Constructs a new Controls instance.

Parameters:

actions - the actions

Returns:

a new Controls instance.

controls

static Controls controls(Control... controls)

Constructs a new Controls instance.

Parameters:

controls - the controls

Returns:

a new Controls instance.

builder

static Controls.ControlsBuilder builder()

Returns:

a new Controls.ControlsBuilder instance

config

static Controls.Config config(ControlSet controls,
 List<ControlId<?>> defaults)

Parameters:

controls - the available controls

defaults - the default controls layout

Returns:

a new Config instance