Record Class DialogInput.SingleOption

java.lang.Object

java.lang.Record

fr.fidorial.dialog.DialogInput.SingleOption

Record Components:

key - the identifier the value is sent under

label - the label displayed to the left of the control

options - the options to pick from, never empty

labelVisible - whether the label is drawn at all

width - the width of the control, between 1 and 1024

All Implemented Interfaces:

DialogInput

Enclosing interface:

DialogInput

public static record DialogInput.SingleOption(String key, Component label, List<DialogInput.SingleOption.Entry> options, boolean labelVisible, int width)
extends Record
implements DialogInput

A drop-down of preset options.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DialogInput.SingleOption.Builder	Fluent builder for DialogInput.SingleOption.
static final record	DialogInput.SingleOption.Entry	One entry of a DialogInput.SingleOption control.

Nested classes/interfaces inherited from interface DialogInput

DialogInput.Bool, DialogInput.NumberRange, DialogInput.SingleOption, DialogInput.Text

Field Summary

Fields inherited from interface DialogInput

DEFAULT_WIDTH, MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
SingleOption(String key, Component label, List<DialogInput.SingleOption.Entry> options, boolean labelVisible, int width)	Creates an instance of a SingleOption record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	key()	Returns the value of the key record component.
Component	label()	Returns the value of the label record component.
boolean	labelVisible()	Returns the value of the labelVisible record component.
List<DialogInput.SingleOption.Entry>	options()	Returns the value of the options record component.
final String	toString()	Returns a string representation of this record class.
int	width()	Returns the value of the width record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SingleOption

public SingleOption(String key,
 Component label,
 List<DialogInput.SingleOption.Entry> options,
 boolean labelVisible,
 int width)

Creates an instance of a SingleOption record class.

Parameters:

key - the value for the key record component

label - the value for the label record component

options - the value for the options record component

labelVisible - the value for the labelVisible record component

width - the value for the width record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

key

public String key()

Returns the value of the key record component.

Specified by:

key in interface DialogInput

Returns:

the value of the key record component

label

public Component label()

Returns the value of the label record component.

Specified by:

label in interface DialogInput

Returns:

the value of the label record component

options

public List<DialogInput.SingleOption.Entry> options()

Returns the value of the options record component.

Returns:

the value of the options record component

labelVisible

public boolean labelVisible()

Returns the value of the labelVisible record component.

Returns:

the value of the labelVisible record component

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component