Package eu.rarogsoftware.rarog.platform.api.plugins.web.page.ui

Record Class UiFragment

java.lang.Object
java.lang.Record
eu.rarogsoftware.rarog.platform.api.plugins.web.page.ui.UiFragment
Record Components:
key - unique key used to identify element under type
placement - string value identifying unique place in application where fragment should be rendered. Placement value is defined by component using UI Fragments. For example "adminPanelQuickAccess" is top left menu with navigation elements.
resource - relative link to resource to be displayed. Usually it should be link to JS with react component, but it may be different for some placements. The best is to consult with documentation for specific placement to make sure.
order - numerical key used to sort elements under the same placement
public record UiFragment(String key, String placement, String resource, int order) extends Record
Represents single UI element that should be dynamically rendered.

NOTE: elements are showed sorted by order property, then by key.

  • Constructor Details

    • UiFragment

      public UiFragment(String key, String placement, String resource, int order)
      Creates an instance of a UiFragment record class.
      Parameters:
      key - the value for the key record component
      placement - the value for the placement record component
      resource - the value for the resource record component
      order - the value for the order 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 '=='.
      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.
      Returns:
      the value of the key record component

    • placement

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

    • resource

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

    • order

      public int order()
      Returns the value of the order record component.
      Returns:
      the value of the order record component