Record Class DialogActionButton

java.lang.Object

java.lang.Record

fr.fidorial.dialog.DialogActionButton

Record Components:

label - the text of the button

tooltip - the text shown on hover, or null

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

action - what pressing the button does, or null to only close the dialog

public record DialogActionButton(Component label, @Nullable Component tooltip, int width, @Nullable DialogAction action)
extends Record

A button of a dialog.

Since:

0.1.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_WIDTH	Default width of a button.
static final int	MAX_WIDTH	Largest width the client accepts for a button.

Constructor Summary

Constructors

Constructor	Description
DialogActionButton(Component label, @Nullable Component tooltip, int width, @Nullable DialogAction action)	Creates an instance of a DialogActionButton record class.

Method Summary

Modifier and Type	Method	Description
@Nullable DialogAction	action()	Returns the value of the action record component.
static DialogActionButton.Builder	builder(ComponentLike label)	Starts building a button.
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.
Component	label()	Returns the value of the label record component.
static DialogActionButton	of(ComponentLike label)	Creates a button of the default width that only dismisses the dialog.
static DialogActionButton	of(ComponentLike label, DialogAction action)	Creates a button of the default width.
@Nullable Component	tooltip()	Returns the value of the tooltip 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

MAX_WIDTH

public static final int MAX_WIDTH

Largest width the client accepts for a button.

Since:

0.1.0

See Also:

• Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default width of a button.

Since:

0.1.0

See Also:

• Constant Field Values

Constructor Details

DialogActionButton

public DialogActionButton(Component label,
 @Nullable Component tooltip,
 int width,
 @Nullable DialogAction action)

Creates an instance of a DialogActionButton record class.

Parameters:

label - the value for the label record component

tooltip - the value for the tooltip record component

width - the value for the width record component

action - the value for the action record component

Method Details

of

@Contract("_ -> new")
public static DialogActionButton of(ComponentLike label)

Creates a button of the default width that only dismisses the dialog.

Parameters:

label - the text on the button

Returns:

the button

Since:

0.1.0

of

@Contract("_, _ -> new")
public static DialogActionButton of(ComponentLike label,
 DialogAction action)

Creates a button of the default width.

Parameters:

label - the text on the button

action - what pressing the button does

Returns:

the button

Since:

0.1.0

builder

@Contract("_ -> new")
public static DialogActionButton.Builder builder(ComponentLike label)

Starts building a button.

Parameters:

label - the text on the button

Returns:

a fresh builder

Since:

0.1.0

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.

label

public Component label()

Returns the value of the label record component.

Returns:

the value of the label record component

tooltip

public @Nullable Component tooltip()

Returns the value of the tooltip record component.

Returns:

the value of the tooltip record component

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component

action

public @Nullable DialogAction action()

Returns the value of the action record component.

Returns:

the value of the action record component