Module is.codion.swing.common.model

Package is.codion.swing.common.model.component.button

Class NullableToggleButtonModel

java.lang.Object

javax.swing.DefaultButtonModel

is.codion.swing.common.model.component.button.NullableToggleButtonModel

All Implemented Interfaces:

ItemSelectable, Serializable, ButtonModel

public final class NullableToggleButtonModel
extends DefaultButtonModel

A ToggleButtonModel implementation, which allows the null state. The states are null -> false -> true. Heavily influenced by TristateCheckBox by Heinz M. Kabutz http://www.javaspecialists.eu/archive/Issue145.html Included with express permission from the author, 2019.

Author:

Heinz M. Kabutz, Björn Darri Sigurðsson

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NULL	The item state NULL.

Fields inherited from class javax.swing.DefaultButtonModel

actionCommand, ARMED, changeEvent, ENABLED, group, listenerList, mnemonic, PRESSED, ROLLOVER, SELECTED, stateMask

Method Summary

Modifier and Type	Method	Description
@Nullable Boolean	get()
boolean	isSelected()
void	next()	Iterates between the states: false -> null -> true
static NullableToggleButtonModel	nullableToggleButtonModel()	Instantiates a new NullableToggleButtonModel with a null initial state.
static NullableToggleButtonModel	nullableToggleButtonModel(@Nullable Boolean initialState)	Instantiates a new NullableToggleButtonModel with the given initial state.
void	set(@Nullable Boolean state)
void	setSelected(boolean selected)	Sets the underlying state to true or false

Methods inherited from class javax.swing.DefaultButtonModel

addActionListener, addChangeListener, addItemListener, fireActionPerformed, fireItemStateChanged, fireStateChanged, getActionCommand, getActionListeners, getChangeListeners, getGroup, getItemListeners, getListeners, getMnemonic, getSelectedObjects, isArmed, isEnabled, isPressed, isRollover, removeActionListener, removeChangeListener, removeItemListener, setActionCommand, setArmed, setEnabled, setGroup, setMnemonic, setPressed, setRollover

Methods inherited from class java.lang.Object

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

Field Details

NULL

public static final int NULL

The item state NULL.

See Also:

• ItemEvent.SELECTED
• ItemEvent.DESELECTED
• Constant Field Values

Method Details

isSelected

public boolean isSelected()

Specified by:

isSelected in interface ButtonModel

Overrides:

isSelected in class DefaultButtonModel

Returns:

true if the underlying state is true

setSelected

public void setSelected(boolean selected)

Sets the underlying state to true or false

Specified by:

setSelected in interface ButtonModel

Overrides:

setSelected in class DefaultButtonModel

Parameters:

selected - the new state

get

public @Nullable Boolean get()

Returns:

the toggle state

set

public void set(@Nullable Boolean state)

Parameters:

state - the toggle state

next

public void next()

Iterates between the states: false -> null -> true

This is the same order as used by macOS, win32, IntelliJ IDEA and on the web as recommended by W3C.

nullableToggleButtonModel

public static NullableToggleButtonModel nullableToggleButtonModel()

Instantiates a new NullableToggleButtonModel with a null initial state.

nullableToggleButtonModel

public static NullableToggleButtonModel nullableToggleButtonModel(@Nullable Boolean initialState)

Instantiates a new NullableToggleButtonModel with the given initial state.

Parameters:

initialState - the initial state