Record Class ElementLayout

java.lang.Object

java.lang.Record

net.ixdarklord.folios.internal.client.page.ElementLayout

public record ElementLayout(@Nullable ElementLayout.Overflow overflow, @Nullable ElementLayout.Height height, @Nullable ElementLayout.Height minHeight, @Nullable FoliosAlign alignment, @Nullable FoliosAlign titleAlignment, @Nullable ElementLayout.Anchor anchor)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ElementLayout.Anchor
static final record	ElementLayout.Height
static enum	ElementLayout.Overflow

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MIN_HEIGHT
static final ElementLayout	NONE

Constructor Summary

Constructors

Constructor	Description
ElementLayout(@Nullable ElementLayout.Overflow overflow, @Nullable ElementLayout.Height height, @Nullable ElementLayout.Height minHeight, @Nullable FoliosAlign alignment, @Nullable FoliosAlign titleAlignment, @Nullable ElementLayout.Anchor anchor)	Creates an instance of a ElementLayout record class.

Method Summary

Modifier and Type	Method	Description
@Nullable FoliosAlign	alignment()	Returns the value of the alignment record component.
@Nullable ElementLayout.Anchor	anchor()	Returns the value of the anchor 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 ElementLayout.Height	height()	Returns the value of the height record component.
int	leastHeight(int full)
@Nullable ElementLayout.Height	minHeight()	Returns the value of the minHeight record component.
ElementLayout	or(ElementLayout outer)
@Nullable ElementLayout.Overflow	overflow()	Returns the value of the overflow record component.
ElementLayout.Overflow	overflowOrFlow()
static ElementLayout	read(@Nullable com.google.gson.JsonObject json, String where)
@Nullable FoliosAlign	titleAlign()
@Nullable FoliosAlign	titleAlignment()	Returns the value of the titleAlignment record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

NONE

public static final ElementLayout NONE

MIN_HEIGHT

public static final int MIN_HEIGHT

See Also:

• Constant Field Values

Constructor Details

ElementLayout

public ElementLayout(@Nullable ElementLayout.Overflow overflow,
 @Nullable ElementLayout.Height height,
 @Nullable ElementLayout.Height minHeight,
 @Nullable FoliosAlign alignment,
 @Nullable FoliosAlign titleAlignment,
 @Nullable ElementLayout.Anchor anchor)

Creates an instance of a ElementLayout record class.

Parameters:

overflow - the value for the overflow record component

height - the value for the height record component

minHeight - the value for the minHeight record component

alignment - the value for the alignment record component

titleAlignment - the value for the titleAlignment record component

anchor - the value for the anchor record component

Method Details

read

public static ElementLayout read(@Nullable com.google.gson.JsonObject json,
 String where)

or

public ElementLayout or(ElementLayout outer)

leastHeight

public int leastHeight(int full)

overflowOrFlow

public ElementLayout.Overflow overflowOrFlow()

titleAlign

public @Nullable FoliosAlign titleAlign()

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

overflow

public @Nullable ElementLayout.Overflow overflow()

Returns the value of the overflow record component.

Returns:

the value of the overflow record component

height

public @Nullable ElementLayout.Height height()

Returns the value of the height record component.

Returns:

the value of the height record component

minHeight

public @Nullable ElementLayout.Height minHeight()

Returns the value of the minHeight record component.

Returns:

the value of the minHeight record component

alignment

public @Nullable FoliosAlign alignment()

Returns the value of the alignment record component.

Returns:

the value of the alignment record component

titleAlignment

public @Nullable FoliosAlign titleAlignment()

Returns the value of the titleAlignment record component.

Returns:

the value of the titleAlignment record component

anchor

public @Nullable ElementLayout.Anchor anchor()

Returns the value of the anchor record component.

Returns:

the value of the anchor record component