Package su.onno.ui

Record Class UiLayout.PageRef

java.lang.Object
java.lang.Record
su.onno.ui.UiLayout.PageRef
Enclosing class:
UiLayout
public static record UiLayout.PageRef(String route, String label, String icon) extends Record
A sidebar link to an authored Page at an arbitrary route — the nav peer of an entity reference. Unlike a catalog/document (whose route and label derive from metadata), a page link carries its own route, display label, and icon. Lets a Layout surface a custom dashboard or report page (section("Reports").page("/ops", "Operations", "activity")).

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageRef(String route, String label, String icon)
    Creates an instance of a PageRef 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
    icon()
    Returns the value of the icon record component.
    String
    label()
    Returns the value of the label record component.
    String
    route()
    Returns the value of the route record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PageRef

      public PageRef(String route, String label, String icon)
      Creates an instance of a PageRef record class.
      Parameters:
      route - the value for the route record component
      label - the value for the label record component
      icon - the value for the icon 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. 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.

    • route

      public String route()
      Returns the value of the route record component.
      Returns:
      the value of the route record component

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • icon

      public String icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component