Record Class DialogInput.NumberRange

java.lang.Object

java.lang.Record

fr.fidorial.dialog.DialogInput.NumberRange

Record Components:

key - the identifier the value is sent under

label - the label displayed to the left of the slider

labelFormat - the translation key building the label, taking the label and the current value as arguments

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

start - the lowest value of the slider

end - the highest value of the slider

step - the increment between two accepted values, or null to accept any value in the range

initial - the value the slider starts on, or null for the middle of the range

All Implemented Interfaces:

DialogInput

Enclosing interface:

DialogInput

public static record DialogInput.NumberRange(String key, Component label, String labelFormat, int width, float start, float end, @Nullable Float step, @Nullable Float initial)
extends Record
implements DialogInput

A slider between two numbers.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DialogInput.NumberRange.Builder	Fluent builder for DialogInput.NumberRange.

Nested classes/interfaces inherited from interface DialogInput

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LABEL_FORMAT	Default value of labelFormat().

Fields inherited from interface DialogInput

DEFAULT_WIDTH, MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
NumberRange(String key, Component label, String labelFormat, int width, float start, float end, @Nullable Float step, @Nullable Float initial)	Creates an instance of a NumberRange record class.

Method Summary

Modifier and Type	Method	Description
float	end()	Returns the value of the end record component.
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.
@Nullable Float	initial()	Returns the value of the initial record component.
String	key()	Returns the value of the key record component.
Component	label()	Returns the value of the label record component.
String	labelFormat()	Returns the value of the labelFormat record component.
float	start()	Returns the value of the start record component.
@Nullable Float	step()	Returns the value of the step 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

Field Details

DEFAULT_LABEL_FORMAT

public static final String DEFAULT_LABEL_FORMAT

Default value of labelFormat().

Since:

0.1.0

See Also:

• Constant Field Values

Constructor Details

NumberRange

public NumberRange(String key,
 Component label,
 String labelFormat,
 int width,
 float start,
 float end,
 @Nullable Float step,
 @Nullable Float initial)

Creates an instance of a NumberRange record class.

Parameters:

key - the value for the key record component

label - the value for the label record component

labelFormat - the value for the labelFormat record component

width - the value for the width record component

start - the value for the start record component

end - the value for the end record component

step - the value for the step record component

initial - the value for the initial 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

labelFormat

public String labelFormat()

Returns the value of the labelFormat record component.

Returns:

the value of the labelFormat record component

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component

start

public float start()

Returns the value of the start record component.

Returns:

the value of the start record component

end

public float end()

Returns the value of the end record component.

Returns:

the value of the end record component

step

public @Nullable Float step()

Returns the value of the step record component.

Returns:

the value of the step record component

initial

public @Nullable Float initial()

Returns the value of the initial record component.

Returns:

the value of the initial record component