Package com.vaadin.flow.server.menu

Record Class MenuEntry

java.lang.Object
java.lang.Record
com.vaadin.flow.server.menu.MenuEntry
Record Components:
path - the path to navigate to
title - the title to display
order - the order in the menu or null for default order
icon - Icon to use in the menu or null for no icon. Value can go inside a <vaadin-icon> element's icon attribute which accepts icon group and name like 'vaadin:file'. Or it can go to a <vaadin-icon> element's src attribute which takes path to the icon. E.g. 'line-awesome/svg/lock-open-solid.svg'.
menuClass - the source class with Menu annotation or null if not available. Always null for Hilla/TypeScript client views.
children - the entries nested under this entry, never null but empty for a flat (non-hierarchical) entry
All Implemented Interfaces:
Serializable
public record MenuEntry(String path, String title, Double order, String icon, Class<? extends Component> menuClass, List<MenuEntry> children) extends Record implements Serializable
Menu entry for the main menu.

An entry may carry nested children when obtained from MenuConfiguration.getMenuEntriesTree(), forming a hierarchical menu. The flat MenuConfiguration.getMenuEntries() returns entries with no children.

See Also:

  • Constructor Details

    • MenuEntry

      public MenuEntry(String path, String title, Double order, String icon, Class<? extends Component> menuClass)
      Creates a flat menu entry with no children.
      Parameters:
      path - the path to navigate to
      title - the title to display
      order - the order in the menu or null for default order
      icon - the icon to use in the menu or null for no icon
      menuClass - the source @Menu class or null if not available

    • MenuEntry

      public MenuEntry(String path, String title, Double order, String icon, Class<? extends Component> menuClass, List<MenuEntry> children)
      Normalizes children to a non-null, unmodifiable list so that children() is never null (e.g. after deserialization of an entry written before children existed).

  • 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.

    • path

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

    • title

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

    • order

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

    • icon

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

    • children

      public List<MenuEntry> children()
      Returns the value of the children record component.
      Returns:
      the value of the children record component