Module is.codion.swing.common.ui

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

Interface ToggleControl

All Superinterfaces:

Action, ActionListener, Control, EventListener

public interface ToggleControl
extends Control

A Control for toggling a boolean value.

Performing it toggles the value, a nullable one in the order false, null, true, as a NullableCheckBox does. A toggle button or a toggle menu item based on it links its value to the button instead, the button toggling it, the control providing the caption, icon and enabled state.

Nested Class Summary

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

Control.ActionCommand, Control.BuilderFactory, Control.Command

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
ToggleControlBuilder	copy()	Returns a ToggleControlBuilder instance, based on a copy of this control, using the same value
ToggleControlBuilder	copy(State state)	Returns a new ToggleControlBuilder instance, based on a copy of this control, using the given state.
ToggleControlBuilder	copy(Value<Boolean> value)	Returns a new ToggleControlBuilder instance, based on a copy of this control, using the given value.
static ControlKey<ToggleControl>	key(String name)
static ControlKey<ToggleControl>	key(String name, @Nullable KeyStroke defaultKeyStroke)
Value<Boolean>	value()

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, caption, description, enabled, font, foreground, keys, keyStroke, largeIcon, mnemonic, setEnabled, smallIcon

Method Details

value

Value<Boolean> value()

Returns:

the value being toggled by this toggle control

copy

ToggleControlBuilder copy()

Returns a ToggleControlBuilder instance, based on a copy of this control, using the same value

Specified by:

copy in interface Control

Returns:

a new builder

copy

ToggleControlBuilder copy(Value<Boolean> value)

Returns a new ToggleControlBuilder instance, based on a copy of this control, using the given value.

Parameters:

value - the value for the resulting toggle control

Returns:

a new builder

copy

ToggleControlBuilder copy(State state)

Returns a new ToggleControlBuilder instance, based on a copy of this control, using the given state.

Parameters:

state - the state for the resulting toggle control

Returns:

a new builder

key

static ControlKey<ToggleControl> key(String name)

Parameters:

name - the control name

Returns:

a new ControlKey for identifying a ToggleControl instance

key

static ControlKey<ToggleControl> key(String name,
 @Nullable KeyStroke defaultKeyStroke)

Parameters:

name - the control name

defaultKeyStroke - the default keystroke, null for none

Returns:

a new ControlKey for identifying a ToggleControl instance