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.Builder	A builder for Controls

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

Control.ActionCommand, 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

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

BACKGROUND, FONT, FOREGROUND

Method Summary

Modifier and Type	Method	Description
List<Action>	actions()
Controls	add(Controls controls)
Controls	add(Action action)	Adds the given action to this Controls instance, adding a null action has the same effect as addSeparator()
Controls	addAll(Controls controls)	Adds all actions found in controls to this controls instance
Controls	addAt(int index, Controls controls)
Controls	addAt(int index, Action action)	Adds the given action to this Controls instance at the specified index, adding a null action has the same effect as addSeparator()
Controls	addSeparator()	Adds a separator to the end of this controls instance
Controls	addSeparatorAt(int index)	Adds a separator at the given index
static Controls.Builder	builder()
static Controls	controls()	Constructs a new Controls instance.
static Controls	controls(Control... controls)	Constructs a new Controls instance.
static Controls	controls(Action... actions)	Constructs a new Controls instance.
boolean	empty()
Action	get(int index)
boolean	notEmpty()
Controls	remove(Action action)
Controls	removeAll()	Removes all actions from this controls instance
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

copy, copy, copy, enabled, getBackground, getDescription, getFont, getForeground, getKeyStroke, getLargeIcon, getMnemonic, getName, getSmallIcon, setBackground, setDescription, setEnabled, setFont, setForeground, setKeyStroke, setLargeIcon, setMnemonic, setName, setSmallIcon

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

add

Controls add(Action action)

Adds the given action to this Controls instance, adding a null action has the same effect as addSeparator()

Parameters:

action - the action to add

Returns:

this Controls instance

addAt

Controls addAt(int index,
 Action action)

Adds the given action to this Controls instance at the specified index, adding a null action has the same effect as addSeparator()

Parameters:

index - the index

action - the action to add at the specified index

Returns:

this Controls instance

remove

Controls remove(Action action)

Parameters:

action - the action to remove

Returns:

this Controls instance

removeAll

Controls removeAll()

Removes all actions from this controls instance

Returns:

this Controls instance

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

add

Controls add(Controls controls)

Parameters:

controls - the controls to add

Returns:

this Control instance

addAt

Controls addAt(int index,
 Controls controls)

Parameters:

index - the index

controls - the controls to add at the specified index

Returns:

this Controls instance

addSeparator

Controls addSeparator()

Adds a separator to the end of this controls instance

Returns:

this Controls instance

addSeparatorAt

Controls addSeparatorAt(int index)

Adds a separator at the given index

Parameters:

index - the index

Returns:

this Controls instance

addAll

Controls addAll(Controls controls)

Adds all actions found in controls to this controls instance

Parameters:

controls - the source list

Returns:

this Controls instance

controls

static Controls controls()

Constructs a new Controls instance.

Returns:

a new Controls instance.

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.Builder builder()

Returns:

a new Controls.Builder instance