Package org.vaadin.addons.componentfactory.sidenavrail

Enum Class RootMatchNested

java.lang.Object
java.lang.Enum<RootMatchNested>
org.vaadin.addons.componentfactory.sidenavrail.RootMatchNested
All Implemented Interfaces:
Serializable, Comparable<RootMatchNested>, Constable
public enum RootMatchNested extends Enum<RootMatchNested>
Controls when the SideNavRail forces matchNested = true on every root item, so a root carries the [current] highlight whenever any descendant route is active. The original per-item value is snapshotted on activation and restored when the override is turned off again, so a SideNavItem.setMatchNested(boolean) call the application made itself survives toggling this feature on and off.

  • Enum Constant Details

    • NONE

      public static final RootMatchNested NONE
      No automatic override. Each root item keeps whatever matchNested value the application set on it (default for plain SideNavItem is false). Matches the standard SideNav behaviour.

    • ONLY_RAIL

      public static final RootMatchNested ONLY_RAIL
      Override is active only while the rail is in rail mode (SideNavRail.isRailMode() == true). This is the default. Useful for the typical use case: in rail mode the active route is no longer visually anchored to an expanded parent, so forcing the root to highlight when a descendant route is current restores that orientation cue. The original matchNested value is restored when leaving rail mode.

    • ALL

      public static final RootMatchNested ALL
      Override is always active, regardless of rail mode. Useful in combination with SideNavRail.setChildrenOnlyInPopover(boolean) or any other configuration where the visible inline tree doesn't expose deeper levels, so the root needs to carry the [current] marker even in normal mode.

  • Method Details

    • values

      public static RootMatchNested[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RootMatchNested valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null