Module is.codion.swing.common.ui

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

Interface Control

All Superinterfaces:

Action, ActionListener, EventListener

All Known Subinterfaces:

CommandControl, Controls, ToggleControl

public interface Control
extends Action

An Action with a reactive enabled state and Optional-based accessors.

Unlike a plain Action, a Control's enabled state is controlled through an ObservableState supplied when building it (ControlBuilder.enabled(ObservableState)); setEnabled(boolean) throws UnsupportedOperationException. Its properties (caption, mnemonic, icons, colors, ...) are exposed via Optional accessors.

Controls come in two flavors: a Control.Command/Control.ActionCommand based CommandControl and a Value/State based ToggleControl.

 State selectionEmpty = // ...

 CommandControl delete = Control.builder()
     .command(this::deleteSelected)
     .caption("Delete")
     .mnemonic('D')
     .enabled(selectionEmpty.not())
     .build();

See Also:

• command(Command)
• action(ActionCommand)
• toggle(Value)
• toggle(State)
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Control.ActionCommand	A command interface, allowing Controls based on ActionEvents.
static interface	Control.BuilderFactory	Provides control builders.
static interface	Control.Command	A command interface, allowing Controls based on method references

Field Summary

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
static CommandControl	action(Control.ActionCommand actionCommand)	Creates a control based on a Control.ActionCommand
Optional<Color>	background()
static Control.BuilderFactory	builder()
Optional<String>	caption()
static CommandControl	command(Control.Command command)	Creates a control based on a Control.Command
<C extends Control, B extends ControlBuilder<C, B>> B	copy()	Returns a new ControlBuilder instance, based on a copy of this control.
Optional<String>	description()
Optional<ObservableState>	enabled()	If this method returns an empty Optional this Control is always enabled.
Optional<Font>	font()
Optional<Color>	foreground()
Collection<String>	keys()
Optional<KeyStroke>	keyStroke()
Optional<Icon>	largeIcon()
OptionalInt	mnemonic()
void	setEnabled(boolean enabled)	Unsupported, the enabled state of Controls is based on their enabled state observer
Optional<Icon>	smallIcon()
static ToggleControl	toggle(State state)	Creates a new ToggleControl based on the given state
static ToggleControl	toggle(Value<Boolean> value)	Creates a new ToggleControl based on the given value

Methods inherited from interface javax.swing.Action

accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Method Details

description

Optional<String> description()

Returns:

the description or an empty Optional if none is available

caption

Optional<String> caption()

Returns:

the caption or an empty Optional if none is available

enabled

Optional<ObservableState> enabled()

If this method returns an empty Optional this Control is always enabled.

Returns:

an ObservableState indicating whether this Control is enabled

mnemonic

OptionalInt mnemonic()

Returns:

the mnemonic or an empty Optional if none is available

keyStroke

Optional<KeyStroke> keyStroke()

Returns:

the KeyStroke associated with this Control or an empty Optional if none is available

smallIcon

Optional<Icon> smallIcon()

Returns:

the small icon or an empty Optional if none is available

largeIcon

Optional<Icon> largeIcon()

Returns:

the large icon or an empty Optional if none is available

background

Optional<Color> background()

Returns:

the background color or an empty Optional if none is available

foreground

Optional<Color> foreground()

Returns:

the foreground color or an empty Optional if none is available

font

Optional<Font> font()

Returns:

the font or an empty Optional if none is available

keys

Collection<String> keys()

Returns:

the keys for values that have been set for this control

See Also:

• Action.getValue(String)

setEnabled

void setEnabled(boolean enabled)

Unsupported, the enabled state of Controls is based on their enabled state observer

Specified by:

setEnabled in interface Action

Parameters:

enabled - the enabled status

Throws:

UnsupportedOperationException - always

See Also:

• ControlBuilder.enabled(ObservableState)

copy

<C extends Control,
B extends ControlBuilder<C,
B>>
B copy()

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

Type Parameters:

C - the control type

B - the builder type

Returns:

a new builder

command

static CommandControl command(Control.Command command)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base the control

Returns:

a Control for calling the given Control.Command

action

static CommandControl action(Control.ActionCommand actionCommand)

Creates a control based on a Control.ActionCommand

Parameters:

actionCommand - the Control.ActionCommand on which to base the control

Returns:

a Control for calling the given Control.ActionCommand

toggle

static ToggleControl toggle(Value<Boolean> value)

Creates a new ToggleControl based on the given value

Parameters:

value - the value

Returns:

a new ToggleControl

toggle

static ToggleControl toggle(State state)

Creates a new ToggleControl based on the given state

Parameters:

state - the state

Returns:

a new ToggleControl

builder

static Control.BuilderFactory builder()

Returns:

a new Control Control.BuilderFactory instance