Package su.onno.ui

Record Class UiLayout

java.lang.Object

java.lang.Record

su.onno.ui.UiLayout

public record UiLayout(List<UiLayout.Section> sections, List<UiLayoutBuilder.WidgetConfig> widgets, List<UiLayout.Profile> profiles, UiIdentityLink identity, ShellConfig shell)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	UiLayout.PageRef	A sidebar link to an authored Page at an arbitrary route — the nav peer of an entity reference.
static enum	UiLayout.Placement
static final record	UiLayout.Profile	A named persona bundle: its own navigation (sections), home (widgets), branding (title/theme) and the roles that resolve into it.
static final record	UiLayout.ResolvedItem
static final record	UiLayout.ResolvedSection
static final record	UiLayout.Section

Constructor Summary

Constructors

Constructor	Description
UiLayout(List<UiLayout.Section> sections, List<UiLayoutBuilder.WidgetConfig> widgets, List<UiLayout.Profile> profiles, UiIdentityLink identity, ShellConfig shell)	Creates an instance of a UiLayout record class.

Method Summary

Modifier and Type	Method	Description
UiLayout.Profile	defaultProfile()	The implicit "default" persona: the top-level sections and widgets, served to any user who matches no named UiLayout.Profile.
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.
UiIdentityLink	identity()	Returns the value of the identity record component.
List<UiLayout.Profile>	profiles()	Returns the value of the profiles record component.
List<UiLayout.Section>	sections()	Returns the value of the sections record component.
ShellConfig	shell()	Returns the value of the shell record component.
final String	toString()	Returns a string representation of this record class.
List<UiLayoutBuilder.WidgetConfig>	widgets()	Returns the value of the widgets record component.

Methods inherited from class java.lang.Object

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

Constructor Details

UiLayout

public UiLayout(List<UiLayout.Section> sections,
 List<UiLayoutBuilder.WidgetConfig> widgets,
 List<UiLayout.Profile> profiles,
 UiIdentityLink identity,
 ShellConfig shell)

Creates an instance of a UiLayout record class.

Parameters:

sections - the value for the sections record component

widgets - the value for the widgets record component

profiles - the value for the profiles record component

identity - the value for the identity record component

shell - the value for the shell record component

Method Details

defaultProfile

public UiLayout.Profile defaultProfile()

The implicit "default" persona: the top-level sections and widgets, served to any user who matches no named UiLayout.Profile. Curation layer only — access is still enforced per data endpoint regardless of profile.

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.

sections

public List<UiLayout.Section> sections()

Returns the value of the sections record component.

Returns:

the value of the sections record component

widgets

public List<UiLayoutBuilder.WidgetConfig> widgets()

Returns the value of the widgets record component.

Returns:

the value of the widgets record component

profiles

public List<UiLayout.Profile> profiles()

Returns the value of the profiles record component.

Returns:

the value of the profiles record component

identity

public UiIdentityLink identity()

Returns the value of the identity record component.

Returns:

the value of the identity record component

shell

public ShellConfig shell()

Returns the value of the shell record component.

Returns:

the value of the shell record component